@atlaskit/eslint-plugin-design-system 4.15.6 → 4.16.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 4.16.0
+
+### Minor Changes
+
+- [`efadee8e999`](https://bitbucket.org/atlassian/atlassian-frontend/commits/efadee8e999) - Update no-deprecated-apis ESlint rule to accept configurations
+
 ## 4.15.6
 
 ### Patch Changes

package/README.md

@@ -40,13 +40,67 @@ module.exports = {
 +    '@atlaskit/design-system/no-unsafe-design-token-usage': ['error', { 'shouldEnsureFallbackUsage': true }],
 +    '@atlaskit/design-system/use-visually-hidden': 'error',
 +    '@atlaskit/design-system/no-deprecated-imports': 'error',
-+    '@atlaskit/design-system/no-deprecated-api-usage': 'error'
++    '@atlaskit/design-system/no-deprecated-api': 'error',
     }
   }
 };
 ```
 
-Rules will where possible come with fixers.
+## Usage of '@atlaskit/design-system/no-deprecated-api'
+
+You can use the `@atlaskit/design-system/no-deprecated-api` rule to check for deprecated API usage in your codebase. The rule can take one option - `deprecatedConfig`, if not provided, the rule will use the default config file. If provided, the rule will override the default config file and use the config file provided.
+See the examples below:
+[Usage with default deprecated APIs config](###Usage-with-default-deprecated-APIs-config)
+[Overwrite default deprecated APIs config](###Overwrite-default-deprecated-APIs-config)
+
+### Default deprecated APIs config
+
+The default config containing the deprecated APIs config for this rule. You can import the default config file from `@atlaskit/eslint-plugin-design-system`.
+
+```js
+import { configs } from '@atlaskit/eslint-plugin-design-system';
+const { deprecatedConfig } = configs;
+```
+
+In the default config file you can find the following fields:
+
+- `deprecatedAPI`, 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`.
+
+### Usage with default deprecated APIs config
+
+Enable the rule as other rules if you want to use the default deprecated APIs config. The rule will automatically load the default config file and use it.
+
+Enable the rule in your `.eslintrc.js` file:
+
+```js
+rules: {
+  '@atlaskit/design-system/no-deprecated-api': 'error'
+}
+```
+
+### Overwrite default deprecated APIs config
+
+You can overwrite the default deprecated APIs to suits your needs. You can do this by providing the `deprecatedConfig` option to the rule. The option can be partial of the default config file, or a new config that contatins the required fields described in the [Default deprecated APIs config](###Default-deprecated-APIs-config) section.
+
+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 listed in the package.json file, and return a list of actionable entries.
+Example:
+
+```js
+import { configs } from '@atlaskit/eslint-plugin-design-system';
+import packageJson from '.path-to/package.json';
+
+rules: {
+  '@atlaskit/design-system/no-deprecated-api': ['error', {
+    'deprecatedConfig': filterActionableDeprecations(configs.deprecatedConfig, JSON.parse(packageJson)),
+  }]
+}
+```
+
+Rules may come with fixers to assist.
 For individual rules see the [`rules`](./src/rules) folder,
 however its strongly recommended to use the rules as above.
 You can read more about configuring eslint in their [documentation](https://eslint.org/docs/user-guide/configuring).

package/configs/deprecated.json

@@ -0,0 +1,33 @@
+{
+  "cssFn": [{
+      "moduleSpecifier": "@atlaskit/menu"
+    },
+    {
+      "moduleSpecifier": "@atlaskit/side-navigation"
+    }
+  ],
+  "overrides": [{
+      "moduleSpecifier": "@atlaskit/menu"
+    },
+    {
+      "moduleSpecifier": "@atlaskit/side-navigation"
+    }
+  ],
+  "type": [{
+    "moduleSpecifier": "@atlaskit/inline-message"
+  }],
+  "textColor": [{
+    "moduleSpecifier": "@atlaskit/logo"
+
+  }],
+  "iconColor": [{
+    "moduleSpecifier": "@atlaskit/logo"
+  }],
+  "iconGradientStart": [{
+    "moduleSpecifier": "@atlaskit/logo"
+  }],
+  "iconGradientStop": [{
+    "moduleSpecifier": "@atlaskit/logo"
+  }]
+
+}

package/dist/cjs/index.js

@@ -4,7 +4,14 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.rules = exports.configs = void 0;
+exports.configs = void 0;
+Object.defineProperty(exports, "filterActionableDeprecations", {
+  enumerable: true,
+  get: function get() {
+    return _filterActionableDeprecations.filterActionableDeprecations;
+  }
+});
+exports.rules = void 0;
 var _ensureDesignTokenUsage = _interopRequireDefault(require("./rules/ensure-design-token-usage"));
 var _ensureDesignTokenUsageSpacing = _interopRequireDefault(require("./rules/ensure-design-token-usage-spacing"));
 var _iconLabel = _interopRequireDefault(require("./rules/icon-label"));
@@ -14,6 +21,7 @@ var _noDeprecatedDesignTokenUsage = _interopRequireDefault(require("./rules/no-d
 var _noDeprecatedImports = _interopRequireDefault(require("./rules/no-deprecated-imports"));
 var _noUnsafeDesignTokenUsage = _interopRequireDefault(require("./rules/no-unsafe-design-token-usage"));
 var _useVisuallyHidden = _interopRequireDefault(require("./rules/use-visually-hidden"));
+var _filterActionableDeprecations = require("./rules/no-deprecated-apis/helpers/filter-actionable-deprecations");
 var rules = {
   'ensure-design-token-usage': _ensureDesignTokenUsage.default,
   'icon-label': _iconLabel.default,

package/dist/cjs/rules/no-deprecated-apis/helpers/filter-actionable-deprecations.js

@@ -0,0 +1,59 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.filterActionableDeprecations = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _semver = _interopRequireDefault(require("semver"));
+var _validateDeprecatedApisConfig = require("./validate-deprecated-apis-config");
+var filterActionableDeprecations = function filterActionableDeprecations(originalDeprecatedConfig, rootPackageJson) {
+  // verify the config is valid and parse it to an object
+  var validatedDeprecatedConfig = (0, _validateDeprecatedApisConfig.getValidatedConfig)(originalDeprecatedConfig);
+
+  // verify the root package.json is valid and parse it to an object
+  var rootPackageDependencies;
+  try {
+    rootPackageDependencies = JSON.parse(rootPackageJson).dependencies;
+    if (!rootPackageDependencies) {
+      throw new Error('No dependencies found in the provided root package.json');
+    }
+  } catch (e) {
+    var error = e;
+    throw new Error("Failed to parse root package.json: ".concat(error.message));
+  }
+  var filteredConfig = {};
+  // filter out the deprecated APIs that are not actionable
+  for (var _i = 0, _Object$entries = Object.entries(validatedDeprecatedConfig); _i < _Object$entries.length; _i++) {
+    var _Object$entries$_i = (0, _slicedToArray2.default)(_Object$entries[_i], 2),
+      apiKey = _Object$entries$_i[0],
+      apiValues = _Object$entries$_i[1];
+    var filterApiValues = apiValues.filter(function (apiValue) {
+      var _rootPackageDependenc;
+      var moduleSpecifier = apiValue.moduleSpecifier,
+        actionableVersion = apiValue.actionableVersion;
+
+      // if actionableVersion is not provided in the deprecated APIs config, it is actionable on all versions
+      if (!actionableVersion) {
+        return true;
+      }
+      var installedVersion = (_rootPackageDependenc = rootPackageDependencies) === null || _rootPackageDependenc === void 0 ? void 0 : _rootPackageDependenc[moduleSpecifier];
+      var coercedInstalledVersion = _semver.default.coerce(installedVersion);
+      if (!coercedInstalledVersion) {
+        throw new Error("No valid ".concat(moduleSpecifier, " found in the dependencies of root package.json."));
+      }
+      var coercedActionableVersion = _semver.default.coerce(actionableVersion);
+      if (!coercedActionableVersion) {
+        throw new Error("Actionable version is invalid for ".concat(moduleSpecifier, " in the deprecated APIs config."));
+      }
+      return _semver.default.gte(coercedInstalledVersion, coercedActionableVersion);
+    });
+    if (filterApiValues.length > 0) {
+      Object.assign(filteredConfig, (0, _defineProperty2.default)({}, apiKey, filterApiValues));
+    }
+  }
+  return JSON.stringify(filteredConfig);
+};
+exports.filterActionableDeprecations = filterActionableDeprecations;

package/dist/cjs/rules/no-deprecated-apis/helpers/validate-deprecated-apis-config.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getValidatedConfig = void 0;
+var _ajv = _interopRequireDefault(require("ajv"));
+var deprecatedSchema = {
+  type: 'object',
+  patternProperties: {
+    '.+': {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          moduleSpecifier: {
+            type: 'string'
+          },
+          namedSpecifiers: {
+            type: 'array',
+            items: {
+              type: 'string'
+            }
+          },
+          actionableVersion: {
+            type: 'string'
+          }
+        },
+        required: ['moduleSpecifier'],
+        additionalProperites: false
+      }
+    }
+  },
+  allowMatchingProperties: true
+};
+var getValidatedConfig = function getValidatedConfig(originalDeprecatedConfig) {
+  var parsedDeprecatedConfig = {};
+  try {
+    parsedDeprecatedConfig = JSON.parse(originalDeprecatedConfig);
+  } catch (e) {
+    var error = e;
+    throw new Error("Failed to parse JSON string: ".concat(error.message));
+  }
+  var ajv = new _ajv.default({
+    allErrors: true
+  });
+  var validate = ajv.compile(deprecatedSchema);
+  var valid = validate(parsedDeprecatedConfig);
+  if (!valid) {
+    var errors = validate.errors;
+    if (errors && errors.length) {
+      throw new Error("Deprecated APIs config is invalid: ".concat(errors));
+    } else {
+      throw new Error('Failed to validate deprecated APIs config with unknown error.');
+    }
+  }
+  return parsedDeprecatedConfig;
+};
+exports.getValidatedConfig = getValidatedConfig;

package/dist/cjs/rules/no-deprecated-apis/index.js

@@ -1,78 +1,154 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
-var _eslintCodemodUtils = require("eslint-codemod-utils");
-var _getImportNodeBySource = require("../utils/get-import-node-by-source");
-var unsafeOverridesConfig = {
-  cssFn: ['@atlaskit/menu', '@atlaskit/side-navigation'],
-  overrides: ['@atlaskit/drawer', '@atlaskit/menu', '@atlaskit/side-navigation'],
-  innerRef: ['@atlaskit/banner'],
-  isOpen: ['@atlaskit/banner'],
-  type: ['@atlaskit/inline-message']
+exports.noDeprecatedJSXAttributeMessageId = exports.name = exports.default = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _utils = require("@typescript-eslint/utils");
+var createRule = _utils.ESLintUtils.RuleCreator(function (name) {
+  return name;
+});
+var noDeprecatedJSXAttributeMessageId = 'noDeprecatedJSXAttributes';
+exports.noDeprecatedJSXAttributeMessageId = noDeprecatedJSXAttributeMessageId;
+var isNodeOfType = function isNodeOfType(node, nodeType) {
+  return _utils.ASTUtils.isNodeOfType(nodeType)(node);
+};
+var isImportDeclaration = function isImportDeclaration(programStatement) {
+  return (programStatement === null || programStatement === void 0 ? void 0 : programStatement.type) === 'ImportDeclaration';
+};
+var findJSXElementName = function findJSXElementName(jsxAttributeNode) {
+  if (!jsxAttributeNode.parent || !isNodeOfType(jsxAttributeNode.parent, _utils.AST_NODE_TYPES.JSXOpeningElement)) {
+    return;
+  }
+  var openingElement = jsxAttributeNode.parent;
+  if (!isNodeOfType(openingElement.name, _utils.AST_NODE_TYPES.JSXIdentifier)) {
+    return;
+  }
+  return openingElement.name.name;
+};
+var getConfig = function getConfig() {
+  var configPath = _path.default.resolve(__dirname, '..', '..', '..', 'configs', 'deprecated.json');
+  var source = _fs.default.readFileSync(configPath, 'utf8');
+  var parsedConfig = JSON.parse(source);
+  return parsedConfig;
 };
-var unsafeOverrides = ['cssFn', 'overrides', 'innerRef', 'isOpen', 'type'];
-var rule = {
+var name = 'no-deprecated-apis';
+exports.name = name;
+var rule = createRule({
+  name: name,
+  defaultOptions: [{
+    deprecatedConfig: getConfig()
+  }],
   meta: {
     type: 'suggestion',
     docs: {
       description: 'Disallow specified APIs that have been marked as deprecated and/or discouraged.',
-      recommended: true
+      recommended: 'warn'
     },
     messages: {
-      noDeprecatedApis: "The prop \"{{propName}}\" has been deprecated. It will be removed in the next major release."
-    }
+      noDeprecatedJSXAttributes: 'The JSX attribute {{propName}} has been deprecated.'
+    },
+    schema: [{
+      type: 'object',
+      properties: {
+        deprecatedConfig: {
+          type: 'object',
+          properties: {
+            '.+': {
+              type: 'array',
+              items: {
+                type: 'object',
+                properties: {
+                  moduleSpecifier: {
+                    type: 'string'
+                  },
+                  namedSpecifiers: {
+                    type: 'array',
+                    items: {
+                      type: 'string'
+                    }
+                  },
+                  actionableVersion: {
+                    type: 'string'
+                  }
+                },
+                required: ['moduleSpecifier'],
+                additionalProperites: false
+              }
+            }
+          }
+        }
+      }
+    }]
   },
-  create: function create(context) {
+  create: function create(context, _ref) {
+    var _context$options$;
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 1),
+      options = _ref2[0];
+    // Get rule configuration
+    var defaultDeprecatedConfig = options.deprecatedConfig;
+
+    // Get the rule configuration specified otherwise use default config.
+    // A bit confusing as it seems that the default options have precedence over the user specified options.
+    var deprecatedConfig = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.deprecatedConfig) || defaultDeprecatedConfig;
     return {
       // find JSX atribute - find name of attribute - get source and find relevant identifiers.
       JSXAttribute: function JSXAttribute(node) {
-        var _node$name;
-        if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'JSXAttribute')) {
+        var jsxAttributeIdentifier = node.name;
+        if (!isNodeOfType(jsxAttributeIdentifier, _utils.AST_NODE_TYPES.JSXIdentifier)) {
           return;
         }
-        if (!unsafeOverrides.includes(node === null || node === void 0 ? void 0 : (_node$name = node.name) === null || _node$name === void 0 ? void 0 : _node$name.name)) {
+        var jsxAttributeName = jsxAttributeIdentifier.name;
+        if (!deprecatedConfig[jsxAttributeName]) {
           return;
         }
-        var source = context.getSourceCode();
-        var bannedApi = node.name.name;
-
-        // traverse the tree to the nearest JSX Element and get its name
-        var closesetJSXElement = (0, _eslintCodemodUtils.closestOfType)(node, 'JSXOpeningElement');
-        var jsxElementName = (0, _eslintCodemodUtils.isNodeOfType)(closesetJSXElement === null || closesetJSXElement === void 0 ? void 0 : closesetJSXElement.name, 'JSXIdentifier') && closesetJSXElement.name.name;
+        var jsxElementName = findJSXElementName(node);
         if (!jsxElementName) {
           return;
         }
+        var source = context.getSourceCode();
 
         // find an import for the path of the banned api
-        unsafeOverridesConfig[bannedApi].forEach(function (path) {
-          var importNode = (0, _getImportNodeBySource.getImportedNodeBySource)(source, path);
+        deprecatedConfig[jsxAttributeName].forEach(function (importItem) {
+          var _importItem$namedSpec;
+          var importNode = source.ast.body.filter(isImportDeclaration).find(function (node) {
+            return node.source.value === importItem.moduleSpecifier;
+          });
           if (!importNode) {
             return;
           }
 
           // find an import that matches our JSX element
-          var hasTargetNode = importNode.specifiers.some(function (node) {
+          var targetNode = importNode.specifiers.find(function (node) {
             return node.local.name === jsxElementName;
           });
-          if (!hasTargetNode) {
+
+          // check if the import exists
+          if (!targetNode) {
             return;
           }
 
-          // if we're here the import exists and there is a valid lint error.
+          // if the import has named specifiers, check if the JSX element is one of them
+          if (importItem !== null && importItem !== void 0 && (_importItem$namedSpec = importItem.namedSpecifiers) !== null && _importItem$namedSpec !== void 0 && _importItem$namedSpec.length && !importItem.namedSpecifiers.includes(targetNode.local.name)) {
+            return;
+          }
+
+          // if we're here, there is a valid lint error.
           context.report({
             node: node,
-            messageId: 'noDeprecatedApis',
+            messageId: 'noDeprecatedJSXAttributes',
             data: {
-              propName: bannedApi
+              propName: jsxAttributeName
             }
           });
         });
       }
     };
   }
-};
+});
 var _default = rule;
 exports.default = _default;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.15.6",
+	"version": "4.16.0",
 	"sideEffects": false
 }

package/dist/configs/deprecated.json

@@ -0,0 +1,33 @@
+{
+  "cssFn": [{
+      "moduleSpecifier": "@atlaskit/menu"
+    },
+    {
+      "moduleSpecifier": "@atlaskit/side-navigation"
+    }
+  ],
+  "overrides": [{
+      "moduleSpecifier": "@atlaskit/menu"
+    },
+    {
+      "moduleSpecifier": "@atlaskit/side-navigation"
+    }
+  ],
+  "type": [{
+    "moduleSpecifier": "@atlaskit/inline-message"
+  }],
+  "textColor": [{
+    "moduleSpecifier": "@atlaskit/logo"
+
+  }],
+  "iconColor": [{
+    "moduleSpecifier": "@atlaskit/logo"
+  }],
+  "iconGradientStart": [{
+    "moduleSpecifier": "@atlaskit/logo"
+  }],
+  "iconGradientStop": [{
+    "moduleSpecifier": "@atlaskit/logo"
+  }]
+
+}

package/dist/es2019/index.js

@@ -42,4 +42,5 @@ export const configs = {
       '@atlaskit/design-system/ensure-design-token-usage-spacing': 'error'
     }
   }
-};
+};
+export { filterActionableDeprecations } from './rules/no-deprecated-apis/helpers/filter-actionable-deprecations';

package/dist/es2019/rules/no-deprecated-apis/helpers/filter-actionable-deprecations.js

@@ -0,0 +1,50 @@
+import semver from 'semver';
+import { getValidatedConfig } from './validate-deprecated-apis-config';
+export const filterActionableDeprecations = (originalDeprecatedConfig, rootPackageJson) => {
+  // verify the config is valid and parse it to an object
+  const validatedDeprecatedConfig = getValidatedConfig(originalDeprecatedConfig);
+
+  // verify the root package.json is valid and parse it to an object
+  let rootPackageDependencies;
+  try {
+    rootPackageDependencies = JSON.parse(rootPackageJson).dependencies;
+    if (!rootPackageDependencies) {
+      throw new Error('No dependencies found in the provided root package.json');
+    }
+  } catch (e) {
+    const error = e;
+    throw new Error(`Failed to parse root package.json: ${error.message}`);
+  }
+  const filteredConfig = {};
+  // filter out the deprecated APIs that are not actionable
+  for (const [apiKey, apiValues] of Object.entries(validatedDeprecatedConfig)) {
+    const filterApiValues = apiValues.filter(apiValue => {
+      var _rootPackageDependenc;
+      const {
+        moduleSpecifier,
+        actionableVersion
+      } = apiValue;
+
+      // if actionableVersion is not provided in the deprecated APIs config, it is actionable on all versions
+      if (!actionableVersion) {
+        return true;
+      }
+      const installedVersion = (_rootPackageDependenc = rootPackageDependencies) === null || _rootPackageDependenc === void 0 ? void 0 : _rootPackageDependenc[moduleSpecifier];
+      const coercedInstalledVersion = semver.coerce(installedVersion);
+      if (!coercedInstalledVersion) {
+        throw new Error(`No valid ${moduleSpecifier} found in the dependencies of root package.json.`);
+      }
+      const coercedActionableVersion = semver.coerce(actionableVersion);
+      if (!coercedActionableVersion) {
+        throw new Error(`Actionable version is invalid for ${moduleSpecifier} in the deprecated APIs config.`);
+      }
+      return semver.gte(coercedInstalledVersion, coercedActionableVersion);
+    });
+    if (filterApiValues.length > 0) {
+      Object.assign(filteredConfig, {
+        [apiKey]: filterApiValues
+      });
+    }
+  }
+  return JSON.stringify(filteredConfig);
+};

package/dist/es2019/rules/no-deprecated-apis/helpers/validate-deprecated-apis-config.js

@@ -0,0 +1,54 @@
+import Ajv from 'ajv';
+const deprecatedSchema = {
+  type: 'object',
+  patternProperties: {
+    '.+': {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          moduleSpecifier: {
+            type: 'string'
+          },
+          namedSpecifiers: {
+            type: 'array',
+            items: {
+              type: 'string'
+            }
+          },
+          actionableVersion: {
+            type: 'string'
+          }
+        },
+        required: ['moduleSpecifier'],
+        additionalProperites: false
+      }
+    }
+  },
+  allowMatchingProperties: true
+};
+export const getValidatedConfig = originalDeprecatedConfig => {
+  let parsedDeprecatedConfig = {};
+  try {
+    parsedDeprecatedConfig = JSON.parse(originalDeprecatedConfig);
+  } catch (e) {
+    const error = e;
+    throw new Error(`Failed to parse JSON string: ${error.message}`);
+  }
+  const ajv = new Ajv({
+    allErrors: true
+  });
+  const validate = ajv.compile(deprecatedSchema);
+  const valid = validate(parsedDeprecatedConfig);
+  if (!valid) {
+    const {
+      errors
+    } = validate;
+    if (errors && errors.length) {
+      throw new Error(`Deprecated APIs config is invalid: ${errors}`);
+    } else {
+      throw new Error('Failed to validate deprecated APIs config with unknown error.');
+    }
+  }
+  return parsedDeprecatedConfig;
+};

package/dist/es2019/rules/no-deprecated-apis/index.js

@@ -1,69 +1,135 @@
-import { closestOfType, isNodeOfType } from 'eslint-codemod-utils';
-import { getImportedNodeBySource } from '../utils/get-import-node-by-source';
-const unsafeOverridesConfig = {
-  cssFn: ['@atlaskit/menu', '@atlaskit/side-navigation'],
-  overrides: ['@atlaskit/drawer', '@atlaskit/menu', '@atlaskit/side-navigation'],
-  innerRef: ['@atlaskit/banner'],
-  isOpen: ['@atlaskit/banner'],
-  type: ['@atlaskit/inline-message']
+import fs from 'fs';
+import path from 'path';
+import { AST_NODE_TYPES, ASTUtils, ESLintUtils } from '@typescript-eslint/utils';
+const createRule = ESLintUtils.RuleCreator(name => name);
+export const noDeprecatedJSXAttributeMessageId = 'noDeprecatedJSXAttributes';
+const isNodeOfType = (node, nodeType) => ASTUtils.isNodeOfType(nodeType)(node);
+const isImportDeclaration = programStatement => {
+  return (programStatement === null || programStatement === void 0 ? void 0 : programStatement.type) === 'ImportDeclaration';
 };
-const unsafeOverrides = ['cssFn', 'overrides', 'innerRef', 'isOpen', 'type'];
-const rule = {
+const findJSXElementName = jsxAttributeNode => {
+  if (!jsxAttributeNode.parent || !isNodeOfType(jsxAttributeNode.parent, AST_NODE_TYPES.JSXOpeningElement)) {
+    return;
+  }
+  const openingElement = jsxAttributeNode.parent;
+  if (!isNodeOfType(openingElement.name, AST_NODE_TYPES.JSXIdentifier)) {
+    return;
+  }
+  return openingElement.name.name;
+};
+const getConfig = () => {
+  const configPath = path.resolve(__dirname, '..', '..', '..', 'configs', 'deprecated.json');
+  const source = fs.readFileSync(configPath, 'utf8');
+  const parsedConfig = JSON.parse(source);
+  return parsedConfig;
+};
+export const name = 'no-deprecated-apis';
+const rule = createRule({
+  name,
+  defaultOptions: [{
+    deprecatedConfig: getConfig()
+  }],
   meta: {
     type: 'suggestion',
     docs: {
       description: 'Disallow specified APIs that have been marked as deprecated and/or discouraged.',
-      recommended: true
+      recommended: 'warn'
     },
     messages: {
-      noDeprecatedApis: `The prop "{{propName}}" has been deprecated. It will be removed in the next major release.`
-    }
+      noDeprecatedJSXAttributes: 'The JSX attribute {{propName}} has been deprecated.'
+    },
+    schema: [{
+      type: 'object',
+      properties: {
+        deprecatedConfig: {
+          type: 'object',
+          properties: {
+            '.+': {
+              type: 'array',
+              items: {
+                type: 'object',
+                properties: {
+                  moduleSpecifier: {
+                    type: 'string'
+                  },
+                  namedSpecifiers: {
+                    type: 'array',
+                    items: {
+                      type: 'string'
+                    }
+                  },
+                  actionableVersion: {
+                    type: 'string'
+                  }
+                },
+                required: ['moduleSpecifier'],
+                additionalProperites: false
+              }
+            }
+          }
+        }
+      }
+    }]
   },
-  create(context) {
+  create(context, [options]) {
+    var _context$options$;
+    // Get rule configuration
+    const {
+      deprecatedConfig: defaultDeprecatedConfig
+    } = options;
+
+    // Get the rule configuration specified otherwise use default config.
+    // A bit confusing as it seems that the default options have precedence over the user specified options.
+    const deprecatedConfig = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.deprecatedConfig) || defaultDeprecatedConfig;
     return {
       // find JSX atribute - find name of attribute - get source and find relevant identifiers.
       JSXAttribute(node) {
-        var _node$name;
-        if (!isNodeOfType(node, 'JSXAttribute')) {
+        const jsxAttributeIdentifier = node.name;
+        if (!isNodeOfType(jsxAttributeIdentifier, AST_NODE_TYPES.JSXIdentifier)) {
           return;
         }
-        if (!unsafeOverrides.includes(node === null || node === void 0 ? void 0 : (_node$name = node.name) === null || _node$name === void 0 ? void 0 : _node$name.name)) {
+        const jsxAttributeName = jsxAttributeIdentifier.name;
+        if (!deprecatedConfig[jsxAttributeName]) {
           return;
         }
-        const source = context.getSourceCode();
-        const bannedApi = node.name.name;
-
-        // traverse the tree to the nearest JSX Element and get its name
-        const closesetJSXElement = closestOfType(node, 'JSXOpeningElement');
-        const jsxElementName = isNodeOfType(closesetJSXElement === null || closesetJSXElement === void 0 ? void 0 : closesetJSXElement.name, 'JSXIdentifier') && closesetJSXElement.name.name;
+        const jsxElementName = findJSXElementName(node);
         if (!jsxElementName) {
           return;
         }
+        const source = context.getSourceCode();
 
         // find an import for the path of the banned api
-        unsafeOverridesConfig[bannedApi].forEach(path => {
-          const importNode = getImportedNodeBySource(source, path);
+        deprecatedConfig[jsxAttributeName].forEach(importItem => {
+          var _importItem$namedSpec;
+          const importNode = source.ast.body.filter(isImportDeclaration).find(node => node.source.value === importItem.moduleSpecifier);
           if (!importNode) {
             return;
           }
 
           // find an import that matches our JSX element
-          const hasTargetNode = importNode.specifiers.some(node => node.local.name === jsxElementName);
-          if (!hasTargetNode) {
+          const targetNode = importNode.specifiers.find(node => node.local.name === jsxElementName);
+
+          // check if the import exists
+          if (!targetNode) {
             return;
           }
 
-          // if we're here the import exists and there is a valid lint error.
+          // if the import has named specifiers, check if the JSX element is one of them
+          if (importItem !== null && importItem !== void 0 && (_importItem$namedSpec = importItem.namedSpecifiers) !== null && _importItem$namedSpec !== void 0 && _importItem$namedSpec.length && !importItem.namedSpecifiers.includes(targetNode.local.name)) {
+            return;
+          }
+
+          // if we're here, there is a valid lint error.
           context.report({
-            node: node,
-            messageId: 'noDeprecatedApis',
+            node,
+            messageId: 'noDeprecatedJSXAttributes',
             data: {
-              propName: bannedApi
+              propName: jsxAttributeName
             }
           });
         });
       }
     };
   }
-};
+});
 export default rule;

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.15.6",
+	"version": "4.16.0",
 	"sideEffects": false
 }

package/dist/esm/index.js

@@ -42,4 +42,5 @@ export var configs = {
       '@atlaskit/design-system/ensure-design-token-usage-spacing': 'error'
     }
   }
-};
+};
+export { filterActionableDeprecations } from './rules/no-deprecated-apis/helpers/filter-actionable-deprecations';

package/dist/esm/rules/no-deprecated-apis/helpers/filter-actionable-deprecations.js

@@ -0,0 +1,51 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import semver from 'semver';
+import { getValidatedConfig } from './validate-deprecated-apis-config';
+export var filterActionableDeprecations = function filterActionableDeprecations(originalDeprecatedConfig, rootPackageJson) {
+  // verify the config is valid and parse it to an object
+  var validatedDeprecatedConfig = getValidatedConfig(originalDeprecatedConfig);
+
+  // verify the root package.json is valid and parse it to an object
+  var rootPackageDependencies;
+  try {
+    rootPackageDependencies = JSON.parse(rootPackageJson).dependencies;
+    if (!rootPackageDependencies) {
+      throw new Error('No dependencies found in the provided root package.json');
+    }
+  } catch (e) {
+    var error = e;
+    throw new Error("Failed to parse root package.json: ".concat(error.message));
+  }
+  var filteredConfig = {};
+  // filter out the deprecated APIs that are not actionable
+  for (var _i = 0, _Object$entries = Object.entries(validatedDeprecatedConfig); _i < _Object$entries.length; _i++) {
+    var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+      apiKey = _Object$entries$_i[0],
+      apiValues = _Object$entries$_i[1];
+    var filterApiValues = apiValues.filter(function (apiValue) {
+      var _rootPackageDependenc;
+      var moduleSpecifier = apiValue.moduleSpecifier,
+        actionableVersion = apiValue.actionableVersion;
+
+      // if actionableVersion is not provided in the deprecated APIs config, it is actionable on all versions
+      if (!actionableVersion) {
+        return true;
+      }
+      var installedVersion = (_rootPackageDependenc = rootPackageDependencies) === null || _rootPackageDependenc === void 0 ? void 0 : _rootPackageDependenc[moduleSpecifier];
+      var coercedInstalledVersion = semver.coerce(installedVersion);
+      if (!coercedInstalledVersion) {
+        throw new Error("No valid ".concat(moduleSpecifier, " found in the dependencies of root package.json."));
+      }
+      var coercedActionableVersion = semver.coerce(actionableVersion);
+      if (!coercedActionableVersion) {
+        throw new Error("Actionable version is invalid for ".concat(moduleSpecifier, " in the deprecated APIs config."));
+      }
+      return semver.gte(coercedInstalledVersion, coercedActionableVersion);
+    });
+    if (filterApiValues.length > 0) {
+      Object.assign(filteredConfig, _defineProperty({}, apiKey, filterApiValues));
+    }
+  }
+  return JSON.stringify(filteredConfig);
+};

package/dist/esm/rules/no-deprecated-apis/helpers/validate-deprecated-apis-config.js

@@ -0,0 +1,52 @@
+import Ajv from 'ajv';
+var deprecatedSchema = {
+  type: 'object',
+  patternProperties: {
+    '.+': {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          moduleSpecifier: {
+            type: 'string'
+          },
+          namedSpecifiers: {
+            type: 'array',
+            items: {
+              type: 'string'
+            }
+          },
+          actionableVersion: {
+            type: 'string'
+          }
+        },
+        required: ['moduleSpecifier'],
+        additionalProperites: false
+      }
+    }
+  },
+  allowMatchingProperties: true
+};
+export var getValidatedConfig = function getValidatedConfig(originalDeprecatedConfig) {
+  var parsedDeprecatedConfig = {};
+  try {
+    parsedDeprecatedConfig = JSON.parse(originalDeprecatedConfig);
+  } catch (e) {
+    var error = e;
+    throw new Error("Failed to parse JSON string: ".concat(error.message));
+  }
+  var ajv = new Ajv({
+    allErrors: true
+  });
+  var validate = ajv.compile(deprecatedSchema);
+  var valid = validate(parsedDeprecatedConfig);
+  if (!valid) {
+    var errors = validate.errors;
+    if (errors && errors.length) {
+      throw new Error("Deprecated APIs config is invalid: ".concat(errors));
+    } else {
+      throw new Error('Failed to validate deprecated APIs config with unknown error.');
+    }
+  }
+  return parsedDeprecatedConfig;
+};

package/dist/esm/rules/no-deprecated-apis/index.js

@@ -1,71 +1,144 @@
-import { closestOfType, isNodeOfType } from 'eslint-codemod-utils';
-import { getImportedNodeBySource } from '../utils/get-import-node-by-source';
-var unsafeOverridesConfig = {
-  cssFn: ['@atlaskit/menu', '@atlaskit/side-navigation'],
-  overrides: ['@atlaskit/drawer', '@atlaskit/menu', '@atlaskit/side-navigation'],
-  innerRef: ['@atlaskit/banner'],
-  isOpen: ['@atlaskit/banner'],
-  type: ['@atlaskit/inline-message']
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import fs from 'fs';
+import path from 'path';
+import { AST_NODE_TYPES, ASTUtils, ESLintUtils } from '@typescript-eslint/utils';
+var createRule = ESLintUtils.RuleCreator(function (name) {
+  return name;
+});
+export var noDeprecatedJSXAttributeMessageId = 'noDeprecatedJSXAttributes';
+var isNodeOfType = function isNodeOfType(node, nodeType) {
+  return ASTUtils.isNodeOfType(nodeType)(node);
 };
-var unsafeOverrides = ['cssFn', 'overrides', 'innerRef', 'isOpen', 'type'];
-var rule = {
+var isImportDeclaration = function isImportDeclaration(programStatement) {
+  return (programStatement === null || programStatement === void 0 ? void 0 : programStatement.type) === 'ImportDeclaration';
+};
+var findJSXElementName = function findJSXElementName(jsxAttributeNode) {
+  if (!jsxAttributeNode.parent || !isNodeOfType(jsxAttributeNode.parent, AST_NODE_TYPES.JSXOpeningElement)) {
+    return;
+  }
+  var openingElement = jsxAttributeNode.parent;
+  if (!isNodeOfType(openingElement.name, AST_NODE_TYPES.JSXIdentifier)) {
+    return;
+  }
+  return openingElement.name.name;
+};
+var getConfig = function getConfig() {
+  var configPath = path.resolve(__dirname, '..', '..', '..', 'configs', 'deprecated.json');
+  var source = fs.readFileSync(configPath, 'utf8');
+  var parsedConfig = JSON.parse(source);
+  return parsedConfig;
+};
+export var name = 'no-deprecated-apis';
+var rule = createRule({
+  name: name,
+  defaultOptions: [{
+    deprecatedConfig: getConfig()
+  }],
   meta: {
     type: 'suggestion',
     docs: {
       description: 'Disallow specified APIs that have been marked as deprecated and/or discouraged.',
-      recommended: true
+      recommended: 'warn'
     },
     messages: {
-      noDeprecatedApis: "The prop \"{{propName}}\" has been deprecated. It will be removed in the next major release."
-    }
+      noDeprecatedJSXAttributes: 'The JSX attribute {{propName}} has been deprecated.'
+    },
+    schema: [{
+      type: 'object',
+      properties: {
+        deprecatedConfig: {
+          type: 'object',
+          properties: {
+            '.+': {
+              type: 'array',
+              items: {
+                type: 'object',
+                properties: {
+                  moduleSpecifier: {
+                    type: 'string'
+                  },
+                  namedSpecifiers: {
+                    type: 'array',
+                    items: {
+                      type: 'string'
+                    }
+                  },
+                  actionableVersion: {
+                    type: 'string'
+                  }
+                },
+                required: ['moduleSpecifier'],
+                additionalProperites: false
+              }
+            }
+          }
+        }
+      }
+    }]
   },
-  create: function create(context) {
+  create: function create(context, _ref) {
+    var _context$options$;
+    var _ref2 = _slicedToArray(_ref, 1),
+      options = _ref2[0];
+    // Get rule configuration
+    var defaultDeprecatedConfig = options.deprecatedConfig;
+
+    // Get the rule configuration specified otherwise use default config.
+    // A bit confusing as it seems that the default options have precedence over the user specified options.
+    var deprecatedConfig = ((_context$options$ = context.options[0]) === null || _context$options$ === void 0 ? void 0 : _context$options$.deprecatedConfig) || defaultDeprecatedConfig;
     return {
       // find JSX atribute - find name of attribute - get source and find relevant identifiers.
       JSXAttribute: function JSXAttribute(node) {
-        var _node$name;
-        if (!isNodeOfType(node, 'JSXAttribute')) {
+        var jsxAttributeIdentifier = node.name;
+        if (!isNodeOfType(jsxAttributeIdentifier, AST_NODE_TYPES.JSXIdentifier)) {
           return;
         }
-        if (!unsafeOverrides.includes(node === null || node === void 0 ? void 0 : (_node$name = node.name) === null || _node$name === void 0 ? void 0 : _node$name.name)) {
+        var jsxAttributeName = jsxAttributeIdentifier.name;
+        if (!deprecatedConfig[jsxAttributeName]) {
           return;
         }
-        var source = context.getSourceCode();
-        var bannedApi = node.name.name;
-
-        // traverse the tree to the nearest JSX Element and get its name
-        var closesetJSXElement = closestOfType(node, 'JSXOpeningElement');
-        var jsxElementName = isNodeOfType(closesetJSXElement === null || closesetJSXElement === void 0 ? void 0 : closesetJSXElement.name, 'JSXIdentifier') && closesetJSXElement.name.name;
+        var jsxElementName = findJSXElementName(node);
         if (!jsxElementName) {
           return;
         }
+        var source = context.getSourceCode();
 
         // find an import for the path of the banned api
-        unsafeOverridesConfig[bannedApi].forEach(function (path) {
-          var importNode = getImportedNodeBySource(source, path);
+        deprecatedConfig[jsxAttributeName].forEach(function (importItem) {
+          var _importItem$namedSpec;
+          var importNode = source.ast.body.filter(isImportDeclaration).find(function (node) {
+            return node.source.value === importItem.moduleSpecifier;
+          });
           if (!importNode) {
             return;
           }
 
           // find an import that matches our JSX element
-          var hasTargetNode = importNode.specifiers.some(function (node) {
+          var targetNode = importNode.specifiers.find(function (node) {
             return node.local.name === jsxElementName;
           });
-          if (!hasTargetNode) {
+
+          // check if the import exists
+          if (!targetNode) {
             return;
           }
 
-          // if we're here the import exists and there is a valid lint error.
+          // if the import has named specifiers, check if the JSX element is one of them
+          if (importItem !== null && importItem !== void 0 && (_importItem$namedSpec = importItem.namedSpecifiers) !== null && _importItem$namedSpec !== void 0 && _importItem$namedSpec.length && !importItem.namedSpecifiers.includes(targetNode.local.name)) {
+            return;
+          }
+
+          // if we're here, there is a valid lint error.
           context.report({
             node: node,
-            messageId: 'noDeprecatedApis',
+            messageId: 'noDeprecatedJSXAttributes',
             data: {
-              propName: bannedApi
+              propName: jsxAttributeName
             }
           });
         });
       }
     };
   }
-};
+});
 export default rule;

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.15.6",
+	"version": "4.16.0",
 	"sideEffects": false
 }

package/dist/types/index.d.ts

@@ -1,7 +1,9 @@
 export declare const rules: {
     'ensure-design-token-usage': import("eslint").Rule.RuleModule;
     'icon-label': import("eslint").Rule.RuleModule;
-    'no-deprecated-apis': import("eslint").Rule.RuleModule;
+    'no-deprecated-apis': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<string, [{
+        deprecatedConfig: import("./rules/no-deprecated-apis").DeprecatedConfig;
+    }], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
     'no-deprecated-design-token-usage': import("eslint").Rule.RuleModule;
     'no-deprecated-imports': import("eslint").Rule.RuleModule;
     'no-banned-imports': import("eslint").Rule.RuleModule;
@@ -34,3 +36,4 @@ export declare const configs: {
         };
     };
 };
+export { filterActionableDeprecations } from './rules/no-deprecated-apis/helpers/filter-actionable-deprecations';

package/dist/types/rules/no-deprecated-apis/helpers/filter-actionable-deprecations.d.ts

@@ -0,0 +1 @@
+export declare const filterActionableDeprecations: (originalDeprecatedConfig: string, rootPackageJson: string) => string;

package/dist/types/rules/no-deprecated-apis/helpers/validate-deprecated-apis-config.d.ts

@@ -0,0 +1,2 @@
+import type { DeprecatedConfig } from '../index';
+export declare const getValidatedConfig: (originalDeprecatedConfig: string) => DeprecatedConfig;

package/dist/types/rules/no-deprecated-apis/index.d.ts

@@ -1,3 +1,15 @@
-import type { Rule } from 'eslint';
-declare const rule: Rule.RuleModule;
+import { TSESLint } from '@typescript-eslint/utils';
+interface DeprecatedConfigEntry {
+    moduleSpecifier: string;
+    namedSpecifiers?: string[];
+    actionableVersion?: string;
+}
+export interface DeprecatedConfig {
+    [key: string]: DeprecatedConfigEntry[];
+}
+export declare const noDeprecatedJSXAttributeMessageId = "noDeprecatedJSXAttributes";
+export declare const name = "no-deprecated-apis";
+declare const rule: TSESLint.RuleModule<string, [{
+    deprecatedConfig: DeprecatedConfig;
+}], TSESLint.RuleListener>;
 export default rule;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/eslint-plugin-design-system",
   "description": "The essential plugin for use with the Atlassian Design System.",
-  "version": "4.15.6",
+  "version": "4.16.0",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -34,7 +34,10 @@
   "dependencies": {
     "@atlaskit/tokens": "^1.2.0",
     "@babel/runtime": "^7.0.0",
-    "eslint-codemod-utils": "^1.6.3"
+    "@typescript-eslint/utils": "^5.48.1",
+    "ajv": "^6.12.6",
+    "eslint-codemod-utils": "^1.6.3",
+    "semver": "^7.3.0"
   },
   "devDependencies": {
     "@atlaskit/ds-lib": "^2.1.0",
@@ -48,6 +51,9 @@
     "tsconfig-paths": "^3.9.0",
     "typescript": "4.5.5"
   },
+  "scripts": {
+    "ak-postbuild": "cp -r configs dist"
+  },
   "techstack": {
     "@atlassian/frontend": {
       "import-structure": "atlassian-conventions",