@atlaskit/eslint-plugin-design-system 8.29.1 → 8.31.0

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

@@ -7,7 +7,6 @@ export declare const configs: {
             '@atlaskit/design-system/ensure-design-token-usage': string;
             '@atlaskit/design-system/ensure-design-token-usage/preview': string;
             '@atlaskit/design-system/icon-label': string;
-            '@atlaskit/design-system/local-cx-xcss': string;
             '@atlaskit/design-system/no-banned-imports': string;
             '@atlaskit/design-system/no-css-tagged-template-expression': string;
             '@atlaskit/design-system/no-deprecated-apis': string;
@@ -31,6 +30,7 @@ export declare const configs: {
             '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
             '@atlaskit/design-system/use-href-in-link-item': string;
             '@atlaskit/design-system/use-primitives': string;
+            '@atlaskit/design-system/use-primitives-text': string;
             '@atlaskit/design-system/use-visually-hidden': string;
         };
     };
@@ -40,7 +40,6 @@ export declare const configs: {
             '@atlaskit/design-system/consistent-css-prop-usage': string;
             '@atlaskit/design-system/ensure-design-token-usage': string;
             '@atlaskit/design-system/icon-label': string;
-            '@atlaskit/design-system/local-cx-xcss': string;
             '@atlaskit/design-system/no-banned-imports': string;
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-design-token-usage': 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::5647ce9c10ba880cffece66b5924fd6e>>
+ * @codegen <<SignedSource::aa64b4343b8763cfa5aa66230faea408>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -10,7 +10,6 @@ declare const _default: {
         '@atlaskit/design-system/ensure-design-token-usage': string;
         '@atlaskit/design-system/ensure-design-token-usage/preview': string;
         '@atlaskit/design-system/icon-label': string;
-        '@atlaskit/design-system/local-cx-xcss': string;
         '@atlaskit/design-system/no-banned-imports': string;
         '@atlaskit/design-system/no-css-tagged-template-expression': string;
         '@atlaskit/design-system/no-deprecated-apis': string;
@@ -34,6 +33,7 @@ declare const _default: {
         '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
         '@atlaskit/design-system/use-href-in-link-item': string;
         '@atlaskit/design-system/use-primitives': string;
+        '@atlaskit/design-system/use-primitives-text': string;
         '@atlaskit/design-system/use-visually-hidden': string;
     };
 };

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

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::577269c832952ce359cde6a50f26f4e0>>
+ * @codegen <<SignedSource::aebc778f0b10032cbb2941b55189d766>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -9,7 +9,6 @@ declare const _default: {
         '@atlaskit/design-system/consistent-css-prop-usage': string;
         '@atlaskit/design-system/ensure-design-token-usage': string;
         '@atlaskit/design-system/icon-label': string;
-        '@atlaskit/design-system/local-cx-xcss': string;
         '@atlaskit/design-system/no-banned-imports': string;
         '@atlaskit/design-system/no-deprecated-apis': string;
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;

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

@@ -3,7 +3,6 @@ declare const _default: {
     'ensure-design-token-usage': import("eslint").Rule.RuleModule;
     'ensure-design-token-usage/preview': import("eslint").Rule.RuleModule;
     'icon-label': import("eslint").Rule.RuleModule;
-    'local-cx-xcss': import("eslint").Rule.RuleModule;
     'no-banned-imports': import("eslint").Rule.RuleModule;
     'no-css-tagged-template-expression': import("eslint").Rule.RuleModule;
     'no-deprecated-apis': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<string, [
@@ -35,6 +34,7 @@ declare const _default: {
     'use-heading-level-in-spotlight-card': import("eslint").Rule.RuleModule;
     'use-href-in-link-item': import("eslint").Rule.RuleModule;
     'use-primitives': import("eslint").Rule.RuleModule;
+    'use-primitives-text': import("eslint").Rule.RuleModule;
     'use-visually-hidden': import("eslint").Rule.RuleModule;
 };
 export default _default;

package/dist/types-ts4.5/rules/use-primitives-text/config/index.d.ts

@@ -0,0 +1,6 @@
+type Pattern = 'paragraph-elements' | 'span-elements' | 'strong-elements' | 'emphasis-elements';
+export interface RuleConfig {
+    patterns: Pattern[];
+}
+export declare const getConfig: (overrides: Partial<RuleConfig>) => Required<RuleConfig>;
+export {};

package/dist/types-ts4.5/rules/{local-cx-xcss → use-primitives-text}/index.d.ts

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

package/dist/types-ts4.5/rules/use-primitives-text/transformers/common.d.ts

@@ -0,0 +1,5 @@
+import type { Rule } from 'eslint';
+import { JSXElement } from 'eslint-codemod-utils';
+export declare function updateTestIdAttributeFix(node: JSXElement, fixer: Rule.RuleFixer): Rule.Fix | undefined;
+export declare const allowedAttrs: string[];
+export declare function hasTextChildrenOnly(node: JSXElement): boolean;

package/dist/types-ts4.5/rules/use-primitives-text/transformers/emphasis-elements.d.ts

@@ -0,0 +1,16 @@
+import type { Rule } from 'eslint';
+import { JSXElement } from 'eslint-codemod-utils';
+import { RuleConfig } from '../config';
+interface MetaData {
+    context: Rule.RuleContext;
+    config: RuleConfig;
+}
+type FixFunction = (fixer: Rule.RuleFixer) => Rule.Fix[];
+export declare const EmphasisElements: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: JSXElement, { context, config }: MetaData): boolean;
+    _fix(node: JSXElement, { context }: {
+        context: Rule.RuleContext;
+    }): FixFunction;
+};
+export {};

package/dist/types-ts4.5/rules/use-primitives-text/transformers/index.d.ts

@@ -0,0 +1,4 @@
+export { EmphasisElements } from './emphasis-elements';
+export { SpanElements } from './span-elements';
+export { StrongElements } from './strong-elements';
+export { ParagraphElements } from './paragraph-elements';

package/dist/types-ts4.5/rules/use-primitives-text/transformers/paragraph-elements.d.ts

@@ -0,0 +1,32 @@
+import type { Rule } from 'eslint';
+import { JSXElement } from 'eslint-codemod-utils';
+import { RuleConfig } from '../config';
+type MetaData = {
+    context: Rule.RuleContext;
+    config: RuleConfig;
+};
+type CheckResult = {
+    success: boolean;
+    refs: {
+        siblings: JSXElement['children'];
+    };
+};
+type FixFunction = (fixer: Rule.RuleFixer) => Rule.Fix[];
+export declare const ParagraphElements: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: JSXElement & {
+        parent: Rule.Node;
+    }, { context, config }: MetaData): CheckResult;
+    _fixSingle(node: JSXElement & {
+        parent: Rule.Node;
+    }, { context }: {
+        context: Rule.RuleContext;
+    }): FixFunction;
+    _fixMultiple(node: JSXElement & {
+        parent: Rule.Node;
+    }, { context, refs }: {
+        context: Rule.RuleContext;
+        refs: CheckResult['refs'];
+    }): FixFunction;
+};
+export {};

package/dist/types-ts4.5/rules/use-primitives-text/transformers/span-elements.d.ts

@@ -0,0 +1,16 @@
+import type { Rule } from 'eslint';
+import { JSXElement } from 'eslint-codemod-utils';
+import { RuleConfig } from '../config';
+interface MetaData {
+    context: Rule.RuleContext;
+    config: RuleConfig;
+}
+type FixFunction = (fixer: Rule.RuleFixer) => Rule.Fix[];
+export declare const SpanElements: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: JSXElement, { context, config }: MetaData): boolean;
+    _fix(node: JSXElement, { context }: {
+        context: Rule.RuleContext;
+    }): FixFunction;
+};
+export {};

package/dist/types-ts4.5/rules/use-primitives-text/transformers/strong-elements.d.ts

@@ -0,0 +1,16 @@
+import type { Rule } from 'eslint';
+import { JSXElement } from 'eslint-codemod-utils';
+import { RuleConfig } from '../config';
+interface MetaData {
+    context: Rule.RuleContext;
+    config: RuleConfig;
+}
+type FixFunction = (fixer: Rule.RuleFixer) => Rule.Fix[];
+export declare const StrongElements: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: JSXElement, { context, config }: MetaData): boolean;
+    _fix(node: JSXElement, { context }: {
+        context: Rule.RuleContext;
+    }): FixFunction;
+};
+export {};

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": "8.29.1",
+  "version": "8.31.0",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/constellation/local-cx-xcss/usage.mdx

@@ -1,37 +0,0 @@
-# local-cx-xcss
-
-This rule ensures the `cx()` function is only used within the `xcss` prop. This aids tracking what styles are applied to a jsx element.
-
-The `cx` function is checked only if it is imported from `@compiled/react` or `@atlaskit/css`.
-
-Passing arguments to the `cx()` function is how you compose styles (combine more than one set of styles together) with XCSS. This is a workaround for the more conventional array syntax (e.g. [in Emotion](https://emotion.sh/docs/composition)) `<div xcss={[style1, style2]} />` not giving robust enough type checking.
-
-## Examples
-
-### Incorrect
-
-```js
-import { cx, cssMap } from '@compiled/react';
-
-const styles = cssMap({
-  text: { color: 'red' },
-  bg: { background: 'blue' },
-});
-
-const joinedStyles = cx(styles.text, styles.bg);
-
-<Button xcss={joinedStyles} />;
-```
-
-### Correct
-
-```js
-import { cx, cssMap } from '@compiled/react';
-
-const styles = cssMap({
-  text: { color: 'red' },
-  bg: { background: 'blue' },
-});
-
-<Button xcss={cx(styles.text, styles.bg)} />;
-```

package/dist/cjs/rules/local-cx-xcss/index.js

@@ -1,51 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.rule = exports.default = void 0;
-var _createRule = require("../utils/create-rule");
-var _isSupportedImport = require("../utils/is-supported-import");
-var IMPORT_SOURCES = [_isSupportedImport.CSS_IN_JS_IMPORTS.compiled, _isSupportedImport.CSS_IN_JS_IMPORTS.atlaskitCss];
-function getParentJSXAttribute(node) {
-  var parent = node.parent;
-  while (parent && parent.type !== 'JSXAttribute') {
-    parent = parent.parent;
-  }
-  if (parent && parent.type === 'JSXAttribute') {
-    return parent;
-  }
-  return null;
-}
-var rule = exports.rule = (0, _createRule.createLintRule)({
-  meta: {
-    name: 'local-cx-xcss',
-    docs: {
-      description: 'Ensures the cx() function, which is part of the XCSS API, is only used within the xcss prop. This aids tracking what styles are applied to a jsx element.',
-      recommended: true,
-      severity: 'error'
-    },
-    messages: {
-      'local-cx-xcss': 'The cx function should only be declared inside the xcss prop to simplify tracking styles that are applied to a jsx element.'
-    },
-    type: 'problem'
-  },
-  create: function create(context) {
-    return {
-      'CallExpression[callee.name="cx"]': function CallExpressionCalleeNameCx(node) {
-        if (node.type === 'CallExpression' && (0, _isSupportedImport.isCxFunction)(node.callee, context.getScope().references, IMPORT_SOURCES)) {
-          var parentJSXAttribute = getParentJSXAttribute(node);
-          var propName = parentJSXAttribute === null || parentJSXAttribute === void 0 ? void 0 : parentJSXAttribute.name.name.toString();
-          if (propName && /[xX]css$/.test(propName)) {
-            return;
-          }
-          context.report({
-            node: node,
-            messageId: 'local-cx-xcss'
-          });
-        }
-      }
-    };
-  }
-});
-var _default = exports.default = rule;

package/dist/cjs/rules/use-primitives/transformers/emotion-css/contains-only-supported-attrs.js

@@ -1,27 +0,0 @@
-"use strict";
-
-var _typeof = require("@babel/runtime/helpers/typeof");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.containsOnlySupportedAttrs = void 0;
-var _eslintCodemodUtils = require("eslint-codemod-utils");
-var ast = _interopRequireWildcard(require("../../../../ast-nodes"));
-var supported = _interopRequireWildcard(require("./supported"));
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-/**
- * Check that every attribute in the JSXElement is something we support.
- * We do this via a whitelist in `this.attributes`. The result is we exclude
- * dangerous attrs like `id` and `style`.
- */
-var containsOnlySupportedAttrs = exports.containsOnlySupportedAttrs = function containsOnlySupportedAttrs(node) {
-  var attrs = ast.JSXElement.getAttributes(node);
-  return attrs.every(function (attr) {
-    if (!(0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXAttribute')) {
-      return false;
-    }
-    var name = ast.JSXAttribute.getName(attr);
-    return supported.attributes.includes(name);
-  });
-};

package/dist/es2019/rules/local-cx-xcss/index.js

@@ -1,45 +0,0 @@
-import { createLintRule } from '../utils/create-rule';
-import { CSS_IN_JS_IMPORTS, isCxFunction } from '../utils/is-supported-import';
-const IMPORT_SOURCES = [CSS_IN_JS_IMPORTS.compiled, CSS_IN_JS_IMPORTS.atlaskitCss];
-function getParentJSXAttribute(node) {
-  let parent = node.parent;
-  while (parent && parent.type !== 'JSXAttribute') {
-    parent = parent.parent;
-  }
-  if (parent && parent.type === 'JSXAttribute') {
-    return parent;
-  }
-  return null;
-}
-export const rule = createLintRule({
-  meta: {
-    name: 'local-cx-xcss',
-    docs: {
-      description: 'Ensures the cx() function, which is part of the XCSS API, is only used within the xcss prop. This aids tracking what styles are applied to a jsx element.',
-      recommended: true,
-      severity: 'error'
-    },
-    messages: {
-      'local-cx-xcss': 'The cx function should only be declared inside the xcss prop to simplify tracking styles that are applied to a jsx element.'
-    },
-    type: 'problem'
-  },
-  create(context) {
-    return {
-      'CallExpression[callee.name="cx"]': node => {
-        if (node.type === 'CallExpression' && isCxFunction(node.callee, context.getScope().references, IMPORT_SOURCES)) {
-          const parentJSXAttribute = getParentJSXAttribute(node);
-          const propName = parentJSXAttribute === null || parentJSXAttribute === void 0 ? void 0 : parentJSXAttribute.name.name.toString();
-          if (propName && /[xX]css$/.test(propName)) {
-            return;
-          }
-          context.report({
-            node,
-            messageId: 'local-cx-xcss'
-          });
-        }
-      }
-    };
-  }
-});
-export default rule;

package/dist/es2019/rules/use-primitives/transformers/emotion-css/contains-only-supported-attrs.js

@@ -1,19 +0,0 @@
-import { isNodeOfType } from 'eslint-codemod-utils';
-import * as ast from '../../../../ast-nodes';
-import * as supported from './supported';
-
-/**
- * Check that every attribute in the JSXElement is something we support.
- * We do this via a whitelist in `this.attributes`. The result is we exclude
- * dangerous attrs like `id` and `style`.
- */
-export const containsOnlySupportedAttrs = node => {
-  const attrs = ast.JSXElement.getAttributes(node);
-  return attrs.every(attr => {
-    if (!isNodeOfType(attr, 'JSXAttribute')) {
-      return false;
-    }
-    const name = ast.JSXAttribute.getName(attr);
-    return supported.attributes.includes(name);
-  });
-};

package/dist/esm/rules/local-cx-xcss/index.js

@@ -1,45 +0,0 @@
-import { createLintRule } from '../utils/create-rule';
-import { CSS_IN_JS_IMPORTS, isCxFunction } from '../utils/is-supported-import';
-var IMPORT_SOURCES = [CSS_IN_JS_IMPORTS.compiled, CSS_IN_JS_IMPORTS.atlaskitCss];
-function getParentJSXAttribute(node) {
-  var parent = node.parent;
-  while (parent && parent.type !== 'JSXAttribute') {
-    parent = parent.parent;
-  }
-  if (parent && parent.type === 'JSXAttribute') {
-    return parent;
-  }
-  return null;
-}
-export var rule = createLintRule({
-  meta: {
-    name: 'local-cx-xcss',
-    docs: {
-      description: 'Ensures the cx() function, which is part of the XCSS API, is only used within the xcss prop. This aids tracking what styles are applied to a jsx element.',
-      recommended: true,
-      severity: 'error'
-    },
-    messages: {
-      'local-cx-xcss': 'The cx function should only be declared inside the xcss prop to simplify tracking styles that are applied to a jsx element.'
-    },
-    type: 'problem'
-  },
-  create: function create(context) {
-    return {
-      'CallExpression[callee.name="cx"]': function CallExpressionCalleeNameCx(node) {
-        if (node.type === 'CallExpression' && isCxFunction(node.callee, context.getScope().references, IMPORT_SOURCES)) {
-          var parentJSXAttribute = getParentJSXAttribute(node);
-          var propName = parentJSXAttribute === null || parentJSXAttribute === void 0 ? void 0 : parentJSXAttribute.name.name.toString();
-          if (propName && /[xX]css$/.test(propName)) {
-            return;
-          }
-          context.report({
-            node: node,
-            messageId: 'local-cx-xcss'
-          });
-        }
-      }
-    };
-  }
-});
-export default rule;

package/dist/esm/rules/use-primitives/transformers/emotion-css/contains-only-supported-attrs.js

@@ -1,19 +0,0 @@
-import { isNodeOfType } from 'eslint-codemod-utils';
-import * as ast from '../../../../ast-nodes';
-import * as supported from './supported';
-
-/**
- * Check that every attribute in the JSXElement is something we support.
- * We do this via a whitelist in `this.attributes`. The result is we exclude
- * dangerous attrs like `id` and `style`.
- */
-export var containsOnlySupportedAttrs = function containsOnlySupportedAttrs(node) {
-  var attrs = ast.JSXElement.getAttributes(node);
-  return attrs.every(function (attr) {
-    if (!isNodeOfType(attr, 'JSXAttribute')) {
-      return false;
-    }
-    var name = ast.JSXAttribute.getName(attr);
-    return supported.attributes.includes(name);
-  });
-};

package/dist/types/rules/use-primitives/transformers/emotion-css/contains-only-supported-attrs.d.ts

@@ -1,7 +0,0 @@
-import { JSXElement } from 'eslint-codemod-utils';
-/**
- * Check that every attribute in the JSXElement is something we support.
- * We do this via a whitelist in `this.attributes`. The result is we exclude
- * dangerous attrs like `id` and `style`.
- */
-export declare const containsOnlySupportedAttrs: (node: JSXElement) => boolean;

package/dist/types-ts4.5/rules/use-primitives/transformers/emotion-css/contains-only-supported-attrs.d.ts

@@ -1,7 +0,0 @@
-import { JSXElement } from 'eslint-codemod-utils';
-/**
- * Check that every attribute in the JSXElement is something we support.
- * We do this via a whitelist in `this.attributes`. The result is we exclude
- * dangerous attrs like `id` and `style`.
- */
-export declare const containsOnlySupportedAttrs: (node: JSXElement) => boolean;