npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-config-ssjs

v2.0.0

Published

ESLint config for Salesforce Marketing Cloud's Server-Side JavaScript

Downloads

1,653

Readme

eslint-config-ssjs

Preset for Salesforce Marketing Cloud's Server-Side JavaScript.

ESLint shareable config

NPM

Features

  • rules limited to *.ssjs files but can be extended to other files by adapting your eslint.config.js
  • all SSJS classes/methods offered by SFMC are defined as unchangable globals
  • ecma script 3 pre-defined
  • quirks of SSJS handled via custom rules
  • based on eslint recommended rules with as little changes as possible

Installation

npm install --save-dev eslint eslint-config-ssjs

Usage

Flat Config: eslint.config.js

Important: Requires ESLint >=8.56.0 and eslint-config-ssjs >=2.0.0

This plugin exports a recommended config that enforces good practices.

ES Module (Recommended)

The folowing will limit SSJS rules to files ending on *.ssjs:

import sfmcSsjs from 'eslint-config-ssjs';

export default [
	// …
	{
		...sfmcSsjs.configs.recommended,
		files: ['**/*.ssjs'],
	},
];

If you don't plan on writing any browser (normal) JavaScript, you can also use the following. This will apply the rules to all files:ggn

import sfmcSsjs from 'eslint-config-ssjs';

export default [
	// …
	sfmcSsjs.configs.recommended,
];

CommonJS

'use strict';
const sfmcSsjs = require('eslint-config-ssjs');

module.exports = [
	// …
	{
		...sfmcSsjs.configs.recommended,
		files: ['**/*.ssjs'],
	},
];

Legacy: .eslintrc.* or package.json

Important: Requires ESLint <9.0.0 and eslint-config-ssjs <2.0.0

Once the eslint-config-ssjs package is installed, you can use it by specifying ssjs in the extends section of your ESLint configuration.

Important: Make sure that your SSJS files end on *.ssjs and not on *.js.

{
  "extends": "ssjs",
  "rules": {
    // your other rules
  }
}

It's good practice to use eslint:recommended ruleset in your project to support front end scripts.

To use SSJS in conjunction with ESLint's recommended rule set, extend with both, making sure to list ssjs last. We do recommend to also use this together with eslint-config-prettier and eslint-plugin-prettier

{
  "extends": ["eslint:recommended", "prettier", "ssjs"],
  "plugins": ["prettier"],
  "rules": {
    // your other rules that don't conflict with the SSJS config
  },
}

Using Prettier with SSJS

Starting with version 2.x of prettier, the plugin automatically has "trailingComma" set to "es5". That's a problem because SSJS actually does not support this.

Also, SFMC tends to remove all tabs when you save queries, scripts, code snippets, emails and cloud pages. We hence strongly recommend to set useTabs to false and define tabWidth according to your liking (2 or 4 are typical values).

Add the following to your .prettierrc file to ensure the above concerns are adressed:

{
	"useTabs": false,
	"tabWidth": 4,
	"singleQuote": true,
	"overrides": [
		{
			"files": "*.ssjs",
			"options": {
				"trailingComma": "none"
			}
		}
	]
}

Using the .ssjs extension in VSCode

Make sure you associate *.ssjs with JavaScript in your IDE. That should automatically enable linting via ESLint.

License

MIT licensed