@atlaskit/eslint-plugin-design-system 10.6.1 → 10.7.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 (10) hide show
  1. package/CHANGELOG.md +9 -1
  2. package/constellation/index/props.mdx +2 -3
  3. package/dist/cjs/rules/use-tokens-typography/index.js +1 -1
  4. package/dist/cjs/rules/use-tokens-typography/transformers/style-object.js +4 -1
  5. package/dist/es2019/rules/use-tokens-typography/index.js +1 -1
  6. package/dist/es2019/rules/use-tokens-typography/transformers/style-object.js +4 -1
  7. package/dist/esm/rules/use-tokens-typography/index.js +1 -1
  8. package/dist/esm/rules/use-tokens-typography/transformers/style-object.js +4 -1
  9. package/package.json +2 -2
  10. package/report.api.md +91 -90
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @atlaskit/eslint-plugin-design-system
2
2
 
3
+ ## 10.7.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#110808](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/110808)
8
+ [`24a3703dbdfe3`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/24a3703dbdfe3) -
9
+ Change use-tokens-typography rule to only suggest fixes.
10
+
3
11
  ## 10.6.1
4
12
 
5
13
  ### Patch Changes
@@ -188,7 +196,7 @@
188
196
 
189
197
  - [#91506](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/91506)
190
198
  [`2724a3783955`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/2724a3783955) -
191
- Add support for React 18.
199
+ Add support for React 18 in non-strict mode.
192
200
 
193
201
  ## 9.4.1
194
202
 
package/constellation/index/props.mdx CHANGED
@@ -8,9 +8,8 @@ module.exports = {
8
8
  };
9
9
  ```
10
10
 
11
- We don't recommended maintaining your own configuration.
12
- If you do not use our config you will need to specify individual rules and configuration.
13
- Add the plugin to your `.eslintrc.js` file.
11
+ We don't recommended maintaining your own configuration. If you do not use our config you will need
12
+ to specify individual rules and configuration. Add the plugin to your `.eslintrc.js` file.
14
13
 
15
14
  ```diff
16
15
  module.exports = {
package/dist/cjs/rules/use-tokens-typography/index.js CHANGED
@@ -27,7 +27,7 @@ var create = function create(context) {
27
27
  var rule = (0, _createRule.createLintRule)({
28
28
  meta: {
29
29
  name: 'use-tokens-typography',
30
- type: 'problem',
30
+ type: 'suggestion',
31
31
  fixable: 'code',
32
32
  hasSuggestions: true,
33
33
  docs: {
package/dist/cjs/rules/use-tokens-typography/transformers/style-object.js CHANGED
@@ -158,7 +158,10 @@ var StyleObject = exports.StyleObject = {
158
158
  data: {
159
159
  payload: "fontSize:".concat(fontSizeRaw)
160
160
  },
161
- fix: StyleObject._fix(fixerRefs, context)
161
+ suggest: [{
162
+ desc: "Convert to font token",
163
+ fix: StyleObject._fix(fixerRefs, context)
164
+ }]
162
165
  });
163
166
  } else if (!matchingTokens.length) {
164
167
  context.report({
package/dist/es2019/rules/use-tokens-typography/index.js CHANGED
@@ -19,7 +19,7 @@ const create = context => {
19
19
  const rule = createLintRule({
20
20
  meta: {
21
21
  name: 'use-tokens-typography',
22
- type: 'problem',
22
+ type: 'suggestion',
23
23
  fixable: 'code',
24
24
  hasSuggestions: true,
25
25
  docs: {
package/dist/es2019/rules/use-tokens-typography/transformers/style-object.js CHANGED
@@ -152,7 +152,10 @@ export const StyleObject = {
152
152
  data: {
153
153
  payload: `fontSize:${fontSizeRaw}`
154
154
  },
155
- fix: StyleObject._fix(fixerRefs, context)
155
+ suggest: [{
156
+ desc: `Convert to font token`,
157
+ fix: StyleObject._fix(fixerRefs, context)
158
+ }]
156
159
  });
157
160
  } else if (!matchingTokens.length) {
158
161
  context.report({
package/dist/esm/rules/use-tokens-typography/index.js CHANGED
@@ -21,7 +21,7 @@ var create = function create(context) {
21
21
  var rule = createLintRule({
22
22
  meta: {
23
23
  name: 'use-tokens-typography',
24
- type: 'problem',
24
+ type: 'suggestion',
25
25
  fixable: 'code',
26
26
  hasSuggestions: true,
27
27
  docs: {
package/dist/esm/rules/use-tokens-typography/transformers/style-object.js CHANGED
@@ -152,7 +152,10 @@ export var StyleObject = {
152
152
  data: {
153
153
  payload: "fontSize:".concat(fontSizeRaw)
154
154
  },
155
- fix: StyleObject._fix(fixerRefs, context)
155
+ suggest: [{
156
+ desc: "Convert to font token",
157
+ fix: StyleObject._fix(fixerRefs, context)
158
+ }]
156
159
  });
157
160
  } else if (!matchingTokens.length) {
158
161
  context.report({
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@atlaskit/eslint-plugin-design-system",
3
3
  "description": "The essential plugin for use with the Atlassian Design System.",
4
- "version": "10.6.1",
4
+ "version": "10.7.0",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
7
7
  "publishConfig": {
@@ -41,7 +41,7 @@
41
41
  "react": "^16.8.0 || ^17.0.0 || ~18.2.0"
42
42
  },
43
43
  "dependencies": {
44
- "@atlaskit/eslint-utils": "^1.5.0",
44
+ "@atlaskit/eslint-utils": "^1.6.0",
45
45
  "@atlaskit/tokens": "*",
46
46
  "@babel/runtime": "^7.0.0",
47
47
  "@typescript-eslint/utils": "^5.48.1",
package/report.api.md CHANGED
@@ -2,7 +2,8 @@
2
2
 
3
3
  ## API Report File for "@atlaskit/eslint-plugin-design-system"
4
4
 
5
- > Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
5
+ > Do not edit this file. This report is auto-generated using
6
+ > [API Extractor](https://api-extractor.com/).
6
7
  > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
7
8
 
8
9
  ### Table of contents
@@ -21,48 +22,48 @@ import { RuleModule } from '@typescript-eslint/utils/dist/ts-eslint/Rule';
21
22
 
22
23
  // @public (undocumented)
23
24
  export const configs: {
24
- all: {
25
- plugins: string[];
26
- rules: {
27
- '@atlaskit/design-system/consistent-css-prop-usage': string;
28
- '@atlaskit/design-system/ensure-design-token-usage': string;
29
- '@atlaskit/design-system/ensure-design-token-usage/preview': string;
30
- '@atlaskit/design-system/icon-label': string;
31
- '@atlaskit/design-system/no-banned-imports': string;
32
- '@atlaskit/design-system/no-css-tagged-template-expression': string;
33
- '@atlaskit/design-system/no-deprecated-apis': string;
34
- '@atlaskit/design-system/no-deprecated-design-token-usage': string;
35
- '@atlaskit/design-system/no-deprecated-imports': string;
36
- '@atlaskit/design-system/no-margin': string;
37
- '@atlaskit/design-system/no-nested-styles': string;
38
- '@atlaskit/design-system/no-physical-properties': string;
39
- '@atlaskit/design-system/no-unsafe-design-token-usage': string;
40
- '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': string;
41
- '@atlaskit/design-system/prefer-primitives': string;
42
- '@atlaskit/design-system/use-drawer-label': string;
43
- '@atlaskit/design-system/use-href-in-link-item': string;
44
- '@atlaskit/design-system/use-primitives': string;
45
- '@atlaskit/design-system/use-visually-hidden': string;
46
- };
47
- };
48
- recommended: {
49
- plugins: string[];
50
- rules: {
51
- '@atlaskit/design-system/consistent-css-prop-usage': string;
52
- '@atlaskit/design-system/ensure-design-token-usage': string;
53
- '@atlaskit/design-system/icon-label': string;
54
- '@atlaskit/design-system/no-banned-imports': string;
55
- '@atlaskit/design-system/no-deprecated-apis': string;
56
- '@atlaskit/design-system/no-deprecated-design-token-usage': string;
57
- '@atlaskit/design-system/no-deprecated-imports': string;
58
- '@atlaskit/design-system/no-nested-styles': string;
59
- '@atlaskit/design-system/no-unsafe-design-token-usage': string;
60
- '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': string;
61
- '@atlaskit/design-system/use-drawer-label': string;
62
- '@atlaskit/design-system/use-href-in-link-item': string;
63
- '@atlaskit/design-system/use-visually-hidden': string;
64
- };
65
- };
25
+ all: {
26
+ plugins: string[];
27
+ rules: {
28
+ '@atlaskit/design-system/consistent-css-prop-usage': string;
29
+ '@atlaskit/design-system/ensure-design-token-usage': string;
30
+ '@atlaskit/design-system/ensure-design-token-usage/preview': string;
31
+ '@atlaskit/design-system/icon-label': string;
32
+ '@atlaskit/design-system/no-banned-imports': string;
33
+ '@atlaskit/design-system/no-css-tagged-template-expression': string;
34
+ '@atlaskit/design-system/no-deprecated-apis': string;
35
+ '@atlaskit/design-system/no-deprecated-design-token-usage': string;
36
+ '@atlaskit/design-system/no-deprecated-imports': string;
37
+ '@atlaskit/design-system/no-margin': string;
38
+ '@atlaskit/design-system/no-nested-styles': string;
39
+ '@atlaskit/design-system/no-physical-properties': string;
40
+ '@atlaskit/design-system/no-unsafe-design-token-usage': string;
41
+ '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': string;
42
+ '@atlaskit/design-system/prefer-primitives': string;
43
+ '@atlaskit/design-system/use-drawer-label': string;
44
+ '@atlaskit/design-system/use-href-in-link-item': string;
45
+ '@atlaskit/design-system/use-primitives': string;
46
+ '@atlaskit/design-system/use-visually-hidden': string;
47
+ };
48
+ };
49
+ recommended: {
50
+ plugins: string[];
51
+ rules: {
52
+ '@atlaskit/design-system/consistent-css-prop-usage': string;
53
+ '@atlaskit/design-system/ensure-design-token-usage': string;
54
+ '@atlaskit/design-system/icon-label': string;
55
+ '@atlaskit/design-system/no-banned-imports': string;
56
+ '@atlaskit/design-system/no-deprecated-apis': string;
57
+ '@atlaskit/design-system/no-deprecated-design-token-usage': string;
58
+ '@atlaskit/design-system/no-deprecated-imports': string;
59
+ '@atlaskit/design-system/no-nested-styles': string;
60
+ '@atlaskit/design-system/no-unsafe-design-token-usage': string;
61
+ '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': string;
62
+ '@atlaskit/design-system/use-drawer-label': string;
63
+ '@atlaskit/design-system/use-href-in-link-item': string;
64
+ '@atlaskit/design-system/use-visually-hidden': string;
65
+ };
66
+ };
66
67
  };
67
68
 
68
69
  // @public (undocumented)
@@ -70,73 +71,73 @@ type DeprecatedConfig = DeprecatedImportConfig | DeprecatedJSXAttributeConfig;
70
71
 
71
72
  // @public (undocumented)
72
73
  type DeprecatedImportConfig = {
73
- [key: string]: DeprecatedImportConfigEntry;
74
+ [key: string]: DeprecatedImportConfigEntry;
74
75
  };
75
76
 
76
77
  // @public (undocumented)
77
78
  type DeprecatedImportConfigEntry = {
78
- message?: string;
79
- importSpecifiers?: {
80
- importName: string;
81
- message: string;
82
- }[];
79
+ message?: string;
80
+ importSpecifiers?: {
81
+ importName: string;
82
+ message: string;
83
+ }[];
83
84
  };
84
85
 
85
86
  // @public (undocumented)
86
87
  type DeprecatedJSXAttributeConfig = {
87
- [key: string]: DeprecatedJSXAttributeConfigEntry[];
88
+ [key: string]: DeprecatedJSXAttributeConfigEntry[];
88
89
  };
89
90
 
90
91
  // @public (undocumented)
91
92
  type DeprecatedJSXAttributeConfigEntry = {
92
- moduleSpecifier: string;
93
- namedSpecifiers?: string[];
94
- actionableVersion?: string;
93
+ moduleSpecifier: string;
94
+ namedSpecifiers?: string[];
95
+ actionableVersion?: string;
95
96
  };
96
97
 
97
98
  // @public (undocumented)
98
99
  export const filterActionableDeprecations: (
99
- originalDeprecatedConfig: string,
100
- rootPackageJson: string,
100
+ originalDeprecatedConfig: string,
101
+ rootPackageJson: string,
101
102
  ) => string;
102
103
 
103
104
  // @public (undocumented)
104
105
  export const rules: {
105
- 'consistent-css-prop-usage': Rule.RuleModule;
106
- 'ensure-design-token-usage': Rule.RuleModule;
107
- 'ensure-design-token-usage/preview': Rule.RuleModule;
108
- 'icon-label': Rule.RuleModule;
109
- 'no-banned-imports': Rule.RuleModule;
110
- 'no-css-tagged-template-expression': Rule.RuleModule;
111
- 'no-deprecated-apis': RuleModule<
112
- string,
113
- [
114
- {
115
- deprecatedConfig: DeprecatedConfig;
116
- },
117
- ],
118
- RuleListener
119
- >;
120
- 'no-deprecated-design-token-usage': Rule.RuleModule;
121
- 'no-deprecated-imports': RuleModule<
122
- string,
123
- [
124
- {
125
- deprecatedConfig: DeprecatedConfig;
126
- },
127
- ],
128
- RuleListener
129
- >;
130
- 'no-margin': Rule.RuleModule;
131
- 'no-nested-styles': Rule.RuleModule;
132
- 'no-physical-properties': Rule.RuleModule;
133
- 'no-unsafe-design-token-usage': Rule.RuleModule;
134
- 'no-unsupported-drag-and-drop-libraries': Rule.RuleModule;
135
- 'prefer-primitives': Rule.RuleModule;
136
- 'use-drawer-label': Rule.RuleModule;
137
- 'use-href-in-link-item': Rule.RuleModule;
138
- 'use-primitives': Rule.RuleModule;
139
- 'use-visually-hidden': Rule.RuleModule;
106
+ 'consistent-css-prop-usage': Rule.RuleModule;
107
+ 'ensure-design-token-usage': Rule.RuleModule;
108
+ 'ensure-design-token-usage/preview': Rule.RuleModule;
109
+ 'icon-label': Rule.RuleModule;
110
+ 'no-banned-imports': Rule.RuleModule;
111
+ 'no-css-tagged-template-expression': Rule.RuleModule;
112
+ 'no-deprecated-apis': RuleModule<
113
+ string,
114
+ [
115
+ {
116
+ deprecatedConfig: DeprecatedConfig;
117
+ },
118
+ ],
119
+ RuleListener
120
+ >;
121
+ 'no-deprecated-design-token-usage': Rule.RuleModule;
122
+ 'no-deprecated-imports': RuleModule<
123
+ string,
124
+ [
125
+ {
126
+ deprecatedConfig: DeprecatedConfig;
127
+ },
128
+ ],
129
+ RuleListener
130
+ >;
131
+ 'no-margin': Rule.RuleModule;
132
+ 'no-nested-styles': Rule.RuleModule;
133
+ 'no-physical-properties': Rule.RuleModule;
134
+ 'no-unsafe-design-token-usage': Rule.RuleModule;
135
+ 'no-unsupported-drag-and-drop-libraries': Rule.RuleModule;
136
+ 'prefer-primitives': Rule.RuleModule;
137
+ 'use-drawer-label': Rule.RuleModule;
138
+ 'use-href-in-link-item': Rule.RuleModule;
139
+ 'use-primitives': Rule.RuleModule;
140
+ 'use-visually-hidden': Rule.RuleModule;
140
141
  };
141
142
 
142
143
  // (No @packageDocumentation comment for this package)