@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.
- package/CHANGELOG.md +6 -0
- package/README.md +18 -5
- package/build/tsconfig.json +2 -4
- package/constellation/consistent-css-prop-usage/usage.mdx +5 -0
- package/constellation/index/overview.mdx +21 -0
- package/constellation/local-cx-xcss/usage.mdx +37 -0
- package/constellation/no-css-tagged-template-expression/usage.mdx +5 -0
- package/constellation/no-empty-styled-expression/usage.mdx +5 -0
- package/constellation/no-exported-css/usage.mdx +5 -0
- package/constellation/no-exported-keyframes/usage.mdx +5 -0
- package/constellation/no-invalid-css-map/usage.mdx +5 -0
- package/constellation/no-js-xcss/usage.mdx +23 -0
- package/constellation/no-keyframes-tagged-template-expression/usage.mdx +5 -0
- package/constellation/no-styled-tagged-template-expression/usage.mdx +5 -0
- package/constellation/no-suppress-xcss/usage.mdx +25 -0
- package/dist/cjs/index.codegen.js +26 -0
- package/dist/cjs/index.js +12 -33
- package/dist/cjs/presets/all.codegen.js +37 -0
- package/dist/cjs/presets/recommended.codegen.js +37 -0
- package/dist/cjs/rules/external-rules.js +143 -0
- package/dist/cjs/rules/index.codegen.js +16 -0
- package/dist/cjs/rules/local-cx-xcss/index.js +51 -0
- package/dist/cjs/rules/utils/create-rule.js +43 -0
- package/dist/cjs/rules/utils/is-supported-import.js +98 -0
- package/dist/es2019/index.codegen.js +12 -0
- package/dist/es2019/index.js +1 -33
- package/dist/es2019/presets/all.codegen.js +31 -0
- package/dist/es2019/presets/recommended.codegen.js +31 -0
- package/dist/es2019/rules/external-rules.js +138 -0
- package/dist/es2019/rules/index.codegen.js +9 -0
- package/dist/es2019/rules/local-cx-xcss/index.js +45 -0
- package/dist/es2019/rules/utils/create-rule.js +33 -0
- package/dist/es2019/rules/utils/is-supported-import.js +87 -0
- package/dist/esm/index.codegen.js +12 -0
- package/dist/esm/index.js +1 -33
- package/dist/esm/presets/all.codegen.js +31 -0
- package/dist/esm/presets/recommended.codegen.js +31 -0
- package/dist/esm/rules/external-rules.js +138 -0
- package/dist/esm/rules/index.codegen.js +9 -0
- package/dist/esm/rules/local-cx-xcss/index.js +45 -0
- package/dist/esm/rules/utils/create-rule.js +35 -0
- package/dist/esm/rules/utils/is-supported-import.js +90 -0
- package/dist/types/index.codegen.d.ts +55 -0
- package/dist/types/index.d.ts +1 -0
- package/dist/types/presets/all.codegen.d.ts +32 -0
- package/dist/types/presets/recommended.codegen.d.ts +32 -0
- package/dist/types/rules/external-rules.d.ts +11 -0
- package/dist/types/rules/index.codegen.d.ts +4 -0
- package/dist/types/rules/local-cx-xcss/index.d.ts +3 -0
- package/dist/types/rules/utils/create-rule.d.ts +64 -0
- package/dist/types/rules/utils/is-supported-import.d.ts +34 -0
- package/dist/types-ts4.5/index.codegen.d.ts +55 -0
- package/dist/types-ts4.5/index.d.ts +1 -0
- package/dist/types-ts4.5/presets/all.codegen.d.ts +32 -0
- package/dist/types-ts4.5/presets/recommended.codegen.d.ts +32 -0
- package/dist/types-ts4.5/rules/external-rules.d.ts +11 -0
- package/dist/types-ts4.5/rules/index.codegen.d.ts +4 -0
- package/dist/types-ts4.5/rules/local-cx-xcss/index.d.ts +3 -0
- package/dist/types-ts4.5/rules/utils/create-rule.d.ts +64 -0
- package/dist/types-ts4.5/rules/utils/is-supported-import.d.ts +34 -0
- package/package.json +13 -4
- package/scripts/codegen.tsx +439 -0
- package/src/index.codegen.tsx +14 -0
- package/src/index.tsx +1 -51
- package/src/presets/all.codegen.tsx +67 -0
- package/src/presets/recommended.codegen.tsx +67 -0
- package/src/rules/TEMPLATE.md +29 -0
- package/src/rules/__tests__/utils/_tester.tsx +40 -0
- package/src/rules/external-rules.tsx +175 -0
- package/src/rules/index.codegen.tsx +10 -0
- package/src/rules/local-cx-xcss/README.md +35 -0
- package/src/rules/local-cx-xcss/__tests__/rule.test.tsx +102 -0
- package/src/rules/local-cx-xcss/index.tsx +69 -0
- package/src/rules/utils/create-rule.tsx +80 -0
- package/src/rules/utils/is-supported-import.tsx +130 -0
- package/tsconfig.app.json +5 -1
- package/tsconfig.dev.json +5 -1
- package/tsconfig.json +7 -6
- package/dist/types/src/index.d.ts +0 -29
- package/dist/types-ts4.5/src/index.d.ts +0 -29
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# @atlaskit/eslint-plugin-ui-styling-standard
|
|
2
2
|
|
|
3
|
+
## 0.4.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [#75600](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/75600) [`8875d9de2e5d`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8875d9de2e5d) - Migrates the ESLint rule from `@atlaskit/design-system/local-cx-xcss` to `@atlaskit/ui-styling-standard/local-cx-xcss` and overhauls the codegen to enable better documentation and rule distribution.
|
|
8
|
+
|
|
3
9
|
## 0.3.0
|
|
4
10
|
|
|
5
11
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -8,8 +8,21 @@ Not intended for use outside the Atlassian frontend repository.
|
|
|
8
8
|
|
|
9
9
|
## Rules
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
|
15
|
-
|
|
|
11
|
+
<!-- START_RULE_TABLE_CODEGEN -->
|
|
12
|
+
<!-- @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen -->
|
|
13
|
+
|
|
14
|
+
| Rule | Description | Recommended | Fixable | Suggestions |
|
|
15
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | ------- | ----------- |
|
|
16
|
+
| <a href="./src/rules/local-cx-xcss/README.md">local-cx-xcss</a> | 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. | Yes | | |
|
|
17
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/consistent-css-prop-usage/usage">@atlaskit/design-system/consistent-css-prop-usage</a> | Ensures consistency with `css` and `xcss` prop usages | Yes | Yes | |
|
|
18
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/no-css-tagged-template-expression/usage">@atlaskit/design-system/no-css-tagged-template-expression</a> | Disallows any `css` tagged template expressions that originate from Emotion, Styled Components or Compiled | Yes | Yes | |
|
|
19
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/no-keyframes-tagged-template-expression/usage">@atlaskit/design-system/no-keyframes-tagged-template-expression</a> | Disallows any `keyframe` tagged template expressions that originate from Emotion, Styled Components or Compiled | Yes | Yes | |
|
|
20
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/no-styled-tagged-template-expression/usage">@atlaskit/design-system/no-styled-tagged-template-expression</a> | Disallows any `styled` tagged template expressions that originate from Emotion, Styled Components or Compiled | Yes | Yes | |
|
|
21
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/no-suppress-xcss/usage">@compiled/no-suppress-xcss</a> | Disallows supressing type violations when using the xcss prop. | Yes | | |
|
|
22
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/no-js-xcss/usage">@compiled/no-js-xcss</a> | Disallows using xcss prop inside JavaScript files. | Yes | | |
|
|
23
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/no-empty-styled-expression/usage">@atlaskit/design-system/no-empty-styled-expression</a> | Forbids any styled expression to be used when passing empty arguments to styled.div() (or other JSX elements). | Yes | | |
|
|
24
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/no-exported-css/usage">@atlaskit/design-system/no-exported-css</a> | Forbid exporting `css` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable. | Yes | | |
|
|
25
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/no-exported-keyframes/usage">@atlaskit/design-system/no-exported-keyframes</a> | Forbid exporting `keyframes` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable. | Yes | | |
|
|
26
|
+
| <a href="https://atlassian.design/components/eslint-plugin-ui-styling-standard/no-invalid-css-map/usage">@atlaskit/design-system/no-invalid-css-map</a> | Checks the validity of a CSS map created through cssMap. This is intended to be used alongside TypeScript's type-checking. | Yes | | |
|
|
27
|
+
|
|
28
|
+
<!-- END_RULE_TABLE_CODEGEN -->
|
package/build/tsconfig.json
CHANGED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# @atlaskit/design-system/consistent-css-prop-usage
|
|
2
|
+
|
|
3
|
+
Ensures consistency with `css` and `xcss` prop usages
|
|
4
|
+
|
|
5
|
+
This rule is maintained by another package and configured here, refer to https://atlassian.design/components/eslint-plugin-design-system/consistent-css-prop-usage/usage for more details
|
|
@@ -3,6 +3,27 @@
|
|
|
3
3
|
The UI Styling Standard is a set of ESLint rules and principles to guide building web styling code
|
|
4
4
|
across Atlassian's frontend codebases and ecosystem.
|
|
5
5
|
|
|
6
|
+
## Rules
|
|
7
|
+
|
|
8
|
+
<!-- START_RULE_TABLE_CODEGEN -->
|
|
9
|
+
<!-- @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen -->
|
|
10
|
+
|
|
11
|
+
| Rule | Description | Recommended | Fixable | Suggestions |
|
|
12
|
+
| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | ------- | ----------- |
|
|
13
|
+
| <a href="local-cx-xcss/usage">local-cx-xcss</a> | 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. | Yes | | |
|
|
14
|
+
| <a href="consistent-css-prop-usage/usage">@atlaskit/design-system/consistent-css-prop-usage</a> | Ensures consistency with `css` and `xcss` prop usages | Yes | Yes | |
|
|
15
|
+
| <a href="no-css-tagged-template-expression/usage">@atlaskit/design-system/no-css-tagged-template-expression</a> | Disallows any `css` tagged template expressions that originate from Emotion, Styled Components or Compiled | Yes | Yes | |
|
|
16
|
+
| <a href="no-keyframes-tagged-template-expression/usage">@atlaskit/design-system/no-keyframes-tagged-template-expression</a> | Disallows any `keyframe` tagged template expressions that originate from Emotion, Styled Components or Compiled | Yes | Yes | |
|
|
17
|
+
| <a href="no-styled-tagged-template-expression/usage">@atlaskit/design-system/no-styled-tagged-template-expression</a> | Disallows any `styled` tagged template expressions that originate from Emotion, Styled Components or Compiled | Yes | Yes | |
|
|
18
|
+
| <a href="no-suppress-xcss/usage">@compiled/no-suppress-xcss</a> | Disallows supressing type violations when using the xcss prop. | Yes | | |
|
|
19
|
+
| <a href="no-js-xcss/usage">@compiled/no-js-xcss</a> | Disallows using xcss prop inside JavaScript files. | Yes | | |
|
|
20
|
+
| <a href="no-empty-styled-expression/usage">@atlaskit/design-system/no-empty-styled-expression</a> | Forbids any styled expression to be used when passing empty arguments to styled.div() (or other JSX elements). | Yes | | |
|
|
21
|
+
| <a href="no-exported-css/usage">@atlaskit/design-system/no-exported-css</a> | Forbid exporting `css` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable. | Yes | | |
|
|
22
|
+
| <a href="no-exported-keyframes/usage">@atlaskit/design-system/no-exported-keyframes</a> | Forbid exporting `keyframes` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable. | Yes | | |
|
|
23
|
+
| <a href="no-invalid-css-map/usage">@atlaskit/design-system/no-invalid-css-map</a> | Checks the validity of a CSS map created through cssMap. This is intended to be used alongside TypeScript's type-checking. | Yes | | |
|
|
24
|
+
|
|
25
|
+
<!-- END_RULE_TABLE_CODEGEN -->
|
|
26
|
+
|
|
6
27
|
## Purpose of the UI Styling Standard
|
|
7
28
|
|
|
8
29
|
To enforce scoped encapsulation, type safety, and deterministic behavior in styling code that is
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# local-cx-xcss
|
|
2
|
+
|
|
3
|
+
This rule ensures the `cx()` function is only used within the `xcss` prop. This aids tracking what styles are applied to a jsx element.
|
|
4
|
+
|
|
5
|
+
The `cx` function is checked only if it is imported from `@compiled/react` or `@atlaskit/css`.
|
|
6
|
+
|
|
7
|
+
Passing arguments to the `cx()` function is how you compose styles (combine more than one set of styles together) with XCSS. This is a workaround for the more conventional array syntax (e.g. [in Emotion](https://emotion.sh/docs/composition)) `<div xcss={[style1, style2]} />` not giving robust enough type checking.
|
|
8
|
+
|
|
9
|
+
## Examples
|
|
10
|
+
|
|
11
|
+
### Incorrect
|
|
12
|
+
|
|
13
|
+
```js
|
|
14
|
+
import { cx, cssMap } from '@compiled/react';
|
|
15
|
+
|
|
16
|
+
const styles = cssMap({
|
|
17
|
+
text: { color: 'red' },
|
|
18
|
+
bg: { background: 'blue' },
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
const joinedStyles = cx(styles.text, styles.bg);
|
|
22
|
+
|
|
23
|
+
<Button xcss={joinedStyles} />;
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### Correct
|
|
27
|
+
|
|
28
|
+
```js
|
|
29
|
+
import { cx, cssMap } from '@compiled/react';
|
|
30
|
+
|
|
31
|
+
const styles = cssMap({
|
|
32
|
+
text: { color: 'red' },
|
|
33
|
+
bg: { background: 'blue' },
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
<Button xcss={cx(styles.text, styles.bg)} />;
|
|
37
|
+
```
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# @atlaskit/design-system/no-css-tagged-template-expression
|
|
2
|
+
|
|
3
|
+
Disallows any css tagged template expressions that originate from @emotion/react, @emotion/core, compiled/react or styled-components.
|
|
4
|
+
|
|
5
|
+
This rule is maintained by another package and configured here, refer to https://atlassian.design/components/eslint-plugin-design-system/no-css-tagged-template-expression/usage for more details
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# @atlaskit/design-system/no-empty-styled-expression
|
|
2
|
+
|
|
3
|
+
Disallows/discourages passing empty arguments to any styled expression when using @compiled/react, as well as any other CSS-in-JS library defined through the importSources option.
|
|
4
|
+
|
|
5
|
+
This rule is maintained by another package and configured here, refer to https://atlassian.design/components/eslint-plugin-design-system/no-empty-styled-expression/usage for more details
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# @atlaskit/design-system/no-exported-css
|
|
2
|
+
|
|
3
|
+
Disallows css export declarations that originate from @compiled/react and @atlaskit/css, as well as any other CSS-in-JS library defined through the importSources option.
|
|
4
|
+
|
|
5
|
+
This rule is maintained by another package and configured here, refer to https://atlassian.design/components/eslint-plugin-design-system/no-exported-css/usage for more details
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# @atlaskit/design-system/no-exported-keyframes
|
|
2
|
+
|
|
3
|
+
Disallows keyframes export declarations that originate from @compiled/react, as well as any other CSS-in-JS library defined through the importSources option.
|
|
4
|
+
|
|
5
|
+
This rule is maintained by another package and configured here, refer to https://atlassian.design/components/eslint-plugin-design-system/no-exported-keyframes/usage for more details
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# @atlaskit/design-system/no-invalid-css-map
|
|
2
|
+
|
|
3
|
+
Ensure that all usages of the cssMap API are valid, and enforces the format of the object that is passed to cssMap.
|
|
4
|
+
|
|
5
|
+
This rule is maintained by another package and configured here, refer to https://atlassian.design/components/eslint-plugin-design-system/no-invalid-css-map/usage for more details
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# @compiled/no-js-xcss
|
|
2
|
+
|
|
3
|
+
Disallows using xcss prop inside JavaScript files.
|
|
4
|
+
|
|
5
|
+
Components that use xcss prop have explicitly declared what styles via the type system they should and should not accept, consumers must adhere to this API. Without TypeScript it's impossible to ensure this is met.
|
|
6
|
+
|
|
7
|
+
## Incorrect
|
|
8
|
+
|
|
9
|
+
Do not use xcss in a JavaScript file as type safety is required to ensure compatability and support
|
|
10
|
+
|
|
11
|
+
```js
|
|
12
|
+
// my-component.js
|
|
13
|
+
<Button xcss={{ fill: 'var(--ds-text)' }} />
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Correct
|
|
17
|
+
|
|
18
|
+
Using xcss in a TypeScript file is perfectly fine
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
// my-component.tsx
|
|
22
|
+
<Button xcss={{ color: 'var(--ds-text)' }} />
|
|
23
|
+
```
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# @atlaskit/design-system/no-keyframes-tagged-template-expression
|
|
2
|
+
|
|
3
|
+
Disallows any keyframes tagged template expressions that originate from @emotion/react, @emotion/core, compiled/react or styled-components.
|
|
4
|
+
|
|
5
|
+
This rule is maintained by another package and configured here, refer to https://atlassian.design/components/eslint-plugin-design-system/no-keyframes-tagged-template-expression/usage for more details
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# @atlaskit/design-system/no-styled-tagged-template-expression
|
|
2
|
+
|
|
3
|
+
Disallows any styled tagged template expressions that originate from @emotion/react, @emotion/core, compiled/react or styled-components.
|
|
4
|
+
|
|
5
|
+
This rule is maintained by another package and configured here, refer to https://atlassian.design/components/eslint-plugin-design-system/no-styled-tagged-template-expression/usage for more details
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# @compiled/no-suppress-xcss
|
|
2
|
+
|
|
3
|
+
Disallows supressing type violations when using the xcss prop. Supressing type violations will cause incidents and unexpected behaviour when code changes in the future.
|
|
4
|
+
|
|
5
|
+
Components that use xcss prop have explicitly declared what styles they should and should not accept, consumers must adhere to this API.
|
|
6
|
+
|
|
7
|
+
## Incorrect
|
|
8
|
+
|
|
9
|
+
Do not suppress type violations; if the value doesn't match the type, fix the value or expect breaking changes in the future.
|
|
10
|
+
|
|
11
|
+
```js
|
|
12
|
+
// @ts-expect-error
|
|
13
|
+
<Button xcss={{ fill: '#fff' }} />
|
|
14
|
+
|
|
15
|
+
// @ts-ignore
|
|
16
|
+
<Button xcss={{ fill: 'var(--ds-text)' }} />
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Correct
|
|
20
|
+
|
|
21
|
+
You should never have a type error.
|
|
22
|
+
|
|
23
|
+
```js
|
|
24
|
+
<Button xcss={{ color: 'var(--ds-text)' }} />
|
|
25
|
+
```
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
+
Object.defineProperty(exports, "__esModule", {
|
|
5
|
+
value: true
|
|
6
|
+
});
|
|
7
|
+
exports.configs = void 0;
|
|
8
|
+
Object.defineProperty(exports, "rules", {
|
|
9
|
+
enumerable: true,
|
|
10
|
+
get: function get() {
|
|
11
|
+
return _index.default;
|
|
12
|
+
}
|
|
13
|
+
});
|
|
14
|
+
var _all = _interopRequireDefault(require("./presets/all.codegen"));
|
|
15
|
+
var _recommended = _interopRequireDefault(require("./presets/recommended.codegen"));
|
|
16
|
+
var _index = _interopRequireDefault(require("./rules/index.codegen"));
|
|
17
|
+
/**
|
|
18
|
+
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
19
|
+
* @codegen <<SignedSource::3fd41935576c9346ca1f1e0c787a0a48>>
|
|
20
|
+
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
|
|
21
|
+
*/
|
|
22
|
+
|
|
23
|
+
var configs = exports.configs = {
|
|
24
|
+
all: _all.default,
|
|
25
|
+
recommended: _recommended.default
|
|
26
|
+
};
|
package/dist/cjs/index.js
CHANGED
|
@@ -3,37 +3,16 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
recommended: {
|
|
11
|
-
plugins: ['@atlaskit/ui-styling-standard', '@atlaskit/design-system', '@compiled'],
|
|
12
|
-
rules: {
|
|
13
|
-
'@atlaskit/design-system/consistent-css-prop-usage': ['warn', {
|
|
14
|
-
// When passing a css prop to a React component, we don't know whether the component
|
|
15
|
-
// is Emotion or Compiled. Hence it is not safe to run autofixes like wrapping it in
|
|
16
|
-
// a `css` function call.
|
|
17
|
-
excludeReactComponents: true
|
|
18
|
-
}],
|
|
19
|
-
'@atlaskit/design-system/local-cx-xcss': 'warn',
|
|
20
|
-
'@atlaskit/design-system/no-css-tagged-template-expression': 'warn',
|
|
21
|
-
'@atlaskit/design-system/no-keyframes-tagged-template-expression': 'warn',
|
|
22
|
-
'@atlaskit/design-system/no-styled-tagged-template-expression': 'warn',
|
|
23
|
-
'@compiled/no-suppress-xcss': 'error',
|
|
24
|
-
'@compiled/no-js-xcss': 'error',
|
|
25
|
-
'@atlaskit/design-system/no-empty-styled-expression': ['warn', {
|
|
26
|
-
importSources: importSources
|
|
27
|
-
}],
|
|
28
|
-
'@atlaskit/design-system/no-exported-css': ['warn', {
|
|
29
|
-
importSources: importSources
|
|
30
|
-
}],
|
|
31
|
-
'@atlaskit/design-system/no-exported-keyframes': ['warn', {
|
|
32
|
-
importSources: importSources
|
|
33
|
-
}],
|
|
34
|
-
'@atlaskit/design-system/no-invalid-css-map': ['warn', {
|
|
35
|
-
allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
|
|
36
|
-
}]
|
|
37
|
-
}
|
|
6
|
+
Object.defineProperty(exports, "configs", {
|
|
7
|
+
enumerable: true,
|
|
8
|
+
get: function get() {
|
|
9
|
+
return _index.configs;
|
|
38
10
|
}
|
|
39
|
-
};
|
|
11
|
+
});
|
|
12
|
+
Object.defineProperty(exports, "rules", {
|
|
13
|
+
enumerable: true,
|
|
14
|
+
get: function get() {
|
|
15
|
+
return _index.rules;
|
|
16
|
+
}
|
|
17
|
+
});
|
|
18
|
+
var _index = require("./index.codegen");
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = void 0;
|
|
7
|
+
/**
|
|
8
|
+
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
9
|
+
* @codegen <<SignedSource::6b1418e07df6af9ad4cae4baf66739c1>>
|
|
10
|
+
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
|
|
11
|
+
*/
|
|
12
|
+
var _default = exports.default = {
|
|
13
|
+
plugins: ['@atlaskit/ui-styling-standard', '@atlaskit/design-system', '@compiled'],
|
|
14
|
+
rules: {
|
|
15
|
+
'@atlaskit/ui-styling-standard/local-cx-xcss': 'warn',
|
|
16
|
+
'@atlaskit/design-system/consistent-css-prop-usage': ['warn', {
|
|
17
|
+
excludeReactComponents: true
|
|
18
|
+
}],
|
|
19
|
+
'@atlaskit/design-system/no-css-tagged-template-expression': 'warn',
|
|
20
|
+
'@atlaskit/design-system/no-keyframes-tagged-template-expression': 'warn',
|
|
21
|
+
'@atlaskit/design-system/no-styled-tagged-template-expression': 'warn',
|
|
22
|
+
'@compiled/no-suppress-xcss': 'warn',
|
|
23
|
+
'@compiled/no-js-xcss': 'warn',
|
|
24
|
+
'@atlaskit/design-system/no-empty-styled-expression': ['warn', {
|
|
25
|
+
importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
|
|
26
|
+
}],
|
|
27
|
+
'@atlaskit/design-system/no-exported-css': ['warn', {
|
|
28
|
+
importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
|
|
29
|
+
}],
|
|
30
|
+
'@atlaskit/design-system/no-exported-keyframes': ['warn', {
|
|
31
|
+
importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
|
|
32
|
+
}],
|
|
33
|
+
'@atlaskit/design-system/no-invalid-css-map': ['warn', {
|
|
34
|
+
allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
|
|
35
|
+
}]
|
|
36
|
+
}
|
|
37
|
+
};
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = void 0;
|
|
7
|
+
/**
|
|
8
|
+
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
9
|
+
* @codegen <<SignedSource::6b1418e07df6af9ad4cae4baf66739c1>>
|
|
10
|
+
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
|
|
11
|
+
*/
|
|
12
|
+
var _default = exports.default = {
|
|
13
|
+
plugins: ['@atlaskit/ui-styling-standard', '@atlaskit/design-system', '@compiled'],
|
|
14
|
+
rules: {
|
|
15
|
+
'@atlaskit/ui-styling-standard/local-cx-xcss': 'warn',
|
|
16
|
+
'@atlaskit/design-system/consistent-css-prop-usage': ['warn', {
|
|
17
|
+
excludeReactComponents: true
|
|
18
|
+
}],
|
|
19
|
+
'@atlaskit/design-system/no-css-tagged-template-expression': 'warn',
|
|
20
|
+
'@atlaskit/design-system/no-keyframes-tagged-template-expression': 'warn',
|
|
21
|
+
'@atlaskit/design-system/no-styled-tagged-template-expression': 'warn',
|
|
22
|
+
'@compiled/no-suppress-xcss': 'warn',
|
|
23
|
+
'@compiled/no-js-xcss': 'warn',
|
|
24
|
+
'@atlaskit/design-system/no-empty-styled-expression': ['warn', {
|
|
25
|
+
importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
|
|
26
|
+
}],
|
|
27
|
+
'@atlaskit/design-system/no-exported-css': ['warn', {
|
|
28
|
+
importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
|
|
29
|
+
}],
|
|
30
|
+
'@atlaskit/design-system/no-exported-keyframes': ['warn', {
|
|
31
|
+
importSources: ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components']
|
|
32
|
+
}],
|
|
33
|
+
'@atlaskit/design-system/no-invalid-css-map': ['warn', {
|
|
34
|
+
allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
|
|
35
|
+
}]
|
|
36
|
+
}
|
|
37
|
+
};
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.externalRules = void 0;
|
|
7
|
+
var _createRule = require("./utils/create-rule");
|
|
8
|
+
/** External rules must be scoped, have a display name, and external urls. */
|
|
9
|
+
|
|
10
|
+
var importSources = ['@compiled/react', '@atlaskit/css', '@emotion/core', '@emotion/react', '@emotion/styled', 'styled-components'];
|
|
11
|
+
var externalRules = exports.externalRules = [{
|
|
12
|
+
name: '@atlaskit/design-system/consistent-css-prop-usage',
|
|
13
|
+
displayName: 'consistent-css-prop-usage',
|
|
14
|
+
isExternal: true,
|
|
15
|
+
fixable: 'code',
|
|
16
|
+
docs: {
|
|
17
|
+
description: 'Ensures consistency with `css` and `xcss` prop usages',
|
|
18
|
+
url: (0, _createRule.getRuleUrl)('consistent-css-prop-usage'),
|
|
19
|
+
externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/consistent-css-prop-usage/usage',
|
|
20
|
+
recommended: true,
|
|
21
|
+
severity: 'warn',
|
|
22
|
+
pluginConfig: {
|
|
23
|
+
// When passing a css prop to a React component, we don't know whether the component
|
|
24
|
+
// is Emotion or Compiled. Hence it is not safe to run autofixes like wrapping it in
|
|
25
|
+
// a `css` function call.
|
|
26
|
+
excludeReactComponents: true
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}, {
|
|
30
|
+
name: '@atlaskit/design-system/no-css-tagged-template-expression',
|
|
31
|
+
displayName: 'no-css-tagged-template-expression',
|
|
32
|
+
isExternal: true,
|
|
33
|
+
fixable: 'code',
|
|
34
|
+
docs: {
|
|
35
|
+
description: 'Disallows any `css` tagged template expressions that originate from Emotion, Styled Components or Compiled',
|
|
36
|
+
url: (0, _createRule.getRuleUrl)('no-css-tagged-template-expression'),
|
|
37
|
+
externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-css-tagged-template-expression/usage',
|
|
38
|
+
recommended: true,
|
|
39
|
+
severity: 'warn'
|
|
40
|
+
}
|
|
41
|
+
}, {
|
|
42
|
+
name: '@atlaskit/design-system/no-keyframes-tagged-template-expression',
|
|
43
|
+
displayName: 'no-keyframes-tagged-template-expression',
|
|
44
|
+
isExternal: true,
|
|
45
|
+
fixable: 'code',
|
|
46
|
+
docs: {
|
|
47
|
+
description: 'Disallows any `keyframe` tagged template expressions that originate from Emotion, Styled Components or Compiled',
|
|
48
|
+
url: (0, _createRule.getRuleUrl)('no-keyframes-tagged-template-expression'),
|
|
49
|
+
externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-keyframes-tagged-template-expression/usage',
|
|
50
|
+
recommended: true,
|
|
51
|
+
severity: 'warn'
|
|
52
|
+
}
|
|
53
|
+
}, {
|
|
54
|
+
name: '@atlaskit/design-system/no-styled-tagged-template-expression',
|
|
55
|
+
displayName: 'no-styled-tagged-template-expression',
|
|
56
|
+
isExternal: true,
|
|
57
|
+
fixable: 'code',
|
|
58
|
+
docs: {
|
|
59
|
+
description: 'Disallows any `styled` tagged template expressions that originate from Emotion, Styled Components or Compiled',
|
|
60
|
+
url: (0, _createRule.getRuleUrl)('no-styled-tagged-template-expression'),
|
|
61
|
+
externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-styled-tagged-template-expression/usage',
|
|
62
|
+
recommended: true,
|
|
63
|
+
severity: 'warn'
|
|
64
|
+
}
|
|
65
|
+
}, {
|
|
66
|
+
name: '@compiled/no-suppress-xcss',
|
|
67
|
+
displayName: 'no-suppress-xcss',
|
|
68
|
+
isExternal: true,
|
|
69
|
+
docs: {
|
|
70
|
+
description: 'Disallows supressing type violations when using the xcss prop.',
|
|
71
|
+
url: (0, _createRule.getRuleUrl)('no-suppress-xcss'),
|
|
72
|
+
externalUrl: 'https://github.com/atlassian-labs/compiled/tree/master/packages/eslint-plugin/src/rules/no-suppress-xcss',
|
|
73
|
+
recommended: true,
|
|
74
|
+
severity: 'warn'
|
|
75
|
+
}
|
|
76
|
+
}, {
|
|
77
|
+
name: '@compiled/no-js-xcss',
|
|
78
|
+
displayName: 'no-js-xcss',
|
|
79
|
+
isExternal: true,
|
|
80
|
+
docs: {
|
|
81
|
+
description: 'Disallows using xcss prop inside JavaScript files.',
|
|
82
|
+
url: (0, _createRule.getRuleUrl)('no-js-xcss'),
|
|
83
|
+
externalUrl: 'https://github.com/atlassian-labs/compiled/tree/master/packages/eslint-plugin/src/rules/no-js-xcss',
|
|
84
|
+
recommended: true,
|
|
85
|
+
severity: 'warn'
|
|
86
|
+
}
|
|
87
|
+
}, {
|
|
88
|
+
name: '@atlaskit/design-system/no-empty-styled-expression',
|
|
89
|
+
displayName: 'no-empty-styled-expression',
|
|
90
|
+
isExternal: true,
|
|
91
|
+
docs: {
|
|
92
|
+
description: 'Forbids any styled expression to be used when passing empty arguments to styled.div() (or other JSX elements).',
|
|
93
|
+
url: (0, _createRule.getRuleUrl)('no-empty-styled-expression'),
|
|
94
|
+
externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-empty-styled-expression/usage',
|
|
95
|
+
recommended: true,
|
|
96
|
+
severity: 'warn',
|
|
97
|
+
pluginConfig: {
|
|
98
|
+
importSources: importSources
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
}, {
|
|
102
|
+
name: '@atlaskit/design-system/no-exported-css',
|
|
103
|
+
displayName: 'no-exported-css',
|
|
104
|
+
isExternal: true,
|
|
105
|
+
docs: {
|
|
106
|
+
description: 'Forbid exporting `css` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable.',
|
|
107
|
+
url: (0, _createRule.getRuleUrl)('no-exported-css'),
|
|
108
|
+
externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-exported-css/usage',
|
|
109
|
+
recommended: true,
|
|
110
|
+
severity: 'warn',
|
|
111
|
+
pluginConfig: {
|
|
112
|
+
importSources: importSources
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}, {
|
|
116
|
+
name: '@atlaskit/design-system/no-exported-keyframes',
|
|
117
|
+
displayName: 'no-exported-keyframes',
|
|
118
|
+
isExternal: true,
|
|
119
|
+
docs: {
|
|
120
|
+
description: 'Forbid exporting `keyframes` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable.',
|
|
121
|
+
url: (0, _createRule.getRuleUrl)('no-exported-keyframes'),
|
|
122
|
+
externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-exported-keyframes/usage',
|
|
123
|
+
recommended: true,
|
|
124
|
+
severity: 'warn',
|
|
125
|
+
pluginConfig: {
|
|
126
|
+
importSources: importSources
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}, {
|
|
130
|
+
name: '@atlaskit/design-system/no-invalid-css-map',
|
|
131
|
+
displayName: 'no-invalid-css-map',
|
|
132
|
+
isExternal: true,
|
|
133
|
+
docs: {
|
|
134
|
+
description: "Checks the validity of a CSS map created through cssMap. This is intended to be used alongside TypeScript's type-checking.",
|
|
135
|
+
url: (0, _createRule.getRuleUrl)('no-invalid-css-map'),
|
|
136
|
+
externalUrl: 'https://atlassian.design/components/eslint-plugin-design-system/no-invalid-css-map/usage',
|
|
137
|
+
recommended: true,
|
|
138
|
+
severity: 'warn',
|
|
139
|
+
pluginConfig: {
|
|
140
|
+
allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
}];
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
+
Object.defineProperty(exports, "__esModule", {
|
|
5
|
+
value: true
|
|
6
|
+
});
|
|
7
|
+
exports.default = void 0;
|
|
8
|
+
var _localCxXcss = _interopRequireDefault(require("./local-cx-xcss"));
|
|
9
|
+
/**
|
|
10
|
+
* THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
|
|
11
|
+
* @codegen <<SignedSource::f907e3f7ab0b7145dcb8318732ae1fec>>
|
|
12
|
+
* @codegenCommand yarn workspace @atlaskit/eslint-plugin-ui-styling-standard codegen
|
|
13
|
+
*/
|
|
14
|
+
var _default = exports.default = {
|
|
15
|
+
'local-cx-xcss': _localCxXcss.default
|
|
16
|
+
};
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.rule = exports.default = void 0;
|
|
7
|
+
var _createRule = require("../utils/create-rule");
|
|
8
|
+
var _isSupportedImport = require("../utils/is-supported-import");
|
|
9
|
+
var IMPORT_SOURCES = [_isSupportedImport.CSS_IN_JS_IMPORTS.compiled, _isSupportedImport.CSS_IN_JS_IMPORTS.atlaskitCss];
|
|
10
|
+
function getParentJSXAttribute(node) {
|
|
11
|
+
var parent = node.parent;
|
|
12
|
+
while (parent && parent.type !== 'JSXAttribute') {
|
|
13
|
+
parent = parent.parent;
|
|
14
|
+
}
|
|
15
|
+
if (parent && parent.type === 'JSXAttribute') {
|
|
16
|
+
return parent;
|
|
17
|
+
}
|
|
18
|
+
return null;
|
|
19
|
+
}
|
|
20
|
+
var rule = exports.rule = (0, _createRule.createLintRule)({
|
|
21
|
+
meta: {
|
|
22
|
+
name: 'local-cx-xcss',
|
|
23
|
+
docs: {
|
|
24
|
+
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.',
|
|
25
|
+
recommended: true,
|
|
26
|
+
severity: 'warn'
|
|
27
|
+
},
|
|
28
|
+
messages: {
|
|
29
|
+
'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.'
|
|
30
|
+
},
|
|
31
|
+
type: 'problem'
|
|
32
|
+
},
|
|
33
|
+
create: function create(context) {
|
|
34
|
+
return {
|
|
35
|
+
'CallExpression[callee.name="cx"]': function CallExpressionCalleeNameCx(node) {
|
|
36
|
+
if (node.type === 'CallExpression' && (0, _isSupportedImport.isCxFunction)(node.callee, context.getScope().references, IMPORT_SOURCES)) {
|
|
37
|
+
var parentJSXAttribute = getParentJSXAttribute(node);
|
|
38
|
+
var propName = parentJSXAttribute === null || parentJSXAttribute === void 0 ? void 0 : parentJSXAttribute.name.name.toString();
|
|
39
|
+
if (propName && /[xX]css$/.test(propName)) {
|
|
40
|
+
return;
|
|
41
|
+
}
|
|
42
|
+
context.report({
|
|
43
|
+
node: node,
|
|
44
|
+
messageId: 'local-cx-xcss'
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
});
|
|
51
|
+
var _default = exports.default = rule;
|