@atlaskit/eslint-plugin-ui-styling-standard 0.15.2 → 0.16.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 (95) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/constellation/index/migration-guide.mdx +309 -0
  3. package/constellation/index/overview.mdx +4 -0
  4. package/constellation/index/props.mdx +9 -5
  5. package/dist/types/rules/no-unsafe-selectors/constants.d.ts +1 -4
  6. package/index.js +9 -9
  7. package/package.json +3 -3
  8. package/scripts/codegen.tsx +223 -284
  9. package/src/rules/__tests__/utils/_tester.tsx +24 -24
  10. package/src/rules/atlaskit-theme/README.md +21 -19
  11. package/src/rules/atlaskit-theme/__tests__/test.ts +53 -53
  12. package/src/rules/atlaskit-theme/index.ts +107 -115
  13. package/src/rules/convert-props-syntax/README.md +32 -22
  14. package/src/rules/convert-props-syntax/__tests__/invalid.test.tsx +46 -46
  15. package/src/rules/convert-props-syntax/__tests__/rule.test.tsx +175 -175
  16. package/src/rules/convert-props-syntax/__tests__/type-annotations.test.tsx +52 -52
  17. package/src/rules/convert-props-syntax/__tests__/unusual-properties.test.tsx +33 -33
  18. package/src/rules/convert-props-syntax/index.tsx +356 -386
  19. package/src/rules/enforce-style-prop/README.md +21 -18
  20. package/src/rules/enforce-style-prop/__tests__/rule.test.tsx +90 -96
  21. package/src/rules/enforce-style-prop/index.tsx +144 -160
  22. package/src/rules/external-rules.tsx +163 -164
  23. package/src/rules/local-cx-xcss/README.md +10 -6
  24. package/src/rules/local-cx-xcss/__tests__/rule.test.tsx +26 -26
  25. package/src/rules/local-cx-xcss/index.tsx +46 -56
  26. package/src/rules/no-array-arguments/README.md +2 -1
  27. package/src/rules/no-array-arguments/__tests__/rule.test.tsx +37 -46
  28. package/src/rules/no-array-arguments/index.tsx +68 -69
  29. package/src/rules/no-classname-prop/README.md +7 -4
  30. package/src/rules/no-classname-prop/__tests__/rule.test.tsx +22 -22
  31. package/src/rules/no-classname-prop/index.tsx +25 -25
  32. package/src/rules/no-container-queries/README.md +11 -9
  33. package/src/rules/no-container-queries/__tests__/rule.test.tsx +47 -50
  34. package/src/rules/no-container-queries/index.tsx +75 -81
  35. package/src/rules/no-dynamic-styles/README.md +16 -19
  36. package/src/rules/no-dynamic-styles/__tests__/rule.test.tsx +58 -67
  37. package/src/rules/no-dynamic-styles/index.tsx +45 -48
  38. package/src/rules/no-exported-styles/README.md +17 -12
  39. package/src/rules/no-exported-styles/__tests__/rule.test.tsx +102 -111
  40. package/src/rules/no-exported-styles/index.tsx +36 -36
  41. package/src/rules/no-global-styles/README.md +15 -14
  42. package/src/rules/no-global-styles/__tests__/no-css-modules.test.tsx +28 -28
  43. package/src/rules/no-global-styles/__tests__/no-global-styles.test.tsx +37 -37
  44. package/src/rules/no-global-styles/index.tsx +59 -62
  45. package/src/rules/no-important-styles/README.md +5 -3
  46. package/src/rules/no-important-styles/__tests__/rule.test.tsx +66 -66
  47. package/src/rules/no-important-styles/index.tsx +49 -49
  48. package/src/rules/no-imported-style-values/README.md +23 -15
  49. package/src/rules/no-imported-style-values/__tests__/rule.test.tsx +123 -123
  50. package/src/rules/no-imported-style-values/index.tsx +116 -120
  51. package/src/rules/no-nested-selectors/README.md +15 -13
  52. package/src/rules/no-nested-selectors/__tests__/rule.test.tsx +128 -128
  53. package/src/rules/no-styled/README.md +14 -9
  54. package/src/rules/no-styled/__tests__/rule.test.tsx +31 -31
  55. package/src/rules/no-styled/index.tsx +34 -41
  56. package/src/rules/no-unsafe-selectors/README.md +103 -93
  57. package/src/rules/no-unsafe-selectors/__tests__/no-grouped-at-rules.test.tsx +21 -24
  58. package/src/rules/no-unsafe-selectors/__tests__/no-increased-specificity.test.tsx +44 -44
  59. package/src/rules/no-unsafe-selectors/__tests__/no-keyframes-at-rules.test.tsx +21 -21
  60. package/src/rules/no-unsafe-selectors/__tests__/no-legacy-pseudo-element-syntax.test.tsx +57 -57
  61. package/src/rules/no-unsafe-selectors/__tests__/no-restricted-at-rules.test.tsx +58 -58
  62. package/src/rules/no-unsafe-selectors/__tests__/no-restricted-pseudos.test.tsx +85 -85
  63. package/src/rules/no-unsafe-selectors/__tests__/no-selectors-object.test.tsx +12 -12
  64. package/src/rules/no-unsafe-selectors/__tests__/no-unparsable-selectors.test.tsx +23 -23
  65. package/src/rules/no-unsafe-selectors/__tests__/rule.test.tsx +114 -114
  66. package/src/rules/no-unsafe-selectors/constants.tsx +69 -77
  67. package/src/rules/no-unsafe-selectors/source-position-utils.tsx +38 -38
  68. package/src/rules/no-unsafe-selectors/walk-css-map.tsx +178 -184
  69. package/src/rules/no-unsafe-values/README.md +34 -40
  70. package/src/rules/no-unsafe-values/__tests__/no-array-values.test.tsx +13 -13
  71. package/src/rules/no-unsafe-values/__tests__/no-conditional-values.test.tsx +18 -18
  72. package/src/rules/no-unsafe-values/__tests__/no-dynamic-keys.test.tsx +104 -104
  73. package/src/rules/no-unsafe-values/__tests__/no-function-calls.test.tsx +128 -128
  74. package/src/rules/no-unsafe-values/__tests__/no-identifier-arguments.test.tsx +23 -23
  75. package/src/rules/no-unsafe-values/__tests__/no-object-access.test.tsx +38 -38
  76. package/src/rules/no-unsafe-values/__tests__/no-object-references.test.tsx +18 -18
  77. package/src/rules/no-unsafe-values/__tests__/no-spread-elements.test.tsx +18 -18
  78. package/src/rules/no-unsafe-values/__tests__/no-unsafe-values.test.tsx +28 -28
  79. package/src/rules/no-unsafe-values/__tests__/no-variables.test.tsx +47 -47
  80. package/src/rules/no-unsafe-values/index.tsx +76 -78
  81. package/src/rules/no-unsafe-values/messages.tsx +12 -12
  82. package/src/rules/no-unsafe-values/utils.tsx +370 -382
  83. package/src/rules/use-compiled/README.md +11 -8
  84. package/src/rules/use-compiled/__tests__/can-auto-fix.test.tsx +32 -32
  85. package/src/rules/use-compiled/__tests__/css.test.tsx +53 -53
  86. package/src/rules/use-compiled/__tests__/imports.test.tsx +90 -95
  87. package/src/rules/use-compiled/__tests__/keyframes.test.tsx +47 -47
  88. package/src/rules/use-compiled/__tests__/pragma.test.tsx +64 -64
  89. package/src/rules/use-compiled/__tests__/styled.test.tsx +53 -53
  90. package/src/rules/use-compiled/__tests__/use-compiled.test.tsx +10 -10
  91. package/src/rules/use-compiled/index.tsx +203 -226
  92. package/src/rules/use-compiled/is-safe.tsx +113 -117
  93. package/src/rules/use-compiled/utils.tsx +14 -18
  94. package/src/rules/utils/create-rule-with-typed-config.tsx +62 -63
  95. package/src/rules/utils/create-rule.tsx +3 -6
@@ -1,96 +1,94 @@
1
1
  import { createLintRule } from '../utils/create-rule';
2
2
  import {
3
- isCss,
4
- getImportSources,
5
- isStyled,
6
- isKeyframes,
7
- isCssMap,
8
- isXcss,
3
+ isCss,
4
+ getImportSources,
5
+ isStyled,
6
+ isKeyframes,
7
+ isCssMap,
8
+ isXcss,
9
9
  } from '@atlaskit/eslint-utils/is-supported-import';
10
10
  import type { JSONSchema4 } from '@typescript-eslint/utils/dist/json-schema';
11
11
  import { Linter } from './utils';
12
12
  import { messages } from './messages';
13
13
 
14
14
  const schema: JSONSchema4 = [
15
- {
16
- type: 'object',
17
- additionalProperties: false,
18
- properties: {
19
- importSources: {
20
- type: 'array',
21
- items: { type: 'string' },
22
- uniqueItems: true,
23
- },
24
- allowedFunctionCalls: {
25
- type: 'array',
26
- items: {
27
- type: 'array',
28
- minItems: 2,
29
- maxItems: 2,
30
- items: [{ type: 'string' }, { type: 'string' }],
31
- },
32
- uniqueItems: true,
33
- },
34
- allowedDynamicKeys: {
35
- type: 'array',
36
- items: {
37
- type: 'array',
38
- minItems: 2,
39
- maxItems: 2,
40
- items: [{ type: 'string' }, { type: 'string' }],
41
- },
42
- uniqueItems: true,
43
- },
44
- },
45
- },
15
+ {
16
+ type: 'object',
17
+ additionalProperties: false,
18
+ properties: {
19
+ importSources: {
20
+ type: 'array',
21
+ items: { type: 'string' },
22
+ uniqueItems: true,
23
+ },
24
+ allowedFunctionCalls: {
25
+ type: 'array',
26
+ items: {
27
+ type: 'array',
28
+ minItems: 2,
29
+ maxItems: 2,
30
+ items: [{ type: 'string' }, { type: 'string' }],
31
+ },
32
+ uniqueItems: true,
33
+ },
34
+ allowedDynamicKeys: {
35
+ type: 'array',
36
+ items: {
37
+ type: 'array',
38
+ minItems: 2,
39
+ maxItems: 2,
40
+ items: [{ type: 'string' }, { type: 'string' }],
41
+ },
42
+ uniqueItems: true,
43
+ },
44
+ },
45
+ },
46
46
  ];
47
47
 
48
48
  export const rule = createLintRule({
49
- meta: {
50
- name: 'no-unsafe-values',
51
- docs: {
52
- description:
53
- 'Disallows styles that are difficult/impossible to statically anaylze.',
54
- recommended: true,
55
- severity: 'warn',
56
- },
57
- messages,
58
- type: 'problem',
59
- schema,
60
- },
61
- create(context) {
62
- const importSources = getImportSources(context);
49
+ meta: {
50
+ name: 'no-unsafe-values',
51
+ docs: {
52
+ description: 'Disallows styles that are difficult/impossible to statically anaylze.',
53
+ recommended: true,
54
+ severity: 'warn',
55
+ },
56
+ messages,
57
+ type: 'problem',
58
+ schema,
59
+ },
60
+ create(context) {
61
+ const importSources = getImportSources(context);
63
62
 
64
- return {
65
- CallExpression(node) {
66
- const { references } = context.sourceCode.getScope(node);
63
+ return {
64
+ CallExpression(node) {
65
+ const { references } = context.sourceCode.getScope(node);
67
66
 
68
- if (
69
- !isCss(node.callee, references, importSources) &&
70
- !isStyled(node.callee, references, importSources) &&
71
- !isKeyframes(node.callee, references, importSources) &&
72
- !isCssMap(node.callee, references, importSources) &&
73
- !isXcss(node.callee, references, importSources)
74
- ) {
75
- return;
76
- }
67
+ if (
68
+ !isCss(node.callee, references, importSources) &&
69
+ !isStyled(node.callee, references, importSources) &&
70
+ !isKeyframes(node.callee, references, importSources) &&
71
+ !isCssMap(node.callee, references, importSources) &&
72
+ !isXcss(node.callee, references, importSources)
73
+ ) {
74
+ return;
75
+ }
77
76
 
78
- if (
79
- isStyled(node.callee, references, importSources) &&
80
- (node.parent.type === 'CallExpression' ||
81
- node.parent.type === 'TaggedTemplateExpression')
82
- ) {
83
- /**
84
- * If it is of the form styled(Base)({}) we don't want to lint the inner function arguments.
85
- */
86
- return;
87
- }
77
+ if (
78
+ isStyled(node.callee, references, importSources) &&
79
+ (node.parent.type === 'CallExpression' || node.parent.type === 'TaggedTemplateExpression')
80
+ ) {
81
+ /**
82
+ * If it is of the form styled(Base)({}) we don't want to lint the inner function arguments.
83
+ */
84
+ return;
85
+ }
88
86
 
89
- const linter = new Linter(context, node);
90
- linter.run();
91
- },
92
- };
93
- },
87
+ const linter = new Linter(context, node);
88
+ linter.run();
89
+ },
90
+ };
91
+ },
94
92
  });
95
93
 
96
94
  export default rule;
@@ -1,10 +1,10 @@
1
1
  import outdent from 'outdent';
2
2
 
3
3
  const whereToGetHelp =
4
- "If you think this should be allowed, or if you're running into issues, reach out in #help-ui-styling-standard";
4
+ "If you think this should be allowed, or if you're running into issues, reach out in #help-ui-styling-standard";
5
5
 
6
6
  export const messages = {
7
- 'no-array-values': outdent`
7
+ 'no-array-values': outdent`
8
8
  Arrays are not allowed in style objects. Support is inconsistent between styling libraries.
9
9
 
10
10
  Compose styles with the css prop instead.
@@ -12,7 +12,7 @@ export const messages = {
12
12
  ${whereToGetHelp}
13
13
  `,
14
14
 
15
- 'no-conditional-values': outdent`
15
+ 'no-conditional-values': outdent`
16
16
  Conditional expressions are not allowed in style objects.
17
17
 
18
18
  Conditionally apply styles with the css prop instead.
@@ -20,19 +20,19 @@ export const messages = {
20
20
  ${whereToGetHelp}
21
21
  `,
22
22
 
23
- 'no-dynamic-keys': outdent`
23
+ 'no-dynamic-keys': outdent`
24
24
  Dynamic keys are not allowed in style objects.
25
25
 
26
26
  ${whereToGetHelp}
27
27
  `,
28
28
 
29
- 'no-function-calls': outdent`
29
+ 'no-function-calls': outdent`
30
30
  Function calls are not allowed in style objects.
31
31
 
32
32
  ${whereToGetHelp}
33
33
  `,
34
34
 
35
- 'no-identifier-arguments': outdent`
35
+ 'no-identifier-arguments': outdent`
36
36
  Variable arguments are not allowed.
37
37
 
38
38
  Inline the object value, or compose styles with the css prop instead.
@@ -40,7 +40,7 @@ export const messages = {
40
40
  ${whereToGetHelp}
41
41
  `,
42
42
 
43
- 'no-object-access': outdent`
43
+ 'no-object-access': outdent`
44
44
  Accessing object values is not allowed in style objects.
45
45
 
46
46
  If you are accessing the component's props, use the style prop to apply dynamic values instead.
@@ -48,7 +48,7 @@ export const messages = {
48
48
  ${whereToGetHelp}
49
49
  `,
50
50
 
51
- 'no-object-references': outdent`
51
+ 'no-object-references': outdent`
52
52
  Referencing objects is not allowed in style objects.
53
53
 
54
54
  Inline the object value instead.
@@ -56,7 +56,7 @@ export const messages = {
56
56
  ${whereToGetHelp}
57
57
  `,
58
58
 
59
- 'no-spread-elements': outdent`
59
+ 'no-spread-elements': outdent`
60
60
  Spread elements are not allowed in style objects.
61
61
 
62
62
  Compose styles with the css prop instead.
@@ -64,14 +64,14 @@ export const messages = {
64
64
  ${whereToGetHelp}
65
65
  `,
66
66
 
67
- // Fallback case if a more specific message is not applicable
68
- 'no-unsafe-values': outdent`
67
+ // Fallback case if a more specific message is not applicable
68
+ 'no-unsafe-values': outdent`
69
69
  Unsafe values are not allowed in style objects.
70
70
 
71
71
  ${whereToGetHelp}
72
72
  `,
73
73
 
74
- 'no-variables': outdent`
74
+ 'no-variables': outdent`
75
75
  Variables are not allowed in style objects, unless they:
76
76
 
77
77
  - Have a simple, static value.