@atlaskit/eslint-plugin-platform 2.1.2 → 2.2.1

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

@@ -21,7 +21,7 @@ const parseTemplateLiteral = (templateLiteral, context) => {
       if (cookedQuasi) {
         const splitQuasis = cookedQuasi.split(' ');
         splitQuasis.forEach(str => {
-          str = str.trim().replace("\'", "");
+          str = str.trim().replace("'", '');
           if (str.length > 0) {
             propertyValues.push(isNaN(Number(str)) ? `'${str}'` : str);
           }
@@ -35,25 +35,59 @@ const parseTemplateLiteral = (templateLiteral, context) => {
   }
   return propertyValues;
 };
-const checkValidPropertyValues = propertyValues => {
+
+/**
+ * Checks if the parsed property values are valid (i.e. no rule violation will be thrown). Cases are, the property values:
+ * 1. Do not contain a token
+ * 2. Have length that are not in the range [1, 4]
+ * 3. Includes `calc(...)`
+ * Then, the rule will return with no error
+ * @param propertyValues property values parsed as list of strings
+ * @returns boolean
+ */
+const isPropertyValueExempted = propertyValues => {
   if (!propertyValues.some(str => str.includes('token('))) {
-    return false;
+    return true;
   }
   if (propertyValues.length < 1 || propertyValues.length > 4) {
-    return false;
+    return true;
   }
   if (propertyValues.some(str => str.includes('calc('))) {
-    return false;
+    return true;
   }
-  return true;
+  return false;
 };
 
-// Check that all expressions in TemplateLiteral are token expressions
-// If true: create an autofix
-// If false: report violation without autofix
-const hasOnlyTokens = templateLiteral => {
+/**
+ * Checks if the parsed property values are invalid (i.e. rule violation thrown) and autofix required. Cases are when:
+ *  1. All expressions in TemplateLiteral are token expressions
+ *  2. Property values must have a format which includes -> e.g. 2, '2(rem|em|px)', auto, initial, inherit, token(...)
+ *  The rule will return with error and provide a fix
+ * @param templateLiteral TemplateLiteral AST Node
+ * @param propertyValues property values parsed as list of strings
+ * @returns boolean
+ */
+const isPropertyValuesInvalidFix = (templateLiteral, propertyValues) => {
   const expressions = templateLiteral.expressions;
-  return expressions.every(expr => expr.type === 'CallExpression' && isTokenCallExpression(expr));
+  if (!expressions.every(expr => expr.type === 'CallExpression' && isTokenCallExpression(expr))) {
+    return false;
+  }
+  for (const propValue of propertyValues) {
+    if (propValue === '0') {
+      continue;
+    }
+    if (['auto', 'initial', 'inherit'].includes(propValue.slice(1, -1))) {
+      continue;
+    }
+    if (/^token\(.*\)$/.test(propValue)) {
+      continue;
+    }
+    if (/^['"]\d+(\.\d+)?((rem)|(em)|(px))['"]$/.test(propValue)) {
+      continue;
+    }
+    return false;
+  }
+  return true;
 };
 
 // To fix spacing shorthands, given a list of spacing property values, expands the spacing property and adds autofix fixes
@@ -104,8 +138,30 @@ const executeExpandSpacingRule = (context, node, propertyShorthand) => {
     return;
   }
   if (node.value.type === 'TemplateLiteral') {
-    // Value of spacing property is a TemplateLiteral type that contains a token, e.g. padding: `0 token('a')`
-    if (!hasOnlyTokens(node.value)) {
+    const propertyValues = parseTemplateLiteral(node.value, context);
+    if (isPropertyValueExempted(propertyValues)) {
+      // Valid, so no error should be thrown
+      return;
+    }
+    if (isPropertyValuesInvalidFix(node.value, propertyValues)) {
+      // Invalid, so error should be thrown and fix provided
+      context.report({
+        node,
+        messageId: 'expandSpacingShorthand',
+        data: {
+          property: propertyShorthand
+        },
+        fix(fixer) {
+          return expandSpacingProperties({
+            context,
+            node,
+            propertyValues,
+            fixer,
+            propertyShorthand
+          });
+        }
+      });
+    } else {
       context.report({
         node,
         messageId: 'expandSpacingShorthand',
@@ -115,26 +171,6 @@ const executeExpandSpacingRule = (context, node, propertyShorthand) => {
       });
       return;
     }
-    const propertyValues = parseTemplateLiteral(node.value, context);
-    if (!checkValidPropertyValues(propertyValues)) {
-      return;
-    }
-    context.report({
-      node,
-      messageId: 'expandSpacingShorthand',
-      data: {
-        property: propertyShorthand
-      },
-      fix(fixer) {
-        return expandSpacingProperties({
-          context,
-          node,
-          propertyValues,
-          fixer,
-          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')
     const propertyValues = [getSourceCode(context).getText(node.value)];

package/dist/esm/index.js

@@ -2,7 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 // eslint-disable-next-line import/no-extraneous-dependencies
-
+import compiledPlugin from '@compiled/eslint-plugin';
 import ensureFeatureFlagRegistration from './rules/ensure-feature-flag-registration';
 import noPreAndPostInstallScripts from './rules/no-pre-post-installs';
 import ensureTestRunnerArguments from './rules/ensure-test-runner-arguments';
@@ -29,7 +29,8 @@ 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 var rules = {
+var packageJson = require('@atlaskit/eslint-plugin-platform/package.json');
+var rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
   'ensure-feature-flag-prefix': ensureFeatureFlagPrefix,
   'ensure-test-runner-arguments': ensureTestRunnerArguments,
@@ -74,75 +75,116 @@ var commonConfig = {
     runtime: 'classic'
   }]
 };
-export var configs = {
-  recommended: {
-    plugins: ['@atlaskit/platform', '@compiled'],
-    rules: _objectSpread(_objectSpread({}, commonConfig), {}, {
-      // See platform/packages/platform/eslint-plugin/src/rules/feature-gating/README.md
-      // These rules are specific to `platform` and seem a WIP; jira and confluence currently have their own rules
-      '@atlaskit/platform/no-module-level-eval': 'error',
-      '@atlaskit/platform/static-feature-flags': 'error',
-      '@atlaskit/platform/no-preconditioning': 'error',
-      '@atlaskit/platform/inline-usage': 'error',
-      '@atlaskit/platform/prefer-fg': 'error',
-      '@atlaskit/platform/no-alias': 'error',
-      // end: feature-gating rules
-      '@atlaskit/platform/ensure-feature-flag-registration': 'error',
-      '@atlaskit/platform/ensure-feature-flag-prefix': ['warn', {
-        allowedPrefixes: ['platform.', 'platform_']
-      }]
-    })
-  },
-  jira: {
-    plugins: ['@atlaskit/platform', '@compiled'],
-    rules: _objectSpread({}, commonConfig)
-  }
-};
+var recommendedRules = _objectSpread(_objectSpread({}, commonConfig), {}, {
+  // See platform/packages/platform/eslint-plugin/src/rules/feature-gating/README.md
+  // These rules are specific to `platform` and seem a WIP; jira and confluence currently have their own rules
+  '@atlaskit/platform/no-module-level-eval': 'error',
+  '@atlaskit/platform/static-feature-flags': 'error',
+  '@atlaskit/platform/no-preconditioning': 'error',
+  '@atlaskit/platform/inline-usage': 'error',
+  '@atlaskit/platform/prefer-fg': 'error',
+  '@atlaskit/platform/no-alias': 'error',
+  // end: feature-gating rules
+  '@atlaskit/platform/ensure-feature-flag-registration': 'error',
+  '@atlaskit/platform/ensure-feature-flag-prefix': ['warn', {
+    allowedPrefixes: ['platform.', 'platform_']
+  }]
+});
+var jiraRules = commonConfig;
 var jsonPrefix = '/* eslint-disable quote-props, comma-dangle, quotes, semi, eol-last, @typescript-eslint/semi, no-template-curly-in-string */ module.exports = ';
 var jsonPrefixForFlatConfig = '/* eslint-disable quote-props, comma-dangle, quotes, semi, eol-last, no-template-curly-in-string */ module.exports = ';
-export var processors = {
-  'package-json-processor': {
-    preprocess: function preprocess(source) {
-      // augment the json into a js file
-      return [jsonPrefix + source.trim()];
+var name = packageJson.name,
+  version = packageJson.version;
+var plugin = {
+  meta: {
+    name: name,
+    version: version
+  },
+  rules: rules,
+  configs: {
+    recommended: {
+      plugins: ['@atlaskit/platform', '@compiled'],
+      rules: recommendedRules
     },
-    postprocess: function postprocess(messages) {
-      return messages[0].map(function (message) {
-        var fix = message.fix;
-        if (!fix) {
-          return message;
+    'recommended/flat': {
+      plugins: {
+        get '@atlaskit/platform'() {
+          return plugin;
+        },
+        // @ts-expect-error there's an issue with the types for @compiled/eslint-plugin ('no-css-prop-without-css-function' specifically)
+        '@compiled': {
+          meta: compiledPlugin.meta,
+          rules: compiledPlugin.rules
         }
-        var offset = jsonPrefix.length;
-        return _objectSpread(_objectSpread({}, message), {}, {
-          fix: _objectSpread(_objectSpread({}, fix), {}, {
-            range: [fix.range[0] - offset, fix.range[1] - offset]
-          })
-        });
-      });
+      },
+      rules: recommendedRules
     },
-    supportsAutofix: true
-  },
-  // This processor is used for ESLint FlatConfig,
-  // once we roll out FlatConfig, we can remove the above processor
-  'package-json-processor-for-flat-config': {
-    preprocess: function preprocess(source) {
-      // augment the json into a js file
-      return [jsonPrefixForFlatConfig + source.trim()];
+    jira: {
+      plugins: ['@atlaskit/platform', '@compiled'],
+      rules: jiraRules
     },
-    postprocess: function postprocess(messages) {
-      return messages[0].map(function (message) {
-        var fix = message.fix;
-        if (!fix) {
-          return message;
+    'jira/flat': {
+      plugins: {
+        get '@atlaskit/platform'() {
+          return plugin;
+        },
+        // @ts-expect-error there's an issue with the types for @compiled/eslint-plugin ('no-css-prop-without-css-function' specifically)
+        '@compiled': {
+          meta: compiledPlugin.meta,
+          rules: compiledPlugin.rules
         }
-        var offset = jsonPrefixForFlatConfig.length;
-        return _objectSpread(_objectSpread({}, message), {}, {
-          fix: _objectSpread(_objectSpread({}, fix), {}, {
-            range: [fix.range[0] - offset, fix.range[1] - offset]
-          })
+      },
+      rules: jiraRules
+    }
+  },
+  processors: {
+    'package-json-processor': {
+      preprocess: function preprocess(source) {
+        // augment the json into a js file
+        return [jsonPrefix + source.trim()];
+      },
+      postprocess: function postprocess(messages) {
+        return messages[0].map(function (message) {
+          var fix = message.fix;
+          if (!fix) {
+            return message;
+          }
+          var offset = jsonPrefix.length;
+          return _objectSpread(_objectSpread({}, message), {}, {
+            fix: _objectSpread(_objectSpread({}, fix), {}, {
+              range: [fix.range[0] - offset, fix.range[1] - offset]
+            })
+          });
         });
-      });
+      },
+      supportsAutofix: true
     },
-    supportsAutofix: true
+    // This processor is used for ESLint FlatConfig,
+    // once we roll out FlatConfig, we can remove the above processor
+    'package-json-processor-for-flat-config': {
+      preprocess: function preprocess(source) {
+        // augment the json into a js file
+        return [jsonPrefixForFlatConfig + source.trim()];
+      },
+      postprocess: function postprocess(messages) {
+        return messages[0].map(function (message) {
+          var fix = message.fix;
+          if (!fix) {
+            return message;
+          }
+          var offset = jsonPrefixForFlatConfig.length;
+          return _objectSpread(_objectSpread({}, message), {}, {
+            fix: _objectSpread(_objectSpread({}, fix), {}, {
+              range: [fix.range[0] - offset, fix.range[1] - offset]
+            })
+          });
+        });
+      },
+      supportsAutofix: true
+    }
   }
-};
+};
+var configs = plugin.configs;
+var processors = plugin.processors;
+export { configs, plugin, processors, rules };
+export default plugin;

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

@@ -25,7 +25,7 @@ var parseTemplateLiteral = function parseTemplateLiteral(templateLiteral, contex
       if (cookedQuasi) {
         var splitQuasis = cookedQuasi.split(' ');
         splitQuasis.forEach(function (str) {
-          str = str.trim().replace("\'", "");
+          str = str.trim().replace("'", '');
           if (str.length > 0) {
             propertyValues.push(isNaN(Number(str)) ? "'".concat(str, "'") : str);
           }
@@ -39,31 +39,74 @@ var parseTemplateLiteral = function parseTemplateLiteral(templateLiteral, contex
   }
   return propertyValues;
 };
-var checkValidPropertyValues = function checkValidPropertyValues(propertyValues) {
+
+/**
+ * Checks if the parsed property values are valid (i.e. no rule violation will be thrown). Cases are, the property values:
+ * 1. Do not contain a token
+ * 2. Have length that are not in the range [1, 4]
+ * 3. Includes `calc(...)`
+ * Then, the rule will return with no error
+ * @param propertyValues property values parsed as list of strings
+ * @returns boolean
+ */
+var isPropertyValueExempted = function isPropertyValueExempted(propertyValues) {
   if (!propertyValues.some(function (str) {
     return str.includes('token(');
   })) {
-    return false;
+    return true;
   }
   if (propertyValues.length < 1 || propertyValues.length > 4) {
-    return false;
+    return true;
   }
   if (propertyValues.some(function (str) {
     return str.includes('calc(');
   })) {
-    return false;
+    return true;
   }
-  return true;
+  return false;
 };
 
-// Check that all expressions in TemplateLiteral are token expressions
-// If true: create an autofix
-// If false: report violation without autofix
-var hasOnlyTokens = function hasOnlyTokens(templateLiteral) {
+/**
+ * Checks if the parsed property values are invalid (i.e. rule violation thrown) and autofix required. Cases are when:
+ *  1. All expressions in TemplateLiteral are token expressions
+ *  2. Property values must have a format which includes -> e.g. 2, '2(rem|em|px)', auto, initial, inherit, token(...)
+ *  The rule will return with error and provide a fix
+ * @param templateLiteral TemplateLiteral AST Node
+ * @param propertyValues property values parsed as list of strings
+ * @returns boolean
+ */
+var isPropertyValuesInvalidFix = function isPropertyValuesInvalidFix(templateLiteral, propertyValues) {
   var expressions = templateLiteral.expressions;
-  return expressions.every(function (expr) {
+  if (!expressions.every(function (expr) {
     return expr.type === 'CallExpression' && isTokenCallExpression(expr);
-  });
+  })) {
+    return false;
+  }
+  var _iterator = _createForOfIteratorHelper(propertyValues),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var propValue = _step.value;
+      if (propValue === '0') {
+        continue;
+      }
+      if (['auto', 'initial', 'inherit'].includes(propValue.slice(1, -1))) {
+        continue;
+      }
+      if (/^token\(.*\)$/.test(propValue)) {
+        continue;
+      }
+      if (/^['"]\d+(\.\d+)?((rem)|(em)|(px))['"]$/.test(propValue)) {
+        continue;
+      }
+      return false;
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return true;
 };
 
 // To fix spacing shorthands, given a list of spacing property values, expands the spacing property and adds autofix fixes
@@ -85,11 +128,11 @@ var expandSpacingProperties = function expandSpacingProperties(_ref) {
   var fixes = [];
   var parentNode = node.parent;
   if (parentNode && parentNode.type === 'ObjectExpression') {
-    var _iterator = _createForOfIteratorHelper(parentNode.properties),
-      _step;
+    var _iterator2 = _createForOfIteratorHelper(parentNode.properties),
+      _step2;
     try {
-      for (_iterator.s(); !(_step = _iterator.n()).done;) {
-        var prop = _step.value;
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        var prop = _step2.value;
         if (prop.type !== 'Property') {
           continue;
         }
@@ -114,9 +157,9 @@ var expandSpacingProperties = function expandSpacingProperties(_ref) {
         }
       }
     } catch (err) {
-      _iterator.e(err);
+      _iterator2.e(err);
     } finally {
-      _iterator.f();
+      _iterator2.f();
     }
   }
   fixes.push(fixer.insertTextAfter(node, "".concat(propertyShorthand, "Top: ").concat(spacing[0], ",\n")));
@@ -131,8 +174,30 @@ var executeExpandSpacingRule = function executeExpandSpacingRule(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')`
-    if (!hasOnlyTokens(node.value)) {
+    var propertyValues = parseTemplateLiteral(node.value, context);
+    if (isPropertyValueExempted(propertyValues)) {
+      // Valid, so no error should be thrown
+      return;
+    }
+    if (isPropertyValuesInvalidFix(node.value, propertyValues)) {
+      // Invalid, so error should be thrown and fix provided
+      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 {
       context.report({
         node: node,
         messageId: 'expandSpacingShorthand',
@@ -142,26 +207,6 @@ var executeExpandSpacingRule = function executeExpandSpacingRule(context, node,
       });
       return;
     }
-    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)];