ESLint plugin

The essential plugin for use with the Atlassian Design System.

no-deprecated-apis

Props across the Atlassian Design System can be deprecated when they are no longer fit for purpose or when their use at scale poses a risk.

Examples

Anything that can be used as props from Atlassian Design System components can be violations when marked as deprecated.

Incorrect

<ButtonItem cssFn={cssFn()} />
            ^^^^

<Drawer overrides={overrides} />
        ^^^^^^^^^

Options

The rule can take one option: deprecatedConfig, if not provided the rule will use an internal config. If provided the rule will use the passed in config instead.

deprecatedConfig

The following fields can be defined in the config:

deprecatedProp, which is the deprecated props. Each prop has the following fields:
- moduleSpecifier, which is the module specifier of the package in which the prop was deprecated. For example: @atlaskit/button.
- namedSpecifier (optional), which is an array of named specifiers of the package in which the prop was deprecated. For example: Button.
- actionableVersion (optional), which is the version of the package in which the prop can be actioned on. For example: 1.0.0.

{
    "cssFn": [
        {
            "moduleSpecifier": "@atlaskit/menu"
        }
    ]
}

import { configs } from '@atlaskit/eslint-plugin-design-system';

module.exports = {
    rules: {
        '@atlaskit/design-system/no-deprecated-api': [
            'error',
            {
                deprecatedConfig: {
                    cssFn: [
                        {
                            moduleSpecifier: '@atlaskit/menu',
                        },
                    ],
                },
            },
        ],
    },
};

The plugin also provides a filterActionableDeprecations util function that accepts the deprecated APIs config and your root package.json as params and will filter the default deprecated APIs config based on the package versions installed.

import { configs, filterActionableDeprecations } from '@atlaskit/eslint-plugin-design-system';
import packageJson from './package.json';

rules: {
  '@atlaskit/design-system/no-deprecated-api': ['error', {
    'deprecatedConfig': filterActionableDeprecations(configs.deprecatedConfig, packageJson),
  }]
}

Was this page helpful?

We use this feedback to improve our documentation.