@atlaskit/eslint-plugin-ui-styling-standard 0.3.0 → 0.4.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 (80) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +18 -5
  3. package/build/tsconfig.json +2 -4
  4. package/constellation/consistent-css-prop-usage/usage.mdx +5 -0
  5. package/constellation/index/overview.mdx +21 -0
  6. package/constellation/local-cx-xcss/usage.mdx +37 -0
  7. package/constellation/no-css-tagged-template-expression/usage.mdx +5 -0
  8. package/constellation/no-empty-styled-expression/usage.mdx +5 -0
  9. package/constellation/no-exported-css/usage.mdx +5 -0
  10. package/constellation/no-exported-keyframes/usage.mdx +5 -0
  11. package/constellation/no-invalid-css-map/usage.mdx +5 -0
  12. package/constellation/no-js-xcss/usage.mdx +23 -0
  13. package/constellation/no-keyframes-tagged-template-expression/usage.mdx +5 -0
  14. package/constellation/no-styled-tagged-template-expression/usage.mdx +5 -0
  15. package/constellation/no-suppress-xcss/usage.mdx +25 -0
  16. package/dist/cjs/index.codegen.js +26 -0
  17. package/dist/cjs/index.js +12 -33
  18. package/dist/cjs/presets/all.codegen.js +37 -0
  19. package/dist/cjs/presets/recommended.codegen.js +37 -0
  20. package/dist/cjs/rules/external-rules.js +143 -0
  21. package/dist/cjs/rules/index.codegen.js +16 -0
  22. package/dist/cjs/rules/local-cx-xcss/index.js +51 -0
  23. package/dist/cjs/rules/utils/create-rule.js +43 -0
  24. package/dist/cjs/rules/utils/is-supported-import.js +98 -0
  25. package/dist/es2019/index.codegen.js +12 -0
  26. package/dist/es2019/index.js +1 -33
  27. package/dist/es2019/presets/all.codegen.js +31 -0
  28. package/dist/es2019/presets/recommended.codegen.js +31 -0
  29. package/dist/es2019/rules/external-rules.js +138 -0
  30. package/dist/es2019/rules/index.codegen.js +9 -0
  31. package/dist/es2019/rules/local-cx-xcss/index.js +45 -0
  32. package/dist/es2019/rules/utils/create-rule.js +33 -0
  33. package/dist/es2019/rules/utils/is-supported-import.js +87 -0
  34. package/dist/esm/index.codegen.js +12 -0
  35. package/dist/esm/index.js +1 -33
  36. package/dist/esm/presets/all.codegen.js +31 -0
  37. package/dist/esm/presets/recommended.codegen.js +31 -0
  38. package/dist/esm/rules/external-rules.js +138 -0
  39. package/dist/esm/rules/index.codegen.js +9 -0
  40. package/dist/esm/rules/local-cx-xcss/index.js +45 -0
  41. package/dist/esm/rules/utils/create-rule.js +35 -0
  42. package/dist/esm/rules/utils/is-supported-import.js +90 -0
  43. package/dist/types/index.codegen.d.ts +55 -0
  44. package/dist/types/index.d.ts +1 -0
  45. package/dist/types/presets/all.codegen.d.ts +32 -0
  46. package/dist/types/presets/recommended.codegen.d.ts +32 -0
  47. package/dist/types/rules/external-rules.d.ts +11 -0
  48. package/dist/types/rules/index.codegen.d.ts +4 -0
  49. package/dist/types/rules/local-cx-xcss/index.d.ts +3 -0
  50. package/dist/types/rules/utils/create-rule.d.ts +64 -0
  51. package/dist/types/rules/utils/is-supported-import.d.ts +34 -0
  52. package/dist/types-ts4.5/index.codegen.d.ts +55 -0
  53. package/dist/types-ts4.5/index.d.ts +1 -0
  54. package/dist/types-ts4.5/presets/all.codegen.d.ts +32 -0
  55. package/dist/types-ts4.5/presets/recommended.codegen.d.ts +32 -0
  56. package/dist/types-ts4.5/rules/external-rules.d.ts +11 -0
  57. package/dist/types-ts4.5/rules/index.codegen.d.ts +4 -0
  58. package/dist/types-ts4.5/rules/local-cx-xcss/index.d.ts +3 -0
  59. package/dist/types-ts4.5/rules/utils/create-rule.d.ts +64 -0
  60. package/dist/types-ts4.5/rules/utils/is-supported-import.d.ts +34 -0
  61. package/package.json +13 -4
  62. package/scripts/codegen.tsx +439 -0
  63. package/src/index.codegen.tsx +14 -0
  64. package/src/index.tsx +1 -51
  65. package/src/presets/all.codegen.tsx +67 -0
  66. package/src/presets/recommended.codegen.tsx +67 -0
  67. package/src/rules/TEMPLATE.md +29 -0
  68. package/src/rules/__tests__/utils/_tester.tsx +40 -0
  69. package/src/rules/external-rules.tsx +175 -0
  70. package/src/rules/index.codegen.tsx +10 -0
  71. package/src/rules/local-cx-xcss/README.md +35 -0
  72. package/src/rules/local-cx-xcss/__tests__/rule.test.tsx +102 -0
  73. package/src/rules/local-cx-xcss/index.tsx +69 -0
  74. package/src/rules/utils/create-rule.tsx +80 -0
  75. package/src/rules/utils/is-supported-import.tsx +130 -0
  76. package/tsconfig.app.json +5 -1
  77. package/tsconfig.dev.json +5 -1
  78. package/tsconfig.json +7 -6
  79. package/dist/types/src/index.d.ts +0 -29
  80. package/dist/types-ts4.5/src/index.d.ts +0 -29
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.createRule = exports.createLintRule = void 0;
7
+ exports.getPathSafeName = getPathSafeName;
8
+ exports.getRuleUrl = getRuleUrl;
9
+ var _utils = require("@typescript-eslint/utils");
10
+ // eslint-disable-next-line import/no-extraneous-dependencies
11
+
12
+ /**
13
+ * We are moving to our own small abstraction to create a lint rule that we have the power
14
+ * to change and mold to our own needs.
15
+ *
16
+ * @see createLintRule
17
+ *
18
+ * @private
19
+ * @deprecated
20
+ */
21
+ var createRule = exports.createRule = _utils.ESLintUtils.RuleCreator(function (name) {
22
+ return getRuleUrl(name);
23
+ });
24
+ /**
25
+ * Tiny wrapped over the ESLint rule module type that ensures
26
+ * there is a docs link to our ESLint plugin documentation page,
27
+ * as well as improving type support.
28
+ */
29
+ var createLintRule = exports.createLintRule = function createLintRule(rule) {
30
+ rule.meta.docs.url = getRuleUrl(rule.meta.name);
31
+ return rule;
32
+ };
33
+ function getRuleUrl(ruleName) {
34
+ var name = getPathSafeName(ruleName);
35
+ return "https://atlassian.design/components/eslint-plugin-ui-styling-standard/".concat(name, "/usage");
36
+ }
37
+
38
+ /**
39
+ * If it's a nested rule, ensure the url is clean and safe for urls, file paths, etc.
40
+ */
41
+ function getPathSafeName(ruleName) {
42
+ return ruleName.replace('/', '-');
43
+ }
@@ -0,0 +1,98 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.isStyled = exports.isKeyframes = exports.isCxFunction = exports.isCssMap = exports.isCss = exports.getImportSources = exports.DEFAULT_IMPORT_SOURCES = exports.CSS_IN_JS_IMPORTS = void 0;
8
+ var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
9
+ // eslint-disable-next-line import/no-extraneous-dependencies
10
+
11
+ var CSS_IN_JS_IMPORTS = exports.CSS_IN_JS_IMPORTS = {
12
+ compiled: '@compiled/react',
13
+ emotionReact: '@emotion/react',
14
+ emotionCore: '@emotion/core',
15
+ styledComponents: 'styled-components',
16
+ atlaskitCss: '@atlaskit/css',
17
+ atlaskitPrimitives: '@atlaskit/primitives'
18
+ };
19
+
20
+ // A CSS-in-JS library an import of a valid css, cx, cssMap, etc.
21
+ // function might originate from, e.g. @compiled/react, @emotion/core.
22
+
23
+ // All ESLint rules originating from `@compiled/eslint-plugin` should apply to these libraries.
24
+ var DEFAULT_IMPORT_SOURCES = exports.DEFAULT_IMPORT_SOURCES = [CSS_IN_JS_IMPORTS.compiled, CSS_IN_JS_IMPORTS.atlaskitCss];
25
+
26
+ /**
27
+ * Given the ESLint rule context, extract and parse the value of the importSources rule option.
28
+ * The importSources option is used to define additional libraries for which an ESLint rule
29
+ * should apply to.
30
+ *
31
+ * Note that `@compiled/react` and `@atlaskit/css` are always included in importSources, regardless
32
+ * of what importSources is configured to by the user.
33
+ *
34
+ * @param context The rule context.
35
+ * @returns An array of strings representing what CSS-in-JS packages that should be checked, based
36
+ * on the rule options configuration.
37
+ */
38
+ var getImportSources = exports.getImportSources = function getImportSources(context) {
39
+ var options = context.options;
40
+ if (!options.length) {
41
+ return DEFAULT_IMPORT_SOURCES;
42
+ }
43
+ if (options[0].importSources && Array.isArray(options[0].importSources)) {
44
+ return [].concat(DEFAULT_IMPORT_SOURCES, (0, _toConsumableArray2.default)(options[0].importSources));
45
+ }
46
+ return DEFAULT_IMPORT_SOURCES;
47
+ };
48
+ var isSupportedImportWrapper = function isSupportedImportWrapper(functionName) {
49
+ var checkDefinitionHasImport = function checkDefinitionHasImport(def, importSources) {
50
+ if (def.type !== 'ImportBinding') {
51
+ return false;
52
+ }
53
+ if (!def.parent || !importSources.includes(def.parent.source.value)) {
54
+ return false;
55
+ }
56
+ return (
57
+ // import { functionName } from 'import-source';
58
+ def.node.type === 'ImportSpecifier' && def.node.imported.name === functionName ||
59
+ // import functionName from 'import-source';
60
+ def.node.type === 'ImportDefaultSpecifier' && def.node.local.name === functionName
61
+ );
62
+ };
63
+
64
+ /**
65
+ * Checks whether:
66
+ *
67
+ * 1. A function name `nodeToCheck` matches the name of the function we
68
+ * want to check for (e.g. `cx`, `css`, `cssMap`, or `keyframes`), and
69
+ * 2. Whether `nodeToCheck` originates from one of the libraries listed
70
+ * in `importSources`.
71
+ *
72
+ * @param nodeToCheck The function callee we are checking (e.g. The `css` in `css()`).
73
+ * @param referencesInScope List of references that are in scope. We'll use this
74
+ * to check where the function callee is imported from.
75
+ * @param importSources List of libraries that we want to ensure `nodeToCheck`
76
+ * comes from.
77
+ *
78
+ * @returns Whether the above conditions are true.
79
+ */
80
+ var isSupportedImport = function isSupportedImport(nodeToCheck, referencesInScope, importSources) {
81
+ return nodeToCheck.type === 'Identifier' && referencesInScope.some(function (reference) {
82
+ var _reference$resolved;
83
+ return reference.identifier === nodeToCheck && ((_reference$resolved = reference.resolved) === null || _reference$resolved === void 0 ? void 0 : _reference$resolved.defs.some(function (def) {
84
+ return checkDefinitionHasImport(def, importSources);
85
+ }));
86
+ });
87
+ };
88
+ return isSupportedImport;
89
+ };
90
+
91
+ // Unused functions have been commented out until we implement corresponding
92
+ // eslint rules which use them
93
+ //
94
+ var isCss = exports.isCss = isSupportedImportWrapper('css');
95
+ var isCxFunction = exports.isCxFunction = isSupportedImportWrapper('cx');
96
+ var isCssMap = exports.isCssMap = isSupportedImportWrapper('cssMap');
97
+ var isKeyframes = exports.isKeyframes = isSupportedImportWrapper('keyframes');
98
+ var isStyled = exports.isStyled = isSupportedImportWrapper('styled');
@@ -0,0 +1,12 @@
1
+ /**
2
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
+ * @codegen <<SignedSource::3fd41935576c9346ca1f1e0c787a0a48>>
4
+ * @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
5
+ */
6
+ import all from './presets/all.codegen';
7
+ import recommended from './presets/recommended.codegen';
8
+ export { default as rules } from './rules/index.codegen';
9
+ export const configs = {
10
+ all,
11
+ recommended
12
+ };
@@ -1,33 +1 @@
1
- export const rules = {};
2
- const importSources = ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/styled', 'styled-components'];
3
- export const configs = {
4
- recommended: {
5
- plugins: ['@atlaskit/ui-styling-standard', '@atlaskit/design-system', '@compiled'],
6
- rules: {
7
- '@atlaskit/design-system/consistent-css-prop-usage': ['warn', {
8
- // When passing a css prop to a React component, we don't know whether the component
9
- // is Emotion or Compiled. Hence it is not safe to run autofixes like wrapping it in
10
- // a `css` function call.
11
- excludeReactComponents: true
12
- }],
13
- '@atlaskit/design-system/local-cx-xcss': 'warn',
14
- '@atlaskit/design-system/no-css-tagged-template-expression': 'warn',
15
- '@atlaskit/design-system/no-keyframes-tagged-template-expression': 'warn',
16
- '@atlaskit/design-system/no-styled-tagged-template-expression': 'warn',
17
- '@compiled/no-suppress-xcss': 'error',
18
- '@compiled/no-js-xcss': 'error',
19
- '@atlaskit/design-system/no-empty-styled-expression': ['warn', {
20
- importSources
21
- }],
22
- '@atlaskit/design-system/no-exported-css': ['warn', {
23
- importSources
24
- }],
25
- '@atlaskit/design-system/no-exported-keyframes': ['warn', {
26
- importSources
27
- }],
28
- '@atlaskit/design-system/no-invalid-css-map': ['warn', {
29
- allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
30
- }]
31
- }
32
- }
33
- };
1
+ export { configs, rules } from './index.codegen';
@@ -0,0 +1,31 @@
1
+ /**
2
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
+ * @codegen <<SignedSource::6b1418e07df6af9ad4cae4baf66739c1>>
4
+ * @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
5
+ */
6
+ export default {
7
+ plugins: ['@atlaskit/ui-styling-standard', '@atlaskit/design-system', '@compiled'],
8
+ rules: {
9
+ '@atlaskit/ui-styling-standard/local-cx-xcss': 'warn',
10
+ '@atlaskit/design-system/consistent-css-prop-usage': ['warn', {
11
+ excludeReactComponents: true
12
+ }],
13
+ '@atlaskit/design-system/no-css-tagged-template-expression': 'warn',
14
+ '@atlaskit/design-system/no-keyframes-tagged-template-expression': 'warn',
15
+ '@atlaskit/design-system/no-styled-tagged-template-expression': 'warn',
16
+ '@compiled/no-suppress-xcss': 'warn',
17
+ '@compiled/no-js-xcss': 'warn',
18
+ '@atlaskit/design-system/no-empty-styled-expression': ['warn', {
19
+ importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
20
+ }],
21
+ '@atlaskit/design-system/no-exported-css': ['warn', {
22
+ importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
23
+ }],
24
+ '@atlaskit/design-system/no-exported-keyframes': ['warn', {
25
+ importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
26
+ }],
27
+ '@atlaskit/design-system/no-invalid-css-map': ['warn', {
28
+ allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
29
+ }]
30
+ }
31
+ };
@@ -0,0 +1,31 @@
1
+ /**
2
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
+ * @codegen <<SignedSource::6b1418e07df6af9ad4cae4baf66739c1>>
4
+ * @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
5
+ */
6
+ export default {
7
+ plugins: ['@atlaskit/ui-styling-standard', '@atlaskit/design-system', '@compiled'],
8
+ rules: {
9
+ '@atlaskit/ui-styling-standard/local-cx-xcss': 'warn',
10
+ '@atlaskit/design-system/consistent-css-prop-usage': ['warn', {
11
+ excludeReactComponents: true
12
+ }],
13
+ '@atlaskit/design-system/no-css-tagged-template-expression': 'warn',
14
+ '@atlaskit/design-system/no-keyframes-tagged-template-expression': 'warn',
15
+ '@atlaskit/design-system/no-styled-tagged-template-expression': 'warn',
16
+ '@compiled/no-suppress-xcss': 'warn',
17
+ '@compiled/no-js-xcss': 'warn',
18
+ '@atlaskit/design-system/no-empty-styled-expression': ['warn', {
19
+ importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
20
+ }],
21
+ '@atlaskit/design-system/no-exported-css': ['warn', {
22
+ importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
23
+ }],
24
+ '@atlaskit/design-system/no-exported-keyframes': ['warn', {
25
+ importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
26
+ }],
27
+ '@atlaskit/design-system/no-invalid-css-map': ['warn', {
28
+ allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
29
+ }]
30
+ }
31
+ };
@@ -0,0 +1,138 @@
1
+ import { getRuleUrl } from './utils/create-rule';
2
+
3
+ /** External rules must be scoped, have a display name, and external urls. */
4
+
5
+ const importSources = ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components'];
6
+ export const externalRules = [{
7
+ name: '@atlaskit/design-system/consistent-css-prop-usage',
8
+ displayName: 'consistent-css-prop-usage',
9
+ isExternal: true,
10
+ fixable: 'code',
11
+ docs: {
12
+ description: 'Ensures consistency with `css` and `xcss` prop usages',
13
+ url: getRuleUrl('consistent-css-prop-usage'),
14
+ externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/consistent-css-prop-usage/usage',
15
+ recommended: true,
16
+ severity: 'warn',
17
+ pluginConfig: {
18
+ // When passing a css prop to a React component, we don't know whether the component
19
+ // is Emotion or Compiled. Hence it is not safe to run autofixes like wrapping it in
20
+ // a `css` function call.
21
+ excludeReactComponents: true
22
+ }
23
+ }
24
+ }, {
25
+ name: '@atlaskit/design-system/no-css-tagged-template-expression',
26
+ displayName: 'no-css-tagged-template-expression',
27
+ isExternal: true,
28
+ fixable: 'code',
29
+ docs: {
30
+ description: 'Disallows any `css` tagged template expressions that originate from Emotion, Styled Components or Compiled',
31
+ url: getRuleUrl('no-css-tagged-template-expression'),
32
+ externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-css-tagged-template-expression/usage',
33
+ recommended: true,
34
+ severity: 'warn'
35
+ }
36
+ }, {
37
+ name: '@atlaskit/design-system/no-keyframes-tagged-template-expression',
38
+ displayName: 'no-keyframes-tagged-template-expression',
39
+ isExternal: true,
40
+ fixable: 'code',
41
+ docs: {
42
+ description: 'Disallows any `keyframe` tagged template expressions that originate from Emotion, Styled Components or Compiled',
43
+ url: getRuleUrl('no-keyframes-tagged-template-expression'),
44
+ externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-keyframes-tagged-template-expression/usage',
45
+ recommended: true,
46
+ severity: 'warn'
47
+ }
48
+ }, {
49
+ name: '@atlaskit/design-system/no-styled-tagged-template-expression',
50
+ displayName: 'no-styled-tagged-template-expression',
51
+ isExternal: true,
52
+ fixable: 'code',
53
+ docs: {
54
+ description: 'Disallows any `styled` tagged template expressions that originate from Emotion, Styled Components or Compiled',
55
+ url: getRuleUrl('no-styled-tagged-template-expression'),
56
+ externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-styled-tagged-template-expression/usage',
57
+ recommended: true,
58
+ severity: 'warn'
59
+ }
60
+ }, {
61
+ name: '@compiled/no-suppress-xcss',
62
+ displayName: 'no-suppress-xcss',
63
+ isExternal: true,
64
+ docs: {
65
+ description: 'Disallows supressing type violations when using the xcss prop.',
66
+ url: getRuleUrl('no-suppress-xcss'),
67
+ externalUrl: 'https://github.com/atlassian-labs/compiled/tree/master/packages/eslint-plugin/src/rules/no-suppress-xcss',
68
+ recommended: true,
69
+ severity: 'warn'
70
+ }
71
+ }, {
72
+ name: '@compiled/no-js-xcss',
73
+ displayName: 'no-js-xcss',
74
+ isExternal: true,
75
+ docs: {
76
+ description: 'Disallows using xcss prop inside JavaScript files.',
77
+ url: getRuleUrl('no-js-xcss'),
78
+ externalUrl: 'https://github.com/atlassian-labs/compiled/tree/master/packages/eslint-plugin/src/rules/no-js-xcss',
79
+ recommended: true,
80
+ severity: 'warn'
81
+ }
82
+ }, {
83
+ name: '@atlaskit/design-system/no-empty-styled-expression',
84
+ displayName: 'no-empty-styled-expression',
85
+ isExternal: true,
86
+ docs: {
87
+ description: 'Forbids any styled expression to be used when passing empty arguments to styled.div() (or other JSX elements).',
88
+ url: getRuleUrl('no-empty-styled-expression'),
89
+ externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-empty-styled-expression/usage',
90
+ recommended: true,
91
+ severity: 'warn',
92
+ pluginConfig: {
93
+ importSources
94
+ }
95
+ }
96
+ }, {
97
+ name: '@atlaskit/design-system/no-exported-css',
98
+ displayName: 'no-exported-css',
99
+ isExternal: true,
100
+ docs: {
101
+ description: 'Forbid exporting `css` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable.',
102
+ url: getRuleUrl('no-exported-css'),
103
+ externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-exported-css/usage',
104
+ recommended: true,
105
+ severity: 'warn',
106
+ pluginConfig: {
107
+ importSources
108
+ }
109
+ }
110
+ }, {
111
+ name: '@atlaskit/design-system/no-exported-keyframes',
112
+ displayName: 'no-exported-keyframes',
113
+ isExternal: true,
114
+ docs: {
115
+ description: 'Forbid exporting `keyframes` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable.',
116
+ url: getRuleUrl('no-exported-keyframes'),
117
+ externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-exported-keyframes/usage',
118
+ recommended: true,
119
+ severity: 'warn',
120
+ pluginConfig: {
121
+ importSources
122
+ }
123
+ }
124
+ }, {
125
+ name: '@atlaskit/design-system/no-invalid-css-map',
126
+ displayName: 'no-invalid-css-map',
127
+ isExternal: true,
128
+ docs: {
129
+ description: "Checks the validity of a CSS map created through cssMap. This is intended to be used alongside TypeScript's type-checking.",
130
+ url: getRuleUrl('no-invalid-css-map'),
131
+ externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-invalid-css-map/usage',
132
+ recommended: true,
133
+ severity: 'warn',
134
+ pluginConfig: {
135
+ allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
136
+ }
137
+ }
138
+ }];
@@ -0,0 +1,9 @@
1
+ /**
2
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
+ * @codegen <<SignedSource::f907e3f7ab0b7145dcb8318732ae1fec>>
4
+ * @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
5
+ */
6
+ import localCxXcss from './local-cx-xcss';
7
+ export default {
8
+ 'local-cx-xcss': localCxXcss
9
+ };
@@ -0,0 +1,45 @@
1
+ import { createLintRule } from '../utils/create-rule';
2
+ import { CSS_IN_JS_IMPORTS, isCxFunction } from '../utils/is-supported-import';
3
+ const IMPORT_SOURCES = [CSS_IN_JS_IMPORTS.compiled, CSS_IN_JS_IMPORTS.atlaskitCss];
4
+ function getParentJSXAttribute(node) {
5
+ let parent = node.parent;
6
+ while (parent && parent.type !== 'JSXAttribute') {
7
+ parent = parent.parent;
8
+ }
9
+ if (parent && parent.type === 'JSXAttribute') {
10
+ return parent;
11
+ }
12
+ return null;
13
+ }
14
+ export const rule = createLintRule({
15
+ meta: {
16
+ name: 'local-cx-xcss',
17
+ docs: {
18
+ description: 'Ensures the cx() function, which is part of the XCSS API, is only used within the xcss prop. This aids tracking what styles are applied to a jsx element.',
19
+ recommended: true,
20
+ severity: 'warn'
21
+ },
22
+ messages: {
23
+ 'local-cx-xcss': 'The cx function should only be declared inside the xcss prop to simplify tracking styles that are applied to a jsx element.'
24
+ },
25
+ type: 'problem'
26
+ },
27
+ create(context) {
28
+ return {
29
+ 'CallExpression[callee.name="cx"]': node => {
30
+ if (node.type === 'CallExpression' && isCxFunction(node.callee, context.getScope().references, IMPORT_SOURCES)) {
31
+ const parentJSXAttribute = getParentJSXAttribute(node);
32
+ const propName = parentJSXAttribute === null || parentJSXAttribute === void 0 ? void 0 : parentJSXAttribute.name.name.toString();
33
+ if (propName && /[xX]css$/.test(propName)) {
34
+ return;
35
+ }
36
+ context.report({
37
+ node,
38
+ messageId: 'local-cx-xcss'
39
+ });
40
+ }
41
+ }
42
+ };
43
+ }
44
+ });
45
+ export default rule;
@@ -0,0 +1,33 @@
1
+ import { ESLintUtils } from '@typescript-eslint/utils';
2
+ // eslint-disable-next-line import/no-extraneous-dependencies
3
+
4
+ /**
5
+ * We are moving to our own small abstraction to create a lint rule that we have the power
6
+ * to change and mold to our own needs.
7
+ *
8
+ * @see createLintRule
9
+ *
10
+ * @private
11
+ * @deprecated
12
+ */
13
+ export const createRule = ESLintUtils.RuleCreator(name => getRuleUrl(name));
14
+ /**
15
+ * Tiny wrapped over the ESLint rule module type that ensures
16
+ * there is a docs link to our ESLint plugin documentation page,
17
+ * as well as improving type support.
18
+ */
19
+ export const createLintRule = rule => {
20
+ rule.meta.docs.url = getRuleUrl(rule.meta.name);
21
+ return rule;
22
+ };
23
+ export function getRuleUrl(ruleName) {
24
+ const name = getPathSafeName(ruleName);
25
+ return `https://atlassian.design/components/eslint-plugin-ui-styling-standard/${name}/usage`;
26
+ }
27
+
28
+ /**
29
+ * If it's a nested rule, ensure the url is clean and safe for urls, file paths, etc.
30
+ */
31
+ export function getPathSafeName(ruleName) {
32
+ return ruleName.replace('/', '-');
33
+ }
@@ -0,0 +1,87 @@
1
+ // eslint-disable-next-line import/no-extraneous-dependencies
2
+
3
+ export const CSS_IN_JS_IMPORTS = {
4
+ compiled: '@compiled/react',
5
+ emotionReact: '@emotion/react',
6
+ emotionCore: '@emotion/core',
7
+ styledComponents: 'styled-components',
8
+ atlaskitCss: '@atlaskit/css',
9
+ atlaskitPrimitives: '@atlaskit/primitives'
10
+ };
11
+
12
+ // A CSS-in-JS library an import of a valid css, cx, cssMap, etc.
13
+ // function might originate from, e.g. @compiled/react, @emotion/core.
14
+ // All ESLint rules originating from `@compiled/eslint-plugin` should apply to these libraries.
15
+ export const DEFAULT_IMPORT_SOURCES = [CSS_IN_JS_IMPORTS.compiled, CSS_IN_JS_IMPORTS.atlaskitCss];
16
+
17
+ /**
18
+ * Given the ESLint rule context, extract and parse the value of the importSources rule option.
19
+ * The importSources option is used to define additional libraries for which an ESLint rule
20
+ * should apply to.
21
+ *
22
+ * Note that `@compiled/react` and `@atlaskit/css` are always included in importSources, regardless
23
+ * of what importSources is configured to by the user.
24
+ *
25
+ * @param context The rule context.
26
+ * @returns An array of strings representing what CSS-in-JS packages that should be checked, based
27
+ * on the rule options configuration.
28
+ */
29
+ export const getImportSources = context => {
30
+ const options = context.options;
31
+ if (!options.length) {
32
+ return DEFAULT_IMPORT_SOURCES;
33
+ }
34
+ if (options[0].importSources && Array.isArray(options[0].importSources)) {
35
+ return [...DEFAULT_IMPORT_SOURCES, ...options[0].importSources];
36
+ }
37
+ return DEFAULT_IMPORT_SOURCES;
38
+ };
39
+ const isSupportedImportWrapper = functionName => {
40
+ const checkDefinitionHasImport = (def, importSources) => {
41
+ if (def.type !== 'ImportBinding') {
42
+ return false;
43
+ }
44
+ if (!def.parent || !importSources.includes(def.parent.source.value)) {
45
+ return false;
46
+ }
47
+ return (
48
+ // import { functionName } from 'import-source';
49
+ def.node.type === 'ImportSpecifier' && def.node.imported.name === functionName ||
50
+ // import functionName from 'import-source';
51
+ def.node.type === 'ImportDefaultSpecifier' && def.node.local.name === functionName
52
+ );
53
+ };
54
+
55
+ /**
56
+ * Checks whether:
57
+ *
58
+ * 1. A function name `nodeToCheck` matches the name of the function we
59
+ * want to check for (e.g. `cx`, `css`, `cssMap`, or `keyframes`), and
60
+ * 2. Whether `nodeToCheck` originates from one of the libraries listed
61
+ * in `importSources`.
62
+ *
63
+ * @param nodeToCheck The function callee we are checking (e.g. The `css` in `css()`).
64
+ * @param referencesInScope List of references that are in scope. We'll use this
65
+ * to check where the function callee is imported from.
66
+ * @param importSources List of libraries that we want to ensure `nodeToCheck`
67
+ * comes from.
68
+ *
69
+ * @returns Whether the above conditions are true.
70
+ */
71
+ const isSupportedImport = (nodeToCheck, referencesInScope, importSources) => {
72
+ return nodeToCheck.type === 'Identifier' && referencesInScope.some(reference => {
73
+ var _reference$resolved;
74
+ return reference.identifier === nodeToCheck && ((_reference$resolved = reference.resolved) === null || _reference$resolved === void 0 ? void 0 : _reference$resolved.defs.some(def => checkDefinitionHasImport(def, importSources)));
75
+ });
76
+ };
77
+ return isSupportedImport;
78
+ };
79
+
80
+ // Unused functions have been commented out until we implement corresponding
81
+ // eslint rules which use them
82
+ //
83
+ export const isCss = isSupportedImportWrapper('css');
84
+ export const isCxFunction = isSupportedImportWrapper('cx');
85
+ export const isCssMap = isSupportedImportWrapper('cssMap');
86
+ export const isKeyframes = isSupportedImportWrapper('keyframes');
87
+ export const isStyled = isSupportedImportWrapper('styled');
@@ -0,0 +1,12 @@
1
+ /**
2
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
+ * @codegen <<SignedSource::3fd41935576c9346ca1f1e0c787a0a48>>
4
+ * @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
5
+ */
6
+ import all from './presets/all.codegen';
7
+ import recommended from './presets/recommended.codegen';
8
+ export { default as rules } from './rules/index.codegen';
9
+ export var configs = {
10
+ all: all,
11
+ recommended: recommended
12
+ };
package/dist/esm/index.js CHANGED
@@ -1,33 +1 @@
1
- export var rules = {};
2
- var importSources = ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/styled', 'styled-components'];
3
- export var configs = {
4
- recommended: {
5
- plugins: ['@atlaskit/ui-styling-standard', '@atlaskit/design-system', '@compiled'],
6
- rules: {
7
- '@atlaskit/design-system/consistent-css-prop-usage': ['warn', {
8
- // When passing a css prop to a React component, we don't know whether the component
9
- // is Emotion or Compiled. Hence it is not safe to run autofixes like wrapping it in
10
- // a `css` function call.
11
- excludeReactComponents: true
12
- }],
13
- '@atlaskit/design-system/local-cx-xcss': 'warn',
14
- '@atlaskit/design-system/no-css-tagged-template-expression': 'warn',
15
- '@atlaskit/design-system/no-keyframes-tagged-template-expression': 'warn',
16
- '@atlaskit/design-system/no-styled-tagged-template-expression': 'warn',
17
- '@compiled/no-suppress-xcss': 'error',
18
- '@compiled/no-js-xcss': 'error',
19
- '@atlaskit/design-system/no-empty-styled-expression': ['warn', {
20
- importSources: importSources
21
- }],
22
- '@atlaskit/design-system/no-exported-css': ['warn', {
23
- importSources: importSources
24
- }],
25
- '@atlaskit/design-system/no-exported-keyframes': ['warn', {
26
- importSources: importSources
27
- }],
28
- '@atlaskit/design-system/no-invalid-css-map': ['warn', {
29
- allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
30
- }]
31
- }
32
- }
33
- };
1
+ export { configs, rules } from './index.codegen';
@@ -0,0 +1,31 @@
1
+ /**
2
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
3
+ * @codegen <<SignedSource::6b1418e07df6af9ad4cae4baf66739c1>>
4
+ * @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
5
+ */
6
+ export default {
7
+ plugins: ['@atlaskit/ui-styling-standard', '@atlaskit/design-system', '@compiled'],
8
+ rules: {
9
+ '@atlaskit/ui-styling-standard/local-cx-xcss': 'warn',
10
+ '@atlaskit/design-system/consistent-css-prop-usage': ['warn', {
11
+ excludeReactComponents: true
12
+ }],
13
+ '@atlaskit/design-system/no-css-tagged-template-expression': 'warn',
14
+ '@atlaskit/design-system/no-keyframes-tagged-template-expression': 'warn',
15
+ '@atlaskit/design-system/no-styled-tagged-template-expression': 'warn',
16
+ '@compiled/no-suppress-xcss': 'warn',
17
+ '@compiled/no-js-xcss': 'warn',
18
+ '@atlaskit/design-system/no-empty-styled-expression': ['warn', {
19
+ importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
20
+ }],
21
+ '@atlaskit/design-system/no-exported-css': ['warn', {
22
+ importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
23
+ }],
24
+ '@atlaskit/design-system/no-exported-keyframes': ['warn', {
25
+ importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
26
+ }],
27
+ '@atlaskit/design-system/no-invalid-css-map': ['warn', {
28
+ allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
29
+ }]
30
+ }
31
+ };