eslint-config-ssjs

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

ESLint shareable config

Features

rules limited to *.ssjs files
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

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
  },
  "overrides": [
    {
      // your target JavaScript version and conflicting rules should only be
      // set as override, as they would otherwise supersede the SSJS config
      "files": ["*.js"],
      "parserOptions": {
        "ecmaVersion": 6
      },
      "rules": {
        // the following rules should only be set here in the 'overrides' section
        "prettier/prettier": "warn",
        // note that the following is not setting proper values to the rules as
        // that is up to your style guide. The empty "" are merely placeholders
        "comma-dangle": "",
        "new-cap": "",
        "no-console": "",
        "no-extend-native": "",
        "no-new": "",
        "no-prototype-builtins": "",
        "no-throw-literal": "",
        "no-use-before-define": "",
        "no-var": ""
      }
    }
  ]

}

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

joernberkefeld / eslint-config-ssjs Goto Github PK