linter-bundle

Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.

Usage no npm install needed!

<script type="module">
  import linterBundle from 'https://cdn.skypack.dev/linter-bundle';
</script>

README

linter-bundle

npm version Dependency Status Known Vulnerabilities npm MIT license

Ready-to use bundle of linting tools, containing configurations for

The linting tools are running in parallel, which can improve the performance by more than 20 percent.

Used plugins

This setup is using the following additional plugins:

ESLint

Beside that, the following additional rules are part of this bundle:

stylelint

Previously used, but now unmaintained plugins

Unfortunately a couple of previously used plugins are not regularly maintained or depend on unmaintained third-party code which blocks them from updating, so they don't provide updates for the major releases of the linters (ESLint and Stylelint). For that reason the following plugins are not used anymore:

If these plugins are maintained again, the plugins will also be used again.

Install

Ensure you are using atleast Node.js version 14.

npm install linter-bundle --save-dev

Usage examples

package.json

{
  "scripts": {
    "lint": "lint tsc ts sass md audit",
    "lint-different-configurations": "lint tsc --tsconfig=./path1/tsconfig.json tsc --tsconfig=./path2/tsconfig.json ts sass md audit"
  }
}

.eslintrc.js

// Sometimes it's required to adjust specific settings. These can be defined here:
global.linterBundleSettings = {
  overrides: {
    general: {
      'no-restricted-globals': {
        additionalRestictions: [
          {
            name: 'fetch',
            message: 'Use Utils.fetchWithTimeout() instead.'
          }
        ]
      },
      'no-restricted-properties': {
        additionalRestictions: [
          {
            object: 'localStorage',
            property: 'getItem',
            message: 'Use StorageHelper.getItem() instead.'
          },
          {
            object: 'localStorage',
            property: 'setItem',
            message: 'Use StorageHelper.setItem() instead.'
          },
          {
            object: 'localStorage',
            property: 'removeItem',
            message: 'Use StorageHelper.removeItem() instead.'
          }
        ]
      },
      'no-restricted-syntax': {
        additionalRestictions: [
          {
            selector: 'NewExpression[callee.name="Blob"]',
            message: 'Use BlobHelper.create() instead of new Blob().'
          }
        ]
      },
      'import/order': {
        additionalExternalPatterns: ['@sentry/*']
      }
    },
    react: {
      'react/forbid-component-props': {
        allowClassNameFor: ['Checkbox', 'Grid', 'GridItem', 'Button'],
        allowStyleFor: []
      }
    }
  }
};

module.exports = {
  extends: [
    require.resolve('linter-bundle/eslint'),
    require.resolve('linter-bundle/eslint/overrides-gatsby'),
    require.resolve('linter-bundle/eslint/overrides-javascript'),
    // require.resolve('linter-bundle/eslint/overrides-javascript-lazy'),
    require.resolve('linter-bundle/eslint/overrides-jest'),
    require.resolve('linter-bundle/eslint/overrides-jsdoc'),
    require.resolve('linter-bundle/eslint/overrides-react'),
    require.resolve('linter-bundle/eslint/overrides-storybook'),
    require.resolve('linter-bundle/eslint/overrides-type-declarations'),
    require.resolve('linter-bundle/eslint/overrides-worker')
  ],
  ignorePatterns: [
    // Define paths which should be ignored here. (The following paths are ignored by default: '.cache/', '.vscode/', 'coverage/', 'node_modules/')
    'build/',
    'etc/',
    'private/'
  ],
  globals: {
    // Define project-specific global variables. JavaScript built-in objects (like ArrayBuffer, typed arrays, Promise, Set/Map etc.) are automatically set to
    // 'readonly', and don't need to be added here.
    __DEV__: 'readonly',
    APP_NAME: 'readonly',
    APP_VERSION: 'readonly',
  }
};
Available extends

Source | Description | Rules setup -|-|- linter-bundle/eslint | General rule setup. This is also the base for the following overrides. | View linter-bundle/eslint/overrides-gatsby | Settings for Gatsby-based projects. | View linter-bundle/eslint/overrides-javascript | Strict settings for JavaScript files, which enforces correct types everywhere. | View linter-bundle/eslint/overrides-javascript-lazy | Can be used instead of overrides-javascript. It's less strict and allows the any type. | View linter-bundle/eslint/overrides-jest | Settings for projects using Jest. | View linter-bundle/eslint/overrides-jsdoc | Settings for projects using JSDoc comments. | View linter-bundle/eslint/overrides-react | Settings for projects using React comments. | View linter-bundle/eslint/overrides-storybook | Settings for projects using Storybook comments. | View linter-bundle/eslint/overrides-type-declarations | Settings for type declaration files (.d.ts). | View linter-bundle/eslint/overrides-worker | Settings for projects using Web Workers. | View

stylelint.config.js

global.linterBundleSettings = {
  // The prefix used for the 'custom-media-pattern' (`@media (--my-prefix-foo)`) and 'custom-property-pattern' (`var(--my-prefix-bar)`) rule. If not defined, these rules are disabled.
  propertyPrefix: 'my-prefix'
};

module.exports = {
  extends: 'linter-bundle/stylelint'
};

.markdownlint.json

{
  "extends": "node_modules/linter-bundle/markdownlint/base.json"
}

.gitignore / .npmignore

.eslintcache

Available commands

The command line arguments are separated in groups. Here are some examples:

# Run TypeScript compiler, ESLint, Stylelint, Markdownlint, and audit in the given order, using the default configuration
lint tsc ts sass md audit

# Run ESLint and Audit, and show their terminal output even on success
lint --verbose ts audit

# Run ESLint and Audit, and show the ESLint terminal output even on success
lint ts --verbose audit

# Run TypeScript compiler and ESLint, but with different tsconfig.json files
lint tsc --tsconfig=./cypress/tsconfig.json ts --tsconfig=./.storybook/tsconfig.json

# Run TypeScript compiler twice with different configurations
lint tsc tsc --tsconfig="./cypress/tsconfig.json"

Below, you can find the available command line arguments and what they are doing.

General optional command line arguments

Argument | Description | Example -|-|- --verbose | By default, the terminal output of linters is only shown if an error occurs. Use this option to show their terminal output even on success. | --verbose --timing | Show information how long each linting process was running. | --timing --git | Experimental Only lint (ESLint, Stylelint and Markdownlint) files which have been detected as changed (compared to the upstream branch) by Git. This can result into massive performance improvements on large code bases, but also lead to undetected issues with cross-file rules. | --git

lint tsc

Will execute:

tsc --skipLibCheck --noEmit

Optional command line arguments for lint tsc

Argument | Description | Example -|-|- --tsconfig | Allows to specifiy a different tsconfig.json file. | --tsconfig=./cypress/tsconfig.json

lint ts

Will execute:

eslint "./**/*.{js,jsx,ts,tsx}" --format unix

Additionally, the environment variable TIMING is set to 10.

Optional command line arguments for lint ts

Argument | Description | Example -|-|- --tsconfig | Allows to specifiy a different tsconfig.json file. | --tsconfig=./cypress/tsconfig.json --include | Patterns with files which should be considered | --include="./cypress/**/*.ts" --exclude | Patterns with files which should not be considered. Can be used multiple times for different patterns. Used as --ignore-pattern argument for ESLint. | --exclude="cypress" --exclude=".storybook"

lint sass

Will execute:

stylelint "src/**/*.scss" --formatter unix --report-needless-disables --report-invalid-scope-disables --report-descriptionless-disables

lint md

Will execute:

markdownlint **/*.md --ignore node_modules

lint audit

If a package.json exist, it will execute:

better-npm-audit audit -l moderate -p

If a yarn.lock exist, it will execute:

improved-yarn-audit --min-severity moderate --fail-on-missing-exclusions --ignore-dev-deps

Optional command line arguments for lint audit

Argument | Description | Example -|-|- --min-severity | Minimum severity to treat as an error, default is moderate (info, low, moderate, high, critical). Used as -l argument for better-npm-audit, and --min-severity argument for improved-yarn-audit. | --min-severity=moderate --exclude | Comma-separated list of advisory IDs to ignore. Used as -i argument for better-npm-audit, and --exclude argument for improved-yarn-audit. | --exclude=118,577

VSCode setup

ESLint

For VSCode I recommend the ESLint extension.

To ensure the ESLint plugins are correctly loaded, you need to adjust the settings of this plugin.

This can be done by adding these options to your .vscode/settings.json:

{
  "eslint.nodePath": "./node_modules/linter-bundle/node_modules/eslint",
  "eslint.options": {
    "overrideConfigFile": "./.eslintrc.js",
    "resolvePluginsRelativeTo": "./node_modules/linter-bundle",
    "rulePaths": ["./node_modules/linter-bundle/eslint/rules"],
    "reportUnusedDisableDirectives": "error",
  }
}

If the ESLint extension shows the following message on the bottom-right:

https://cdn.jsdelivr.net/gh/jens-duttke/linter-bundle@f7d514f/vscode-eslint-1.png

Click on "Select Node Path". A selection popup will appear at the top of the editor:

https://cdn.jsdelivr.net/gh/jens-duttke/linter-bundle@f7d514f/vscode-eslint-2.png

Here, choose the option "Use NODE_PATH value defined via setting".

stylelint

For VSCode I recommend the stylelint extension.

To ensure the stylelint plugins are correctly loaded, you need to adjust the settings of this plugin in your .vscode/settings.json:

{
  "stylelint.enable": true,
  "stylelint.validate": [
    "scss"
  ],
  "css.validate": false,
  "less.validate": false,
  "scss.validate": false
}

Auto-fix code on save

In order to fix the code according to the ESLint/stylelint rules when saving, the following settings can be added to your .vscode/settings.json:

{
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true,
    "source.fixAll.stylelint": true
  }
}

Rulers

To visualize the max line-length rules in VSCode, you can activate rulers, by adding the following settings to your .vscode/settings.json:

{
  "[markdown]": {
    "editor.rulers": [300]
  },
  "[scss]": {
    "editor.rulers": [160]
  },
  "[typescript]": {
    "editor.rulers": [300]
  },
  "[typescriptreact]": {
    "editor.rulers": [300]
  }
}