@atlaskit/eslint-plugin-platform 2.8.0 → 2.9.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 +16 -0
- package/dist/cjs/index.js +8 -1
- package/dist/cjs/rules/ensure-critical-dependency-resolutions/index.js +0 -1
- package/dist/cjs/rules/ensure-use-sync-external-store-server-snapshot/index.js +41 -0
- package/dist/cjs/rules/import/no-barrel-entry-imports/index.js +534 -74
- package/dist/cjs/rules/import/no-barrel-entry-jest-mock/index.js +428 -119
- package/dist/cjs/rules/import/no-jest-mock-barrel-files/index.js +3 -2
- package/dist/cjs/rules/import/no-relative-barrel-file-imports/index.js +7 -3
- package/dist/cjs/rules/import/shared/jest-utils.js +62 -9
- package/dist/cjs/rules/import/shared/package-resolution.js +300 -22
- package/dist/cjs/rules/no-restricted-fedramp-imports/index.js +65 -0
- package/dist/cjs/rules/visit-example-type-import-required/index.js +409 -0
- package/dist/es2019/index.js +8 -1
- package/dist/es2019/rules/ensure-critical-dependency-resolutions/index.js +0 -1
- package/dist/es2019/rules/ensure-use-sync-external-store-server-snapshot/index.js +43 -0
- package/dist/es2019/rules/import/no-barrel-entry-imports/index.js +431 -25
- package/dist/es2019/rules/import/no-barrel-entry-jest-mock/index.js +287 -25
- package/dist/es2019/rules/import/no-jest-mock-barrel-files/index.js +3 -2
- package/dist/es2019/rules/import/no-relative-barrel-file-imports/index.js +7 -3
- package/dist/es2019/rules/import/shared/jest-utils.js +44 -0
- package/dist/es2019/rules/import/shared/package-resolution.js +211 -4
- package/dist/es2019/rules/no-restricted-fedramp-imports/index.js +47 -0
- package/dist/es2019/rules/visit-example-type-import-required/index.js +375 -0
- package/dist/esm/index.js +8 -1
- package/dist/esm/rules/ensure-critical-dependency-resolutions/index.js +0 -1
- package/dist/esm/rules/ensure-use-sync-external-store-server-snapshot/index.js +35 -0
- package/dist/esm/rules/import/no-barrel-entry-imports/index.js +535 -75
- package/dist/esm/rules/import/no-barrel-entry-jest-mock/index.js +430 -121
- package/dist/esm/rules/import/no-jest-mock-barrel-files/index.js +3 -2
- package/dist/esm/rules/import/no-relative-barrel-file-imports/index.js +7 -3
- package/dist/esm/rules/import/shared/jest-utils.js +61 -9
- package/dist/esm/rules/import/shared/package-resolution.js +298 -24
- package/dist/esm/rules/no-restricted-fedramp-imports/index.js +59 -0
- package/dist/esm/rules/visit-example-type-import-required/index.js +402 -0
- package/dist/types/index.d.ts +14 -0
- package/dist/types/rules/ensure-use-sync-external-store-server-snapshot/index.d.ts +3 -0
- package/dist/types/rules/import/shared/jest-utils.d.ts +8 -0
- package/dist/types/rules/import/shared/package-resolution.d.ts +47 -2
- package/dist/types/rules/no-restricted-fedramp-imports/index.d.ts +3 -0
- package/dist/types/rules/visit-example-type-import-required/index.d.ts +4 -0
- package/dist/types-ts4.5/index.d.ts +14 -0
- package/dist/types-ts4.5/rules/ensure-use-sync-external-store-server-snapshot/index.d.ts +3 -0
- package/dist/types-ts4.5/rules/import/shared/jest-utils.d.ts +8 -0
- package/dist/types-ts4.5/rules/import/shared/package-resolution.d.ts +47 -2
- package/dist/types-ts4.5/rules/no-restricted-fedramp-imports/index.d.ts +3 -0
- package/dist/types-ts4.5/rules/visit-example-type-import-required/index.d.ts +4 -0
- package/package.json +3 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @atlaskit/eslint-plugin-platform
|
|
2
2
|
|
|
3
|
+
## 2.9.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`5fed54075f1b8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5fed54075f1b8) -
|
|
8
|
+
add eslint rule for restricting isFedramp and isIsolatedCloud imports
|
|
9
|
+
|
|
10
|
+
## 2.9.0
|
|
11
|
+
|
|
12
|
+
### Minor Changes
|
|
13
|
+
|
|
14
|
+
- [`50be0b9fcf83d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/50be0b9fcf83d) -
|
|
15
|
+
Added new ESLint rule `ensure-use-sync-external-store-server-snapshot` that enforces all
|
|
16
|
+
`useSyncExternalStore` calls include the third argument (`getServerSnapshot`) for SSR
|
|
17
|
+
compatibility. The rule is enabled as an error in all platform, jira, and confluence configs.
|
|
18
|
+
|
|
3
19
|
## 2.8.0
|
|
4
20
|
|
|
5
21
|
### Minor Changes
|
package/dist/cjs/index.js
CHANGED
|
@@ -36,11 +36,14 @@ var _noSparseCheckout = _interopRequireDefault(require("./rules/no-sparse-checko
|
|
|
36
36
|
var _noDirectDocumentUsage = _interopRequireDefault(require("./rules/no-direct-document-usage"));
|
|
37
37
|
var _noSetImmediate = _interopRequireDefault(require("./rules/no-set-immediate"));
|
|
38
38
|
var _preferCryptoRandomUuid = _interopRequireDefault(require("./rules/prefer-crypto-random-uuid"));
|
|
39
|
+
var _noRestrictedFedrampImports = _interopRequireDefault(require("./rules/no-restricted-fedramp-imports"));
|
|
39
40
|
var _noBarrelEntryImports = _interopRequireDefault(require("./rules/import/no-barrel-entry-imports"));
|
|
40
41
|
var _noBarrelEntryJestMock = _interopRequireDefault(require("./rules/import/no-barrel-entry-jest-mock"));
|
|
41
42
|
var _noJestMockBarrelFiles = _interopRequireDefault(require("./rules/import/no-jest-mock-barrel-files"));
|
|
42
43
|
var _noRelativeBarrelFileImports = _interopRequireDefault(require("./rules/import/no-relative-barrel-file-imports"));
|
|
43
44
|
var _noConversationAssistantBarrelImports = _interopRequireDefault(require("./rules/import/no-conversation-assistant-barrel-imports"));
|
|
45
|
+
var _visitExampleTypeImportRequired = _interopRequireDefault(require("./rules/visit-example-type-import-required"));
|
|
46
|
+
var _ensureUseSyncExternalStoreServerSnapshot = _interopRequireDefault(require("./rules/ensure-use-sync-external-store-server-snapshot"));
|
|
44
47
|
var _nodePath = require("node:path");
|
|
45
48
|
var _nodeFs = require("node:fs");
|
|
46
49
|
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
|
|
@@ -92,15 +95,19 @@ var rules = exports.rules = {
|
|
|
92
95
|
'no-direct-document-usage': _noDirectDocumentUsage.default,
|
|
93
96
|
'no-set-immediate': _noSetImmediate.default,
|
|
94
97
|
'prefer-crypto-random-uuid': _preferCryptoRandomUuid.default,
|
|
98
|
+
'no-restricted-fedramp-imports': _noRestrictedFedrampImports.default,
|
|
95
99
|
'no-barrel-entry-imports': _noBarrelEntryImports.default,
|
|
96
100
|
'no-barrel-entry-jest-mock': _noBarrelEntryJestMock.default,
|
|
97
101
|
'no-jest-mock-barrel-files': _noJestMockBarrelFiles.default,
|
|
98
102
|
'no-relative-barrel-file-imports': _noRelativeBarrelFileImports.default,
|
|
99
|
-
'no-conversation-assistant-barrel-imports': _noConversationAssistantBarrelImports.default
|
|
103
|
+
'no-conversation-assistant-barrel-imports': _noConversationAssistantBarrelImports.default,
|
|
104
|
+
'visit-example-type-import-required': _visitExampleTypeImportRequired.default,
|
|
105
|
+
'ensure-use-sync-external-store-server-snapshot': _ensureUseSyncExternalStoreServerSnapshot.default
|
|
100
106
|
};
|
|
101
107
|
var commonConfig = {
|
|
102
108
|
'@atlaskit/platform/ensure-test-runner-arguments': 'error',
|
|
103
109
|
'@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
|
|
110
|
+
'@atlaskit/platform/ensure-use-sync-external-store-server-snapshot': 'error',
|
|
104
111
|
'@atlaskit/platform/no-invalid-feature-flag-usage': 'error',
|
|
105
112
|
'@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error',
|
|
106
113
|
'@atlaskit/platform/ensure-atlassian-team': 'error',
|
|
@@ -18,7 +18,6 @@ var DESIRED_PKG_VERSIONS = {
|
|
|
18
18
|
tslib: ['2.6', '2.8'],
|
|
19
19
|
'@types/react': ['16.14', '18.2', '18.3'],
|
|
20
20
|
'react-relay': ['npm:atl-react-relay@0.0.0-main-39e79f66'],
|
|
21
|
-
'relay-compiler': ['npm:atl-relay-compiler@0.0.0-main-39e79f66'],
|
|
22
21
|
'relay-runtime': ['npm:atl-relay-runtime@0.0.0-main-39e79f66'],
|
|
23
22
|
'relay-test-utils': ['npm:atl-relay-test-utils@0.0.0-main-39e79f66']
|
|
24
23
|
};
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = void 0;
|
|
7
|
+
// eslint-disable-next-line import/no-extraneous-dependencies
|
|
8
|
+
|
|
9
|
+
var FUNCTION_NAME = 'useSyncExternalStore';
|
|
10
|
+
var rule = {
|
|
11
|
+
meta: {
|
|
12
|
+
type: 'problem',
|
|
13
|
+
docs: {
|
|
14
|
+
description: "Enforce that ".concat(FUNCTION_NAME, " is called with a third argument (getServerSnapshot) for SSR compatibility"),
|
|
15
|
+
recommended: true
|
|
16
|
+
},
|
|
17
|
+
messages: {
|
|
18
|
+
missingServerSnapshot: "'".concat(FUNCTION_NAME, "' must be called with a third argument (getServerSnapshot). Without it, React will throw during server-side rendering.\n\nIf your component relies on browser-only APIs (e.g. localStorage, WebRTC, WebGL) and must not render on the server, pass `() => null` (or another stable fallback) as the third argument \u2014 this is the correct way to opt out of SSR, not an omission.\n\nPrefer higher-level APIs that wrap ").concat(FUNCTION_NAME, " where available, as they handle SSR concerns for you.\n\nSee the React docs for usage guidance: https://react.dev/reference/react/useSyncExternalStore")
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
create: function create(context) {
|
|
22
|
+
return {
|
|
23
|
+
CallExpression: function CallExpression(node) {
|
|
24
|
+
var callee = node.callee,
|
|
25
|
+
args = node.arguments;
|
|
26
|
+
var isDirectCall = callee.type === 'Identifier' && callee.name === FUNCTION_NAME;
|
|
27
|
+
var isMemberCall = callee.type === 'MemberExpression' && callee.property.type === 'Identifier' && callee.property.name === FUNCTION_NAME;
|
|
28
|
+
if (!isDirectCall && !isMemberCall) {
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
if (args.length < 3) {
|
|
32
|
+
context.report({
|
|
33
|
+
node: node,
|
|
34
|
+
messageId: 'missingServerSnapshot'
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
};
|
|
41
|
+
var _default = exports.default = rule;
|