@atlaskit/eslint-plugin-platform 2.0.2 → 2.1.0

package/dist/esm/rules/compiled/expand-spacing-shorthand/index.js

@@ -0,0 +1,189 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { getSourceCode } from '../../util/context-compat';
+import { isCompiledAPI } from '../../util/compiled-utils';
+var spacingPos = ["Top", "Right", "Bottom", "Left"];
+;
+
+// Checks if node is a call expression with identifier 'token'
+var isTokenCallExpression = function isTokenCallExpression(node) {
+  if (node.callee.type === 'Identifier' && node.callee.name === 'token') {
+    return true;
+  }
+  return false;
+};
+
+// Given a TemplateLiteral node, returns the value of the spacing property as an array of strings
+// e.g. `0 ${token('a')} ${token('b')}` -> ['0', 'token('a')', 'token('b')']
+var parseTemplateLiteral = function parseTemplateLiteral(templateLiteral, context) {
+  var expressions = templateLiteral.expressions;
+  var quasis = templateLiteral.quasis;
+  var propertyValues = [];
+  for (var i = 0; i < expressions.length || i < quasis.length; i++) {
+    if (i < quasis.length) {
+      var cookedQuasi = quasis[i].value.cooked;
+      if (cookedQuasi) {
+        var splitQuasi = cookedQuasi.split(" ").filter(function (str) {
+          return str.length > 0;
+        });
+        splitQuasi.forEach(function (str) {
+          propertyValues.push(isNaN(Number(str)) ? "'".concat(str, "'") : str);
+        });
+      }
+    }
+    if (i < expressions.length) {
+      var expr = getSourceCode(context).getText(expressions[i]);
+      propertyValues.push(expr);
+    }
+  }
+  return propertyValues;
+};
+var checkValidPropertyValues = function checkValidPropertyValues(propertyValues) {
+  if (!propertyValues.some(function (str) {
+    return str.includes("token(");
+  })) {
+    return false;
+  }
+  if (propertyValues.length < 1 || propertyValues.length > 4) {
+    return false;
+  }
+  if (propertyValues.some(function (str) {
+    return str.includes("calc(");
+  })) {
+    return false;
+  }
+  return true;
+};
+
+// To fix spacing shorthands, given a list of spacing property values, expands the spacing property and adds autofix fixes
+var expandSpacingProperties = function expandSpacingProperties(_ref) {
+  var context = _ref.context,
+    node = _ref.node,
+    propertyValues = _ref.propertyValues,
+    fixer = _ref.fixer,
+    propertyShorthand = _ref.propertyShorthand;
+  var _propertyValues = _slicedToArray(propertyValues, 4),
+    top = _propertyValues[0],
+    _propertyValues$ = _propertyValues[1],
+    right = _propertyValues$ === void 0 ? top : _propertyValues$,
+    _propertyValues$2 = _propertyValues[2],
+    bottom = _propertyValues$2 === void 0 ? top : _propertyValues$2,
+    _propertyValues$3 = _propertyValues[3],
+    left = _propertyValues$3 === void 0 ? right : _propertyValues$3;
+  var spacing = [top, right, bottom, left];
+  var fixes = [];
+  var parentNode = node.parent;
+  if (parentNode && parentNode.type === 'ObjectExpression') {
+    var _iterator = _createForOfIteratorHelper(parentNode.properties),
+      _step;
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var prop = _step.value;
+        if (prop.type !== 'Property') {
+          continue;
+        }
+        if (prop.key.type === 'Identifier' && prop.range && prop.key.name !== "".concat(propertyShorthand)) {
+          for (var i = 0; i < spacing.length; i++) {
+            if (prop.key.name === "".concat(propertyShorthand).concat(spacingPos[i])) {
+              var _prop$range = _slicedToArray(prop.range, 2),
+                start = _prop$range[0],
+                end = _prop$range[1];
+              // Remove the entire line for the duplicate property
+              while (getSourceCode(context).text[end] !== "\n") {
+                end += 1;
+              }
+              while (getSourceCode(context).text[start] !== "\n") {
+                start -= 1;
+              }
+              spacing[i] = getSourceCode(context).getText(prop.value);
+              fixes.push(fixer.removeRange([start, end]));
+              break;
+            }
+          }
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  }
+  fixes.push(fixer.insertTextAfter(node, "".concat(propertyShorthand, "Top: ").concat(spacing[0], ",\n")));
+  fixes.push(fixer.insertTextAfter(node, "\t".concat(propertyShorthand, "Right: ").concat(spacing[1], ",\n")));
+  fixes.push(fixer.insertTextAfter(node, "\t".concat(propertyShorthand, "Bottom: ").concat(spacing[2], ",\n")));
+  fixes.push(fixer.insertTextAfter(node, "\t".concat(propertyShorthand, "Left: ").concat(spacing[3])));
+  fixes.push(fixer.remove(node));
+  return fixes;
+};
+var executeExpandSpacingRule = function executeExpandSpacingRule(context, node, propertyShorthand) {
+  if (!isCompiledAPI(context, node)) {
+    return;
+  }
+  if (node.value.type === 'TemplateLiteral') {
+    // Value of spacing property is a TemplateLiteral type that contains a token, e.g. padding: `0 token('a')`
+    var propertyValues = parseTemplateLiteral(node.value, context);
+    if (!checkValidPropertyValues(propertyValues)) {
+      return;
+    }
+    context.report({
+      node: node,
+      messageId: 'expandSpacingShorthand',
+      data: {
+        property: propertyShorthand
+      },
+      fix: function fix(fixer) {
+        return expandSpacingProperties({
+          context: context,
+          node: node,
+          propertyValues: propertyValues,
+          fixer: fixer,
+          propertyShorthand: propertyShorthand
+        });
+      }
+    });
+  } else if (node.value.type === 'CallExpression' && isTokenCallExpression(node.value)) {
+    // Value of spacing property is a token CallExpression type, e.g. margin: token('space.100', '8px')
+    var _propertyValues2 = [getSourceCode(context).getText(node.value)];
+    context.report({
+      node: node,
+      messageId: 'expandSpacingShorthand',
+      data: {
+        property: propertyShorthand
+      },
+      fix: function fix(fixer) {
+        return expandSpacingProperties({
+          context: context,
+          node: node,
+          propertyValues: _propertyValues2,
+          fixer: fixer,
+          propertyShorthand: propertyShorthand
+        });
+      }
+    });
+  }
+};
+export var expandSpacingShorthand = {
+  meta: {
+    docs: {
+      url: 'https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master/platform/packages/platform/eslint-plugin/src/rules/compiled/expand-spacing-shorthand/'
+    },
+    messages: {
+      expandSpacingShorthand: 'Use {{ property }}Top, {{ property }}Right, {{ property }}Bottom and {{ property }}Left instead of {{ property }} shorthand'
+    },
+    type: 'problem',
+    fixable: 'code'
+  },
+  create: function create(context) {
+    return {
+      'Property[key.name="padding"]': function PropertyKeyNamePadding(node) {
+        executeExpandSpacingRule(context, node, 'padding');
+      },
+      'Property[key.name="margin"]': function PropertyKeyNameMargin(node) {
+        executeExpandSpacingRule(context, node, 'margin');
+      }
+    };
+  }
+};
+export default expandSpacingShorthand;

package/dist/esm/rules/util/compiled-utils.js

@@ -0,0 +1,16 @@
+import { getAncestors, getScope } from './context-compat';
+import { getImportSources, isCompiled, isAtlasKitCSS } from '@atlaskit/eslint-utils/is-supported-import';
+
+// Checks if the function that holds the property is using a Compiled import package that this rule is targeting
+export var isCompiledAPI = function isCompiledAPI(context, node) {
+  var importSources = getImportSources(context);
+  var _getScope = getScope(context, node),
+    references = _getScope.references;
+  var ancestors = getAncestors(context, node);
+  if (ancestors.some(function (ancestor) {
+    return ancestor.type === 'CallExpression' && ancestor.callee && (isCompiled(ancestor.callee, references, importSources) || isAtlasKitCSS(ancestor.callee, references, importSources));
+  })) {
+    return true;
+  }
+  return false;
+};

package/dist/esm/rules/util/context-compat.js

@@ -9,7 +9,7 @@
  * `context.getSourceCode()` is deprecated in v8 and removed in v9.
  * @param context - The ESLint rule context
  */
-var getSourceCode = function getSourceCode(context) {
+export var getSourceCode = function getSourceCode(context) {
   var _context$sourceCode;
   return (_context$sourceCode = context.sourceCode) !== null && _context$sourceCode !== void 0 ? _context$sourceCode : context.getSourceCode();
 };

package/dist/types/index.d.ts

@@ -10,6 +10,7 @@ export declare const rules: {
     'ensure-valid-bin-values': import("eslint").Rule.RuleModule;
     'expand-border-shorthand': import("eslint").Rule.RuleModule;
     'expand-background-shorthand': import("eslint").Rule.RuleModule;
+    'expand-spacing-shorthand': import("eslint").Rule.RuleModule;
     'no-duplicate-dependencies': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;
     'no-pre-post-install-scripts': import("eslint").Rule.RuleModule;
@@ -48,6 +49,7 @@ export declare const configs: {
             '@atlaskit/platform/no-module-level-eval-nav4': string;
             '@atlaskit/platform/expand-border-shorthand': string;
             '@atlaskit/platform/expand-background-shorthand': string;
+            '@atlaskit/platform/expand-spacing-shorthand': string;
             '@compiled/jsx-pragma': (string | {
                 importSources: string[];
                 onlyRunIfImportingCompiled: boolean;
@@ -66,6 +68,7 @@ export declare const configs: {
             '@atlaskit/platform/no-module-level-eval-nav4': string;
             '@atlaskit/platform/expand-border-shorthand': string;
             '@atlaskit/platform/expand-background-shorthand': string;
+            '@atlaskit/platform/expand-spacing-shorthand': string;
             '@compiled/jsx-pragma': (string | {
                 importSources: string[];
                 onlyRunIfImportingCompiled: boolean;

package/dist/types/rules/compiled/expand-spacing-shorthand/index.d.ts

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

package/dist/types/rules/util/compiled-utils.d.ts

@@ -0,0 +1,3 @@
+import type { Node } from 'estree';
+import type { Rule } from 'eslint';
+export declare const isCompiledAPI: (context: Rule.RuleContext, node: Node) => boolean;

package/dist/types/rules/util/context-compat.d.ts

@@ -1,5 +1,16 @@
-import type { Rule, Scope } from 'eslint';
+import type { Rule, Scope, SourceCode } from 'eslint';
 import type { Node } from 'estree';
+/**
+ * TODO: Consider whether this should be replaced by ESLint's compat library.
+ * Either way, this should be removed once we no longer need to support ESLint versions less than 8.40.
+ */
+/**
+ * A compatibility layer to support older versions of ESLint.
+ * `context.sourceCode` is the preferred way to access SourceCode, as
+ * `context.getSourceCode()` is deprecated in v8 and removed in v9.
+ * @param context - The ESLint rule context
+ */
+export declare const getSourceCode: (context: Rule.RuleContext) => SourceCode;
 /**
  * A compatibility layer to support older versions of ESLint.
  * `context.sourceCode.getScope()` is the preferred way to access Scope, as

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

@@ -10,6 +10,7 @@ export declare const rules: {
     'ensure-valid-bin-values': import("eslint").Rule.RuleModule;
     'expand-border-shorthand': import("eslint").Rule.RuleModule;
     'expand-background-shorthand': import("eslint").Rule.RuleModule;
+    'expand-spacing-shorthand': import("eslint").Rule.RuleModule;
     'no-duplicate-dependencies': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;
     'no-pre-post-install-scripts': import("eslint").Rule.RuleModule;
@@ -48,6 +49,7 @@ export declare const configs: {
             '@atlaskit/platform/no-module-level-eval-nav4': string;
             '@atlaskit/platform/expand-border-shorthand': string;
             '@atlaskit/platform/expand-background-shorthand': string;
+            '@atlaskit/platform/expand-spacing-shorthand': string;
             '@compiled/jsx-pragma': (string | {
                 importSources: string[];
                 onlyRunIfImportingCompiled: boolean;
@@ -66,6 +68,7 @@ export declare const configs: {
             '@atlaskit/platform/no-module-level-eval-nav4': string;
             '@atlaskit/platform/expand-border-shorthand': string;
             '@atlaskit/platform/expand-background-shorthand': string;
+            '@atlaskit/platform/expand-spacing-shorthand': string;
             '@compiled/jsx-pragma': (string | {
                 importSources: string[];
                 onlyRunIfImportingCompiled: boolean;

package/dist/types-ts4.5/rules/compiled/expand-spacing-shorthand/index.d.ts

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

package/dist/types-ts4.5/rules/util/compiled-utils.d.ts

@@ -0,0 +1,3 @@
+import type { Node } from 'estree';
+import type { Rule } from 'eslint';
+export declare const isCompiledAPI: (context: Rule.RuleContext, node: Node) => boolean;

package/dist/types-ts4.5/rules/util/context-compat.d.ts

@@ -1,5 +1,16 @@
-import type { Rule, Scope } from 'eslint';
+import type { Rule, Scope, SourceCode } from 'eslint';
 import type { Node } from 'estree';
+/**
+ * TODO: Consider whether this should be replaced by ESLint's compat library.
+ * Either way, this should be removed once we no longer need to support ESLint versions less than 8.40.
+ */
+/**
+ * A compatibility layer to support older versions of ESLint.
+ * `context.sourceCode` is the preferred way to access SourceCode, as
+ * `context.getSourceCode()` is deprecated in v8 and removed in v9.
+ * @param context - The ESLint rule context
+ */
+export declare const getSourceCode: (context: Rule.RuleContext) => SourceCode;
 /**
  * A compatibility layer to support older versions of ESLint.
  * `context.sourceCode.getScope()` is the preferred way to access Scope, as

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
 	"description": "The essential plugin for use with Atlassian frontend platform tools",
-	"version": "2.0.2",
+	"version": "2.1.0",
 	"author": "Atlassian Pty Ltd",
 	"atlassian": {
 		"team": "Build Infra",

package/src/index.tsx

@@ -25,6 +25,7 @@ import noAlias from './rules/feature-gating/no-alias';
 import useEntrypointsInExamples from './rules/use-entrypoints-in-examples';
 import useRecommendedUtils from './rules/feature-gating/use-recommended-utils';
 import expandBackgroundShorthand from './rules/compiled/expand-background-shorthand';
+import expandSpacingShorthand from './rules/compiled/expand-spacing-shorthand';
 
 export const rules = {
 	'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
@@ -37,6 +38,7 @@ export const rules = {
 	'ensure-valid-bin-values': ensureValidBinValues,
 	'expand-border-shorthand': expandBorderShorthand,
 	'expand-background-shorthand': expandBackgroundShorthand,
+	'expand-spacing-shorthand': expandSpacingShorthand,
 	'no-duplicate-dependencies': noDuplicateDependencies,
 	'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
 	'no-pre-post-install-scripts': noPreAndPostInstallScripts,
@@ -64,6 +66,7 @@ const commonConfig = {
 	// Compiled: rules that are not included via `@compiled/recommended
 	'@atlaskit/platform/expand-border-shorthand': 'error',
 	'@atlaskit/platform/expand-background-shorthand': 'error',
+	'@atlaskit/platform/expand-spacing-shorthand': 'warn',
 	'@compiled/jsx-pragma': [
 		'error',
 		{

package/src/rules/compiled/expand-background-shorthand/__tests__/rule.test.ts

@@ -13,7 +13,7 @@ const exempt_packages_calls_and_imports = [
 	['css', 'styled-components'],
 	['xcss', '@atlaskit/primitives'],
 ];
-tester.run('expand-border-shorthand', expandBackgroundShorthand, {
+tester.run('expand-background-shorthand', expandBackgroundShorthand, {
 	valid: [
 		...exempt_packages_calls_and_imports.map(([pkg, imp]) => ({
 			name: `do not have to handle non-Compiled packages (${pkg}, ${imp})`,

package/src/rules/compiled/expand-background-shorthand/index.tsx

@@ -1,30 +1,6 @@
 import type { Rule } from 'eslint';
 import type { Property, Node } from 'estree';
-import {
-	getImportSources,
-	isCompiled,
-	isAtlasKitCSS,
-} from '@atlaskit/eslint-utils/is-supported-import';
-import { getAncestors, getScope } from '../../util/context-compat';
-
-// Checks if the function that holds the border property is using an import package that this rule is targeting
-const isCompiledAPI = (context: Rule.RuleContext, node: Node): boolean => {
-	const importSources = getImportSources(context);
-	const { references } = getScope(context, node);
-	const ancestors = getAncestors(context, node);
-	if (
-		ancestors.some(
-			(ancestor) =>
-				ancestor.type === 'CallExpression' &&
-				ancestor.callee &&
-				(isCompiled(ancestor.callee, references, importSources) ||
-					isAtlasKitCSS(ancestor.callee, references, importSources)),
-		)
-	) {
-		return true;
-	}
-	return false;
-};
+import { isCompiledAPI } from '../../util/compiled-utils';
 
 // Checks if node is a call expression with identifier 'token'
 const isTokenCallExpression = (node: Node) => {

package/src/rules/compiled/expand-spacing-shorthand/README.md

@@ -0,0 +1,38 @@
+# `expand-spacing-shorthand`
+
+This ESLint rule enforces the expansion of the CSS `padding` and `margin` shorthand properties into
+its longhand equivalent `{spacing}Top`, `{spacing}Right`, `{spacing}Bottom`, `{spacing}Left`, where 
+the property's value is either an Atlassian Design System token or a template literal which contains
+a token, and the function call originates from `@compiled/react` or `@atlaskit/css`. 
+
+## Rule details
+
+👎 Examples of **incorrect** code for this rule:
+
+```js
+const styles = css({
+	padding: token('space.200'),
+});
+
+const styles = css({
+	margin: `${token('space.100')} 0 2px`,
+});
+```
+
+👍 Examples of **correct** code for this rule:
+
+```js
+const styles = css({
+	paddingTop: token('space.200'),
+    paddingRight: token('space.200'),
+    paddingBottom: token('space.200'),
+    paddingLeft: token('space.200'),
+});
+
+const styles = css({
+	marginTop: token('space.100'),
+    marginRight: 0,
+    marginBottom: '2px',
+    marginLeft: 0,
+});
+```