You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

eslint-config-ssjs

Package Overview
Dependencies
Maintainers
0
Versions
18
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

eslint-config-ssjs

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


Version published
Weekly downloads
903
increased by31.63%
Maintainers
0
Created
Weekly downloads
 

Readme

Source

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.

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

Keywords

FAQs

Package last updated on 30 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc