@atlaskit/eslint-plugin-design-system 9.6.0 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/CHANGELOG.md +1004 -411
  2. package/README.md +7 -5
  3. package/constellation/consistent-css-prop-usage/usage.mdx +44 -30
  4. package/constellation/ensure-design-token-usage/usage.mdx +12 -7
  5. package/constellation/ensure-design-token-usage-preview/usage.mdx +2 -1
  6. package/constellation/icon-label/usage.mdx +5 -3
  7. package/constellation/index/usage.mdx +5 -2
  8. package/constellation/no-banned-imports/usage.mdx +3 -1
  9. package/constellation/no-css-tagged-template-expression/usage.mdx +22 -17
  10. package/constellation/no-deprecated-apis/usage.mdx +33 -27
  11. package/constellation/no-deprecated-design-token-usage/usage.mdx +7 -4
  12. package/constellation/no-deprecated-imports/usage.mdx +31 -27
  13. package/constellation/no-direct-use-of-web-platform-drag-and-drop/usage.mdx +19 -10
  14. package/constellation/no-empty-styled-expression/usage.mdx +19 -14
  15. package/constellation/no-exported-css/usage.mdx +15 -10
  16. package/constellation/no-exported-keyframes/usage.mdx +15 -10
  17. package/constellation/no-html-anchor/usage.mdx +40 -0
  18. package/constellation/no-html-button/usage.mdx +52 -0
  19. package/constellation/no-invalid-css-map/usage.mdx +69 -58
  20. package/constellation/no-keyframes-tagged-template-expression/usage.mdx +24 -18
  21. package/constellation/no-margin/usage.mdx +3 -2
  22. package/constellation/no-nested-styles/usage.mdx +16 -16
  23. package/constellation/no-physical-properties/usage.mdx +13 -13
  24. package/constellation/no-styled-tagged-template-expression/usage.mdx +39 -34
  25. package/constellation/no-unsafe-design-token-usage/usage.mdx +8 -7
  26. package/constellation/no-unsafe-style-overrides/usage.mdx +10 -7
  27. package/constellation/no-unsupported-drag-and-drop-libraries/usage.mdx +8 -2
  28. package/constellation/prefer-primitives/usage.mdx +3 -2
  29. package/constellation/use-button-group-label/usage.mdx +4 -2
  30. package/constellation/use-drawer-label/usage.mdx +4 -2
  31. package/constellation/use-heading/usage.mdx +7 -4
  32. package/constellation/use-heading-level-in-spotlight-card/usage.mdx +3 -2
  33. package/constellation/use-href-in-link-item/usage.mdx +2 -1
  34. package/constellation/use-popup-label/usage.mdx +56 -0
  35. package/constellation/use-primitives/usage.mdx +40 -39
  36. package/constellation/use-primitives-text/usage.mdx +7 -3
  37. package/constellation/use-tokens-space/usage.mdx +7 -3
  38. package/constellation/use-tokens-typography/usage.mdx +15 -6
  39. package/constellation/use-visually-hidden/usage.mdx +2 -1
  40. package/dist/cjs/common/token-maps.partial.js +49 -0
  41. package/dist/cjs/index.codegen.js +1 -1
  42. package/dist/cjs/presets/all.codegen.js +4 -2
  43. package/dist/cjs/presets/recommended.codegen.js +2 -1
  44. package/dist/cjs/rules/index.codegen.js +7 -3
  45. package/dist/cjs/rules/no-html-anchor/index.js +39 -0
  46. package/dist/cjs/rules/no-html-anchor/node-types/index.js +19 -0
  47. package/dist/cjs/rules/no-html-anchor/node-types/jsx-element/index.js +28 -0
  48. package/dist/cjs/rules/no-html-anchor/node-types/styled-component/get-styled-component-call.js +47 -0
  49. package/dist/cjs/rules/no-html-anchor/node-types/styled-component/index.js +37 -0
  50. package/dist/cjs/rules/no-html-anchor/node-types/supported.js +66 -0
  51. package/dist/cjs/rules/no-html-anchor/utils/get-jsx-element-by-name.js +53 -0
  52. package/dist/cjs/rules/no-html-button/index.js +39 -0
  53. package/dist/cjs/rules/no-html-button/node-types/index.js +19 -0
  54. package/dist/cjs/rules/no-html-button/node-types/jsx-element/index.js +28 -0
  55. package/dist/cjs/rules/no-html-button/node-types/styled-component/get-styled-component-call.js +47 -0
  56. package/dist/cjs/rules/no-html-button/node-types/styled-component/index.js +37 -0
  57. package/dist/cjs/rules/no-html-button/node-types/supported.js +79 -0
  58. package/dist/cjs/rules/no-html-button/utils/get-jsx-element-by-name.js +53 -0
  59. package/dist/cjs/rules/use-popup-label/index.js +90 -0
  60. package/dist/es2019/common/token-maps.partial.js +42 -0
  61. package/dist/es2019/index.codegen.js +1 -1
  62. package/dist/es2019/presets/all.codegen.js +4 -2
  63. package/dist/es2019/presets/recommended.codegen.js +2 -1
  64. package/dist/es2019/rules/index.codegen.js +7 -3
  65. package/dist/es2019/rules/no-html-anchor/index.js +33 -0
  66. package/dist/es2019/rules/no-html-anchor/node-types/index.js +2 -0
  67. package/dist/es2019/rules/no-html-anchor/node-types/jsx-element/index.js +20 -0
  68. package/dist/es2019/rules/no-html-anchor/node-types/styled-component/get-styled-component-call.js +42 -0
  69. package/dist/es2019/rules/no-html-anchor/node-types/styled-component/index.js +32 -0
  70. package/dist/es2019/rules/no-html-anchor/node-types/supported.js +56 -0
  71. package/dist/es2019/rules/no-html-anchor/utils/get-jsx-element-by-name.js +39 -0
  72. package/dist/es2019/rules/no-html-button/index.js +33 -0
  73. package/dist/es2019/rules/no-html-button/node-types/index.js +2 -0
  74. package/dist/es2019/rules/no-html-button/node-types/jsx-element/index.js +20 -0
  75. package/dist/es2019/rules/no-html-button/node-types/styled-component/get-styled-component-call.js +42 -0
  76. package/dist/es2019/rules/no-html-button/node-types/styled-component/index.js +32 -0
  77. package/dist/es2019/rules/no-html-button/node-types/supported.js +69 -0
  78. package/dist/es2019/rules/no-html-button/utils/get-jsx-element-by-name.js +39 -0
  79. package/dist/es2019/rules/use-popup-label/index.js +80 -0
  80. package/dist/esm/common/token-maps.partial.js +42 -0
  81. package/dist/esm/index.codegen.js +1 -1
  82. package/dist/esm/presets/all.codegen.js +4 -2
  83. package/dist/esm/presets/recommended.codegen.js +2 -1
  84. package/dist/esm/rules/index.codegen.js +7 -3
  85. package/dist/esm/rules/no-html-anchor/index.js +33 -0
  86. package/dist/esm/rules/no-html-anchor/node-types/index.js +2 -0
  87. package/dist/esm/rules/no-html-anchor/node-types/jsx-element/index.js +19 -0
  88. package/dist/esm/rules/no-html-anchor/node-types/styled-component/get-styled-component-call.js +42 -0
  89. package/dist/esm/rules/no-html-anchor/node-types/styled-component/index.js +31 -0
  90. package/dist/esm/rules/no-html-anchor/node-types/supported.js +57 -0
  91. package/dist/esm/rules/no-html-anchor/utils/get-jsx-element-by-name.js +47 -0
  92. package/dist/esm/rules/no-html-button/index.js +33 -0
  93. package/dist/esm/rules/no-html-button/node-types/index.js +2 -0
  94. package/dist/esm/rules/no-html-button/node-types/jsx-element/index.js +19 -0
  95. package/dist/esm/rules/no-html-button/node-types/styled-component/get-styled-component-call.js +42 -0
  96. package/dist/esm/rules/no-html-button/node-types/styled-component/index.js +31 -0
  97. package/dist/esm/rules/no-html-button/node-types/supported.js +70 -0
  98. package/dist/esm/rules/no-html-button/utils/get-jsx-element-by-name.js +47 -0
  99. package/dist/esm/rules/use-popup-label/index.js +84 -0
  100. package/dist/types/common/token-maps.partial.d.ts +65 -0
  101. package/dist/types/index.codegen.d.ts +4 -1
  102. package/dist/types/presets/all.codegen.d.ts +4 -2
  103. package/dist/types/presets/recommended.codegen.d.ts +2 -1
  104. package/dist/types/rules/index.codegen.d.ts +3 -1
  105. package/dist/types/rules/no-html-anchor/index.d.ts +3 -0
  106. package/dist/types/rules/no-html-anchor/node-types/index.d.ts +2 -0
  107. package/dist/types/rules/no-html-anchor/node-types/jsx-element/index.d.ts +8 -0
  108. package/dist/types/rules/no-html-anchor/node-types/styled-component/get-styled-component-call.d.ts +6 -0
  109. package/dist/types/rules/no-html-anchor/node-types/styled-component/index.d.ts +8 -0
  110. package/dist/types/rules/no-html-anchor/node-types/supported.d.ts +7 -0
  111. package/dist/types/rules/no-html-anchor/utils/get-jsx-element-by-name.d.ts +6 -0
  112. package/dist/types/rules/no-html-button/index.d.ts +3 -0
  113. package/dist/types/rules/no-html-button/node-types/index.d.ts +2 -0
  114. package/dist/types/rules/no-html-button/node-types/jsx-element/index.d.ts +8 -0
  115. package/dist/types/rules/no-html-button/node-types/styled-component/get-styled-component-call.d.ts +6 -0
  116. package/dist/types/rules/no-html-button/node-types/styled-component/index.d.ts +8 -0
  117. package/dist/types/rules/no-html-button/node-types/supported.d.ts +7 -0
  118. package/dist/types/rules/no-html-button/utils/get-jsx-element-by-name.d.ts +6 -0
  119. package/dist/types/rules/use-popup-label/index.d.ts +3 -0
  120. package/dist/types/rules/use-tokens-typography/utils.d.ts +0 -33
  121. package/dist/types-ts4.5/common/token-maps.partial.d.ts +65 -0
  122. package/dist/types-ts4.5/index.codegen.d.ts +4 -1
  123. package/dist/types-ts4.5/presets/all.codegen.d.ts +4 -2
  124. package/dist/types-ts4.5/presets/recommended.codegen.d.ts +2 -1
  125. package/dist/types-ts4.5/rules/index.codegen.d.ts +3 -1
  126. package/dist/types-ts4.5/rules/no-html-anchor/node-types/index.d.ts +2 -0
  127. package/dist/types-ts4.5/rules/no-html-anchor/node-types/jsx-element/index.d.ts +8 -0
  128. package/dist/types-ts4.5/rules/no-html-anchor/node-types/styled-component/get-styled-component-call.d.ts +6 -0
  129. package/dist/types-ts4.5/rules/no-html-anchor/node-types/styled-component/index.d.ts +8 -0
  130. package/dist/types-ts4.5/rules/no-html-anchor/node-types/supported.d.ts +7 -0
  131. package/dist/types-ts4.5/rules/no-html-anchor/utils/get-jsx-element-by-name.d.ts +6 -0
  132. package/dist/types-ts4.5/rules/no-html-button/node-types/index.d.ts +2 -0
  133. package/dist/types-ts4.5/rules/no-html-button/node-types/jsx-element/index.d.ts +8 -0
  134. package/dist/types-ts4.5/rules/no-html-button/node-types/styled-component/get-styled-component-call.d.ts +6 -0
  135. package/dist/types-ts4.5/rules/no-html-button/node-types/styled-component/index.d.ts +8 -0
  136. package/dist/types-ts4.5/rules/no-html-button/node-types/supported.d.ts +7 -0
  137. package/dist/types-ts4.5/rules/no-html-button/utils/get-jsx-element-by-name.d.ts +6 -0
  138. package/dist/types-ts4.5/rules/use-popup-label/index.d.ts +3 -0
  139. package/dist/types-ts4.5/rules/use-tokens-typography/utils.d.ts +0 -33
  140. package/package.json +4 -3
  141. package/constellation/no-html-button-element/usage.mdx +0 -26
  142. package/dist/cjs/rules/no-html-button-element/index.js +0 -107
  143. package/dist/cjs/rules/no-html-button-element/utils.js +0 -18
  144. package/dist/es2019/rules/no-html-button-element/index.js +0 -101
  145. package/dist/es2019/rules/no-html-button-element/utils.js +0 -12
  146. package/dist/esm/rules/no-html-button-element/index.js +0 -101
  147. package/dist/esm/rules/no-html-button-element/utils.js +0 -12
  148. package/dist/types/rules/no-html-button-element/utils.d.ts +0 -2
  149. package/dist/types-ts4.5/rules/no-html-button-element/utils.d.ts +0 -2
  150. /package/dist/types-ts4.5/rules/{no-html-button-element → no-html-anchor}/index.d.ts +0 -0
  151. /package/dist/{types/rules/no-html-button-element → types-ts4.5/rules/no-html-button}/index.d.ts +0 -0
@@ -0,0 +1,79 @@
1
+ "use strict";
2
+
3
+ var _typeof = require("@babel/runtime/helpers/typeof");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.isSupportedForLint = isSupportedForLint;
8
+ var _eslintCodemodUtils = require("eslint-codemod-utils");
9
+ var ast = _interopRequireWildcard(require("../../../ast-nodes"));
10
+ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
11
+ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
12
+ var supportedElements = [{
13
+ name: 'button'
14
+ }, {
15
+ name: 'input',
16
+ attributes: [{
17
+ name: 'type',
18
+ // Values from https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/button_role#best_practices
19
+ values: ['submit', 'reset', 'button', 'image']
20
+ }]
21
+ }, {
22
+ name: '*',
23
+ attributes: [{
24
+ name: 'role',
25
+ values: ['button']
26
+ }]
27
+ }];
28
+
29
+ /**
30
+ * Determines if the given JSX element is a supported element to lint with this rule.
31
+ */
32
+ function isSupportedForLint(jsxNode, elementName) {
33
+ if (!(0, _eslintCodemodUtils.isNodeOfType)(jsxNode, 'JSXElement')) {
34
+ return false;
35
+ }
36
+
37
+ // Allow passing in the element name because the jsxNode doesn't
38
+ // represent the element name with styled components
39
+ var elName = elementName || ast.JSXElement.getName(jsxNode);
40
+ if (!elName) {
41
+ return false;
42
+ }
43
+
44
+ // Only check native HTML elements, not components
45
+ if (elName[0] !== elName[0].toLowerCase()) {
46
+ return false;
47
+ }
48
+ var supportedElement = supportedElements.find(function (_ref) {
49
+ var name = _ref.name;
50
+ return name === elName;
51
+ });
52
+ if (!supportedElement) {
53
+ supportedElement = supportedElements.find(function (_ref2) {
54
+ var name = _ref2.name;
55
+ return name === '*';
56
+ });
57
+ }
58
+ if (!supportedElement) {
59
+ return false;
60
+ }
61
+
62
+ // Check if the element has any attributes that are not supported
63
+ var attributes = ast.JSXElement.getAttributes(jsxNode);
64
+ if (supportedElement.attributes && !supportedElement.attributes.every(function (_ref3) {
65
+ var name = _ref3.name,
66
+ values = _ref3.values;
67
+ return attributes.some(function (attribute) {
68
+ if (attribute.type === 'JSXSpreadAttribute') {
69
+ return false;
70
+ }
71
+ var isMatchingName = attribute.name.name === name;
72
+ var isMatchingValues = values && attribute.value && attribute.value.type === 'Literal' && typeof attribute.value.value === 'string' && (values === null || values === void 0 ? void 0 : values.includes(attribute.value.value));
73
+ return isMatchingName && isMatchingValues;
74
+ });
75
+ })) {
76
+ return false;
77
+ }
78
+ return true;
79
+ }
@@ -0,0 +1,53 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.getJsxElementByName = void 0;
8
+ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
9
+ var _eslintCodemodUtils = require("eslint-codemod-utils");
10
+ /**
11
+ * Given a component name finds its JSX usage
12
+ */
13
+ var getJsxElementByName = exports.getJsxElementByName = function getJsxElementByName(componentName, scope) {
14
+ var _variableDeclaration$;
15
+ var variableDeclaration = scope.variables.find(function (v) {
16
+ return v.name === componentName;
17
+ });
18
+ if (!variableDeclaration) {
19
+ return;
20
+ }
21
+
22
+ // length here should be exactly 2 to indicate only two references:
23
+ // one being the variable declaration itself
24
+ // second being the JSX call site
25
+ // we might consider handling multiple local JSX call sites in the future
26
+ // but "this is good enough for now"™️
27
+ if (variableDeclaration.references.length !== 2) {
28
+ return;
29
+ }
30
+ var jsxUsage = (_variableDeclaration$ = variableDeclaration.references[1]) === null || _variableDeclaration$ === void 0 ? void 0 : _variableDeclaration$.identifier;
31
+ var _variableDeclaration$2 = variableDeclaration.references.map(function (ref) {
32
+ return ref === null || ref === void 0 ? void 0 : ref.identifier;
33
+ }),
34
+ _variableDeclaration$3 = (0, _slicedToArray2.default)(_variableDeclaration$2, 2),
35
+ firstIdentifier = _variableDeclaration$3[0],
36
+ secondIdentifier = _variableDeclaration$3[1];
37
+ // Check if the first reference is a JSXOpeningElement and the second is not or vice versa
38
+ if ((0, _eslintCodemodUtils.isNodeOfType)(firstIdentifier, 'JSXIdentifier') && !(0, _eslintCodemodUtils.isNodeOfType)(secondIdentifier, 'JSXIdentifier')) {
39
+ jsxUsage = firstIdentifier;
40
+ } else if ((0, _eslintCodemodUtils.isNodeOfType)(secondIdentifier, 'JSXIdentifier') && !(0, _eslintCodemodUtils.isNodeOfType)(firstIdentifier, 'JSXIdentifier')) {
41
+ jsxUsage = secondIdentifier;
42
+ } else {
43
+ return;
44
+ }
45
+ if (!(0, _eslintCodemodUtils.isNodeOfType)(jsxUsage, 'JSXIdentifier')) {
46
+ return;
47
+ }
48
+ var jsxOpeningElement = jsxUsage.parent;
49
+ if (!(0, _eslintCodemodUtils.isNodeOfType)(jsxOpeningElement, 'JSXOpeningElement')) {
50
+ return;
51
+ }
52
+ return jsxOpeningElement;
53
+ };
@@ -0,0 +1,90 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ var _eslintCodemodUtils = require("eslint-codemod-utils");
8
+ var _createRule = require("../utils/create-rule");
9
+ // eslint-disable-next-line import/no-extraneous-dependencies
10
+
11
+ var elementsAccessibleNameProps = ['label', 'titleId'];
12
+ var rule = (0, _createRule.createLintRule)({
13
+ meta: {
14
+ name: 'use-popup-label',
15
+ type: 'suggestion',
16
+ docs: {
17
+ description: 'Encourages to provide accessible name for Atlassian Design System Popup component.',
18
+ recommended: true,
19
+ severity: 'warn'
20
+ },
21
+ messages: {
22
+ missingLabelProp: 'Missing accessible name. If there is no visible content to associate use `label` prop, otherwise pass id of element to `titleId` prop to be associated as label.',
23
+ labelPropShouldHaveContents: 'Define string that labels the interactive element.',
24
+ titleIdShouldHaveValue: '`titleId` should reference the id of element that define accessible name.',
25
+ noBothPropsUsage: 'Do not include both `titleId` and `label` properties. Use `titleId` if the label text is available in the DOM to reference it, otherwise use `label` to provide accessible name explicitly.'
26
+ },
27
+ hasSuggestions: true
28
+ },
29
+ create: function create(context) {
30
+ var contextLocalIdentifier = [];
31
+ return {
32
+ ImportDeclaration: function ImportDeclaration(node) {
33
+ if (node.source.value === '@atlaskit/popup') {
34
+ if (node.specifiers.length) {
35
+ var defaultImport = node.specifiers.filter(function (spec) {
36
+ return spec.type === 'ImportDefaultSpecifier';
37
+ });
38
+ if (defaultImport.length) {
39
+ var local = defaultImport[0].local;
40
+ contextLocalIdentifier.push(local.name);
41
+ }
42
+ }
43
+ }
44
+ },
45
+ JSXElement: function JSXElement(node) {
46
+ if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'JSXElement')) {
47
+ return;
48
+ }
49
+ if (!(0, _eslintCodemodUtils.isNodeOfType)(node.openingElement.name, 'JSXIdentifier')) {
50
+ return;
51
+ }
52
+ var name = node.openingElement.name.name;
53
+ if (contextLocalIdentifier.includes(name)) {
54
+ var componentRoleDialogProp = node.openingElement.attributes.find(function (attr) {
55
+ return (0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXAttribute') && (0, _eslintCodemodUtils.isNodeOfType)(attr.name, 'JSXIdentifier') && attr.value && (0, _eslintCodemodUtils.isNodeOfType)(attr.value, 'Literal') && attr.name.name === 'role' && attr.value.value === 'dialog';
56
+ });
57
+ var componentLabelProps = node.openingElement.attributes.filter(function (attr) {
58
+ return (0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXAttribute') && (0, _eslintCodemodUtils.isNodeOfType)(attr.name, 'JSXIdentifier') && elementsAccessibleNameProps.includes(attr.name.name);
59
+ });
60
+ if (componentLabelProps.length === 1) {
61
+ var prop = componentLabelProps[0];
62
+ if ('value' in prop && prop.value) {
63
+ if ((0, _eslintCodemodUtils.isNodeOfType)(prop.value, 'Literal') && !prop.value.value || (0, _eslintCodemodUtils.isNodeOfType)(prop.value, 'JSXExpressionContainer') && !prop.value.expression) {
64
+ context.report({
65
+ node: prop,
66
+ messageId: prop.name.name === 'label' ? 'labelPropShouldHaveContents' : 'titleIdShouldHaveValue'
67
+ });
68
+ }
69
+ }
70
+ } else if (componentLabelProps.length > 1) {
71
+ context.report({
72
+ node: node.openingElement,
73
+ messageId: 'noBothPropsUsage'
74
+ });
75
+ } else {
76
+ if (componentRoleDialogProp) {
77
+ context.report({
78
+ node: node.openingElement,
79
+ messageId: 'missingLabelProp'
80
+ });
81
+ } else {
82
+ return;
83
+ }
84
+ }
85
+ }
86
+ }
87
+ };
88
+ }
89
+ });
90
+ var _default = exports.default = rule;
@@ -0,0 +1,42 @@
1
+ /**
2
+ * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
+ * @codegen <<SignedSource::30c84f908843af1f250860b6f3deeea0>>
4
+ * @codegenId spacing
5
+ * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen-token-maps
6
+ * @codegenDependency ../../../tokens/src/artifacts/tokens-raw/atlassian-spacing.tsx <<SignedSource::55622b91aca9b3afac4bce440f222b71>>
7
+ */
8
+ export const positiveSpaceMap = {
9
+ '0px': 'space.0',
10
+ '2px': 'space.025',
11
+ '4px': 'space.050',
12
+ '6px': 'space.075',
13
+ '8px': 'space.100',
14
+ '12px': 'space.150',
15
+ '16px': 'space.200',
16
+ '20px': 'space.250',
17
+ '24px': 'space.300',
18
+ '32px': 'space.400',
19
+ '40px': 'space.500',
20
+ '48px': 'space.600',
21
+ '64px': 'space.800',
22
+ '80px': 'space.1000'
23
+ };
24
+ export const negativeSpaceMap = {
25
+ '-2px': 'space.negative.025',
26
+ '-4px': 'space.negative.050',
27
+ '-6px': 'space.negative.075',
28
+ '-8px': 'space.negative.100',
29
+ '-12px': 'space.negative.150',
30
+ '-16px': 'space.negative.200',
31
+ '-20px': 'space.negative.250',
32
+ '-24px': 'space.negative.300',
33
+ '-32px': 'space.negative.400'
34
+ };
35
+ export const allSpaceMap = {
36
+ ...positiveSpaceMap,
37
+ ...negativeSpaceMap
38
+ };
39
+
40
+ /**
41
+ * @codegenEnd
42
+ */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
- * @codegen <<SignedSource::11fe367c1ab4107f7418a84fa435cc23>>
3
+ * @codegen <<SignedSource::a1bb0f17560603fa4895326b1d50744e>>
4
4
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
5
5
  */
6
6
  import all from './presets/all.codegen';
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
- * @codegen <<SignedSource::1ab11547db880eba1206f334a9b2150f>>
3
+ * @codegen <<SignedSource::0be7639a95bf4c9bbfe00154d8193477>>
4
4
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
5
5
  */
6
6
  export default {
@@ -19,7 +19,8 @@ export default {
19
19
  '@atlaskit/design-system/no-empty-styled-expression': 'warn',
20
20
  '@atlaskit/design-system/no-exported-css': 'warn',
21
21
  '@atlaskit/design-system/no-exported-keyframes': 'warn',
22
- '@atlaskit/design-system/no-html-button-element': 'warn',
22
+ '@atlaskit/design-system/no-html-anchor': 'warn',
23
+ '@atlaskit/design-system/no-html-button': 'warn',
23
24
  '@atlaskit/design-system/no-invalid-css-map': 'error',
24
25
  '@atlaskit/design-system/no-keyframes-tagged-template-expression': 'error',
25
26
  '@atlaskit/design-system/no-margin': 'warn',
@@ -35,6 +36,7 @@ export default {
35
36
  '@atlaskit/design-system/use-heading': 'warn',
36
37
  '@atlaskit/design-system/use-heading-level-in-spotlight-card': 'warn',
37
38
  '@atlaskit/design-system/use-href-in-link-item': 'warn',
39
+ '@atlaskit/design-system/use-popup-label': 'warn',
38
40
  '@atlaskit/design-system/use-primitives': 'warn',
39
41
  '@atlaskit/design-system/use-primitives-text': 'warn',
40
42
  '@atlaskit/design-system/use-tokens-space': 'error',
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
- * @codegen <<SignedSource::05b4fe8f97edc4f7e46ded52b4917037>>
3
+ * @codegen <<SignedSource::73a3666b244b58cc221eebcda071161d>>
4
4
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
5
5
  */
6
6
  export default {
@@ -26,6 +26,7 @@ export default {
26
26
  '@atlaskit/design-system/use-drawer-label': 'warn',
27
27
  '@atlaskit/design-system/use-heading-level-in-spotlight-card': 'warn',
28
28
  '@atlaskit/design-system/use-href-in-link-item': 'warn',
29
+ '@atlaskit/design-system/use-popup-label': 'warn',
29
30
  '@atlaskit/design-system/use-visually-hidden': 'error'
30
31
  }
31
32
  };
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
- * @codegen <<SignedSource::293575f7bd0150862f792e3fffc286c4>>
3
+ * @codegen <<SignedSource::9b934590b0ff7880e962fa4dd73bdb0b>>
4
4
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
5
5
  */
6
6
  import consistentCssPropUsage from './consistent-css-prop-usage';
@@ -16,7 +16,8 @@ import noDirectUseOfWebPlatformDragAndDrop from './no-direct-use-of-web-platform
16
16
  import noEmptyStyledExpression from './no-empty-styled-expression';
17
17
  import noExportedCss from './no-exported-css';
18
18
  import noExportedKeyframes from './no-exported-keyframes';
19
- import noHtmlButtonElement from './no-html-button-element';
19
+ import noHtmlAnchor from './no-html-anchor';
20
+ import noHtmlButton from './no-html-button';
20
21
  import noInvalidCssMap from './no-invalid-css-map';
21
22
  import noKeyframesTaggedTemplateExpression from './no-keyframes-tagged-template-expression';
22
23
  import noMargin from './no-margin';
@@ -32,6 +33,7 @@ import useDrawerLabel from './use-drawer-label';
32
33
  import useHeading from './use-heading';
33
34
  import useHeadingLevelInSpotlightCard from './use-heading-level-in-spotlight-card';
34
35
  import useHrefInLinkItem from './use-href-in-link-item';
36
+ import usePopupLabel from './use-popup-label';
35
37
  import usePrimitives from './use-primitives';
36
38
  import usePrimitivesText from './use-primitives-text';
37
39
  import useTokensSpace from './use-tokens-space';
@@ -51,7 +53,8 @@ export default {
51
53
  'no-empty-styled-expression': noEmptyStyledExpression,
52
54
  'no-exported-css': noExportedCss,
53
55
  'no-exported-keyframes': noExportedKeyframes,
54
- 'no-html-button-element': noHtmlButtonElement,
56
+ 'no-html-anchor': noHtmlAnchor,
57
+ 'no-html-button': noHtmlButton,
55
58
  'no-invalid-css-map': noInvalidCssMap,
56
59
  'no-keyframes-tagged-template-expression': noKeyframesTaggedTemplateExpression,
57
60
  'no-margin': noMargin,
@@ -67,6 +70,7 @@ export default {
67
70
  'use-heading': useHeading,
68
71
  'use-heading-level-in-spotlight-card': useHeadingLevelInSpotlightCard,
69
72
  'use-href-in-link-item': useHrefInLinkItem,
73
+ 'use-popup-label': usePopupLabel,
70
74
  'use-primitives': usePrimitives,
71
75
  'use-primitives-text': usePrimitivesText,
72
76
  'use-tokens-space': useTokensSpace,
@@ -0,0 +1,33 @@
1
+ import { createLintRule } from '../utils/create-rule';
2
+ import { JSXElement, StyledComponent } from './node-types';
3
+ const rule = createLintRule({
4
+ meta: {
5
+ name: 'no-html-anchor',
6
+ type: 'suggestion',
7
+ docs: {
8
+ description: 'Discourage direct usage of HTML anchor elements in favor of Atlassian Design System link components.',
9
+ recommended: false,
10
+ severity: 'warn'
11
+ },
12
+ messages: {
13
+ noHtmlAnchor: `This <{{ name }}> should be replaced with a link component from the Atlassian Design System, such as the "Link" or "LinkButton" component when suitable. For custom links use the "Anchor" primitive. ADS links include event tracking, automatic router configuration, ensure accessible implementations, and provide access to ADS styling features like design tokens.`
14
+ }
15
+ },
16
+ create(context) {
17
+ return {
18
+ // transforms styled.<anchor>(...) usages
19
+ CallExpression(node) {
20
+ StyledComponent.lint(node, {
21
+ context
22
+ });
23
+ },
24
+ // transforms <anchor css={...}> usages
25
+ JSXElement(node) {
26
+ JSXElement.lint(node, {
27
+ context
28
+ });
29
+ }
30
+ };
31
+ }
32
+ });
33
+ export default rule;
@@ -0,0 +1,2 @@
1
+ export { StyledComponent } from './styled-component';
2
+ export { JSXElement } from './jsx-element';
@@ -0,0 +1,20 @@
1
+ /* eslint-disable @repo/internal/react/require-jsdoc */
2
+
3
+ import * as ast from '../../../../ast-nodes';
4
+ import { isSupportedForLint } from '../supported';
5
+ export const JSXElement = {
6
+ lint(node, {
7
+ context
8
+ }) {
9
+ if (!isSupportedForLint(node)) {
10
+ return;
11
+ }
12
+ context.report({
13
+ node: node.openingElement,
14
+ messageId: 'noHtmlAnchor',
15
+ data: {
16
+ name: ast.JSXElement.getName(node)
17
+ }
18
+ });
19
+ }
20
+ };
@@ -0,0 +1,42 @@
1
+ import { closestOfType, isNodeOfType } from 'eslint-codemod-utils';
2
+
3
+ /**
4
+ * Returns a styled component
5
+ */
6
+
7
+ export const getStyledComponentCall = node => {
8
+ // halts unless we are dealing with a styled component
9
+ if (!isStyledCallExpression(node)) {
10
+ return;
11
+ }
12
+ // halts if the component is being exported directly
13
+ if (closestOfType(node, 'ExportNamedDeclaration')) {
14
+ return;
15
+ }
16
+ const styledComponentVariableRef = node.parent;
17
+ // halts if the styled component is not assigned to a variable immediately
18
+ if (!isNodeOfType(styledComponentVariableRef, 'VariableDeclarator')) {
19
+ return;
20
+ }
21
+ return styledComponentVariableRef;
22
+ };
23
+
24
+ /**
25
+ * Some verbose precondition checks but all it does is check
26
+ * a call expression is of form `styled.a` or `styled2.a`
27
+ */
28
+ const isStyledCallExpression = call => {
29
+ if (!isNodeOfType(call, 'CallExpression')) {
30
+ return false;
31
+ }
32
+ if (!isNodeOfType(call.callee, 'MemberExpression')) {
33
+ return false;
34
+ }
35
+ if (!isNodeOfType(call.callee.object, 'Identifier') || !isNodeOfType(call.callee.property, 'Identifier')) {
36
+ return false;
37
+ }
38
+ if (/^styled2?$/.test(call.callee.object.name)) {
39
+ return true;
40
+ }
41
+ return false;
42
+ };
@@ -0,0 +1,32 @@
1
+ /* eslint-disable @repo/internal/react/require-jsdoc */
2
+
3
+ import { isNodeOfType } from 'eslint-codemod-utils';
4
+ import { getJsxElementByName } from '../../utils/get-jsx-element-by-name';
5
+ import { isSupportedForLint } from '../supported';
6
+ import { getStyledComponentCall } from './get-styled-component-call';
7
+ export const StyledComponent = {
8
+ lint(node, {
9
+ context
10
+ }) {
11
+ var _getJsxElementByName;
12
+ if (!isNodeOfType(node, 'CallExpression') || !isNodeOfType(node.callee, 'MemberExpression') || !isNodeOfType(node.callee.object, 'Identifier') || !isNodeOfType(node.callee.property, 'Identifier')) {
13
+ return;
14
+ }
15
+ const styles = getStyledComponentCall(node);
16
+ const elementName = node.callee.property.name;
17
+ if (!styles || !isNodeOfType(styles.id, 'Identifier')) {
18
+ return;
19
+ }
20
+ const jsxElement = (_getJsxElementByName = getJsxElementByName(styles.id.name, context.getScope())) === null || _getJsxElementByName === void 0 ? void 0 : _getJsxElementByName.parent;
21
+ if (jsxElement && !isSupportedForLint(jsxElement, elementName)) {
22
+ return;
23
+ }
24
+ context.report({
25
+ node: styles,
26
+ messageId: 'noHtmlAnchor',
27
+ data: {
28
+ name: node.callee.property.name
29
+ }
30
+ });
31
+ }
32
+ };
@@ -0,0 +1,56 @@
1
+ import { isNodeOfType } from 'eslint-codemod-utils';
2
+ import * as ast from '../../../ast-nodes';
3
+ const supportedElements = [{
4
+ name: 'a'
5
+ }];
6
+
7
+ /**
8
+ * Determines if the given JSX element is a supported element to lint with this rule.
9
+ */
10
+ export function isSupportedForLint(jsxNode, elementName) {
11
+ if (!isNodeOfType(jsxNode, 'JSXElement')) {
12
+ return false;
13
+ }
14
+
15
+ // Allow passing in the element name because the jsxNode doesn't
16
+ // represent the element name with styled components
17
+ const elName = elementName || ast.JSXElement.getName(jsxNode);
18
+ if (!elName) {
19
+ return false;
20
+ }
21
+
22
+ // Only check native HTML elements, not components
23
+ if (elName[0] !== elName[0].toLowerCase()) {
24
+ return false;
25
+ }
26
+ let supportedElement = supportedElements.find(({
27
+ name
28
+ }) => name === elName);
29
+ if (!supportedElement) {
30
+ supportedElement = supportedElements.find(({
31
+ name
32
+ }) => name === '*');
33
+ }
34
+ if (!supportedElement) {
35
+ return false;
36
+ }
37
+
38
+ // Check if the element has any attributes that are not supported
39
+ const attributes = ast.JSXElement.getAttributes(jsxNode);
40
+ if (supportedElement.attributes && !supportedElement.attributes.every(({
41
+ name,
42
+ values
43
+ }) => {
44
+ return attributes.some(attribute => {
45
+ if (attribute.type === 'JSXSpreadAttribute') {
46
+ return false;
47
+ }
48
+ const isMatchingName = attribute.name.name === name;
49
+ const isMatchingValues = values && attribute.value && attribute.value.type === 'Literal' && typeof attribute.value.value === 'string' && (values === null || values === void 0 ? void 0 : values.includes(attribute.value.value));
50
+ return isMatchingName && isMatchingValues;
51
+ });
52
+ })) {
53
+ return false;
54
+ }
55
+ return true;
56
+ }
@@ -0,0 +1,39 @@
1
+ import { isNodeOfType } from 'eslint-codemod-utils';
2
+
3
+ /**
4
+ * Given a component name finds its JSX usage
5
+ */
6
+ export const getJsxElementByName = (componentName, scope) => {
7
+ var _variableDeclaration$;
8
+ const variableDeclaration = scope.variables.find(v => v.name === componentName);
9
+ if (!variableDeclaration) {
10
+ return;
11
+ }
12
+
13
+ // length here should be exactly 2 to indicate only two references:
14
+ // one being the variable declaration itself
15
+ // second being the JSX call site
16
+ // we might consider handling multiple local JSX call sites in the future
17
+ // but "this is good enough for now"™️
18
+ if (variableDeclaration.references.length !== 2) {
19
+ return;
20
+ }
21
+ let jsxUsage = (_variableDeclaration$ = variableDeclaration.references[1]) === null || _variableDeclaration$ === void 0 ? void 0 : _variableDeclaration$.identifier;
22
+ const [firstIdentifier, secondIdentifier] = variableDeclaration.references.map(ref => ref === null || ref === void 0 ? void 0 : ref.identifier);
23
+ // Check if the first reference is a JSXOpeningElement and the second is not or vice versa
24
+ if (isNodeOfType(firstIdentifier, 'JSXIdentifier') && !isNodeOfType(secondIdentifier, 'JSXIdentifier')) {
25
+ jsxUsage = firstIdentifier;
26
+ } else if (isNodeOfType(secondIdentifier, 'JSXIdentifier') && !isNodeOfType(firstIdentifier, 'JSXIdentifier')) {
27
+ jsxUsage = secondIdentifier;
28
+ } else {
29
+ return;
30
+ }
31
+ if (!isNodeOfType(jsxUsage, 'JSXIdentifier')) {
32
+ return;
33
+ }
34
+ const jsxOpeningElement = jsxUsage.parent;
35
+ if (!isNodeOfType(jsxOpeningElement, 'JSXOpeningElement')) {
36
+ return;
37
+ }
38
+ return jsxOpeningElement;
39
+ };
@@ -0,0 +1,33 @@
1
+ import { createLintRule } from '../utils/create-rule';
2
+ import { JSXElement, StyledComponent } from './node-types';
3
+ const rule = createLintRule({
4
+ meta: {
5
+ name: 'no-html-button',
6
+ type: 'suggestion',
7
+ docs: {
8
+ description: 'Discourage direct usage of HTML button elements in favor of Atlassian Design System button components.',
9
+ recommended: false,
10
+ severity: 'warn'
11
+ },
12
+ messages: {
13
+ noHtmlButton: `This {{ name }} should be replaced with a button component from the Atlassian Design System, such as the "Button" component when suitable. For custom buttons use the "Pressable" primitive. ADS buttons include event tracking, ensure accessible implementations, and provide access to ADS styling features like design tokens.`
14
+ }
15
+ },
16
+ create(context) {
17
+ return {
18
+ // transforms styled.<button>(...) usages
19
+ CallExpression(node) {
20
+ StyledComponent.lint(node, {
21
+ context
22
+ });
23
+ },
24
+ // transforms <button css={...}> usages
25
+ JSXElement(node) {
26
+ JSXElement.lint(node, {
27
+ context
28
+ });
29
+ }
30
+ };
31
+ }
32
+ });
33
+ export default rule;
@@ -0,0 +1,2 @@
1
+ export { StyledComponent } from './styled-component';
2
+ export { JSXElement } from './jsx-element';
@@ -0,0 +1,20 @@
1
+ /* eslint-disable @repo/internal/react/require-jsdoc */
2
+
3
+ import * as ast from '../../../../ast-nodes';
4
+ import { isSupportedForLint } from '../supported';
5
+ export const JSXElement = {
6
+ lint(node, {
7
+ context
8
+ }) {
9
+ if (!isSupportedForLint(node)) {
10
+ return;
11
+ }
12
+ context.report({
13
+ node: node.openingElement,
14
+ messageId: 'noHtmlButton',
15
+ data: {
16
+ name: ast.JSXElement.getName(node)
17
+ }
18
+ });
19
+ }
20
+ };