backstage
@backstage/eslint-plugin
A collection of ESLint rules useful to Backstage projects.
Usage
This ESLint plugin is part of the default lint configuration provided by the Backstage CLI, so you generally do not need to install it manually.
If you do wish to install this plugin manually, start by adding it as a development dependency to your project:
yarn add --dev @backstage/eslint-plugin
Then add it to your ESLint configuration:
extends: [ 'plugin:@backstage/recommended',],
Alternatively, if you want to install in individual rules manually:
plugins: [ '@backstage',],rules: { '@backstage/no-forbidden-package-imports': 'error',}
Rules
The following rules are provided by this plugin:
Rule | Description |
---|---|
@backstage/no-forbidden-package-imports | Disallow internal monorepo imports from package subpaths that are not exported. |
@backstage/no-relative-monorepo-imports | Forbid relative imports that reach outside of the package in a monorepo. |
@backstage/no-undeclared-imports | Forbid imports of external packages that have not been declared in the appropriate dependencies field in package.json . |
@backstage/no-top-level-material-ui-4-imports | Forbid top level import from Material UI v4 packages. |