@atlaskit/eslint-plugin-design-system 5.2.0 → 5.3.1
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.
- package/CHANGELOG.md +12 -0
- package/README.md +1 -1
- package/constellation/index/usage.mdx +1 -1
- package/dist/cjs/presets/all.codegen.js +5 -5
- package/dist/cjs/rules/ensure-design-token-usage/index.js +2 -1
- package/dist/cjs/rules/icon-label/index.js +2 -1
- package/dist/cjs/rules/no-banned-imports/index.js +2 -1
- package/dist/cjs/rules/no-deprecated-design-token-usage/index.js +2 -1
- package/dist/cjs/rules/no-margin/index.js +1 -0
- package/dist/cjs/rules/no-unsafe-design-token-usage/index.js +2 -1
- package/dist/cjs/rules/use-primitives/index.js +3 -1
- package/dist/cjs/rules/use-visually-hidden/index.js +2 -1
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/presets/all.codegen.js +5 -5
- package/dist/es2019/rules/ensure-design-token-usage/index.js +2 -1
- package/dist/es2019/rules/icon-label/index.js +2 -1
- package/dist/es2019/rules/no-banned-imports/index.js +2 -1
- package/dist/es2019/rules/no-deprecated-design-token-usage/index.js +2 -1
- package/dist/es2019/rules/no-margin/index.js +1 -0
- package/dist/es2019/rules/no-unsafe-design-token-usage/index.js +2 -1
- package/dist/es2019/rules/use-primitives/index.js +3 -1
- package/dist/es2019/rules/use-visually-hidden/index.js +2 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/presets/all.codegen.js +5 -5
- package/dist/esm/rules/ensure-design-token-usage/index.js +2 -1
- package/dist/esm/rules/icon-label/index.js +2 -1
- package/dist/esm/rules/no-banned-imports/index.js +2 -1
- package/dist/esm/rules/no-deprecated-design-token-usage/index.js +2 -1
- package/dist/esm/rules/no-margin/index.js +1 -0
- package/dist/esm/rules/no-unsafe-design-token-usage/index.js +2 -1
- package/dist/esm/rules/use-primitives/index.js +3 -1
- package/dist/esm/rules/use-visually-hidden/index.js +2 -1
- package/dist/esm/version.json +1 -1
- package/dist/types/presets/all.codegen.d.ts +5 -5
- package/dist/types/presets/recommended.codegen.d.ts +5 -5
- package/dist/types/rules/ensure-design-token-usage-spacing/index.d.ts +2 -2
- package/dist/types/rules/ensure-design-token-usage-spacing/utils.d.ts +2 -2
- package/dist/types/rules/use-primitives/types.d.ts +1 -1
- package/dist/types/rules/use-visually-hidden/utils.d.ts +2 -2
- package/dist/types/rules/utils/create-rule.d.ts +6 -3
- package/dist/types/rules/utils/get-is-exception.d.ts +1 -1
- package/dist/types/rules/utils/is-node.d.ts +2 -2
- package/dist/types/rules/utils/types.d.ts +6 -6
- package/package.json +6 -5
- package/dist/types-ts4.0/index.codegen.d.ts +0 -32
- package/dist/types-ts4.0/index.d.ts +0 -2
- package/dist/types-ts4.0/presets/all.codegen.d.ts +0 -22
- package/dist/types-ts4.0/presets/recommended.codegen.d.ts +0 -19
- package/dist/types-ts4.0/rules/ensure-design-token-usage/index.d.ts +0 -3
- package/dist/types-ts4.0/rules/ensure-design-token-usage-spacing/index.d.ts +0 -9
- package/dist/types-ts4.0/rules/ensure-design-token-usage-spacing/utils.d.ts +0 -166
- package/dist/types-ts4.0/rules/icon-label/index.d.ts +0 -2
- package/dist/types-ts4.0/rules/index.codegen.d.ts +0 -27
- package/dist/types-ts4.0/rules/no-banned-imports/index.d.ts +0 -2
- package/dist/types-ts4.0/rules/no-banned-imports/paths.d.ts +0 -4
- package/dist/types-ts4.0/rules/no-deprecated-apis/helpers/filter-actionable-deprecations.d.ts +0 -1
- package/dist/types-ts4.0/rules/no-deprecated-apis/helpers/validate-deprecated-apis-config.d.ts +0 -2
- package/dist/types-ts4.0/rules/no-deprecated-apis/index.d.ts +0 -10
- package/dist/types-ts4.0/rules/no-deprecated-design-token-usage/index.d.ts +0 -3
- package/dist/types-ts4.0/rules/no-deprecated-imports/index.d.ts +0 -37
- package/dist/types-ts4.0/rules/no-margin/index.d.ts +0 -3
- package/dist/types-ts4.0/rules/no-unsafe-design-token-usage/index.d.ts +0 -3
- package/dist/types-ts4.0/rules/use-primitives/index.d.ts +0 -2
- package/dist/types-ts4.0/rules/use-primitives/types.d.ts +0 -3
- package/dist/types-ts4.0/rules/use-primitives/utils.d.ts +0 -7
- package/dist/types-ts4.0/rules/use-visually-hidden/constants.d.ts +0 -3
- package/dist/types-ts4.0/rules/use-visually-hidden/fix-jsx.d.ts +0 -3
- package/dist/types-ts4.0/rules/use-visually-hidden/fix-vanilla.d.ts +0 -3
- package/dist/types-ts4.0/rules/use-visually-hidden/index.d.ts +0 -3
- package/dist/types-ts4.0/rules/use-visually-hidden/utils.d.ts +0 -35
- package/dist/types-ts4.0/rules/utils/create-rule.d.ts +0 -45
- package/dist/types-ts4.0/rules/utils/get-deprecated-config.d.ts +0 -2
- package/dist/types-ts4.0/rules/utils/get-import-node-by-source.d.ts +0 -8
- package/dist/types-ts4.0/rules/utils/get-is-exception.d.ts +0 -2
- package/dist/types-ts4.0/rules/utils/is-color.d.ts +0 -5
- package/dist/types-ts4.0/rules/utils/is-elevation.d.ts +0 -5
- package/dist/types-ts4.0/rules/utils/is-node.d.ts +0 -10
- package/dist/types-ts4.0/rules/utils/is-token.d.ts +0 -1
- package/dist/types-ts4.0/rules/utils/jsx.d.ts +0 -2
- package/dist/types-ts4.0/rules/utils/types.d.ts +0 -22
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @atlaskit/eslint-plugin-design-system
|
|
2
2
|
|
|
3
|
+
## 5.3.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
|
|
8
|
+
|
|
9
|
+
## 5.3.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- [`51a48a1bb1b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/51a48a1bb1b) - Update docs to accept a `severity` property so the purpose of `recommended` is no longer double. "all" preset now respects this preference - before it was always "error". This makes the presets more aligned with the underlying implementations."
|
|
14
|
+
|
|
3
15
|
## 5.2.0
|
|
4
16
|
|
|
5
17
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -58,7 +58,7 @@ module.exports = {
|
|
|
58
58
|
| <a href="./src/rules/no-deprecated-imports/README.md">no-deprecated-imports</a> | Disallow importing deprecated modules. | Yes | | |
|
|
59
59
|
| <a href="./src/rules/no-margin/README.md">no-margin</a> | Disallow using the margin CSS property. | | | |
|
|
60
60
|
| <a href="./src/rules/no-unsafe-design-token-usage/README.md">no-unsafe-design-token-usage</a> | Enforces design token usage is statically and locally analyzable. | Yes | Yes | |
|
|
61
|
-
| <a href="./src/rules/use-primitives/README.md">use-primitives</a> | Encourage the usage of primitives components. | | Yes |
|
|
61
|
+
| <a href="./src/rules/use-primitives/README.md">use-primitives</a> | Encourage the usage of primitives components. | | Yes | Yes |
|
|
62
62
|
| <a href="./src/rules/use-visually-hidden/README.md">use-visually-hidden</a> | Enforce usage of the visually hidden component. | Yes | Yes | |
|
|
63
63
|
|
|
64
64
|
<!-- END_RULE_TABLE_CODEGEN -->
|
|
@@ -22,7 +22,7 @@ This plugin contains rules that should be used when working with the [Atlassian
|
|
|
22
22
|
| <a href="#no-deprecated-imports">no-deprecated-imports</a> | Disallow importing deprecated modules. | Yes | | |
|
|
23
23
|
| <a href="#no-margin">no-margin</a> | Disallow using the margin CSS property. | | | |
|
|
24
24
|
| <a href="#no-unsafe-design-token-usage">no-unsafe-design-token-usage</a> | Enforces design token usage is statically and locally analyzable. | Yes | Yes | |
|
|
25
|
-
| <a href="#use-primitives">use-primitives</a> | Encourage the usage of primitives components. | | Yes |
|
|
25
|
+
| <a href="#use-primitives">use-primitives</a> | Encourage the usage of primitives components. | | Yes | Yes |
|
|
26
26
|
| <a href="#use-visually-hidden">use-visually-hidden</a> | Enforce usage of the visually hidden component. | Yes | Yes | |
|
|
27
27
|
|
|
28
28
|
<!-- END_RULE_TABLE_CODEGEN -->
|
|
@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports.default = void 0;
|
|
7
7
|
/**
|
|
8
8
|
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
9
|
-
* @codegen <<SignedSource::
|
|
9
|
+
* @codegen <<SignedSource::3f9b973d6350522de7bd32f13c58ce56>>
|
|
10
10
|
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
|
|
11
11
|
*/
|
|
12
12
|
var _default = {
|
|
@@ -14,14 +14,14 @@ var _default = {
|
|
|
14
14
|
rules: {
|
|
15
15
|
'@atlaskit/design-system/ensure-design-token-usage': 'error',
|
|
16
16
|
'@atlaskit/design-system/ensure-design-token-usage-spacing': 'error',
|
|
17
|
-
'@atlaskit/design-system/icon-label': '
|
|
17
|
+
'@atlaskit/design-system/icon-label': 'warn',
|
|
18
18
|
'@atlaskit/design-system/no-banned-imports': 'error',
|
|
19
19
|
'@atlaskit/design-system/no-deprecated-apis': 'error',
|
|
20
|
-
'@atlaskit/design-system/no-deprecated-design-token-usage': '
|
|
20
|
+
'@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
|
|
21
21
|
'@atlaskit/design-system/no-deprecated-imports': 'error',
|
|
22
|
-
'@atlaskit/design-system/no-margin': '
|
|
22
|
+
'@atlaskit/design-system/no-margin': 'warn',
|
|
23
23
|
'@atlaskit/design-system/no-unsafe-design-token-usage': 'error',
|
|
24
|
-
'@atlaskit/design-system/use-primitives': '
|
|
24
|
+
'@atlaskit/design-system/use-primitives': 'warn',
|
|
25
25
|
'@atlaskit/design-system/use-visually-hidden': 'error'
|
|
26
26
|
}
|
|
27
27
|
};
|
|
@@ -16,7 +16,8 @@ var rule = (0, _createRule.createLintRule)({
|
|
|
16
16
|
type: 'suggestion',
|
|
17
17
|
docs: {
|
|
18
18
|
description: 'Enforces accessible usage of icon labels when composed with Atlassian Design System components.',
|
|
19
|
-
recommended:
|
|
19
|
+
recommended: true,
|
|
20
|
+
severity: 'warn'
|
|
20
21
|
},
|
|
21
22
|
messages: {
|
|
22
23
|
unneededLabelPropContents: 'Label prop should be an empty string to prevent duplicate screen reader announcements. Learn more here: http://go/adsc/icon/usage#accessibility-guidelines.',
|
|
@@ -13,7 +13,8 @@ var rule = (0, _createRule.createLintRule)({
|
|
|
13
13
|
type: 'problem',
|
|
14
14
|
docs: {
|
|
15
15
|
description: 'Disallow importing banned modules.',
|
|
16
|
-
recommended:
|
|
16
|
+
recommended: true,
|
|
17
|
+
severity: 'error'
|
|
17
18
|
},
|
|
18
19
|
messages: {
|
|
19
20
|
path: "The '{{importSource}}' import is restricted from being used. {{customMessage}}"
|
|
@@ -13,7 +13,8 @@ var rule = (0, _createRule.createLintRule)({
|
|
|
13
13
|
name: 'no-deprecated-design-token-usage',
|
|
14
14
|
docs: {
|
|
15
15
|
description: 'Disallow using deprecated design tokens.',
|
|
16
|
-
recommended:
|
|
16
|
+
recommended: true,
|
|
17
|
+
severity: 'warn'
|
|
17
18
|
},
|
|
18
19
|
fixable: 'code',
|
|
19
20
|
type: 'problem',
|
|
@@ -20,7 +20,8 @@ var rule = (0, _createRule.createLintRule)({
|
|
|
20
20
|
name: 'no-unsafe-design-token-usage',
|
|
21
21
|
docs: {
|
|
22
22
|
description: 'Enforces design token usage is statically and locally analyzable.',
|
|
23
|
-
recommended:
|
|
23
|
+
recommended: true,
|
|
24
|
+
severity: 'error'
|
|
24
25
|
},
|
|
25
26
|
fixable: 'code',
|
|
26
27
|
type: 'problem',
|
|
@@ -15,9 +15,11 @@ var rule = (0, _createRule.createLintRule)({
|
|
|
15
15
|
name: 'use-primitives',
|
|
16
16
|
type: 'suggestion',
|
|
17
17
|
fixable: 'code',
|
|
18
|
+
hasSuggestions: true,
|
|
18
19
|
docs: {
|
|
19
20
|
description: 'Encourage the usage of primitives components.',
|
|
20
|
-
recommended: false
|
|
21
|
+
recommended: false,
|
|
22
|
+
severity: 'warn'
|
|
21
23
|
},
|
|
22
24
|
messages: {
|
|
23
25
|
preferPrimitivesBox: "This \"{{element}}\" may be able to be replaced with a \"Box\". See ".concat(boxDocsUrl, " for guidance."),
|
|
@@ -20,7 +20,8 @@ var rule = (0, _createRule.createLintRule)({
|
|
|
20
20
|
fixable: 'code',
|
|
21
21
|
docs: {
|
|
22
22
|
description: 'Enforce usage of the visually hidden component.',
|
|
23
|
-
recommended:
|
|
23
|
+
recommended: true,
|
|
24
|
+
severity: 'error'
|
|
24
25
|
},
|
|
25
26
|
messages: {
|
|
26
27
|
noDeprecatedUsage: 'Using the export `{{local}}` from `{{import}}` as a mixin is discouraged. Please use `@atlaskit/visually-hidden` instead.',
|
package/dist/cjs/version.json
CHANGED
|
@@ -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::
|
|
3
|
+
* @codegen <<SignedSource::3f9b973d6350522de7bd32f13c58ce56>>
|
|
4
4
|
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
|
|
5
5
|
*/
|
|
6
6
|
export default {
|
|
@@ -8,14 +8,14 @@ export default {
|
|
|
8
8
|
rules: {
|
|
9
9
|
'@atlaskit/design-system/ensure-design-token-usage': 'error',
|
|
10
10
|
'@atlaskit/design-system/ensure-design-token-usage-spacing': 'error',
|
|
11
|
-
'@atlaskit/design-system/icon-label': '
|
|
11
|
+
'@atlaskit/design-system/icon-label': 'warn',
|
|
12
12
|
'@atlaskit/design-system/no-banned-imports': 'error',
|
|
13
13
|
'@atlaskit/design-system/no-deprecated-apis': 'error',
|
|
14
|
-
'@atlaskit/design-system/no-deprecated-design-token-usage': '
|
|
14
|
+
'@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
|
|
15
15
|
'@atlaskit/design-system/no-deprecated-imports': 'error',
|
|
16
|
-
'@atlaskit/design-system/no-margin': '
|
|
16
|
+
'@atlaskit/design-system/no-margin': 'warn',
|
|
17
17
|
'@atlaskit/design-system/no-unsafe-design-token-usage': 'error',
|
|
18
|
-
'@atlaskit/design-system/use-primitives': '
|
|
18
|
+
'@atlaskit/design-system/use-primitives': 'warn',
|
|
19
19
|
'@atlaskit/design-system/use-visually-hidden': 'error'
|
|
20
20
|
}
|
|
21
21
|
};
|
|
@@ -10,7 +10,8 @@ const rule = createLintRule({
|
|
|
10
10
|
type: 'suggestion',
|
|
11
11
|
docs: {
|
|
12
12
|
description: 'Enforces accessible usage of icon labels when composed with Atlassian Design System components.',
|
|
13
|
-
recommended:
|
|
13
|
+
recommended: true,
|
|
14
|
+
severity: 'warn'
|
|
14
15
|
},
|
|
15
16
|
messages: {
|
|
16
17
|
unneededLabelPropContents: 'Label prop should be an empty string to prevent duplicate screen reader announcements. Learn more here: http://go/adsc/icon/usage#accessibility-guidelines.',
|
|
@@ -7,7 +7,8 @@ const rule = createLintRule({
|
|
|
7
7
|
type: 'problem',
|
|
8
8
|
docs: {
|
|
9
9
|
description: 'Disallow importing banned modules.',
|
|
10
|
-
recommended:
|
|
10
|
+
recommended: true,
|
|
11
|
+
severity: 'error'
|
|
11
12
|
},
|
|
12
13
|
messages: {
|
|
13
14
|
path: "The '{{importSource}}' import is restricted from being used. {{customMessage}}"
|
|
@@ -13,7 +13,8 @@ const rule = createLintRule({
|
|
|
13
13
|
name: 'no-unsafe-design-token-usage',
|
|
14
14
|
docs: {
|
|
15
15
|
description: 'Enforces design token usage is statically and locally analyzable.',
|
|
16
|
-
recommended:
|
|
16
|
+
recommended: true,
|
|
17
|
+
severity: 'error'
|
|
17
18
|
},
|
|
18
19
|
fixable: 'code',
|
|
19
20
|
type: 'problem',
|
|
@@ -9,9 +9,11 @@ const rule = createLintRule({
|
|
|
9
9
|
name: 'use-primitives',
|
|
10
10
|
type: 'suggestion',
|
|
11
11
|
fixable: 'code',
|
|
12
|
+
hasSuggestions: true,
|
|
12
13
|
docs: {
|
|
13
14
|
description: 'Encourage the usage of primitives components.',
|
|
14
|
-
recommended: false
|
|
15
|
+
recommended: false,
|
|
16
|
+
severity: 'warn'
|
|
15
17
|
},
|
|
16
18
|
messages: {
|
|
17
19
|
preferPrimitivesBox: `This "{{element}}" may be able to be replaced with a "Box". See ${boxDocsUrl} for guidance.`,
|
|
@@ -12,7 +12,8 @@ const rule = createLintRule({
|
|
|
12
12
|
fixable: 'code',
|
|
13
13
|
docs: {
|
|
14
14
|
description: 'Enforce usage of the visually hidden component.',
|
|
15
|
-
recommended:
|
|
15
|
+
recommended: true,
|
|
16
|
+
severity: 'error'
|
|
16
17
|
},
|
|
17
18
|
messages: {
|
|
18
19
|
noDeprecatedUsage: 'Using the export `{{local}}` from `{{import}}` as a mixin is discouraged. Please use `@atlaskit/visually-hidden` instead.',
|
package/dist/es2019/version.json
CHANGED
|
@@ -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::
|
|
3
|
+
* @codegen <<SignedSource::3f9b973d6350522de7bd32f13c58ce56>>
|
|
4
4
|
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
|
|
5
5
|
*/
|
|
6
6
|
export default {
|
|
@@ -8,14 +8,14 @@ export default {
|
|
|
8
8
|
rules: {
|
|
9
9
|
'@atlaskit/design-system/ensure-design-token-usage': 'error',
|
|
10
10
|
'@atlaskit/design-system/ensure-design-token-usage-spacing': 'error',
|
|
11
|
-
'@atlaskit/design-system/icon-label': '
|
|
11
|
+
'@atlaskit/design-system/icon-label': 'warn',
|
|
12
12
|
'@atlaskit/design-system/no-banned-imports': 'error',
|
|
13
13
|
'@atlaskit/design-system/no-deprecated-apis': 'error',
|
|
14
|
-
'@atlaskit/design-system/no-deprecated-design-token-usage': '
|
|
14
|
+
'@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
|
|
15
15
|
'@atlaskit/design-system/no-deprecated-imports': 'error',
|
|
16
|
-
'@atlaskit/design-system/no-margin': '
|
|
16
|
+
'@atlaskit/design-system/no-margin': 'warn',
|
|
17
17
|
'@atlaskit/design-system/no-unsafe-design-token-usage': 'error',
|
|
18
|
-
'@atlaskit/design-system/use-primitives': '
|
|
18
|
+
'@atlaskit/design-system/use-primitives': 'warn',
|
|
19
19
|
'@atlaskit/design-system/use-visually-hidden': 'error'
|
|
20
20
|
}
|
|
21
21
|
};
|
|
@@ -10,7 +10,8 @@ var rule = createLintRule({
|
|
|
10
10
|
type: 'suggestion',
|
|
11
11
|
docs: {
|
|
12
12
|
description: 'Enforces accessible usage of icon labels when composed with Atlassian Design System components.',
|
|
13
|
-
recommended:
|
|
13
|
+
recommended: true,
|
|
14
|
+
severity: 'warn'
|
|
14
15
|
},
|
|
15
16
|
messages: {
|
|
16
17
|
unneededLabelPropContents: 'Label prop should be an empty string to prevent duplicate screen reader announcements. Learn more here: http://go/adsc/icon/usage#accessibility-guidelines.',
|
|
@@ -7,7 +7,8 @@ var rule = createLintRule({
|
|
|
7
7
|
type: 'problem',
|
|
8
8
|
docs: {
|
|
9
9
|
description: 'Disallow importing banned modules.',
|
|
10
|
-
recommended:
|
|
10
|
+
recommended: true,
|
|
11
|
+
severity: 'error'
|
|
11
12
|
},
|
|
12
13
|
messages: {
|
|
13
14
|
path: "The '{{importSource}}' import is restricted from being used. {{customMessage}}"
|
|
@@ -13,7 +13,8 @@ var rule = createLintRule({
|
|
|
13
13
|
name: 'no-unsafe-design-token-usage',
|
|
14
14
|
docs: {
|
|
15
15
|
description: 'Enforces design token usage is statically and locally analyzable.',
|
|
16
|
-
recommended:
|
|
16
|
+
recommended: true,
|
|
17
|
+
severity: 'error'
|
|
17
18
|
},
|
|
18
19
|
fixable: 'code',
|
|
19
20
|
type: 'problem',
|
|
@@ -9,9 +9,11 @@ var rule = createLintRule({
|
|
|
9
9
|
name: 'use-primitives',
|
|
10
10
|
type: 'suggestion',
|
|
11
11
|
fixable: 'code',
|
|
12
|
+
hasSuggestions: true,
|
|
12
13
|
docs: {
|
|
13
14
|
description: 'Encourage the usage of primitives components.',
|
|
14
|
-
recommended: false
|
|
15
|
+
recommended: false,
|
|
16
|
+
severity: 'warn'
|
|
15
17
|
},
|
|
16
18
|
messages: {
|
|
17
19
|
preferPrimitivesBox: "This \"{{element}}\" may be able to be replaced with a \"Box\". See ".concat(boxDocsUrl, " for guidance."),
|
|
@@ -13,7 +13,8 @@ var rule = createLintRule({
|
|
|
13
13
|
fixable: 'code',
|
|
14
14
|
docs: {
|
|
15
15
|
description: 'Enforce usage of the visually hidden component.',
|
|
16
|
-
recommended:
|
|
16
|
+
recommended: true,
|
|
17
|
+
severity: 'error'
|
|
17
18
|
},
|
|
18
19
|
messages: {
|
|
19
20
|
noDeprecatedUsage: 'Using the export `{{local}}` from `{{import}}` as a mixin is discouraged. Please use `@atlaskit/visually-hidden` instead.',
|
package/dist/esm/version.json
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
3
|
+
* @codegen <<SignedSource::3f9b973d6350522de7bd32f13c58ce56>>
|
|
4
|
+
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
|
|
5
|
+
*/
|
|
1
6
|
declare const _default: {
|
|
2
7
|
plugins: string[];
|
|
3
8
|
rules: {
|
|
@@ -14,9 +19,4 @@ declare const _default: {
|
|
|
14
19
|
'@atlaskit/design-system/use-visually-hidden': string;
|
|
15
20
|
};
|
|
16
21
|
};
|
|
17
|
-
/**
|
|
18
|
-
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
19
|
-
* @codegen <<SignedSource::536ea9ab01a5dbae76af59e8ca84f921>>
|
|
20
|
-
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
|
|
21
|
-
*/
|
|
22
22
|
export default _default;
|
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
3
|
+
* @codegen <<SignedSource::b3d2f24d8d37a87fc2bbd964dfdcb87c>>
|
|
4
|
+
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
|
|
5
|
+
*/
|
|
1
6
|
declare const _default: {
|
|
2
7
|
plugins: string[];
|
|
3
8
|
rules: {
|
|
@@ -11,9 +16,4 @@ declare const _default: {
|
|
|
11
16
|
'@atlaskit/design-system/use-visually-hidden': string;
|
|
12
17
|
};
|
|
13
18
|
};
|
|
14
|
-
/**
|
|
15
|
-
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
16
|
-
* @codegen <<SignedSource::b3d2f24d8d37a87fc2bbd964dfdcb87c>>
|
|
17
|
-
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
|
|
18
|
-
*/
|
|
19
19
|
export default _default;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { Rule, Scope } from 'eslint';
|
|
2
2
|
import { EslintNode, TaggedTemplateExpression } from 'eslint-codemod-utils';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
3
|
+
export type ProcessedCSSLines = [string, string][];
|
|
4
|
+
export type TargetOptions = ('spacing' | 'typography' | 'shape')[];
|
|
5
5
|
/**
|
|
6
6
|
* Currently we have a wide range of experimental spacing tokens that we are testing.
|
|
7
7
|
* We only want transforms to apply to the stable scale values, not the rest.
|
|
@@ -10,11 +10,11 @@ declare const referenceObject: {
|
|
|
10
10
|
overflow: string;
|
|
11
11
|
whiteSpace: string;
|
|
12
12
|
};
|
|
13
|
-
|
|
13
|
+
type KeyValue = {
|
|
14
14
|
key: string;
|
|
15
15
|
value: string;
|
|
16
16
|
};
|
|
17
|
-
export
|
|
17
|
+
export type ReferenceObject = typeof referenceObject;
|
|
18
18
|
/**
|
|
19
19
|
* Returns the first import in the esprima AST.
|
|
20
20
|
*/
|
|
@@ -30,11 +30,14 @@ export interface LintRuleMeta extends Omit<Rule.RuleMetaData, 'docs'> {
|
|
|
30
30
|
description: string;
|
|
31
31
|
/**
|
|
32
32
|
* If this rule should be in the recommended preset or not.
|
|
33
|
-
* When setting to `"error"` it will mean releasing a breaking change.
|
|
34
|
-
*
|
|
35
33
|
* Set to `false` to exclude it from the recommended preset.
|
|
36
34
|
*/
|
|
37
|
-
recommended:
|
|
35
|
+
recommended: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* The severity level to be applied to this rule.
|
|
38
|
+
* When setting to `"error"` it will mean releasing a breaking change.
|
|
39
|
+
*/
|
|
40
|
+
severity: 'error' | 'warn';
|
|
38
41
|
};
|
|
39
42
|
}
|
|
40
43
|
/**
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import type { Rule } from 'eslint';
|
|
2
|
-
export declare const getIsException: (exceptions?: string[]
|
|
2
|
+
export declare const getIsException: (exceptions?: string[]) => (node: Rule.Node) => boolean;
|
|
@@ -4,7 +4,7 @@ export declare const isDecendantOfGlobalToken: (node: EslintNode) => boolean;
|
|
|
4
4
|
export declare const isDecendantOfType: (node: Rule.Node, type: Rule.Node['type'], skipNode?: boolean) => boolean;
|
|
5
5
|
export declare const isPropertyKey: (node: Rule.Node) => boolean;
|
|
6
6
|
export declare const isDecendantOfStyleJsxAttribute: (node: Rule.Node) => boolean;
|
|
7
|
-
export declare const isStyledTemplateNode: (node?: Expression | null
|
|
8
|
-
export declare const isStyledObjectNode: (node?: Expression | null
|
|
7
|
+
export declare const isStyledTemplateNode: (node?: Expression | null) => node is TaggedTemplateExpression;
|
|
8
|
+
export declare const isStyledObjectNode: (node?: Expression | null) => node is CallExpression;
|
|
9
9
|
export declare const isDecendantOfStyleBlock: (node: Rule.Node) => boolean;
|
|
10
10
|
export declare const isChildOfType: (node: Rule.Node, type: Rule.Node['type']) => boolean;
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
export
|
|
2
|
-
export
|
|
3
|
-
export
|
|
1
|
+
export type DeprecatedCategories = 'jsxAttributes' | 'imports';
|
|
2
|
+
export type DeprecatedConfig = DeprecatedJSXAttributeConfig | DeprecatedImportConfig;
|
|
3
|
+
export type DeprecatedJSXAttributeConfig = {
|
|
4
4
|
[key: string]: DeprecatedJSXAttributeConfigEntry[];
|
|
5
5
|
};
|
|
6
|
-
export
|
|
6
|
+
export type DeprecatedJSXAttributeConfigEntry = {
|
|
7
7
|
moduleSpecifier: string;
|
|
8
8
|
namedSpecifiers?: string[];
|
|
9
9
|
actionableVersion?: string;
|
|
10
10
|
};
|
|
11
|
-
export
|
|
11
|
+
export type DeprecatedImportConfig = {
|
|
12
12
|
[key: string]: DeprecatedImportConfigEntry;
|
|
13
13
|
};
|
|
14
|
-
export
|
|
14
|
+
export type DeprecatedImportConfigEntry = {
|
|
15
15
|
message?: string;
|
|
16
16
|
importSpecifiers?: {
|
|
17
17
|
importName: string;
|
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": "5.
|
|
4
|
+
"version": "5.3.1",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"publishConfig": {
|
|
7
7
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -20,9 +20,10 @@
|
|
|
20
20
|
"module:es2019": "dist/es2019/index.js",
|
|
21
21
|
"types": "dist/types/index.d.ts",
|
|
22
22
|
"typesVersions": {
|
|
23
|
-
">=4.
|
|
23
|
+
">=4.5 <4.9": {
|
|
24
24
|
"*": [
|
|
25
|
-
"dist/types-ts4.
|
|
25
|
+
"dist/types-ts4.5/*",
|
|
26
|
+
"dist/types-ts4.5/index.d.ts"
|
|
26
27
|
]
|
|
27
28
|
}
|
|
28
29
|
},
|
|
@@ -32,7 +33,7 @@
|
|
|
32
33
|
".": "./src/index.tsx"
|
|
33
34
|
},
|
|
34
35
|
"dependencies": {
|
|
35
|
-
"@atlaskit/tokens": "^1.
|
|
36
|
+
"@atlaskit/tokens": "^1.4.0",
|
|
36
37
|
"@babel/runtime": "^7.0.0",
|
|
37
38
|
"@typescript-eslint/utils": "^5.48.1",
|
|
38
39
|
"ajv": "^6.12.6",
|
|
@@ -54,7 +55,7 @@
|
|
|
54
55
|
"react": "^16.8.0",
|
|
55
56
|
"ts-node": "^10.9.1",
|
|
56
57
|
"tsconfig-paths": "^3.9.0",
|
|
57
|
-
"typescript": "4.
|
|
58
|
+
"typescript": "~4.9.5"
|
|
58
59
|
},
|
|
59
60
|
"scripts": {
|
|
60
61
|
"ak-postbuild": "cp -r configs dist",
|