@atlaskit/eslint-plugin-design-system 10.19.0 → 10.20.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 10.20.0
+
+### Minor Changes
+
+- [#142315](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/142315)
+  [`4810530a99092`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4810530a99092) -
+  Add `no-dark-theme-vr-tests` rule
+
 ## 10.19.0
 
 ### Minor Changes

package/README.md

@@ -57,6 +57,7 @@ module.exports = {
 | <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     |             |
 | <a href="./src/rules/no-custom-icons/README.md">no-custom-icons</a>                                                         | Enforces custom glyph icons are used.                                                                                                                                                                                                                                                                               |             |         |             |
+| <a href="./src/rules/no-dark-theme-vr-tests/README.md">no-dark-theme-vr-tests</a>                                           | Disallow using dark colorScheme in VR tests.                                                                                                                                                                                                                                                                        |             | Yes     |             |
 | <a href="./src/rules/no-deprecated-apis/README.md">no-deprecated-apis</a>                                                   | Disallow using deprecated APIs.                                                                                                                                                                                                                                                                                     | Yes         |         |             |
 | <a href="./src/rules/no-deprecated-design-token-usage/README.md">no-deprecated-design-token-usage</a>                       | Disallow using deprecated design tokens.                                                                                                                                                                                                                                                                            | Yes         | Yes     |             |
 | <a href="./src/rules/no-deprecated-imports/README.md">no-deprecated-imports</a>                                             | Disallow importing deprecated modules.                                                                                                                                                                                                                                                                              | 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::be4dfc6cd2ee9af2084965a89f8b8a91>>
+ * @codegen <<SignedSource::310e184a1b8eca0da1246cfe8d128e2c>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 var _default = exports.default = {
@@ -20,6 +20,7 @@ var _default = exports.default = {
     '@atlaskit/design-system/no-banned-imports': 'error',
     '@atlaskit/design-system/no-css-tagged-template-expression': 'error',
     '@atlaskit/design-system/no-custom-icons': 'warn',
+    '@atlaskit/design-system/no-dark-theme-vr-tests': 'error',
     '@atlaskit/design-system/no-deprecated-apis': 'error',
     '@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
     '@atlaskit/design-system/no-deprecated-imports': 'error',

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

@@ -13,6 +13,7 @@ var _iconLabel = _interopRequireDefault(require("./icon-label"));
 var _noBannedImports = _interopRequireDefault(require("./no-banned-imports"));
 var _noCssTaggedTemplateExpression = _interopRequireDefault(require("./no-css-tagged-template-expression"));
 var _noCustomIcons = _interopRequireDefault(require("./no-custom-icons"));
+var _noDarkThemeVrTests = _interopRequireDefault(require("./no-dark-theme-vr-tests"));
 var _noDeprecatedApis = _interopRequireDefault(require("./no-deprecated-apis"));
 var _noDeprecatedDesignTokenUsage = _interopRequireDefault(require("./no-deprecated-design-token-usage"));
 var _noDeprecatedImports = _interopRequireDefault(require("./no-deprecated-imports"));
@@ -50,7 +51,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::4c05727190930e765289a0d292c2928f>>
+ * @codegen <<SignedSource::2c61c8c9aa86b4fb1d11e0bcba9d83a1>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 var _default = exports.default = {
@@ -62,6 +63,7 @@ var _default = exports.default = {
   'no-banned-imports': _noBannedImports.default,
   'no-css-tagged-template-expression': _noCssTaggedTemplateExpression.default,
   'no-custom-icons': _noCustomIcons.default,
+  'no-dark-theme-vr-tests': _noDarkThemeVrTests.default,
   'no-deprecated-apis': _noDeprecatedApis.default,
   'no-deprecated-design-token-usage': _noDeprecatedDesignTokenUsage.default,
   'no-deprecated-imports': _noDeprecatedImports.default,

package/dist/cjs/rules/no-dark-theme-vr-tests/index.js

@@ -0,0 +1,65 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _createRule = require("../utils/create-rule");
+var rule = (0, _createRule.createLintRule)({
+  meta: {
+    name: 'no-dark-theme-vr-tests',
+    type: 'problem',
+    fixable: 'code',
+    docs: {
+      description: 'Disallow using dark colorScheme in VR tests.',
+      recommended: false,
+      severity: 'error'
+    },
+    messages: {
+      noDarkThemeVR: "Redundant dark theme VR tests are not allowed. Check out this [RFC](https://hello.atlassian.net/wiki/spaces/DST/pages/4083370233/DSTRFC-022+-+Intent+to+remove+dark+VR+tests+from+AFM)"
+    }
+  },
+  create: function create(context) {
+    var importSources = [];
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        if (node.source.type === 'Literal' && typeof node.source.value === 'string') {
+          importSources.push(node.source.value);
+        }
+      },
+      ObjectExpression: function ObjectExpression(node) {
+        if (importSources.every(function (source) {
+          return ['@af/visual-regression', '@atlassian/jira-vr-testing', '@atlassian/gemini'].includes(source);
+        })) {
+          return {};
+        }
+        node.properties.forEach(function (prop) {
+          var environmentProperty = prop.type === 'Property' && prop.key.type === 'Identifier' && prop.key.name === 'environment' ? prop : null;
+          if (environmentProperty && environmentProperty.value.type === 'ObjectExpression') {
+            var colorSchemeProperty = environmentProperty.value.properties.find(function (path) {
+              return path.type === 'Property' && path.key.type === 'Identifier' && path.key.name === 'colorScheme';
+            });
+            if (colorSchemeProperty && colorSchemeProperty.type === 'Property' && colorSchemeProperty.value.type === 'Literal' && colorSchemeProperty.value.value === 'dark') {
+              context.report({
+                node: node,
+                messageId: 'noDarkThemeVR',
+                fix: function fix(fixer) {
+                  if (node.range) {
+                    var _node$range = (0, _slicedToArray2.default)(node.range, 2),
+                      start = _node$range[0],
+                      end = _node$range[1];
+                    return fixer.removeRange([start, end + 1]);
+                  }
+                  return null;
+                }
+              });
+            }
+          }
+        });
+      }
+    };
+  }
+});
+var _default = exports.default = rule;

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::be4dfc6cd2ee9af2084965a89f8b8a91>>
+ * @codegen <<SignedSource::310e184a1b8eca0da1246cfe8d128e2c>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -14,6 +14,7 @@ export default {
     '@atlaskit/design-system/no-banned-imports': 'error',
     '@atlaskit/design-system/no-css-tagged-template-expression': 'error',
     '@atlaskit/design-system/no-custom-icons': 'warn',
+    '@atlaskit/design-system/no-dark-theme-vr-tests': 'error',
     '@atlaskit/design-system/no-deprecated-apis': 'error',
     '@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
     '@atlaskit/design-system/no-deprecated-imports': '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::4c05727190930e765289a0d292c2928f>>
+ * @codegen <<SignedSource::2c61c8c9aa86b4fb1d11e0bcba9d83a1>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import consistentCssPropUsage from './consistent-css-prop-usage';
@@ -11,6 +11,7 @@ import iconLabel from './icon-label';
 import noBannedImports from './no-banned-imports';
 import noCssTaggedTemplateExpression from './no-css-tagged-template-expression';
 import noCustomIcons from './no-custom-icons';
+import noDarkThemeVrTests from './no-dark-theme-vr-tests';
 import noDeprecatedApis from './no-deprecated-apis';
 import noDeprecatedDesignTokenUsage from './no-deprecated-design-token-usage';
 import noDeprecatedImports from './no-deprecated-imports';
@@ -55,6 +56,7 @@ export default {
   'no-banned-imports': noBannedImports,
   'no-css-tagged-template-expression': noCssTaggedTemplateExpression,
   'no-custom-icons': noCustomIcons,
+  'no-dark-theme-vr-tests': noDarkThemeVrTests,
   'no-deprecated-apis': noDeprecatedApis,
   'no-deprecated-design-token-usage': noDeprecatedDesignTokenUsage,
   'no-deprecated-imports': noDeprecatedImports,

package/dist/es2019/rules/no-dark-theme-vr-tests/index.js

@@ -0,0 +1,51 @@
+import { createLintRule } from '../utils/create-rule';
+const rule = createLintRule({
+  meta: {
+    name: 'no-dark-theme-vr-tests',
+    type: 'problem',
+    fixable: 'code',
+    docs: {
+      description: 'Disallow using dark colorScheme in VR tests.',
+      recommended: false,
+      severity: 'error'
+    },
+    messages: {
+      noDarkThemeVR: `Redundant dark theme VR tests are not allowed. Check out this [RFC](https://hello.atlassian.net/wiki/spaces/DST/pages/4083370233/DSTRFC-022+-+Intent+to+remove+dark+VR+tests+from+AFM)`
+    }
+  },
+  create(context) {
+    let importSources = [];
+    return {
+      ImportDeclaration(node) {
+        if (node.source.type === 'Literal' && typeof node.source.value === 'string') {
+          importSources.push(node.source.value);
+        }
+      },
+      ObjectExpression(node) {
+        if (importSources.every(source => ['@af/visual-regression', '@atlassian/jira-vr-testing', '@atlassian/gemini'].includes(source))) {
+          return {};
+        }
+        node.properties.forEach(prop => {
+          const environmentProperty = prop.type === 'Property' && prop.key.type === 'Identifier' && prop.key.name === 'environment' ? prop : null;
+          if (environmentProperty && environmentProperty.value.type === 'ObjectExpression') {
+            const colorSchemeProperty = environmentProperty.value.properties.find(path => path.type === 'Property' && path.key.type === 'Identifier' && path.key.name === 'colorScheme');
+            if (colorSchemeProperty && colorSchemeProperty.type === 'Property' && colorSchemeProperty.value.type === 'Literal' && colorSchemeProperty.value.value === 'dark') {
+              context.report({
+                node: node,
+                messageId: 'noDarkThemeVR',
+                fix: fixer => {
+                  if (node.range) {
+                    const [start, end] = node.range;
+                    return fixer.removeRange([start, end + 1]);
+                  }
+                  return null;
+                }
+              });
+            }
+          }
+        });
+      }
+    };
+  }
+});
+export default rule;

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::be4dfc6cd2ee9af2084965a89f8b8a91>>
+ * @codegen <<SignedSource::310e184a1b8eca0da1246cfe8d128e2c>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -14,6 +14,7 @@ export default {
     '@atlaskit/design-system/no-banned-imports': 'error',
     '@atlaskit/design-system/no-css-tagged-template-expression': 'error',
     '@atlaskit/design-system/no-custom-icons': 'warn',
+    '@atlaskit/design-system/no-dark-theme-vr-tests': 'error',
     '@atlaskit/design-system/no-deprecated-apis': 'error',
     '@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
     '@atlaskit/design-system/no-deprecated-imports': '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::4c05727190930e765289a0d292c2928f>>
+ * @codegen <<SignedSource::2c61c8c9aa86b4fb1d11e0bcba9d83a1>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import consistentCssPropUsage from './consistent-css-prop-usage';
@@ -11,6 +11,7 @@ import iconLabel from './icon-label';
 import noBannedImports from './no-banned-imports';
 import noCssTaggedTemplateExpression from './no-css-tagged-template-expression';
 import noCustomIcons from './no-custom-icons';
+import noDarkThemeVrTests from './no-dark-theme-vr-tests';
 import noDeprecatedApis from './no-deprecated-apis';
 import noDeprecatedDesignTokenUsage from './no-deprecated-design-token-usage';
 import noDeprecatedImports from './no-deprecated-imports';
@@ -55,6 +56,7 @@ export default {
   'no-banned-imports': noBannedImports,
   'no-css-tagged-template-expression': noCssTaggedTemplateExpression,
   'no-custom-icons': noCustomIcons,
+  'no-dark-theme-vr-tests': noDarkThemeVrTests,
   'no-deprecated-apis': noDeprecatedApis,
   'no-deprecated-design-token-usage': noDeprecatedDesignTokenUsage,
   'no-deprecated-imports': noDeprecatedImports,

package/dist/esm/rules/no-dark-theme-vr-tests/index.js

@@ -0,0 +1,58 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { createLintRule } from '../utils/create-rule';
+var rule = createLintRule({
+  meta: {
+    name: 'no-dark-theme-vr-tests',
+    type: 'problem',
+    fixable: 'code',
+    docs: {
+      description: 'Disallow using dark colorScheme in VR tests.',
+      recommended: false,
+      severity: 'error'
+    },
+    messages: {
+      noDarkThemeVR: "Redundant dark theme VR tests are not allowed. Check out this [RFC](https://hello.atlassian.net/wiki/spaces/DST/pages/4083370233/DSTRFC-022+-+Intent+to+remove+dark+VR+tests+from+AFM)"
+    }
+  },
+  create: function create(context) {
+    var importSources = [];
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        if (node.source.type === 'Literal' && typeof node.source.value === 'string') {
+          importSources.push(node.source.value);
+        }
+      },
+      ObjectExpression: function ObjectExpression(node) {
+        if (importSources.every(function (source) {
+          return ['@af/visual-regression', '@atlassian/jira-vr-testing', '@atlassian/gemini'].includes(source);
+        })) {
+          return {};
+        }
+        node.properties.forEach(function (prop) {
+          var environmentProperty = prop.type === 'Property' && prop.key.type === 'Identifier' && prop.key.name === 'environment' ? prop : null;
+          if (environmentProperty && environmentProperty.value.type === 'ObjectExpression') {
+            var colorSchemeProperty = environmentProperty.value.properties.find(function (path) {
+              return path.type === 'Property' && path.key.type === 'Identifier' && path.key.name === 'colorScheme';
+            });
+            if (colorSchemeProperty && colorSchemeProperty.type === 'Property' && colorSchemeProperty.value.type === 'Literal' && colorSchemeProperty.value.value === 'dark') {
+              context.report({
+                node: node,
+                messageId: 'noDarkThemeVR',
+                fix: function fix(fixer) {
+                  if (node.range) {
+                    var _node$range = _slicedToArray(node.range, 2),
+                      start = _node$range[0],
+                      end = _node$range[1];
+                    return fixer.removeRange([start, end + 1]);
+                  }
+                  return null;
+                }
+              });
+            }
+          }
+        });
+      }
+    };
+  }
+});
+export default rule;

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

@@ -11,6 +11,7 @@ export declare const configs: {
             '@atlaskit/design-system/no-banned-imports': string;
             '@atlaskit/design-system/no-css-tagged-template-expression': string;
             '@atlaskit/design-system/no-custom-icons': string;
+            '@atlaskit/design-system/no-dark-theme-vr-tests': string;
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;

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::be4dfc6cd2ee9af2084965a89f8b8a91>>
+ * @codegen <<SignedSource::310e184a1b8eca0da1246cfe8d128e2c>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -14,6 +14,7 @@ declare const _default: {
         '@atlaskit/design-system/no-banned-imports': string;
         '@atlaskit/design-system/no-css-tagged-template-expression': string;
         '@atlaskit/design-system/no-custom-icons': string;
+        '@atlaskit/design-system/no-dark-theme-vr-tests': string;
         '@atlaskit/design-system/no-deprecated-apis': string;
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;

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

@@ -7,6 +7,7 @@ declare const _default: {
     'no-banned-imports': import("eslint").Rule.RuleModule;
     'no-css-tagged-template-expression': import("eslint").Rule.RuleModule;
     'no-custom-icons': import("eslint").Rule.RuleModule;
+    'no-dark-theme-vr-tests': import("eslint").Rule.RuleModule;
     'no-deprecated-apis': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<string, [{
         deprecatedConfig: import("./utils/types").DeprecatedConfig;
     }], import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;

package/dist/types/rules/no-dark-theme-vr-tests/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/index.codegen.d.ts

@@ -11,6 +11,7 @@ export declare const configs: {
             '@atlaskit/design-system/no-banned-imports': string;
             '@atlaskit/design-system/no-css-tagged-template-expression': string;
             '@atlaskit/design-system/no-custom-icons': string;
+            '@atlaskit/design-system/no-dark-theme-vr-tests': string;
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;

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::be4dfc6cd2ee9af2084965a89f8b8a91>>
+ * @codegen <<SignedSource::310e184a1b8eca0da1246cfe8d128e2c>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -14,6 +14,7 @@ declare const _default: {
         '@atlaskit/design-system/no-banned-imports': string;
         '@atlaskit/design-system/no-css-tagged-template-expression': string;
         '@atlaskit/design-system/no-custom-icons': string;
+        '@atlaskit/design-system/no-dark-theme-vr-tests': string;
         '@atlaskit/design-system/no-deprecated-apis': string;
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;

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

@@ -7,6 +7,7 @@ declare const _default: {
     'no-banned-imports': import("eslint").Rule.RuleModule;
     'no-css-tagged-template-expression': import("eslint").Rule.RuleModule;
     'no-custom-icons': import("eslint").Rule.RuleModule;
+    'no-dark-theme-vr-tests': import("eslint").Rule.RuleModule;
     'no-deprecated-apis': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<string, [
         {
             deprecatedConfig: import("./utils/types").DeprecatedConfig;

package/dist/types-ts4.5/rules/no-dark-theme-vr-tests/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+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": "10.19.0",
+	"version": "10.20.0",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {