This package has been deprecated

Author message:

This package has reached end of life and is deprecated. Please refer to our support policy, https://www.itwinjs.org/learning/api-support-policies/, and changelog, https://www.itwinjs.org/v3/changehistory/3.0.0/#package-name-changes.

@bentley/eslint-plugin

ESLint plugin with default configuration and custom rules for iModel.js projects. For best results, use with Typescript 4.1+

Installation

You'll first need to install ESLint and @bentley/eslint-plugin:

npm i eslint --save-dev
npm i @bentley/eslint-plugin --save-dev

Usage

Add @bentley to the plugins section of your eslint configuration and (optionally) extend one of the provided configs. You can omit the /eslint-plugin suffix:

{
  "plugins": ["@bentley"],
  "extends": "plugin:@bentley/imodeljs-recommended"
}

Then configure the rules you want to override under the rules section.

{
  "rules": {
    "@bentley/rule-name": "off"
  }
}

Using with VSCode

VSCode has an ESLint plugin, but it has some issues with plugin resolution. In order to use this config without errors, it needs to be configured to resolve plugins relative to this package (in .vscode/settings.json):

"eslint.options": {
  "resolvePluginsRelativeTo": "./node_modules/@bentley/eslint-plugin",
  ...
},

As a side effect, any additional plugins added in consumer packages won't be loaded. If you want to use another ESLint plugin, there are two options:

1. Submit a PR to add the ESLint plugin (and an accompanying optional configuration) to this package.
2. Add all the plugins used in this package along with the new one to your package's devDependencies and remove the above configuration from settings.json.

Rules not in recommended configs

no-internal - prevents use of internal/alpha APIs. Example configurations

// custom config
"@bentley/no-internal": [
"error",
  {
    "tag": ["internal", "alpha", "beta"]
  }
]

// default config
"@bentley/no-internal": "error"
// tag is set to ["internal", "alpha"] by default

The rule will report an error whenever you use anything marked with one of the tags configured in the tag option. Allowed tags: internal, alpha, beta, public.

Helper commands

no-internal-report - Runs eslint with the @bentley/no-internal rule turned on ("error") using a custom formatter that summarizes the output

This can be run using npx or from the scripts section of package.json:

  "scripts": {
    "no-internal-report": "no-internal-report src/**/*.ts*"
  },

This command forwards all arguments to eslint, so it can be further customized as needed. For example, to specify the tags for the no-internal rule:

  "scripts": {
    "no-internal-report": "no-internal-report -rule '@bentley/no-internal: ['error', { 'tag': [ 'internal', 'alpha', 'beta' ]}]' src/**/*.ts*"
  },