@atlaskit/eslint-plugin-design-system 4.0.1 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 4.1.0
+
+### Minor Changes
+
+- [`52fbe80eeb5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/52fbe80eeb5) - Moved logic for detecting deprecated tokens out of no-unsafe-design-token-usage and moves it into a new rule: no-deprecated-token-usage. This rule is solely reponsible for catching usage of deprecated tokens. In most cases this allows consumers to set this rule to "warn", allowing iterative migration to new token names rather than in a big bang.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 4.0.1
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -9,6 +9,8 @@ exports.rules = exports.configs = void 0;
 
 var _ensureDesignTokenUsage = _interopRequireDefault(require("./rules/ensure-design-token-usage"));
 
+var _noDeprecatedDesignTokenUsage = _interopRequireDefault(require("./rules/no-deprecated-design-token-usage"));
+
 var _noDeprecatedImports = _interopRequireDefault(require("./rules/no-deprecated-imports"));
 
 var _noUnsafeDesignTokenUsage = _interopRequireDefault(require("./rules/no-unsafe-design-token-usage"));
@@ -16,6 +18,7 @@ var _noUnsafeDesignTokenUsage = _interopRequireDefault(require("./rules/no-unsaf
 var rules = {
   'ensure-design-token-usage': _ensureDesignTokenUsage.default,
   'no-unsafe-design-token-usage': _noUnsafeDesignTokenUsage.default,
+  'no-deprecated-design-token-usage': _noDeprecatedDesignTokenUsage.default,
   'no-deprecated-imports': _noDeprecatedImports.default
 };
 exports.rules = rules;

package/dist/cjs/rules/no-deprecated-design-token-usage/index.js

@@ -0,0 +1,76 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _renameMapping = _interopRequireDefault(require("@atlaskit/tokens/rename-mapping"));
+
+var getCleanPathId = function getCleanPathId(path) {
+  return path.split('.').filter(function (el) {
+    return el !== '[default]';
+  }).join('.');
+};
+
+var rule = {
+  meta: {
+    docs: {
+      recommended: true
+    },
+    fixable: 'code',
+    type: 'problem',
+    messages: {
+      tokenRenamed: 'The token "{{name}}" is deprecated in favour of "{{replacement}}".'
+    }
+  },
+  create: function create(context) {
+    return {
+      'CallExpression[callee.name="token"]': function CallExpressionCalleeNameToken(node) {
+        if (node.type !== 'CallExpression') {
+          return;
+        }
+
+        if (node.arguments[0].type !== 'Literal') {
+          return;
+        }
+
+        var tokenKey = node.arguments[0].value;
+
+        if (!tokenKey) {
+          return;
+        }
+
+        if (typeof tokenKey !== 'string') {
+          return;
+        }
+
+        var migrationMeta = _renameMapping.default.filter(function (t) {
+          return t.state === 'deprecated';
+        }).find(function (t) {
+          return t.path === tokenKey;
+        });
+
+        if (migrationMeta) {
+          var cleanTokenKey = getCleanPathId(migrationMeta.replacement);
+          context.report({
+            messageId: 'tokenRenamed',
+            node: node,
+            data: {
+              name: tokenKey,
+              replacement: cleanTokenKey
+            },
+            fix: function fix(fixer) {
+              return fixer.replaceText(node.arguments[0], "'".concat(cleanTokenKey, "'"));
+            }
+          });
+          return;
+        }
+      }
+    };
+  }
+};
+var _default = rule;
+exports.default = _default;

package/dist/cjs/rules/no-unsafe-design-token-usage/index.js

@@ -15,6 +15,12 @@ var _isNode = require("../utils/is-node");
 
 var _isToken = require("../utils/is-token");
 
+var getCleanPathId = function getCleanPathId(path) {
+  return path.split('.').filter(function (el) {
+    return el !== '[default]';
+  }).join('.');
+};
+
 var defaultConfig = {
   shouldEnforceFallbacks: false
 };
@@ -29,7 +35,7 @@ var rule = {
       directTokenUsage: "Access the global theme using the token function.\n\n```\nimport { token } from '@atlaskit/tokens';\n\ntoken('{{tokenKey}}');\n```\n",
       staticToken: "Token string should be inlined directly into the function call.\n\n```\ntoken('color.background.blanket');\n```\n",
       invalidToken: 'The token "{{name}}" does not exist.',
-      tokenRenamed: 'The token "{{name}}" has been renamed.',
+      tokenRemoved: 'The token "{{name}}" is removed in favour of "{{replacement}}".',
       tokenFallbackEnforced: "Token function requires a fallback, preferably something that best matches the light/default theme in case tokens aren't present.\n\n```\ntoken('color.background.blanket', N500A);\n```\n      ",
       tokenFallbackRestricted: "Token function must not use a fallback.\n\n```\ntoken('color.background.blanket');\n```\n      "
     }
@@ -130,15 +136,23 @@ var rule = {
           return;
         }
 
-        if (typeof tokenKey === 'string' && tokenKey in _renameMapping.default) {
+        var migrationMeta = _renameMapping.default.filter(function (t) {
+          return t.state === 'deleted';
+        }).find(function (t) {
+          return t.path === tokenKey;
+        });
+
+        if (typeof tokenKey === 'string' && migrationMeta) {
+          var cleanTokenKey = getCleanPathId(migrationMeta.replacement);
           context.report({
-            messageId: 'tokenRenamed',
+            messageId: 'tokenRemoved',
             node: node,
             data: {
-              name: tokenKey
+              name: tokenKey,
+              replacement: cleanTokenKey
             },
             fix: function fix(fixer) {
-              return fixer.replaceText(node.arguments[0], "'".concat(_renameMapping.default[tokenKey], "'"));
+              return fixer.replaceText(node.arguments[0], "'".concat(cleanTokenKey, "'"));
             }
           });
           return;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.0.1",
+	"version": "4.1.0",
 	"sideEffects": false
 }

package/dist/es2019/index.js

@@ -1,9 +1,11 @@
 import ensureTokenUsage from './rules/ensure-design-token-usage';
+import noDeprecatedUsage from './rules/no-deprecated-design-token-usage';
 import noDeprecatedImports from './rules/no-deprecated-imports';
 import noUnsafeUsage from './rules/no-unsafe-design-token-usage';
 export const rules = {
   'ensure-design-token-usage': ensureTokenUsage,
   'no-unsafe-design-token-usage': noUnsafeUsage,
+  'no-deprecated-design-token-usage': noDeprecatedUsage,
   'no-deprecated-imports': noDeprecatedImports
 };
 export const configs = {

package/dist/es2019/rules/no-deprecated-design-token-usage/index.js

@@ -0,0 +1,58 @@
+import renameMapping from '@atlaskit/tokens/rename-mapping';
+
+const getCleanPathId = path => path.split('.').filter(el => el !== '[default]').join('.');
+
+const rule = {
+  meta: {
+    docs: {
+      recommended: true
+    },
+    fixable: 'code',
+    type: 'problem',
+    messages: {
+      tokenRenamed: 'The token "{{name}}" is deprecated in favour of "{{replacement}}".'
+    }
+  },
+
+  create(context) {
+    return {
+      'CallExpression[callee.name="token"]': node => {
+        if (node.type !== 'CallExpression') {
+          return;
+        }
+
+        if (node.arguments[0].type !== 'Literal') {
+          return;
+        }
+
+        const tokenKey = node.arguments[0].value;
+
+        if (!tokenKey) {
+          return;
+        }
+
+        if (typeof tokenKey !== 'string') {
+          return;
+        }
+
+        const migrationMeta = renameMapping.filter(t => t.state === 'deprecated').find(t => t.path === tokenKey);
+
+        if (migrationMeta) {
+          const cleanTokenKey = getCleanPathId(migrationMeta.replacement);
+          context.report({
+            messageId: 'tokenRenamed',
+            node,
+            data: {
+              name: tokenKey,
+              replacement: cleanTokenKey
+            },
+            fix: fixer => fixer.replaceText(node.arguments[0], `'${cleanTokenKey}'`)
+          });
+          return;
+        }
+      }
+    };
+  }
+
+};
+export default rule;

package/dist/es2019/rules/no-unsafe-design-token-usage/index.js

@@ -2,6 +2,9 @@ import renameMapping from '@atlaskit/tokens/rename-mapping';
 import tokens from '@atlaskit/tokens/token-names';
 import { isDecendantOfStyleBlock, isDecendantOfStyleJsxAttribute } from '../utils/is-node';
 import { isToken } from '../utils/is-token';
+
+const getCleanPathId = path => path.split('.').filter(el => el !== '[default]').join('.');
+
 const defaultConfig = {
   shouldEnforceFallbacks: false
 };
@@ -28,7 +31,7 @@ token('color.background.blanket');
 \`\`\`
 `,
       invalidToken: 'The token "{{name}}" does not exist.',
-      tokenRenamed: 'The token "{{name}}" has been renamed.',
+      tokenRemoved: 'The token "{{name}}" is removed in favour of "{{replacement}}".',
       tokenFallbackEnforced: `Token function requires a fallback, preferably something that best matches the light/default theme in case tokens aren't present.
 
 \`\`\`
@@ -136,14 +139,18 @@ token('color.background.blanket');
           return;
         }
 
-        if (typeof tokenKey === 'string' && tokenKey in renameMapping) {
+        const migrationMeta = renameMapping.filter(t => t.state === 'deleted').find(t => t.path === tokenKey);
+
+        if (typeof tokenKey === 'string' && migrationMeta) {
+          const cleanTokenKey = getCleanPathId(migrationMeta.replacement);
           context.report({
-            messageId: 'tokenRenamed',
+            messageId: 'tokenRemoved',
             node,
             data: {
-              name: tokenKey
+              name: tokenKey,
+              replacement: cleanTokenKey
             },
-            fix: fixer => fixer.replaceText(node.arguments[0], `'${renameMapping[tokenKey]}'`)
+            fix: fixer => fixer.replaceText(node.arguments[0], `'${cleanTokenKey}'`)
           });
           return;
         }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.0.1",
+	"version": "4.1.0",
 	"sideEffects": false
 }

package/dist/esm/index.js

@@ -1,9 +1,11 @@
 import ensureTokenUsage from './rules/ensure-design-token-usage';
+import noDeprecatedUsage from './rules/no-deprecated-design-token-usage';
 import noDeprecatedImports from './rules/no-deprecated-imports';
 import noUnsafeUsage from './rules/no-unsafe-design-token-usage';
 export var rules = {
   'ensure-design-token-usage': ensureTokenUsage,
   'no-unsafe-design-token-usage': noUnsafeUsage,
+  'no-deprecated-design-token-usage': noDeprecatedUsage,
   'no-deprecated-imports': noDeprecatedImports
 };
 export var configs = {

package/dist/esm/rules/no-deprecated-design-token-usage/index.js

@@ -0,0 +1,66 @@
+import renameMapping from '@atlaskit/tokens/rename-mapping';
+
+var getCleanPathId = function getCleanPathId(path) {
+  return path.split('.').filter(function (el) {
+    return el !== '[default]';
+  }).join('.');
+};
+
+var rule = {
+  meta: {
+    docs: {
+      recommended: true
+    },
+    fixable: 'code',
+    type: 'problem',
+    messages: {
+      tokenRenamed: 'The token "{{name}}" is deprecated in favour of "{{replacement}}".'
+    }
+  },
+  create: function create(context) {
+    return {
+      'CallExpression[callee.name="token"]': function CallExpressionCalleeNameToken(node) {
+        if (node.type !== 'CallExpression') {
+          return;
+        }
+
+        if (node.arguments[0].type !== 'Literal') {
+          return;
+        }
+
+        var tokenKey = node.arguments[0].value;
+
+        if (!tokenKey) {
+          return;
+        }
+
+        if (typeof tokenKey !== 'string') {
+          return;
+        }
+
+        var migrationMeta = renameMapping.filter(function (t) {
+          return t.state === 'deprecated';
+        }).find(function (t) {
+          return t.path === tokenKey;
+        });
+
+        if (migrationMeta) {
+          var cleanTokenKey = getCleanPathId(migrationMeta.replacement);
+          context.report({
+            messageId: 'tokenRenamed',
+            node: node,
+            data: {
+              name: tokenKey,
+              replacement: cleanTokenKey
+            },
+            fix: function fix(fixer) {
+              return fixer.replaceText(node.arguments[0], "'".concat(cleanTokenKey, "'"));
+            }
+          });
+          return;
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/esm/rules/no-unsafe-design-token-usage/index.js

@@ -2,6 +2,13 @@ import renameMapping from '@atlaskit/tokens/rename-mapping';
 import tokens from '@atlaskit/tokens/token-names';
 import { isDecendantOfStyleBlock, isDecendantOfStyleJsxAttribute } from '../utils/is-node';
 import { isToken } from '../utils/is-token';
+
+var getCleanPathId = function getCleanPathId(path) {
+  return path.split('.').filter(function (el) {
+    return el !== '[default]';
+  }).join('.');
+};
+
 var defaultConfig = {
   shouldEnforceFallbacks: false
 };
@@ -16,7 +23,7 @@ var rule = {
       directTokenUsage: "Access the global theme using the token function.\n\n```\nimport { token } from '@atlaskit/tokens';\n\ntoken('{{tokenKey}}');\n```\n",
       staticToken: "Token string should be inlined directly into the function call.\n\n```\ntoken('color.background.blanket');\n```\n",
       invalidToken: 'The token "{{name}}" does not exist.',
-      tokenRenamed: 'The token "{{name}}" has been renamed.',
+      tokenRemoved: 'The token "{{name}}" is removed in favour of "{{replacement}}".',
       tokenFallbackEnforced: "Token function requires a fallback, preferably something that best matches the light/default theme in case tokens aren't present.\n\n```\ntoken('color.background.blanket', N500A);\n```\n      ",
       tokenFallbackRestricted: "Token function must not use a fallback.\n\n```\ntoken('color.background.blanket');\n```\n      "
     }
@@ -117,15 +124,23 @@ var rule = {
           return;
         }
 
-        if (typeof tokenKey === 'string' && tokenKey in renameMapping) {
+        var migrationMeta = renameMapping.filter(function (t) {
+          return t.state === 'deleted';
+        }).find(function (t) {
+          return t.path === tokenKey;
+        });
+
+        if (typeof tokenKey === 'string' && migrationMeta) {
+          var cleanTokenKey = getCleanPathId(migrationMeta.replacement);
           context.report({
-            messageId: 'tokenRenamed',
+            messageId: 'tokenRemoved',
             node: node,
             data: {
-              name: tokenKey
+              name: tokenKey,
+              replacement: cleanTokenKey
             },
             fix: function fix(fixer) {
-              return fixer.replaceText(node.arguments[0], "'".concat(renameMapping[tokenKey], "'"));
+              return fixer.replaceText(node.arguments[0], "'".concat(cleanTokenKey, "'"));
             }
           });
           return;

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.0.1",
+	"version": "4.1.0",
 	"sideEffects": false
 }

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export declare const rules: {
     'ensure-design-token-usage': import("eslint").Rule.RuleModule;
     'no-unsafe-design-token-usage': import("eslint").Rule.RuleModule;
+    'no-deprecated-design-token-usage': import("eslint").Rule.RuleModule;
     'no-deprecated-imports': import("eslint").Rule.RuleModule;
 };
 export declare const configs: {

package/dist/types/rules/no-deprecated-design-token-usage/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/eslint-plugin-design-system",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -20,7 +20,7 @@
     ".": "./src/index.tsx"
   },
   "dependencies": {
-    "@atlaskit/tokens": "^0.4.0",
+    "@atlaskit/tokens": "^0.5.0",
     "@babel/runtime": "^7.0.0"
   },
   "devDependencies": {