@atlaskit/eslint-plugin-design-system 13.21.3 → 13.23.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 13.23.0
+
+### Minor Changes
+
+- [`8bb8c54e2f01f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8bb8c54e2f01f) -
+  Create use-spotlight-package rule.
+
+## 13.22.0
+
+### Minor Changes
+
+- [`4df3a43323a47`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4df3a43323a47) -
+  Added `turnOffAutoFixer` configuration option to the `no-deprecated-imports` rule, allowing users
+  to disable automatic code fixes while still reporting deprecated import violations.
+
 ## 13.21.3
 
 ### Patch Changes

package/README.md

@@ -111,6 +111,7 @@ module.exports = {
 | <a href="./packages/design-system/eslint-plugin/src/rules/use-primitives/README.md">use-primitives</a>                                                           | Encourage the usage of primitives components.                                                                                                                                                                                                                                                                       |             | Yes     | Yes         |
 | <a href="./packages/design-system/eslint-plugin/src/rules/use-primitives-text/README.md">use-primitives-text</a>                                                 | Encourage the usage of text components.                                                                                                                                                                                                                                                                             |             | Yes     | Yes         |
 | <a href="./packages/design-system/eslint-plugin/src/rules/use-should-render-to-parent/README.md">use-should-render-to-parent</a>                                 | Encourages makers to use the `shouldRenderToParent` where possible in Atlassian Design System `Popup` and `DropdownMenu` components.                                                                                                                                                                                | Yes         |         | Yes         |
+| <a href="./packages/design-system/eslint-plugin/src/rules/use-spotlight-package/README.md">use-spotlight-package</a>                                             | Discourage the use of deprecated imports from @atlaskit/onboarding in favor of @atlaskit/spotlight.                                                                                                                                                                                                                 |             | Yes     | Yes         |
 | <a href="./packages/design-system/eslint-plugin/src/rules/use-tag-group-label/README.md">use-tag-group-label</a>                                                 | Ensures tag groups are described to assistive technology by a direct label or by another element.                                                                                                                                                                                                                   | Yes         |         | Yes         |
 | <a href="./packages/design-system/eslint-plugin/src/rules/use-tokens-shape/README.md">use-tokens-shape</a>                                                       | Enforces usage of shape design tokens rather than hard-coded values.                                                                                                                                                                                                                                                |             | Yes     | Yes         |
 | <a href="./packages/design-system/eslint-plugin/src/rules/use-tokens-space/README.md">use-tokens-space</a>                                                       | Enforces usage of space design tokens rather than hard-coded values.                                                                                                                                                                                                                                                |             | Yes     | Yes         |

package/dist/cjs/presets/all-flat.codegen.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::6210f09c70f4d44befb986dfd548ed3e>>
+ * @codegen <<SignedSource::5aac2d8dc7c2832bcb8a96a143d60db5>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -75,6 +75,7 @@ var rules = {
     '@atlaskit/design-system/use-primitives': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-spotlight-package': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-shape': 'error',
     '@atlaskit/design-system/use-tokens-space': 'error',

package/dist/cjs/presets/all.codegen.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::daf4a5893d65c7a1592f8bc6e51920c6>>
+ * @codegen <<SignedSource::43ea4411c4e338a916772d4bfda146cc>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -74,6 +74,7 @@ var rules = {
     '@atlaskit/design-system/use-primitives': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-spotlight-package': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-shape': 'error',
     '@atlaskit/design-system/use-tokens-space': 'error',

package/dist/cjs/rules/index.codegen.js

@@ -67,6 +67,7 @@ var _usePopupLabel = _interopRequireDefault(require("./use-popup-label"));
 var _usePrimitives = _interopRequireDefault(require("./use-primitives"));
 var _usePrimitivesText = _interopRequireDefault(require("./use-primitives-text"));
 var _useShouldRenderToParent = _interopRequireDefault(require("./use-should-render-to-parent"));
+var _useSpotlightPackage = _interopRequireDefault(require("./use-spotlight-package"));
 var _useTagGroupLabel = _interopRequireDefault(require("./use-tag-group-label"));
 var _useTokensShape = _interopRequireDefault(require("./use-tokens-shape"));
 var _useTokensSpace = _interopRequireDefault(require("./use-tokens-space"));
@@ -74,7 +75,7 @@ var _useTokensTypography = _interopRequireDefault(require("./use-tokens-typograp
 var _useVisuallyHidden = _interopRequireDefault(require("./use-visually-hidden"));
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::4693db80b637ac078521dd6e0591f75b>>
+ * @codegen <<SignedSource::732bff0fc39d7ff05b6688694101698d>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -141,6 +142,7 @@ var rules = exports.rules = {
   'use-primitives': _usePrimitives.default,
   'use-primitives-text': _usePrimitivesText.default,
   'use-should-render-to-parent': _useShouldRenderToParent.default,
+  'use-spotlight-package': _useSpotlightPackage.default,
   'use-tag-group-label': _useTagGroupLabel.default,
   'use-tokens-shape': _useTokensShape.default,
   'use-tokens-space': _useTokensSpace.default,

package/dist/cjs/rules/no-deprecated-imports/handlers/icon.js

@@ -24,6 +24,12 @@ var getDeprecationIconHandler = exports.getDeprecationIconHandler = function get
   var identifiers = new Map();
   var importErrors = {};
   var exportErrors = {};
+  var getConfigFlag = function getConfigFlag(key, defaultValue) {
+    if (context.options && context.options.length > 0 && context.options[0] && context.options[0].hasOwnProperty(key)) {
+      return context.options[0][key] === !defaultValue ? !defaultValue : defaultValue;
+    }
+    return defaultValue;
+  };
   var getIconComponentName = function getIconComponentName(name) {
     return name.split(/\W/).map(function (part) {
       return "".concat(part[0].toUpperCase()).concat(part.slice(1));
@@ -63,6 +69,7 @@ var getDeprecationIconHandler = exports.getDeprecationIconHandler = function get
     }
   };
   var throwErrors = function throwErrors() {
+    var shouldTurnOffAutoFixer = getConfigFlag('turnOffAutoFixer', false);
     for (var _i = 0, _Object$entries = Object.entries(importErrors); _i < _Object$entries.length; _i++) {
       var _Object$entries$_i = (0, _slicedToArray2.default)(_Object$entries[_i], 2),
         importSource = _Object$entries$_i[0],
@@ -83,7 +90,9 @@ var getDeprecationIconHandler = exports.getDeprecationIconHandler = function get
         var replacement = metadata === null || metadata === void 0 || (_metadata$deprecatedI = metadata[deprecatedIconName]) === null || _metadata$deprecatedI === void 0 ? void 0 : _metadata$deprecatedI.replacement;
         if (replacement && ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.unfixable) === 'false') {
           var newIconName = getIconComponentName(replacement.name);
-          addAutoFix(error, importSource, "".concat(replacement.location, "/").concat(replacement.type, "/migration/").concat(replacement.name, "--").concat(legacyIconName), newIconName);
+          if (!shouldTurnOffAutoFixer) {
+            addAutoFix(error, importSource, "".concat(replacement.location, "/").concat(replacement.type, "/migration/").concat(replacement.name, "--").concat(legacyIconName), newIconName);
+          }
         }
       } else {
         var _metadata2;
@@ -101,7 +110,9 @@ var getDeprecationIconHandler = exports.getDeprecationIconHandler = function get
         var _replacement = (_metadata2 = _metadata) === null || _metadata2 === void 0 || (_metadata2 = _metadata2[_name]) === null || _metadata2 === void 0 ? void 0 : _metadata2.replacement;
         if (_replacement) {
           var _newIconName = getIconComponentName(_replacement.name);
-          addAutoFix(error, importSource, "".concat(_replacement.location, "/").concat(_replacement.type, "/").concat(_replacement.name), _newIconName);
+          if (!shouldTurnOffAutoFixer) {
+            addAutoFix(error, importSource, "".concat(_replacement.location, "/").concat(_replacement.type, "/").concat(_replacement.name), _newIconName);
+          }
         }
       }
       context.report(error);

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

@@ -53,6 +53,9 @@ var rule = (0, _createRule.createLintRule)({
     schema: [{
       type: 'object',
       properties: {
+        turnOffAutoFixer: {
+          type: 'boolean'
+        },
         deprecatedConfig: {
           type: 'object',
           properties: {
@@ -81,7 +84,8 @@ var rule = (0, _createRule.createLintRule)({
             }
           }
         }
-      }
+      },
+      additionalProperties: false
     }]
   },
   create: function create(context) {

package/dist/cjs/rules/use-spotlight-package/index.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _createRule = require("../utils/create-rule");
+var _linters = require("./linters");
+var rule = (0, _createRule.createLintRule)({
+  meta: {
+    name: 'use-spotlight-package',
+    type: 'problem',
+    fixable: 'code',
+    hasSuggestions: true,
+    docs: {
+      description: 'Discourage the use of deprecated imports from @atlaskit/onboarding in favor of @atlaskit/spotlight.',
+      recommended: false,
+      severity: 'warn'
+    },
+    messages: (0, _defineProperty2.default)({}, 'use-spotlight-package', '@atlaskit/onboarding is being deprecated in favor of @atlaskit/spotlight. Please migrate your spotlight experiences accordingly.')
+  },
+  create: function create(context) {
+    return {
+      'ImportDeclaration[source.value="@atlaskit/onboarding"]': function ImportDeclarationSourceValueAtlaskit_onboarding(node) {
+        return _linters.ImportDeclaration.lint(node, {
+          context: context
+        });
+      }
+    };
+  }
+});
+var _default = exports.default = rule;

package/dist/cjs/rules/use-spotlight-package/linters/import-declaration/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ImportDeclaration = void 0;
+var _eslintCodemodUtils = require("eslint-codemod-utils");
+/* eslint-disable @repo/internal/react/require-jsdoc */
+
+var messageId = 'use-spotlight-package';
+var ImportDeclaration = exports.ImportDeclaration = {
+  lint: function lint(node, _ref) {
+    var context = _ref.context;
+    // Check whether all criteria needed to make a transformation are met
+    var _ImportDeclaration$_c = ImportDeclaration._check(node),
+      success = _ImportDeclaration$_c.success,
+      ref = _ImportDeclaration$_c.ref;
+    if (!success) {
+      return;
+    }
+    context.report({
+      node: ref,
+      messageId: messageId
+    });
+  },
+  _check: function _check(node) {
+    if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'ImportDeclaration')) {
+      return {
+        success: false,
+        ref: undefined
+      };
+    }
+    return {
+      success: true,
+      ref: node
+    };
+  }
+};

package/dist/cjs/rules/use-spotlight-package/linters/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ImportDeclaration", {
+  enumerable: true,
+  get: function get() {
+    return _importDeclaration.ImportDeclaration;
+  }
+});
+var _importDeclaration = require("./import-declaration");

package/dist/es2019/presets/all-flat.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::6210f09c70f4d44befb986dfd548ed3e>>
+ * @codegen <<SignedSource::5aac2d8dc7c2832bcb8a96a143d60db5>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -69,6 +69,7 @@ const rules = {
     '@atlaskit/design-system/use-primitives': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-spotlight-package': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-shape': 'error',
     '@atlaskit/design-system/use-tokens-space': 'error',

package/dist/es2019/presets/all.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::daf4a5893d65c7a1592f8bc6e51920c6>>
+ * @codegen <<SignedSource::43ea4411c4e338a916772d4bfda146cc>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -68,6 +68,7 @@ const rules = {
     '@atlaskit/design-system/use-primitives': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-spotlight-package': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-shape': 'error',
     '@atlaskit/design-system/use-tokens-space': 'error',

package/dist/es2019/rules/index.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::4693db80b637ac078521dd6e0591f75b>>
+ * @codegen <<SignedSource::732bff0fc39d7ff05b6688694101698d>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -66,6 +66,7 @@ import usePopupLabel from './use-popup-label';
 import usePrimitives from './use-primitives';
 import usePrimitivesText from './use-primitives-text';
 import useShouldRenderToParent from './use-should-render-to-parent';
+import useSpotlightPackage from './use-spotlight-package';
 import useTagGroupLabel from './use-tag-group-label';
 import useTokensShape from './use-tokens-shape';
 import useTokensSpace from './use-tokens-space';
@@ -134,6 +135,7 @@ export const rules = {
   'use-primitives': usePrimitives,
   'use-primitives-text': usePrimitivesText,
   'use-should-render-to-parent': useShouldRenderToParent,
+  'use-spotlight-package': useSpotlightPackage,
   'use-tag-group-label': useTagGroupLabel,
   'use-tokens-shape': useTokensShape,
   'use-tokens-space': useTokensSpace,

package/dist/es2019/rules/no-deprecated-imports/handlers/icon.js

@@ -13,6 +13,12 @@ export const getDeprecationIconHandler = context => {
   const identifiers = new Map();
   const importErrors = {};
   const exportErrors = {};
+  const getConfigFlag = (key, defaultValue) => {
+    if (context.options && context.options.length > 0 && context.options[0] && context.options[0].hasOwnProperty(key)) {
+      return context.options[0][key] === !defaultValue ? !defaultValue : defaultValue;
+    }
+    return defaultValue;
+  };
   const getIconComponentName = name => {
     return name.split(/\W/).map(part => `${part[0].toUpperCase()}${part.slice(1)}`).join('').concat('Icon');
   };
@@ -52,6 +58,7 @@ export const getDeprecationIconHandler = context => {
     }
   };
   const throwErrors = () => {
+    const shouldTurnOffAutoFixer = getConfigFlag('turnOffAutoFixer', false);
     for (const [importSource, error] of Object.entries(importErrors)) {
       if (importSource.includes('/migration/')) {
         var _metadata$deprecatedI, _error$data;
@@ -61,7 +68,9 @@ export const getDeprecationIconHandler = context => {
         const replacement = metadata === null || metadata === void 0 ? void 0 : (_metadata$deprecatedI = metadata[deprecatedIconName]) === null || _metadata$deprecatedI === void 0 ? void 0 : _metadata$deprecatedI.replacement;
         if (replacement && ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.unfixable) === 'false') {
           const newIconName = getIconComponentName(replacement.name);
-          addAutoFix(error, importSource, `${replacement.location}/${replacement.type}/migration/${replacement.name}--${legacyIconName}`, newIconName);
+          if (!shouldTurnOffAutoFixer) {
+            addAutoFix(error, importSource, `${replacement.location}/${replacement.type}/migration/${replacement.name}--${legacyIconName}`, newIconName);
+          }
         }
       } else {
         var _metadata, _metadata$name;
@@ -75,7 +84,9 @@ export const getDeprecationIconHandler = context => {
         const replacement = (_metadata = metadata) === null || _metadata === void 0 ? void 0 : (_metadata$name = _metadata[name]) === null || _metadata$name === void 0 ? void 0 : _metadata$name.replacement;
         if (replacement) {
           const newIconName = getIconComponentName(replacement.name);
-          addAutoFix(error, importSource, `${replacement.location}/${replacement.type}/${replacement.name}`, newIconName);
+          if (!shouldTurnOffAutoFixer) {
+            addAutoFix(error, importSource, `${replacement.location}/${replacement.type}/${replacement.name}`, newIconName);
+          }
         }
       }
       context.report(error);

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

@@ -47,6 +47,9 @@ const rule = createLintRule({
     schema: [{
       type: 'object',
       properties: {
+        turnOffAutoFixer: {
+          type: 'boolean'
+        },
         deprecatedConfig: {
           type: 'object',
           properties: {
@@ -75,7 +78,8 @@ const rule = createLintRule({
             }
           }
         }
-      }
+      },
+      additionalProperties: false
     }]
   },
   create(context) {

package/dist/es2019/rules/use-spotlight-package/index.js

@@ -0,0 +1,26 @@
+import { createLintRule } from '../utils/create-rule';
+import { ImportDeclaration } from './linters';
+const rule = createLintRule({
+  meta: {
+    name: 'use-spotlight-package',
+    type: 'problem',
+    fixable: 'code',
+    hasSuggestions: true,
+    docs: {
+      description: 'Discourage the use of deprecated imports from @atlaskit/onboarding in favor of @atlaskit/spotlight.',
+      recommended: false,
+      severity: 'warn'
+    },
+    messages: {
+      ['use-spotlight-package']: '@atlaskit/onboarding is being deprecated in favor of @atlaskit/spotlight. Please migrate your spotlight experiences accordingly.'
+    }
+  },
+  create(context) {
+    return {
+      'ImportDeclaration[source.value="@atlaskit/onboarding"]': node => ImportDeclaration.lint(node, {
+        context
+      })
+    };
+  }
+});
+export default rule;

package/dist/es2019/rules/use-spotlight-package/linters/import-declaration/index.js

@@ -0,0 +1,34 @@
+/* eslint-disable @repo/internal/react/require-jsdoc */
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+const messageId = 'use-spotlight-package';
+export const ImportDeclaration = {
+  lint(node, {
+    context
+  }) {
+    // Check whether all criteria needed to make a transformation are met
+    const {
+      success,
+      ref
+    } = ImportDeclaration._check(node);
+    if (!success) {
+      return;
+    }
+    context.report({
+      node: ref,
+      messageId
+    });
+  },
+  _check(node) {
+    if (!isNodeOfType(node, 'ImportDeclaration')) {
+      return {
+        success: false,
+        ref: undefined
+      };
+    }
+    return {
+      success: true,
+      ref: node
+    };
+  }
+};

package/dist/es2019/rules/use-spotlight-package/linters/index.js

@@ -0,0 +1 @@
+export { ImportDeclaration } from './import-declaration';

package/dist/esm/presets/all-flat.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::6210f09c70f4d44befb986dfd548ed3e>>
+ * @codegen <<SignedSource::5aac2d8dc7c2832bcb8a96a143d60db5>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -69,6 +69,7 @@ var rules = {
     '@atlaskit/design-system/use-primitives': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-spotlight-package': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-shape': 'error',
     '@atlaskit/design-system/use-tokens-space': 'error',

package/dist/esm/presets/all.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::daf4a5893d65c7a1592f8bc6e51920c6>>
+ * @codegen <<SignedSource::43ea4411c4e338a916772d4bfda146cc>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -68,6 +68,7 @@ var rules = {
     '@atlaskit/design-system/use-primitives': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-spotlight-package': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-shape': 'error',
     '@atlaskit/design-system/use-tokens-space': 'error',

package/dist/esm/rules/index.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::4693db80b637ac078521dd6e0591f75b>>
+ * @codegen <<SignedSource::732bff0fc39d7ff05b6688694101698d>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -66,6 +66,7 @@ import usePopupLabel from './use-popup-label';
 import usePrimitives from './use-primitives';
 import usePrimitivesText from './use-primitives-text';
 import useShouldRenderToParent from './use-should-render-to-parent';
+import useSpotlightPackage from './use-spotlight-package';
 import useTagGroupLabel from './use-tag-group-label';
 import useTokensShape from './use-tokens-shape';
 import useTokensSpace from './use-tokens-space';
@@ -134,6 +135,7 @@ export var rules = {
   'use-primitives': usePrimitives,
   'use-primitives-text': usePrimitivesText,
   'use-should-render-to-parent': useShouldRenderToParent,
+  'use-spotlight-package': useSpotlightPackage,
   'use-tag-group-label': useTagGroupLabel,
   'use-tokens-shape': useTokensShape,
   'use-tokens-space': useTokensSpace,

package/dist/esm/rules/no-deprecated-imports/handlers/icon.js

@@ -17,6 +17,12 @@ export var getDeprecationIconHandler = function getDeprecationIconHandler(contex
   var identifiers = new Map();
   var importErrors = {};
   var exportErrors = {};
+  var getConfigFlag = function getConfigFlag(key, defaultValue) {
+    if (context.options && context.options.length > 0 && context.options[0] && context.options[0].hasOwnProperty(key)) {
+      return context.options[0][key] === !defaultValue ? !defaultValue : defaultValue;
+    }
+    return defaultValue;
+  };
   var getIconComponentName = function getIconComponentName(name) {
     return name.split(/\W/).map(function (part) {
       return "".concat(part[0].toUpperCase()).concat(part.slice(1));
@@ -56,6 +62,7 @@ export var getDeprecationIconHandler = function getDeprecationIconHandler(contex
     }
   };
   var throwErrors = function throwErrors() {
+    var shouldTurnOffAutoFixer = getConfigFlag('turnOffAutoFixer', false);
     for (var _i = 0, _Object$entries = Object.entries(importErrors); _i < _Object$entries.length; _i++) {
       var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
         importSource = _Object$entries$_i[0],
@@ -76,7 +83,9 @@ export var getDeprecationIconHandler = function getDeprecationIconHandler(contex
         var replacement = metadata === null || metadata === void 0 || (_metadata$deprecatedI = metadata[deprecatedIconName]) === null || _metadata$deprecatedI === void 0 ? void 0 : _metadata$deprecatedI.replacement;
         if (replacement && ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.unfixable) === 'false') {
           var newIconName = getIconComponentName(replacement.name);
-          addAutoFix(error, importSource, "".concat(replacement.location, "/").concat(replacement.type, "/migration/").concat(replacement.name, "--").concat(legacyIconName), newIconName);
+          if (!shouldTurnOffAutoFixer) {
+            addAutoFix(error, importSource, "".concat(replacement.location, "/").concat(replacement.type, "/migration/").concat(replacement.name, "--").concat(legacyIconName), newIconName);
+          }
         }
       } else {
         var _metadata2;
@@ -94,7 +103,9 @@ export var getDeprecationIconHandler = function getDeprecationIconHandler(contex
         var _replacement = (_metadata2 = _metadata) === null || _metadata2 === void 0 || (_metadata2 = _metadata2[_name]) === null || _metadata2 === void 0 ? void 0 : _metadata2.replacement;
         if (_replacement) {
           var _newIconName = getIconComponentName(_replacement.name);
-          addAutoFix(error, importSource, "".concat(_replacement.location, "/").concat(_replacement.type, "/").concat(_replacement.name), _newIconName);
+          if (!shouldTurnOffAutoFixer) {
+            addAutoFix(error, importSource, "".concat(_replacement.location, "/").concat(_replacement.type, "/").concat(_replacement.name), _newIconName);
+          }
         }
       }
       context.report(error);

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

@@ -47,6 +47,9 @@ var rule = createLintRule({
     schema: [{
       type: 'object',
       properties: {
+        turnOffAutoFixer: {
+          type: 'boolean'
+        },
         deprecatedConfig: {
           type: 'object',
           properties: {
@@ -75,7 +78,8 @@ var rule = createLintRule({
             }
           }
         }
-      }
+      },
+      additionalProperties: false
     }]
   },
   create: function create(context) {

package/dist/esm/rules/use-spotlight-package/index.js

@@ -0,0 +1,27 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { createLintRule } from '../utils/create-rule';
+import { ImportDeclaration } from './linters';
+var rule = createLintRule({
+  meta: {
+    name: 'use-spotlight-package',
+    type: 'problem',
+    fixable: 'code',
+    hasSuggestions: true,
+    docs: {
+      description: 'Discourage the use of deprecated imports from @atlaskit/onboarding in favor of @atlaskit/spotlight.',
+      recommended: false,
+      severity: 'warn'
+    },
+    messages: _defineProperty({}, 'use-spotlight-package', '@atlaskit/onboarding is being deprecated in favor of @atlaskit/spotlight. Please migrate your spotlight experiences accordingly.')
+  },
+  create: function create(context) {
+    return {
+      'ImportDeclaration[source.value="@atlaskit/onboarding"]': function ImportDeclarationSourceValueAtlaskit_onboarding(node) {
+        return ImportDeclaration.lint(node, {
+          context: context
+        });
+      }
+    };
+  }
+});
+export default rule;

package/dist/esm/rules/use-spotlight-package/linters/import-declaration/index.js

@@ -0,0 +1,32 @@
+/* eslint-disable @repo/internal/react/require-jsdoc */
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+var messageId = 'use-spotlight-package';
+export var ImportDeclaration = {
+  lint: function lint(node, _ref) {
+    var context = _ref.context;
+    // Check whether all criteria needed to make a transformation are met
+    var _ImportDeclaration$_c = ImportDeclaration._check(node),
+      success = _ImportDeclaration$_c.success,
+      ref = _ImportDeclaration$_c.ref;
+    if (!success) {
+      return;
+    }
+    context.report({
+      node: ref,
+      messageId: messageId
+    });
+  },
+  _check: function _check(node) {
+    if (!isNodeOfType(node, 'ImportDeclaration')) {
+      return {
+        success: false,
+        ref: undefined
+      };
+    }
+    return {
+      success: true,
+      ref: node
+    };
+  }
+};

package/dist/esm/rules/use-spotlight-package/linters/index.js

@@ -0,0 +1 @@
+export { ImportDeclaration } from './import-declaration';

package/dist/types/presets/all-flat.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::6210f09c70f4d44befb986dfd548ed3e>>
+ * @codegen <<SignedSource::5aac2d8dc7c2832bcb8a96a143d60db5>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import type { Linter } from 'eslint';

package/dist/types/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::daf4a5893d65c7a1592f8bc6e51920c6>>
+ * @codegen <<SignedSource::43ea4411c4e338a916772d4bfda146cc>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import type { ESLint } from 'eslint';

package/dist/types/rules/index.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::4693db80b637ac078521dd6e0591f75b>>
+ * @codegen <<SignedSource::732bff0fc39d7ff05b6688694101698d>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import type { Rule } from 'eslint';

package/dist/types/rules/use-spotlight-package/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types/rules/use-spotlight-package/linters/import-declaration/index.d.ts

@@ -0,0 +1,16 @@
+import type { Rule } from 'eslint';
+import { type ImportDeclaration as ImportDeclarationNode } from 'eslint-codemod-utils';
+type Check = {
+    success: false;
+    ref: undefined;
+} | {
+    success: true;
+    ref: ImportDeclarationNode;
+};
+export declare const ImportDeclaration: {
+    lint(node: Rule.Node, { context }: {
+        context: Rule.RuleContext;
+    }): void;
+    _check(node: Rule.Node): Check;
+};
+export {};

package/dist/types/rules/use-spotlight-package/linters/index.d.ts

@@ -0,0 +1 @@
+export { ImportDeclaration } from './import-declaration';

package/dist/types-ts4.5/presets/all-flat.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::6210f09c70f4d44befb986dfd548ed3e>>
+ * @codegen <<SignedSource::5aac2d8dc7c2832bcb8a96a143d60db5>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import type { Linter } from 'eslint';

package/dist/types-ts4.5/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::daf4a5893d65c7a1592f8bc6e51920c6>>
+ * @codegen <<SignedSource::43ea4411c4e338a916772d4bfda146cc>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import type { ESLint } from 'eslint';

package/dist/types-ts4.5/rules/index.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::4693db80b637ac078521dd6e0591f75b>>
+ * @codegen <<SignedSource::732bff0fc39d7ff05b6688694101698d>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import type { Rule } from 'eslint';

package/dist/types-ts4.5/rules/use-spotlight-package/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types-ts4.5/rules/use-spotlight-package/linters/import-declaration/index.d.ts

@@ -0,0 +1,16 @@
+import type { Rule } from 'eslint';
+import { type ImportDeclaration as ImportDeclarationNode } from 'eslint-codemod-utils';
+type Check = {
+    success: false;
+    ref: undefined;
+} | {
+    success: true;
+    ref: ImportDeclarationNode;
+};
+export declare const ImportDeclaration: {
+    lint(node: Rule.Node, { context }: {
+        context: Rule.RuleContext;
+    }): void;
+    _check(node: Rule.Node): Check;
+};
+export {};

package/dist/types-ts4.5/rules/use-spotlight-package/linters/index.d.ts

@@ -0,0 +1 @@
+export { ImportDeclaration } from './import-declaration';

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": "13.21.3",
+	"version": "13.23.0",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {