ESLint plugin
The essential plugin for use with the Atlassian Design System.Installation
| Install | yarn add @atlaskit/eslint-plugin-design-system |
|---|---|
| Source | Bitbucket.org, (opens new window) |
| npm | @atlaskit/eslint-plugin-design-system, (opens new window) |
| Bundle | unpkg.com, (opens new window) |
Use the recommended config to get reasonable defaults recommended by the Atlassian Design System:
module.exports = {
extends: [
+ 'plugin:@atlaskit/design-system/recommended',
],
};
We don't recommended maintaining your own configuration. If you do not use our config you will need
to specify individual rules and configuration. Add the plugin to your eslint.config.cjs file.
module.exports = {
plugins: [
+ '@atlaskit/design-system',
],
};
Enable the rules that you would like to use.
module.exports = {
rules: [
+ '@atlaskit/design-system/no-deprecated-apis': 'error',
],
};