@atlaskit/eslint-plugin-design-system 8.23.3 → 8.23.4

package/dist/es2019/rules/utils/is-supported-import.js

@@ -0,0 +1,52 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+export const CSS_IN_JS_IMPORTS = {
+  compiled: '@compiled/react',
+  emotionReact: '@emotion/react',
+  emotionCore: '@emotion/core',
+  styledComponents: 'styled-components',
+  atlaskitCss: '@atlaskit/css'
+};
+
+// List of CSS-in-JS libraries an import of a valid css, cx, cssMap, etc.
+// function might originate from, e.g. @compiled/react, @emotion/core.
+const isSupportedImportWrapper = functionName => {
+  // This will need to be extended to support default imports once we start
+  // checking cases like `import css from '@emotion/css'`
+  const checkDefinitionHasImport = (def, importSources) => {
+    var _def$parent, _def$parent2;
+    return def.node.type === 'ImportSpecifier' && def.node.imported.type === 'Identifier' && def.node.imported.name === functionName && ((_def$parent = def.parent) === null || _def$parent === void 0 ? void 0 : _def$parent.type) === 'ImportDeclaration' && importSources.includes((_def$parent2 = def.parent) === null || _def$parent2 === void 0 ? void 0 : _def$parent2.source.value);
+  };
+
+  /**
+   * Checks whether:
+   *
+   * 1. a function name `nodeToCheck` matches the name of the function we
+   *    want to check for (e.g. `cx`, `css`, `cssMap`, or `keyframes`), and
+   * 2. whether `nodeToCheck` originates from one of the libraries listed
+   *     in `importSources`.
+   *
+   * @param nodeToCheck the function callee we are checking (e.g. the `css` in `css()`)
+   * @param referencesInScope list of references that are in scope. We'll use this
+   *                          to check where the function callee is imported from.
+   * @param importSources list of libraries that we want to ensure `nodeToCheck`
+   *                      comes from
+   *
+   * @returns whether the above conditions are true
+   */
+  const isSupportedImport = (nodeToCheck, referencesInScope, importSources) => {
+    return nodeToCheck.type === 'Identifier' && referencesInScope.some(reference => {
+      var _reference$resolved;
+      return reference.identifier === nodeToCheck && ((_reference$resolved = reference.resolved) === null || _reference$resolved === void 0 ? void 0 : _reference$resolved.defs.some(def => checkDefinitionHasImport(def, importSources)));
+    });
+  };
+  return isSupportedImport;
+};
+
+// Unused functions have been commented out until we implement corresponding
+// eslint rules which use them
+//
+export const isCss = isSupportedImportWrapper('css');
+export const isCxFunction = isSupportedImportWrapper('cx');
+// export const isCssMap = isLibraryImportWrapper('cssMap');
+// export const isKeyframes = isLibraryImportWrapper('keyframes');

package/dist/esm/ast-nodes/index.js

@@ -2,4 +2,5 @@ export { FunctionCall } from './function-call';
 export { Import } from './import';
 export { JSXAttribute } from './jsx-attribute';
 export { JSXElement } from './jsx-element';
+export { Object } from './object';
 export { Root } from './root';

package/dist/esm/ast-nodes/object.js

@@ -0,0 +1,79 @@
+/* eslint-disable @repo/internal/react/require-jsdoc */
+
+import { identifier, isNodeOfType, literal, property } from 'eslint-codemod-utils';
+var ASTObjectExpression = {
+  /**
+   * Returns `true` if an object contains a property with the specified name, `false` otherwise.
+   */
+  hasProperty: function hasProperty(node, name) {
+    return !!ASTObjectExpression.getProperty(node, name);
+  },
+  /**
+   * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`
+   */
+  getEntryByPropertyName: function getEntryByPropertyName(node, name) {
+    return node.properties.find(function (property) {
+      if (!isNodeOfType(property, 'Property')) {
+        return false;
+      }
+      if (!isNodeOfType(property.key, 'Identifier')) {
+        return false;
+      }
+      return property.key.name === name;
+    });
+  },
+  deleteEntry: function deleteEntry(node, name, fixer) {
+    var entry = ASTObjectExpression.getEntryByPropertyName(node, name);
+    if (!entry) {
+      return [];
+    }
+    return [fixer.remove(entry)];
+  },
+  /**
+   * Returns a only the property @type {Property['key']} like: `padding` from: `{ padding: '8px' }`
+   */
+  getProperty: function getProperty(node, name) {
+    var _ASTObjectExpression$;
+    return (_ASTObjectExpression$ = ASTObjectExpression.getEntryByPropertyName(node, name)) === null || _ASTObjectExpression$ === void 0 ? void 0 : _ASTObjectExpression$.key;
+  },
+  /**
+   * Returns a only the property @type {Property['value']} like: `'8px` from: `{ padding: '8px' }`
+   *
+   * Values can be basically anything, so be careful with this
+   */
+  getValueByPropertyName: function getValueByPropertyName(node, name) {
+    var _ASTObjectExpression$2;
+    return (_ASTObjectExpression$2 = ASTObjectExpression.getEntryByPropertyName(node, name)) === null || _ASTObjectExpression$2 === void 0 ? void 0 : _ASTObjectExpression$2.value;
+  },
+  containsSpreadProps: function containsSpreadProps(node) {
+    return node.properties.some(function (property) {
+      return isNodeOfType(property, 'SpreadElement');
+    });
+  },
+  updateValue: function updateValue(node, propertyName, newValue, fixer) {
+    var value = ASTObjectExpression.getValueByPropertyName(node, propertyName);
+    if (value === undefined) {
+      throw new Error("Object.updateValue: Could not get value of property ".concat(propertyName));
+    }
+    return fixer.replaceText(value, newValue);
+  },
+  /**
+   * Appends a key-value pair to the end of an object. For example:
+   * ```
+   * ast.Object.appendEntry(
+   *   node, // { padding: 'space.100' }
+   *   key, // 'margin',
+   *   value, // 'space.200'
+   *   fixer,
+   * )
+   * ```
+   * Will result in `{ padding: 'space.100', margin: 'space.200'}`
+   */
+  appendEntry: function appendEntry(node, key, value, fixer) {
+    return fixer.insertTextAfter(node.properties[node.properties.length - 1], "".concat(property({
+      key: identifier(key),
+      value: literal(value)
+    }).toString(), ", "));
+  }
+};
+export { ASTObjectExpression as Object };

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::d1a459e1ea71650f65b2890dc86cc398>>
+ * @codegen <<SignedSource::5026ba2cb55b3c1bcacbfe7fb7728a6c>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -10,6 +10,7 @@ export default {
     '@atlaskit/design-system/ensure-design-token-usage': 'error',
     '@atlaskit/design-system/ensure-design-token-usage/preview': 'warn',
     '@atlaskit/design-system/icon-label': 'warn',
+    '@atlaskit/design-system/local-cx-xcss': 'error',
     '@atlaskit/design-system/no-banned-imports': 'error',
     '@atlaskit/design-system/no-css-tagged-template-expression': 'error',
     '@atlaskit/design-system/no-deprecated-apis': 'error',

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

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::3b93cfbbe0ea14514b9600509632394b>>
+ * @codegen <<SignedSource::839224bfab98c1ddf6018dec5320968e>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -9,6 +9,7 @@ export default {
     '@atlaskit/design-system/consistent-css-prop-usage': 'error',
     '@atlaskit/design-system/ensure-design-token-usage': 'error',
     '@atlaskit/design-system/icon-label': 'warn',
+    '@atlaskit/design-system/local-cx-xcss': 'error',
     '@atlaskit/design-system/no-banned-imports': 'error',
     '@atlaskit/design-system/no-deprecated-apis': 'error',
     '@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',

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

@@ -1,12 +1,13 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::14cdfdcbd8b999ee097a1a5b245d7117>>
+ * @codegen <<SignedSource::a67afc33adf50db651edb1cf12e16ef3>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import consistentCssPropUsage from './consistent-css-prop-usage';
 import ensureDesignTokenUsage from './ensure-design-token-usage';
 import ensureDesignTokenUsagePreview from './ensure-design-token-usage-preview';
 import iconLabel from './icon-label';
+import localCxXcss from './local-cx-xcss';
 import noBannedImports from './no-banned-imports';
 import noCssTaggedTemplateExpression from './no-css-tagged-template-expression';
 import noDeprecatedApis from './no-deprecated-apis';
@@ -30,6 +31,7 @@ export default {
   'ensure-design-token-usage': ensureDesignTokenUsage,
   'ensure-design-token-usage/preview': ensureDesignTokenUsagePreview,
   'icon-label': iconLabel,
+  'local-cx-xcss': localCxXcss,
   'no-banned-imports': noBannedImports,
   'no-css-tagged-template-expression': noCssTaggedTemplateExpression,
   'no-deprecated-apis': noDeprecatedApis,

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

@@ -0,0 +1,45 @@
+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/no-css-tagged-template-expression/create-no-tagged-template-expression-rule/index.js

@@ -2,16 +2,18 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 // Original source from Compiled https://github.com/atlassian-labs/compiled/blob/master/packages/eslint-plugin/src/utils/create-no-tagged-template-expression-rule/index.ts
 // eslint-disable-next-line import/no-extraneous-dependencies
 
+import { CSS_IN_JS_IMPORTS } from '../../utils/is-supported-import';
 import { generate } from './generate';
 import { getTaggedTemplateExpressionOffset } from './get-tagged-template-expression-offset';
 import { toArguments } from './to-arguments';
+var IMPORT_SOURCES = [CSS_IN_JS_IMPORTS.compiled, CSS_IN_JS_IMPORTS.emotionReact, CSS_IN_JS_IMPORTS.emotionCore, CSS_IN_JS_IMPORTS.styledComponents];
 export var createNoTaggedTemplateExpressionRule = function createNoTaggedTemplateExpressionRule(isUsage, messageId) {
   return function (context) {
     return {
       TaggedTemplateExpression: function TaggedTemplateExpression(node) {
         var _context$getScope = context.getScope(),
           references = _context$getScope.references;
-        if (!isUsage(node.tag, references)) {
+        if (!isUsage(node.tag, references, IMPORT_SOURCES)) {
           return;
         }
         context.report({

package/dist/esm/rules/no-css-tagged-template-expression/index.js

@@ -1,6 +1,6 @@
 import { createLintRule } from '../utils/create-rule';
+import { isCss } from '../utils/is-supported-import';
 import { createNoTaggedTemplateExpressionRule } from './create-no-tagged-template-expression-rule';
-import { isSupportedImport } from './is-supported-import';
 var rule = createLintRule({
   meta: {
     name: 'no-css-tagged-template-expression',
@@ -15,6 +15,6 @@ var rule = createLintRule({
       unexpectedTaggedTemplate: 'Unexpected `css` tagged template expression'
     }
   },
-  create: createNoTaggedTemplateExpressionRule(isSupportedImport('css'), 'unexpectedTaggedTemplate')
+  create: createNoTaggedTemplateExpressionRule(isCss, 'unexpectedTaggedTemplate')
 });
 export default rule;

package/dist/esm/rules/utils/is-supported-import.js

@@ -0,0 +1,54 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+export var CSS_IN_JS_IMPORTS = {
+  compiled: '@compiled/react',
+  emotionReact: '@emotion/react',
+  emotionCore: '@emotion/core',
+  styledComponents: 'styled-components',
+  atlaskitCss: '@atlaskit/css'
+};
+
+// List of CSS-in-JS libraries an import of a valid css, cx, cssMap, etc.
+// function might originate from, e.g. @compiled/react, @emotion/core.
+var isSupportedImportWrapper = function isSupportedImportWrapper(functionName) {
+  // This will need to be extended to support default imports once we start
+  // checking cases like `import css from '@emotion/css'`
+  var checkDefinitionHasImport = function checkDefinitionHasImport(def, importSources) {
+    var _def$parent, _def$parent2;
+    return def.node.type === 'ImportSpecifier' && def.node.imported.type === 'Identifier' && def.node.imported.name === functionName && ((_def$parent = def.parent) === null || _def$parent === void 0 ? void 0 : _def$parent.type) === 'ImportDeclaration' && importSources.includes((_def$parent2 = def.parent) === null || _def$parent2 === void 0 ? void 0 : _def$parent2.source.value);
+  };
+
+  /**
+   * Checks whether:
+   *
+   * 1. a function name `nodeToCheck` matches the name of the function we
+   *    want to check for (e.g. `cx`, `css`, `cssMap`, or `keyframes`), and
+   * 2. whether `nodeToCheck` originates from one of the libraries listed
+   *     in `importSources`.
+   *
+   * @param nodeToCheck the function callee we are checking (e.g. the `css` in `css()`)
+   * @param referencesInScope list of references that are in scope. We'll use this
+   *                          to check where the function callee is imported from.
+   * @param importSources list of libraries that we want to ensure `nodeToCheck`
+   *                      comes from
+   *
+   * @returns whether the above conditions are true
+   */
+  var isSupportedImport = function isSupportedImport(nodeToCheck, referencesInScope, importSources) {
+    return nodeToCheck.type === 'Identifier' && referencesInScope.some(function (reference) {
+      var _reference$resolved;
+      return reference.identifier === nodeToCheck && ((_reference$resolved = reference.resolved) === null || _reference$resolved === void 0 ? void 0 : _reference$resolved.defs.some(function (def) {
+        return checkDefinitionHasImport(def, importSources);
+      }));
+    });
+  };
+  return isSupportedImport;
+};
+
+// Unused functions have been commented out until we implement corresponding
+// eslint rules which use them
+//
+export var isCss = isSupportedImportWrapper('css');
+export var isCxFunction = isSupportedImportWrapper('cx');
+// export const isCssMap = isLibraryImportWrapper('cssMap');
+// export const isKeyframes = isLibraryImportWrapper('keyframes');

package/dist/types/ast-nodes/index.d.ts

@@ -2,4 +2,5 @@ export { FunctionCall } from './function-call';
 export { Import } from './import';
 export { JSXAttribute } from './jsx-attribute';
 export { JSXElement } from './jsx-element';
+export { Object } from './object';
 export { Root } from './root';

package/dist/types/ast-nodes/object.d.ts

@@ -0,0 +1,39 @@
+import type { Rule } from 'eslint';
+import { ObjectExpression, Property } from 'eslint-codemod-utils';
+declare const ASTObjectExpression: {
+    /**
+     * Returns `true` if an object contains a property with the specified name, `false` otherwise.
+     */
+    hasProperty(node: ObjectExpression, name: string): boolean;
+    /**
+     * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`
+     */
+    getEntryByPropertyName(node: ObjectExpression, name: string): Property | undefined;
+    deleteEntry(node: ObjectExpression, name: string, fixer: Rule.RuleFixer): Rule.Fix[];
+    /**
+     * Returns a only the property @type {Property['key']} like: `padding` from: `{ padding: '8px' }`
+     */
+    getProperty(node: ObjectExpression, name: string): Property['key'] | undefined;
+    /**
+     * Returns a only the property @type {Property['value']} like: `'8px` from: `{ padding: '8px' }`
+     *
+     * Values can be basically anything, so be careful with this
+     */
+    getValueByPropertyName(node: ObjectExpression, name: string): Property['value'] | undefined;
+    containsSpreadProps(node: ObjectExpression): boolean;
+    updateValue(node: ObjectExpression, propertyName: string, newValue: string, fixer: Rule.RuleFixer): Rule.Fix;
+    /**
+     * Appends a key-value pair to the end of an object. For example:
+     * ```
+     * ast.Object.appendEntry(
+     *   node, // { padding: 'space.100' }
+     *   key, // 'margin',
+     *   value, // 'space.200'
+     *   fixer,
+     * )
+     * ```
+     * Will result in `{ padding: 'space.100', margin: 'space.200'}`
+     */
+    appendEntry(node: ObjectExpression, key: string, value: string, fixer: Rule.RuleFixer): Rule.Fix;
+};
+export { ASTObjectExpression as Object };

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

@@ -7,6 +7,7 @@ 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;
@@ -33,6 +34,7 @@ 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/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::d1a459e1ea71650f65b2890dc86cc398>>
+ * @codegen <<SignedSource::5026ba2cb55b3c1bcacbfe7fb7728a6c>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -10,6 +10,7 @@ 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;

package/dist/types/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::3b93cfbbe0ea14514b9600509632394b>>
+ * @codegen <<SignedSource::839224bfab98c1ddf6018dec5320968e>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -9,6 +9,7 @@ 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/rules/index.codegen.d.ts

@@ -3,6 +3,7 @@ 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, [{

package/dist/types/rules/local-cx-xcss/index.d.ts

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

package/dist/types/rules/no-css-tagged-template-expression/create-no-tagged-template-expression-rule/index.d.ts

@@ -1,6 +1,5 @@
-import type { Rule, Scope } from 'eslint';
-type Node = Rule.Node;
-type Reference = Scope.Reference;
+import type { Rule } from 'eslint';
+import { SupportedNameChecker } from '../../utils/is-supported-import';
 type RuleModule = Rule.RuleModule;
-export declare const createNoTaggedTemplateExpressionRule: (isUsage: (node: Node, references: Reference[]) => boolean, messageId: string) => RuleModule['create'];
+export declare const createNoTaggedTemplateExpressionRule: (isUsage: SupportedNameChecker, messageId: string) => RuleModule['create'];
 export {};

package/dist/types/rules/utils/is-supported-import.d.ts

@@ -0,0 +1,16 @@
+import type { Scope } from 'eslint';
+import type { CallExpression } from 'estree';
+type Callee = CallExpression['callee'];
+type Reference = Scope.Reference;
+export declare const CSS_IN_JS_IMPORTS: {
+    compiled: string;
+    emotionReact: string;
+    emotionCore: string;
+    styledComponents: string;
+    atlaskitCss: string;
+};
+type ValidImportSources = string[];
+export type SupportedNameChecker = (nodeToCheck: Callee, referencesInScope: Reference[], importSources: ValidImportSources) => boolean;
+export declare const isCss: SupportedNameChecker;
+export declare const isCxFunction: SupportedNameChecker;
+export {};

package/dist/types-ts4.5/ast-nodes/index.d.ts

@@ -2,4 +2,5 @@ export { FunctionCall } from './function-call';
 export { Import } from './import';
 export { JSXAttribute } from './jsx-attribute';
 export { JSXElement } from './jsx-element';
+export { Object } from './object';
 export { Root } from './root';

package/dist/types-ts4.5/ast-nodes/object.d.ts

@@ -0,0 +1,39 @@
+import type { Rule } from 'eslint';
+import { ObjectExpression, Property } from 'eslint-codemod-utils';
+declare const ASTObjectExpression: {
+    /**
+     * Returns `true` if an object contains a property with the specified name, `false` otherwise.
+     */
+    hasProperty(node: ObjectExpression, name: string): boolean;
+    /**
+     * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`
+     */
+    getEntryByPropertyName(node: ObjectExpression, name: string): Property | undefined;
+    deleteEntry(node: ObjectExpression, name: string, fixer: Rule.RuleFixer): Rule.Fix[];
+    /**
+     * Returns a only the property @type {Property['key']} like: `padding` from: `{ padding: '8px' }`
+     */
+    getProperty(node: ObjectExpression, name: string): Property['key'] | undefined;
+    /**
+     * Returns a only the property @type {Property['value']} like: `'8px` from: `{ padding: '8px' }`
+     *
+     * Values can be basically anything, so be careful with this
+     */
+    getValueByPropertyName(node: ObjectExpression, name: string): Property['value'] | undefined;
+    containsSpreadProps(node: ObjectExpression): boolean;
+    updateValue(node: ObjectExpression, propertyName: string, newValue: string, fixer: Rule.RuleFixer): Rule.Fix;
+    /**
+     * Appends a key-value pair to the end of an object. For example:
+     * ```
+     * ast.Object.appendEntry(
+     *   node, // { padding: 'space.100' }
+     *   key, // 'margin',
+     *   value, // 'space.200'
+     *   fixer,
+     * )
+     * ```
+     * Will result in `{ padding: 'space.100', margin: 'space.200'}`
+     */
+    appendEntry(node: ObjectExpression, key: string, value: string, fixer: Rule.RuleFixer): Rule.Fix;
+};
+export { ASTObjectExpression as Object };

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

@@ -7,6 +7,7 @@ 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;
@@ -33,6 +34,7 @@ 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::d1a459e1ea71650f65b2890dc86cc398>>
+ * @codegen <<SignedSource::5026ba2cb55b3c1bcacbfe7fb7728a6c>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -10,6 +10,7 @@ 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;

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::3b93cfbbe0ea14514b9600509632394b>>
+ * @codegen <<SignedSource::839224bfab98c1ddf6018dec5320968e>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -9,6 +9,7 @@ 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,6 +3,7 @@ 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, [

package/dist/types-ts4.5/rules/local-cx-xcss/index.d.ts

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

package/dist/types-ts4.5/rules/no-css-tagged-template-expression/create-no-tagged-template-expression-rule/index.d.ts

@@ -1,6 +1,5 @@
-import type { Rule, Scope } from 'eslint';
-type Node = Rule.Node;
-type Reference = Scope.Reference;
+import type { Rule } from 'eslint';
+import { SupportedNameChecker } from '../../utils/is-supported-import';
 type RuleModule = Rule.RuleModule;
-export declare const createNoTaggedTemplateExpressionRule: (isUsage: (node: Node, references: Reference[]) => boolean, messageId: string) => RuleModule['create'];
+export declare const createNoTaggedTemplateExpressionRule: (isUsage: SupportedNameChecker, messageId: string) => RuleModule['create'];
 export {};

package/dist/types-ts4.5/rules/utils/is-supported-import.d.ts

@@ -0,0 +1,16 @@
+import type { Scope } from 'eslint';
+import type { CallExpression } from 'estree';
+type Callee = CallExpression['callee'];
+type Reference = Scope.Reference;
+export declare const CSS_IN_JS_IMPORTS: {
+    compiled: string;
+    emotionReact: string;
+    emotionCore: string;
+    styledComponents: string;
+    atlaskitCss: string;
+};
+type ValidImportSources = string[];
+export type SupportedNameChecker = (nodeToCheck: Callee, referencesInScope: Reference[], importSources: ValidImportSources) => boolean;
+export declare const isCss: SupportedNameChecker;
+export declare const isCxFunction: SupportedNameChecker;
+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.23.3",
+  "version": "8.23.4",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"