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

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 8.24.0
+
+### Minor Changes
+
+- [#70036](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/70036) [`667c0a990b15`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/667c0a990b15) - Allow linting of multiple property style objects in use-primitives rule.
+
 ## 8.23.4
 
 ### Patch Changes

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

@@ -15,7 +15,25 @@ var ASTObjectExpression = exports.Object = {
     return !!ASTObjectExpression.getProperty(node, name);
   },
   /**
-   * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`
+   * Returns true if an object contains no nested values, false otherwise.
+   *
+   * Note:
+   *  - Returns false if object contains spread elements.
+   *  - Returns true if object is empty.
+   */
+  isFlat: function isFlat(node) {
+    return node.properties.every(function (entry) {
+      if (!(0, _eslintCodemodUtils.isNodeOfType)(entry, 'Property')) {
+        return false;
+      }
+      if ((0, _eslintCodemodUtils.isNodeOfType)(entry.value, 'ObjectExpression')) {
+        return false;
+      }
+      return true;
+    });
+  },
+  /**
+   * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`.
    */
   getEntryByPropertyName: function getEntryByPropertyName(node, name) {
     return node.properties.find(function (property) {
@@ -36,16 +54,16 @@ var ASTObjectExpression = exports.Object = {
     return [fixer.remove(entry)];
   },
   /**
-   * Returns a only the property @type {Property['key']} like: `padding` from: `{ padding: '8px' }`
+   * 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' }`
+   * Returns a only the property @type {Property['value']} like: `'8px` from: `{ padding: '8px' }`.
    *
-   * Values can be basically anything, so be careful with this
+   * Values can be basically anything, so be careful with this.
    */
   getValueByPropertyName: function getValueByPropertyName(node, name) {
     var _ASTObjectExpression$2;
@@ -73,7 +91,7 @@ var ASTObjectExpression = exports.Object = {
    *   fixer,
    * )
    * ```
-   * Will result in `{ padding: 'space.100', margin: 'space.200'}`
+   * 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((0, _eslintCodemodUtils.property)({

package/dist/cjs/rules/use-primitives/utils/is-valid-css-properties-to-transform.js

@@ -1,6 +1,7 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof3 = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -8,9 +9,12 @@ exports.isValidCssPropertiesToTransform = void 0;
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _eslintCodemodUtils = require("eslint-codemod-utils");
+var ast = _interopRequireWildcard(require("../../../ast-nodes"));
 var _cssToXcss = require("../transformers/css-to-xcss");
 var _convertAstObjectExpressionToJsObject = require("./convert-ast-object-expression-to-js-object");
 var _excluded = ["unsupported"];
+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 || _typeof3(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; }
 var isValidCssPropertiesToTransform = exports.isValidCssPropertiesToTransform = function isValidCssPropertiesToTransform(node, config) {
   if (!node) {
     return false;
@@ -20,13 +24,20 @@ var isValidCssPropertiesToTransform = exports.isValidCssPropertiesToTransform =
   if (!cssObjectExpression || !(0, _eslintCodemodUtils.isNodeOfType)(cssObjectExpression, 'ObjectExpression')) {
     return false;
   }
+  if (!ast.Object.isFlat(cssObjectExpression)) {
+    return false;
+  }
   var _convertASTObjectExpr = (0, _convertAstObjectExpressionToJsObject.convertASTObjectExpressionToJSObject)(cssObjectExpression),
     unsupported = _convertASTObjectExpr.unsupported,
     cssObject = (0, _objectWithoutProperties2.default)(_convertASTObjectExpr, _excluded);
   // Bail if there are any unsupported styles
-  if (unsupported.length > 0 || Object.keys(cssObject).length !== 1) {
+  if (unsupported.length > 0) {
     return false;
   }
+  if (!config.patterns.includes('multiple-properties') && Object.keys(cssObject).length > 1) {
+    return false;
+  }
+
   // Short-circuit when token calls are found but pattern is not enabled in config
   if (!config.patterns.includes('css-property-with-tokens') && Object.values(cssObject).some(function (value) {
     return (0, _typeof2.default)(value) === 'object' && value.tokenName;

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

@@ -9,7 +9,25 @@ const ASTObjectExpression = {
     return !!ASTObjectExpression.getProperty(node, name);
   },
   /**
-   * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`
+   * Returns true if an object contains no nested values, false otherwise.
+   *
+   * Note:
+   *  - Returns false if object contains spread elements.
+   *  - Returns true if object is empty.
+   */
+  isFlat(node) {
+    return node.properties.every(entry => {
+      if (!isNodeOfType(entry, 'Property')) {
+        return false;
+      }
+      if (isNodeOfType(entry.value, 'ObjectExpression')) {
+        return false;
+      }
+      return true;
+    });
+  },
+  /**
+   * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`.
    */
   getEntryByPropertyName(node, name) {
     return node.properties.find(property => {
@@ -30,16 +48,16 @@ const ASTObjectExpression = {
     return [fixer.remove(entry)];
   },
   /**
-   * Returns a only the property @type {Property['key']} like: `padding` from: `{ padding: '8px' }`
+   * Returns a only the property @type {Property['key']} like: `padding` from: `{ padding: '8px' }`.
    */
   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' }`
+   * Returns a only the property @type {Property['value']} like: `'8px` from: `{ padding: '8px' }`.
    *
-   * Values can be basically anything, so be careful with this
+   * Values can be basically anything, so be careful with this.
    */
   getValueByPropertyName(node, name) {
     var _ASTObjectExpression$2;
@@ -67,7 +85,7 @@ const ASTObjectExpression = {
    *   fixer,
    * )
    * ```
-   * Will result in `{ padding: 'space.100', margin: 'space.200'}`
+   * Will result in `{ padding: 'space.100', margin: 'space.200'}`.
    */
   appendEntry(node, key, value, fixer) {
     return fixer.insertTextAfter(node.properties[node.properties.length - 1], `${property({

package/dist/es2019/rules/use-primitives/utils/is-valid-css-properties-to-transform.js

@@ -1,4 +1,5 @@
 import { isNodeOfType } from 'eslint-codemod-utils';
+import * as ast from '../../../ast-nodes';
 import { supportedStylesMap } from '../transformers/css-to-xcss';
 import { convertASTObjectExpressionToJSObject } from './convert-ast-object-expression-to-js-object';
 export const isValidCssPropertiesToTransform = (node, config) => {
@@ -10,14 +11,21 @@ export const isValidCssPropertiesToTransform = (node, config) => {
   if (!cssObjectExpression || !isNodeOfType(cssObjectExpression, 'ObjectExpression')) {
     return false;
   }
+  if (!ast.Object.isFlat(cssObjectExpression)) {
+    return false;
+  }
   const {
     unsupported,
     ...cssObject
   } = convertASTObjectExpressionToJSObject(cssObjectExpression);
   // Bail if there are any unsupported styles
-  if (unsupported.length > 0 || Object.keys(cssObject).length !== 1) {
+  if (unsupported.length > 0) {
     return false;
   }
+  if (!config.patterns.includes('multiple-properties') && Object.keys(cssObject).length > 1) {
+    return false;
+  }
+
   // Short-circuit when token calls are found but pattern is not enabled in config
   if (!config.patterns.includes('css-property-with-tokens') && Object.values(cssObject).some(value => typeof value === 'object' && value.tokenName)) {
     return false;

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

@@ -9,7 +9,25 @@ var ASTObjectExpression = {
     return !!ASTObjectExpression.getProperty(node, name);
   },
   /**
-   * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`
+   * Returns true if an object contains no nested values, false otherwise.
+   *
+   * Note:
+   *  - Returns false if object contains spread elements.
+   *  - Returns true if object is empty.
+   */
+  isFlat: function isFlat(node) {
+    return node.properties.every(function (entry) {
+      if (!isNodeOfType(entry, 'Property')) {
+        return false;
+      }
+      if (isNodeOfType(entry.value, 'ObjectExpression')) {
+        return false;
+      }
+      return true;
+    });
+  },
+  /**
+   * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`.
    */
   getEntryByPropertyName: function getEntryByPropertyName(node, name) {
     return node.properties.find(function (property) {
@@ -30,16 +48,16 @@ var ASTObjectExpression = {
     return [fixer.remove(entry)];
   },
   /**
-   * Returns a only the property @type {Property['key']} like: `padding` from: `{ padding: '8px' }`
+   * 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' }`
+   * Returns a only the property @type {Property['value']} like: `'8px` from: `{ padding: '8px' }`.
    *
-   * Values can be basically anything, so be careful with this
+   * Values can be basically anything, so be careful with this.
    */
   getValueByPropertyName: function getValueByPropertyName(node, name) {
     var _ASTObjectExpression$2;
@@ -67,7 +85,7 @@ var ASTObjectExpression = {
    *   fixer,
    * )
    * ```
-   * Will result in `{ padding: 'space.100', margin: 'space.200'}`
+   * 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({

package/dist/esm/rules/use-primitives/utils/is-valid-css-properties-to-transform.js

@@ -2,6 +2,7 @@ import _typeof from "@babel/runtime/helpers/typeof";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 var _excluded = ["unsupported"];
 import { isNodeOfType } from 'eslint-codemod-utils';
+import * as ast from '../../../ast-nodes';
 import { supportedStylesMap } from '../transformers/css-to-xcss';
 import { convertASTObjectExpressionToJSObject } from './convert-ast-object-expression-to-js-object';
 export var isValidCssPropertiesToTransform = function isValidCssPropertiesToTransform(node, config) {
@@ -13,13 +14,20 @@ export var isValidCssPropertiesToTransform = function isValidCssPropertiesToTran
   if (!cssObjectExpression || !isNodeOfType(cssObjectExpression, 'ObjectExpression')) {
     return false;
   }
+  if (!ast.Object.isFlat(cssObjectExpression)) {
+    return false;
+  }
   var _convertASTObjectExpr = convertASTObjectExpressionToJSObject(cssObjectExpression),
     unsupported = _convertASTObjectExpr.unsupported,
     cssObject = _objectWithoutProperties(_convertASTObjectExpr, _excluded);
   // Bail if there are any unsupported styles
-  if (unsupported.length > 0 || Object.keys(cssObject).length !== 1) {
+  if (unsupported.length > 0) {
     return false;
   }
+  if (!config.patterns.includes('multiple-properties') && Object.keys(cssObject).length > 1) {
+    return false;
+  }
+
   // Short-circuit when token calls are found but pattern is not enabled in config
   if (!config.patterns.includes('css-property-with-tokens') && Object.values(cssObject).some(function (value) {
     return _typeof(value) === 'object' && value.tokenName;

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

@@ -6,18 +6,26 @@ declare const ASTObjectExpression: {
      */
     hasProperty(node: ObjectExpression, name: string): boolean;
     /**
-     * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`
+     * Returns true if an object contains no nested values, false otherwise.
+     *
+     * Note:
+     *  - Returns false if object contains spread elements.
+     *  - Returns true if object is empty.
+     */
+    isFlat(node: ObjectExpression): 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' }`
+     * 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' }`
+     * Returns a only the property @type {Property['value']} like: `'8px` from: `{ padding: '8px' }`.
      *
-     * Values can be basically anything, so be careful with this
+     * Values can be basically anything, so be careful with this.
      */
     getValueByPropertyName(node: ObjectExpression, name: string): Property['value'] | undefined;
     containsSpreadProps(node: ObjectExpression): boolean;
@@ -32,7 +40,7 @@ declare const ASTObjectExpression: {
      *   fixer,
      * )
      * ```
-     * Will result in `{ padding: 'space.100', margin: 'space.200'}`
+     * Will result in `{ padding: 'space.100', margin: 'space.200'}`.
      */
     appendEntry(node: ObjectExpression, key: string, value: string, fixer: Rule.RuleFixer): Rule.Fix;
 };

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

@@ -1,4 +1,4 @@
-type Pattern = 'compiled-css-function' | 'compiled-styled-object' | 'css-template-literal' | 'css-property-with-tokens' | 'css-property-multiple-values';
+type Pattern = 'compiled-css-function' | 'compiled-styled-object' | 'css-template-literal' | 'css-property-with-tokens' | 'css-property-multiple-values' | 'multiple-properties';
 export interface RuleConfig {
     patterns: Pattern[];
 }

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

@@ -6,18 +6,26 @@ declare const ASTObjectExpression: {
      */
     hasProperty(node: ObjectExpression, name: string): boolean;
     /**
-     * Returns a key-value pair like: `padding: '8px'` from: `{ padding: '8px' }`
+     * Returns true if an object contains no nested values, false otherwise.
+     *
+     * Note:
+     *  - Returns false if object contains spread elements.
+     *  - Returns true if object is empty.
+     */
+    isFlat(node: ObjectExpression): 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' }`
+     * 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' }`
+     * Returns a only the property @type {Property['value']} like: `'8px` from: `{ padding: '8px' }`.
      *
-     * Values can be basically anything, so be careful with this
+     * Values can be basically anything, so be careful with this.
      */
     getValueByPropertyName(node: ObjectExpression, name: string): Property['value'] | undefined;
     containsSpreadProps(node: ObjectExpression): boolean;
@@ -32,7 +40,7 @@ declare const ASTObjectExpression: {
      *   fixer,
      * )
      * ```
-     * Will result in `{ padding: 'space.100', margin: 'space.200'}`
+     * Will result in `{ padding: 'space.100', margin: 'space.200'}`.
      */
     appendEntry(node: ObjectExpression, key: string, value: string, fixer: Rule.RuleFixer): Rule.Fix;
 };

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

@@ -1,4 +1,4 @@
-type Pattern = 'compiled-css-function' | 'compiled-styled-object' | 'css-template-literal' | 'css-property-with-tokens' | 'css-property-multiple-values';
+type Pattern = 'compiled-css-function' | 'compiled-styled-object' | 'css-template-literal' | 'css-property-with-tokens' | 'css-property-multiple-values' | 'multiple-properties';
 export interface RuleConfig {
     patterns: Pattern[];
 }

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