@atlaskit/eslint-plugin-design-system 8.25.1 → 8.26.0

package/dist/es2019/rules/utils/create-no-exported-rule/check-if-supported-export.js

@@ -0,0 +1,142 @@
+import { isStyledComponent } from './is-styled-component';
+const getStack = (context, node) => {
+  var _scope;
+  const {
+    scopeManager
+  } = context.getSourceCode();
+  const stack = {
+    nodes: [],
+    root: node
+  };
+  let scope;
+  for (let current = node; current.type !== 'Program'; current = current.parent) {
+    if (!scope) {
+      const currentScope = scopeManager.acquire(current);
+      if (currentScope) {
+        scope = currentScope;
+      }
+    }
+    switch (current.type) {
+      case 'ExportDefaultDeclaration':
+      case 'ExportNamedDeclaration':
+        stack.root = current;
+        break;
+      case 'VariableDeclarator':
+        stack.root = current;
+        break;
+      case 'ExportSpecifier':
+      case 'ObjectExpression':
+      case 'VariableDeclaration':
+        break;
+      default:
+        stack.nodes.unshift(current);
+    }
+  }
+  return {
+    ...stack,
+    scope: (_scope = scope) !== null && _scope !== void 0 ? _scope : context.getScope()
+  };
+};
+const matches = (defs, refs) => {
+  // When there are no defs, the definition is inlined. This must be a match as we know the refs contain the initial
+  // definition.
+  if (!defs.length) {
+    return true;
+  }
+
+  // When there are no refs, the reference refers to the entire definition and therefore must be a match.
+  if (!refs.length) {
+    return true;
+  }
+
+  // When both the references and definitions exist, they should match in length
+  if (defs.length !== refs.length) {
+    return false;
+  }
+  return defs.every((def, i) => {
+    const ref = refs[i];
+    if (def.type === 'Property') {
+      // There is a match between the def and the ref when both names match:
+      //
+      // const fooDef = { bar: '' };
+      // const barRef = fooDef.bar
+      //
+      // There is no match when the ref property does not match the definition key name:
+      //
+      // const barRef = fooDef.notFound
+      return def.key.type === 'Identifier' && ref.type === 'MemberExpression' && ref.property.type === 'Identifier' && ref.property.name === def.key.name;
+    }
+
+    // Anything here is either unsupported or should not match...
+    return false;
+  });
+};
+export const checkIfSupportedExport = (context, node, importSources, scope = context.getScope()) => {
+  // Ignore any expression defined outside of the global or module scope as we have no way of statically analysing them
+  if (scope.type !== 'global' && scope.type !== 'module') {
+    return {
+      isExport: false
+    };
+  }
+  const {
+    root,
+    nodes
+  } = getStack(context, node.parent);
+  // Exporting a component with a css reference should be allowed
+  if (isStyledComponent(nodes, context, importSources)) {
+    return {
+      isExport: false
+    };
+  }
+  if (root.type === 'ExportDefaultDeclaration' || root.type === 'ExportNamedDeclaration') {
+    return {
+      isExport: true,
+      node: root
+    };
+  }
+  if (root.type !== 'VariableDeclarator') {
+    return {
+      isExport: false
+    };
+  }
+
+  // Find the reference to the variable declarator
+  const reference = scope.references.find(({
+    identifier
+  }) => identifier === root.id);
+  if (!reference) {
+    return {
+      isExport: false
+    };
+  }
+
+  // Iterate through all of the references to the resolved variable declarator node
+  const {
+    resolved
+  } = reference;
+  for (const {
+    identifier
+  } of (_resolved$references = resolved === null || resolved === void 0 ? void 0 : resolved.references) !== null && _resolved$references !== void 0 ? _resolved$references : []) {
+    var _resolved$references;
+    // Skip references to the root, since it has already been processed above
+    if (identifier === root.id) {
+      continue;
+    }
+    const {
+      nodes: refs,
+      scope: nextScope
+    } = getStack(context, identifier.parent);
+
+    // Only validate the resolved reference if it accesses the definition node
+    if (matches(nodes, refs.reverse())) {
+      // Now validate the identifier reference as a definition
+      const validity = checkIfSupportedExport(context, identifier, importSources, nextScope);
+      if (validity.isExport) {
+        return validity;
+      }
+    }
+  }
+  return {
+    isExport: false
+  };
+};

package/dist/es2019/rules/utils/create-no-exported-rule/is-styled-component.js

@@ -0,0 +1,74 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+/**
+ * Given a list of node, find and return the callee of the first Compiled or styled-components `styled` function call found in the list.
+ *
+ * For example, given `styled.div({ ... })`, we return the node corresponding to the
+ * `styled.div` part. Alternatively, given `styled(button)(style)`, we return the `styled`
+ * part.
+ *
+ * @param nodes
+ * @returns The callee of the first `styled` function call found.
+ */
+const findNode = nodes => {
+  const node = nodes.find(n => n.type === 'TaggedTemplateExpression' || n.type === 'CallExpression');
+  if (!node) {
+    return;
+  }
+  if (node.type === 'CallExpression') {
+    // Eg. const Component = styled.button(style)
+    if (node.callee.type === 'MemberExpression') {
+      return node.callee;
+    }
+
+    // Eg. const Component = styled(button)(style)
+    if (node.callee.type === 'CallExpression' && node.callee.callee.type === 'Identifier') {
+      return node.callee.callee;
+    }
+  }
+
+  // Eg. const Component = styled.div`${styles}`;
+  if (node.type === 'TaggedTemplateExpression' && node.tag.type === 'MemberExpression') {
+    return node.tag;
+  }
+  return;
+};
+
+/**
+ * Given a rule, return the local name used to import the `styled` API. (for Compiled or styled-components).
+ *
+ * @param context Rule context.
+ * @returns The local name used to import the `styled` API.
+ */
+const getStyledImportSpecifierName = (context, importSources) => {
+  var _supportedImports$0$s;
+  const isSupportedImport = node => {
+    return isNodeOfType(node, 'ImportDeclaration') && typeof node.source.value === 'string' && importSources.includes(node.source.value);
+  };
+  const source = context.getSourceCode();
+  const supportedImports = source.ast.body.filter(isSupportedImport);
+  return (_supportedImports$0$s = supportedImports[0].specifiers.find(spec => spec.type === 'ImportSpecifier' && spec.imported.name === 'styled')) === null || _supportedImports$0$s === void 0 ? void 0 : _supportedImports$0$s.local.name;
+};
+
+/**
+ * Returns whether the node is a usage of the `styled` API in the libraries we support.
+ *
+ * @param nodes Nodes to check.
+ * @param context Rule context.
+ * @param importSources A list of libraries we support.
+ * @returns Whether the node is a usage of the `styled` API.
+ */
+export const isStyledComponent = (nodes, context, importSources) => {
+  const node = findNode(nodes);
+  if (!node) {
+    return false;
+  }
+  const styledImportSpecifierName = getStyledImportSpecifierName(context, importSources);
+  if (styledImportSpecifierName) {
+    if (node.type === 'Identifier') {
+      return node.name === styledImportSpecifierName;
+    } else {
+      return node.object.type === 'Identifier' && node.object.name === styledImportSpecifierName;
+    }
+  }
+  return false;
+};

package/dist/es2019/rules/utils/create-no-exported-rule/main.js

@@ -0,0 +1,59 @@
+import { getImportSources } from '../is-supported-import';
+import { checkIfSupportedExport } from './check-if-supported-export';
+/**
+ * Creates a new ESLint rule for banning exporting certain function calls, e.g.
+ * `css` and `keyframes`.
+ *
+ * Copied from the `utils/create-no-exported-rule/` folder in @compiled/eslint-plugin.
+ *
+ * Requires an importSources option defined on the rule, which is used to define additional
+ * packages which should be checked as part of this rule.
+ *
+ * @param isUsage A function that checks whether the current node matches the desired
+ *                function call to check.
+ * @param messageId The ESLint error message to use for lint violations.
+ * @returns An eslint rule.
+ */
+export const createNoExportedRule = (isUsage, messageId) => context => {
+  const importSources = getImportSources(context);
+  const {
+    text
+  } = context.getSourceCode();
+  if (importSources.every(importSource => !text.includes(importSource))) {
+    return {};
+  }
+  return {
+    CallExpression(node) {
+      const {
+        references
+      } = context.getScope();
+      if (!isUsage(node.callee, references, importSources)) {
+        return;
+      }
+      const state = checkIfSupportedExport(context, node, importSources);
+      if (!state.isExport) {
+        return;
+      }
+      context.report({
+        messageId,
+        node: state.node
+      });
+    },
+    TaggedTemplateExpression(node) {
+      const {
+        references
+      } = context.getScope();
+      if (!isUsage(node.tag, references, importSources)) {
+        return;
+      }
+      const state = checkIfSupportedExport(context, node, importSources);
+      if (!state.isExport) {
+        return;
+      }
+      context.report({
+        messageId,
+        node: state.node
+      });
+    }
+  };
+};

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

@@ -8,31 +8,64 @@ export const CSS_IN_JS_IMPORTS = {
   atlaskitCss: '@atlaskit/css'
 };
 
-// List of CSS-in-JS libraries an import of a valid css, cx, cssMap, etc.
+// A CSS-in-JS library an import of a valid css, cx, cssMap, etc.
 // function might originate from, e.g. @compiled/react, @emotion/core.
+// All ESLint rules originating from `@compiled/eslint-plugin` should apply to these libraries.
+export const DEFAULT_IMPORT_SOURCES = [CSS_IN_JS_IMPORTS.compiled, CSS_IN_JS_IMPORTS.atlaskitCss];
+
+/**
+ * Given the ESLint rule context, extract and parse the value of the importSources rule option.
+ * The importSources option is used to define additional libraries for which an ESLint rule
+ * should apply to.
+ *
+ * Note that `@compiled/react` and `@atlaskit/css` are always included in importSources, regardless
+ * of what importSources is configured to by the user.
+ *
+ * @param context The rule context.
+ * @returns An array of strings representing what CSS-in-JS packages that should be checked, based
+ *          on the rule options configuration.
+ */
+export const getImportSources = context => {
+  const options = context.options;
+  if (!options.length) {
+    return DEFAULT_IMPORT_SOURCES;
+  }
+  if (options[0].importSources && Array.isArray(options[0].importSources)) {
+    return [...DEFAULT_IMPORT_SOURCES, ...options[0].importSources];
+  }
+  return DEFAULT_IMPORT_SOURCES;
+};
 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);
+    if (def.type !== 'ImportBinding') {
+      return false;
+    }
+    if (!def.parent || !importSources.includes(def.parent.source.value)) {
+      return false;
+    }
+    return (
+      // import { functionName } from 'import-source';
+      def.node.type === 'ImportSpecifier' && def.node.imported.name === functionName ||
+      // import functionName from 'import-source';
+      def.node.type === 'ImportDefaultSpecifier' && def.node.local.name === functionName
+    );
   };
 
   /**
    * Checks whether:
    *
-   * 1. a function name `nodeToCheck` matches the name of the function we
+   * 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
+   * 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
+   * @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
+   * @param importSources List of libraries that we want to ensure `nodeToCheck`
+   *                      comes from.
    *
-   * @returns whether the above conditions are true
+   * @returns Whether the above conditions are true.
    */
   const isSupportedImport = (nodeToCheck, referencesInScope, importSources) => {
     return nodeToCheck.type === 'Identifier' && referencesInScope.some(reference => {
@@ -48,5 +81,6 @@ const isSupportedImportWrapper = functionName => {
 //
 export const isCss = isSupportedImportWrapper('css');
 export const isCxFunction = isSupportedImportWrapper('cx');
-// export const isCssMap = isLibraryImportWrapper('cssMap');
-// export const isKeyframes = isLibraryImportWrapper('keyframes');
+export const isCssMap = isSupportedImportWrapper('cssMap');
+export const isKeyframes = isSupportedImportWrapper('keyframes');
+export const isStyled = isSupportedImportWrapper('styled');

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

@@ -48,12 +48,19 @@ var ASTObjectExpression = {
     return [fixer.remove(entry)];
   },
   /**
-   * Returns a only the property @type {Property['key']} like: `padding` from: `{ padding: '8px' }`.
+   * Returns only the property @type {Property['key']} like: `padding` from: `{ padding: '8px' }`.
+   * If you want the key/value pair, use `getEntryByPropertyName`.
    */
   getProperty: function getProperty(node, name) {
     var _ASTObjectExpression$;
     return (_ASTObjectExpression$ = ASTObjectExpression.getEntryByPropertyName(node, name)) === null || _ASTObjectExpression$ === void 0 ? void 0 : _ASTObjectExpression$.key;
   },
+  /**
+   * Gets the array of key/value pairs in an ObjectExpression.
+   */
+  getEntries: function getEntries(node) {
+    return node.properties;
+  },
   /**
    * Returns a only the property @type {Property['value']} like: `'8px` from: `{ padding: '8px' }`.
    *

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::5026ba2cb55b3c1bcacbfe7fb7728a6c>>
+ * @codegen <<SignedSource::914085544778f4543f43e3e30d0982e0>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -16,6 +16,10 @@ export default {
     '@atlaskit/design-system/no-deprecated-apis': 'error',
     '@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
     '@atlaskit/design-system/no-deprecated-imports': 'error',
+    '@atlaskit/design-system/no-empty-styled-expression': 'warn',
+    '@atlaskit/design-system/no-exported-css': 'warn',
+    '@atlaskit/design-system/no-exported-keyframes': 'warn',
+    '@atlaskit/design-system/no-invalid-css-map': 'error',
     '@atlaskit/design-system/no-margin': 'warn',
     '@atlaskit/design-system/no-nested-styles': 'error',
     '@atlaskit/design-system/no-physical-properties': '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::839224bfab98c1ddf6018dec5320968e>>
+ * @codegen <<SignedSource::577269c832952ce359cde6a50f26f4e0>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -14,6 +14,10 @@ export default {
     '@atlaskit/design-system/no-deprecated-apis': 'error',
     '@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
     '@atlaskit/design-system/no-deprecated-imports': 'error',
+    '@atlaskit/design-system/no-empty-styled-expression': 'warn',
+    '@atlaskit/design-system/no-exported-css': 'warn',
+    '@atlaskit/design-system/no-exported-keyframes': 'warn',
+    '@atlaskit/design-system/no-invalid-css-map': 'error',
     '@atlaskit/design-system/no-nested-styles': 'error',
     '@atlaskit/design-system/no-unsafe-design-token-usage': 'error',
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',

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::a67afc33adf50db651edb1cf12e16ef3>>
+ * @codegen <<SignedSource::0a2d88c9772eb438048415f13550f592>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 import consistentCssPropUsage from './consistent-css-prop-usage';
@@ -13,6 +13,10 @@ import noCssTaggedTemplateExpression from './no-css-tagged-template-expression';
 import noDeprecatedApis from './no-deprecated-apis';
 import noDeprecatedDesignTokenUsage from './no-deprecated-design-token-usage';
 import noDeprecatedImports from './no-deprecated-imports';
+import noEmptyStyledExpression from './no-empty-styled-expression';
+import noExportedCss from './no-exported-css';
+import noExportedKeyframes from './no-exported-keyframes';
+import noInvalidCssMap from './no-invalid-css-map';
 import noMargin from './no-margin';
 import noNestedStyles from './no-nested-styles';
 import noPhysicalProperties from './no-physical-properties';
@@ -37,6 +41,10 @@ export default {
   'no-deprecated-apis': noDeprecatedApis,
   'no-deprecated-design-token-usage': noDeprecatedDesignTokenUsage,
   'no-deprecated-imports': noDeprecatedImports,
+  'no-empty-styled-expression': noEmptyStyledExpression,
+  'no-exported-css': noExportedCss,
+  'no-exported-keyframes': noExportedKeyframes,
+  'no-invalid-css-map': noInvalidCssMap,
   'no-margin': noMargin,
   'no-nested-styles': noNestedStyles,
   'no-physical-properties': noPhysicalProperties,

package/dist/esm/rules/no-empty-styled-expression/index.js

@@ -0,0 +1,68 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { createLintRule } from '../utils/create-rule';
+import { getImportSources, isStyled } from '../utils/is-supported-import';
+var isEmptyStyledExpression = function isEmptyStyledExpression(node) {
+  var _node$arguments = _slicedToArray(node.arguments, 1),
+    firstArg = _node$arguments[0];
+  if (node.arguments.length === 0) {
+    return true;
+  } else if (node.arguments.length === 1 && (firstArg === null || firstArg === void 0 ? void 0 : firstArg.type) === 'ArrayExpression') {
+    return firstArg.elements.length === 0;
+  } else if (node.arguments.length === 1 && (firstArg === null || firstArg === void 0 ? void 0 : firstArg.type) === 'ObjectExpression') {
+    return firstArg.properties.length === 0;
+  }
+  return false;
+};
+var createNoEmptyStyledExpressionRule = function createNoEmptyStyledExpressionRule(isEmptyStyledExpression, messageId) {
+  return function (context) {
+    var importSources = getImportSources(context);
+    return {
+      'CallExpression[callee.type="MemberExpression"]': function CallExpressionCalleeTypeMemberExpression(node) {
+        var _context$getScope = context.getScope(),
+          references = _context$getScope.references;
+
+        // If we have styled.div(...), make sure `callee` only refers to the
+        // `styled` part instead of the whole `styled.div` expression.
+        var callee = node.callee.type === 'MemberExpression' ? node.callee.object : node.callee;
+        if (!isStyled(callee, references, importSources)) {
+          return;
+        }
+        if (!isEmptyStyledExpression(node)) {
+          return;
+        }
+        context.report({
+          messageId: messageId,
+          node: node
+        });
+      }
+    };
+  };
+};
+var noEmptyStyledExpressionRule = createLintRule({
+  meta: {
+    name: 'no-empty-styled-expression',
+    docs: {
+      description: 'Forbids any styled expression to be used when passing empty arguments to styled.div() (or other JSX elements).',
+      recommended: true,
+      severity: 'warn'
+    },
+    messages: {
+      unexpected: 'Found an empty expression, or empty object argument passed to `styled` function call. This unnecessarily causes a major performance penalty - please use a plain JSX element or a React fragment instead (e.g. `<div>Hello</div>` or `<>Hello</>`).'
+    },
+    type: 'problem',
+    schema: [{
+      type: 'object',
+      properties: {
+        importSources: {
+          type: 'array',
+          items: [{
+            type: 'string'
+          }]
+        }
+      },
+      additionalProperties: false
+    }]
+  },
+  create: createNoEmptyStyledExpressionRule(isEmptyStyledExpression, 'unexpected')
+});
+export default noEmptyStyledExpressionRule;

package/dist/esm/rules/no-exported-css/index.js

@@ -0,0 +1,31 @@
+import { createNoExportedRule } from '../utils/create-no-exported-rule/main';
+import { createLintRule } from '../utils/create-rule';
+import { isCss } from '../utils/is-supported-import';
+var noExportedCssRule = createLintRule({
+  meta: {
+    name: 'no-exported-css',
+    type: 'problem',
+    docs: {
+      description: 'Forbid exporting `css` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable.',
+      recommended: true,
+      severity: 'warn'
+    },
+    messages: {
+      unexpected: "`css` can't be exported - this will cause unexpected behaviour at runtime. Instead, please move your `css(...)` code to the same file where these styles are being used."
+    },
+    schema: [{
+      type: 'object',
+      properties: {
+        importSources: {
+          type: 'array',
+          items: [{
+            type: 'string'
+          }]
+        }
+      },
+      additionalProperties: false
+    }]
+  },
+  create: createNoExportedRule(isCss, 'unexpected')
+});
+export default noExportedCssRule;

package/dist/esm/rules/no-exported-keyframes/index.js

@@ -0,0 +1,31 @@
+import { createNoExportedRule } from '../utils/create-no-exported-rule/main';
+import { createLintRule } from '../utils/create-rule';
+import { isKeyframes } from '../utils/is-supported-import';
+var noExportedKeyframesRule = createLintRule({
+  meta: {
+    name: 'no-exported-keyframes',
+    type: 'problem',
+    docs: {
+      description: 'Forbid exporting `keyframes` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable.',
+      recommended: true,
+      severity: 'warn'
+    },
+    messages: {
+      unexpected: "`keyframes` can't be exported - this will cause unexpected behaviour at runtime. Instead, please move your `keyframes(...)` code to the same file where these styles are being used."
+    },
+    schema: [{
+      type: 'object',
+      properties: {
+        importSources: {
+          type: 'array',
+          items: [{
+            type: 'string'
+          }]
+        }
+      },
+      additionalProperties: false
+    }]
+  },
+  create: createNoExportedRule(isKeyframes, 'unexpected')
+});
+export default noExportedKeyframesRule;