@atlaskit/eslint-plugin-design-system 10.15.0 → 10.17.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 10.17.0
+
+### Minor Changes
+
+- [#131211](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/131211)
+  [`9877a261592a7`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/9877a261592a7) -
+  Added an autofixer for `no-legacy-icons` eslint rule which migrates icons in the "Auto Migration"
+  category to new icons. Use `shouldUseMigrationPath` option to control the import path of the new
+  icon.
+
+## 10.16.0
+
+### Minor Changes
+
+- [#130413](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/130413)
+  [`1a796c4acf4e9`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/1a796c4acf4e9) -
+  Added new eslint plugin, ensure-icon-color
+
 ## 10.15.0
 
 ### Minor Changes

package/README.md

@@ -52,6 +52,7 @@ module.exports = {
 | <a href="./src/rules/consistent-css-prop-usage/README.md">consistent-css-prop-usage</a>                                     | Ensures consistency with `css` and `xcss` prop usages                                                                                                                                                                                                                                                               | Yes         | Yes     |             |
 | <a href="./src/rules/ensure-design-token-usage/README.md">ensure-design-token-usage</a>                                     | Enforces usage of design tokens rather than hard-coded values.                                                                                                                                                                                                                                                      | Yes         | Yes     | Yes         |
 | <a href="./src/rules/ensure-design-token-usage-preview/README.md">ensure-design-token-usage/preview</a>                     | Enforces usage of pre-release design tokens rather than hard-coded values.                                                                                                                                                                                                                                          |             | Yes     | Yes         |
+| <a href="./src/rules/ensure-icon-color/README.md">ensure-icon-color</a>                                                     | Enforces that upcoming icon components have a color prop set, to enable a migration of the default value.                                                                                                                                                                                                           |             |         |             |
 | <a href="./src/rules/icon-label/README.md">icon-label</a>                                                                   | Enforces accessible usage of icon labels when composed with Atlassian Design System components.                                                                                                                                                                                                                     | Yes         | Yes     |             |
 | <a href="./src/rules/no-banned-imports/README.md">no-banned-imports</a>                                                     | Disallow importing banned modules.                                                                                                                                                                                                                                                                                  | Yes         |         |             |
 | <a href="./src/rules/no-css-tagged-template-expression/README.md">no-css-tagged-template-expression</a>                     | Disallows any `css` tagged template expressions that originate from Emotion, Styled Components or Compiled                                                                                                                                                                                                          |             | Yes     |             |

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::b6947ac630ea512fe3f4e3f44abb6783>>
+ * @codegen <<SignedSource::16613cb3962ed68af0bffd70eef5f5e2>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 var _default = exports.default = {
@@ -15,6 +15,7 @@ var _default = exports.default = {
     '@atlaskit/design-system/consistent-css-prop-usage': 'error',
     '@atlaskit/design-system/ensure-design-token-usage': 'error',
     '@atlaskit/design-system/ensure-design-token-usage/preview': 'warn',
+    '@atlaskit/design-system/ensure-icon-color': 'error',
     '@atlaskit/design-system/icon-label': 'warn',
     '@atlaskit/design-system/no-banned-imports': 'error',
     '@atlaskit/design-system/no-css-tagged-template-expression': 'error',

package/dist/cjs/rules/ensure-icon-color/index.js

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _eslintCodemodUtils = require("eslint-codemod-utils");
+var _isFromImportSource = require("../no-custom-icons/checks/is-from-import-source");
+var _createRule = require("../utils/create-rule");
+var _errorBoundary = require("../utils/error-boundary");
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+/**
+ * Returns if the node is a JSXElement with a prop that matches the given name.
+ */
+function hasProp(node, propName) {
+  return (0, _eslintCodemodUtils.isNodeOfType)(node.openingElement, 'JSXOpeningElement') && node.openingElement.attributes.some(function (a) {
+    return a.type === 'JSXAttribute' && a.name.name === propName;
+  });
+}
+var rule = (0, _createRule.createLintRule)({
+  meta: {
+    name: 'ensure-icon-color',
+    docs: {
+      description: 'Enforces that upcoming icon components have a color prop set, to enable a migration of the default value.',
+      recommended: false,
+      severity: 'error'
+    },
+    messages: {
+      missingColorProp: 'The default value of the `color` prop is about to change. To assist in the migration, the color prop must be set on new icons from `@atlaskit/icon/(core|utility)`.'
+    }
+  },
+  create: function create(context) {
+    /**
+     * Contains a map of imported icon components from any atlaskit icon package.
+     */
+    var isNewIcon = (0, _isFromImportSource.createIsFromImportSourceFor)(/^@(atlaskit\/icon|atlassian\/icon-lab)\/(core|utility)\/*/);
+    return (0, _errorBoundary.errorBoundary)({
+      JSXElement: function JSXElement(node) {
+        var _isNewIcon$getImportS;
+        if (!isNewIcon(node) || hasProp(node, 'color')) {
+          return;
+        }
+        var importSource = (_isNewIcon$getImportS = isNewIcon.getImportSource(node)) !== null && _isNewIcon$getImportS !== void 0 ? _isNewIcon$getImportS : '';
+        context.report({
+          node: node.openingElement,
+          messageId: 'missingColorProp',
+          data: {
+            importSource: importSource
+          }
+        });
+      },
+      ImportDeclaration: isNewIcon.importDeclarationHook
+    });
+  }
+});
+var _default = exports.default = rule;

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

@@ -8,6 +8,7 @@ exports.default = void 0;
 var _consistentCssPropUsage = _interopRequireDefault(require("./consistent-css-prop-usage"));
 var _ensureDesignTokenUsage = _interopRequireDefault(require("./ensure-design-token-usage"));
 var _ensureDesignTokenUsagePreview = _interopRequireDefault(require("./ensure-design-token-usage-preview"));
+var _ensureIconColor = _interopRequireDefault(require("./ensure-icon-color"));
 var _iconLabel = _interopRequireDefault(require("./icon-label"));
 var _noBannedImports = _interopRequireDefault(require("./no-banned-imports"));
 var _noCssTaggedTemplateExpression = _interopRequireDefault(require("./no-css-tagged-template-expression"));
@@ -48,13 +49,14 @@ 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::402e6eb5433560b1032e5ed926bb5564>>
+ * @codegen <<SignedSource::c2a140a3f690737dd938e746ef8fb9d5>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 var _default = exports.default = {
   'consistent-css-prop-usage': _consistentCssPropUsage.default,
   'ensure-design-token-usage': _ensureDesignTokenUsage.default,
   'ensure-design-token-usage/preview': _ensureDesignTokenUsagePreview.default,
+  'ensure-icon-color': _ensureIconColor.default,
   'icon-label': _iconLabel.default,
   'no-banned-imports': _noBannedImports.default,
   'no-css-tagged-template-expression': _noCssTaggedTemplateExpression.default,