ESLint SharePoint Framework Preset

Update your SharePoint Framework v1.12.1+ project to replace the deprecated & outdated TSLint utility in favor of ESLint!

This utility is based on our blog post: Get with the times & ditch TSLint in favor of ESLint in SharePoint Framework projects.

NOTE: This preset does not contain any support for SPFx projects that utilize React. See @voitanos/eslint-preset-react for the React version of this preset.

Installing this this preset in your SPFx project will do the following:

1. install all dependencies required for ESLint to support TypeScript
2. install a gulp task for running ESLint as part of your toolchain, both independently and also as a pre-task to the existing build task
3. copy a bare-bones ESLint configuration file to your project's ./config folder
4. disable TSLint and remove the tslint.json file from your project

Installation

Install the desired ESLint preset using your package manager of choice:

npm install @voitanos/eslint-preset-spfx --save-dev

This will install eslint, gulp-eslint, & two utilities that add TypeScript file support to ESLint as dependencies in your project.

The postinstall script will add a ./config/eslint.json configuration file for ESLint and the ./.eslintignore configuration file that tells ESLint what files to ignore.

IMPORTANT: Make sure you install the version of the preset that matches the version of TypeScript you're using in your project. See Installing specific preset versions for details on how to determine the correct version.

NOTE: A specific version of eslint is used to support the SPFx supported version of TypeScript as more current versions of eslint require newer versions of TypeScript that is not included in default SPFx projects.

Installing specific preset versions

Figuring out the correct matrix of package versions to install can be challenging. This mostly comes down to TypeScript.

ESLint v6 is supported for use with TypeScript versions >= v3.2.1 and < v3.7.0 while ESLint v7 supports TypeScript >= v3.8. In addition, you must install the correct supporting packages for ESLint and TypeScript based on the version of ESLint you're using.

Sounds confusing, doesn't it?

But no worries! We've done the hard part of figuring out what combinations of versions you need.

Determine the TypeScript version of your project

First, determine the version of TypeScript your SPFx project uses:

1. Open the package.json file in your SPFx project.

2. Within the devDependencies object, look for the package that starts with the name @microsoft/rush-stack-compiler-.

   This package is the bridge to a specific version of TypeScript. The TypeScript version is indicated by the last part of the name of the package.

   For example, consider the following entry in the package.json file:

   {
     ...
     "devDependencies": {
       "@microsoft/rush-stack-compiler-3.7": "0.2.3",
       ...
     }
   }

   This SPFx project is using TypeScript v3.7.

Determine the matching preset version

The next step is to determine the corresponding version of the preset that is configured with the version of TypeScript in your project.

The preset NPM package contains distribution tags that are used to alias specific published versions of the package. We use them to indicate which version is built for a specific version of TypeScript.

1. Get a list of all distribution tags by executing the following command:

   npm info @voitanos/eslint-preset-spfx

2. Locate the matching TypeScript version. The previous command will write the package information to the console as well as a list of the published distribution tags:

   dist-tags:
   latest: 1.0.0             next: 1.1.0-beta.b385582  ts3.7: 1.0.0

   From this output, you can see three tags:

   • latest: the most current stable version of the NPM package that's been published
   • next: the next version of the NPM package, usually a beta and used for testing
   • ts3.7: the version built for TypeScript v3.7

Install a specific preset package version

Using the information above, install the specific preset package:

npm install @voitanos/[email protected] --save-dev --save-exact

Validating installation

To validate a successful install, try it out!

1. Execute the following to see a list of installed tasks:

   gulp --tasks

2. Verify the eslint task is present, as you can see below:

   ➜ gulp --tasks
   [16:27:33] Tasks for ~/_play/eslint-test1/gulpfile.js
   [16:27:33] ├── clean
   [16:27:33] ├── eslint    <<<<<
   [16:27:33] ├── build
   [16:27:33] ├── default
   [16:27:33] ├── bundle
   [16:27:33] ├── deploy-azure-storage
   [16:27:33] ├── package-solution
   [16:27:33] ├── test
   [16:27:33] ├── serve-deprecated
   [16:27:33] ├── trust-dev-cert
   [16:27:33] ├── untrust-dev-cert
   [16:27:33] ├── test-only
   [16:27:33] └── serve

ESLint rules & default SPFx linting rules

Unlike a normal SPFx project, no SPFx-specific linting rules are applied in the ESLint config provided by this preset.

However, the ./config/eslint.spfx.json file added to your project by this preset contains all the ESLint rules that match the TSLint rules defined in the default SPFx project's ./tslint.json config file.

To use the SPFx ported TSLints with ESLint, uncomment the line in the extends:[] array within the ./config/eslint.json file.

Refer to the comments in the ./config/eslint.json configuration file added to your project for more information.