@atlaskit/eslint-plugin-platform 2.7.2 → 2.9.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/eslint-plugin-platform
 
+## 2.9.0
+
+### Minor Changes
+
+- [`50be0b9fcf83d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/50be0b9fcf83d) -
+  Added new ESLint rule `ensure-use-sync-external-store-server-snapshot` that enforces all
+  `useSyncExternalStore` calls include the third argument (`getServerSnapshot`) for SSR
+  compatibility. The rule is enabled as an error in all platform, jira, and confluence configs.
+
+## 2.8.0
+
+### Minor Changes
+
+- [`390e72480c2f2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/390e72480c2f2) -
+  Updated references to de-barreling eslint rules to point to new @atlaskit/platform rule prefix.
+
 ## 2.7.2
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -20,7 +20,6 @@ var _ensureNoPrivateDependencies = _interopRequireDefault(require("./rules/ensur
 var _expandBorderShorthand = _interopRequireDefault(require("./rules/compiled/expand-border-shorthand"));
 var _noInvalidStorybookDecoratorUsage = _interopRequireDefault(require("./rules/no-invalid-storybook-decorator-usage"));
 var _ensurePublishValid = _interopRequireDefault(require("./rules/ensure-publish-valid"));
-var _ensureNativeAndAfExportsSynced = _interopRequireDefault(require("./rules/ensure-native-and-af-exports-synced"));
 var _noModuleLevelEval = _interopRequireDefault(require("./rules/feature-gating/no-module-level-eval"));
 var _noModuleLevelEvalNav = _interopRequireDefault(require("./rules/feature-gating/no-module-level-eval-nav4"));
 var _staticFeatureFlags = _interopRequireDefault(require("./rules/feature-gating/static-feature-flags"));
@@ -30,12 +29,20 @@ var _preferFg = _interopRequireDefault(require("./rules/feature-gating/prefer-fg
 var _noAlias = _interopRequireDefault(require("./rules/feature-gating/no-alias"));
 var _useEntrypointsInExamples = _interopRequireDefault(require("./rules/use-entrypoints-in-examples"));
 var _useRecommendedUtils = _interopRequireDefault(require("./rules/feature-gating/use-recommended-utils"));
+var _validGateName = _interopRequireDefault(require("./rules/feature-gating/valid-gate-name"));
 var _expandBackgroundShorthand = _interopRequireDefault(require("./rules/compiled/expand-background-shorthand"));
 var _expandSpacingShorthand = _interopRequireDefault(require("./rules/compiled/expand-spacing-shorthand"));
 var _noSparseCheckout = _interopRequireDefault(require("./rules/no-sparse-checkout"));
 var _noDirectDocumentUsage = _interopRequireDefault(require("./rules/no-direct-document-usage"));
 var _noSetImmediate = _interopRequireDefault(require("./rules/no-set-immediate"));
 var _preferCryptoRandomUuid = _interopRequireDefault(require("./rules/prefer-crypto-random-uuid"));
+var _noBarrelEntryImports = _interopRequireDefault(require("./rules/import/no-barrel-entry-imports"));
+var _noBarrelEntryJestMock = _interopRequireDefault(require("./rules/import/no-barrel-entry-jest-mock"));
+var _noJestMockBarrelFiles = _interopRequireDefault(require("./rules/import/no-jest-mock-barrel-files"));
+var _noRelativeBarrelFileImports = _interopRequireDefault(require("./rules/import/no-relative-barrel-file-imports"));
+var _noConversationAssistantBarrelImports = _interopRequireDefault(require("./rules/import/no-conversation-assistant-barrel-imports"));
+var _visitExampleTypeImportRequired = _interopRequireDefault(require("./rules/visit-example-type-import-required"));
+var _ensureUseSyncExternalStoreServerSnapshot = _interopRequireDefault(require("./rules/ensure-use-sync-external-store-server-snapshot"));
 var _nodePath = require("node:path");
 var _nodeFs = require("node:fs");
 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; }
@@ -73,7 +80,6 @@ var rules = exports.rules = {
   'no-pre-post-install-scripts': _noPrePostInstalls.default,
   'no-invalid-storybook-decorator-usage': _noInvalidStorybookDecoratorUsage.default,
   'ensure-publish-valid': _ensurePublishValid.default,
-  'ensure-native-and-af-exports-synced': _ensureNativeAndAfExportsSynced.default,
   'no-module-level-eval': _noModuleLevelEval.default,
   'no-module-level-eval-nav4': _noModuleLevelEvalNav.default,
   'static-feature-flags': _staticFeatureFlags.default,
@@ -83,14 +89,23 @@ var rules = exports.rules = {
   'no-alias': _noAlias.default,
   'use-entrypoints-in-examples': _useEntrypointsInExamples.default,
   'use-recommended-utils': _useRecommendedUtils.default,
+  'valid-gate-name': _validGateName.default,
   'no-sparse-checkout': _noSparseCheckout.default,
   'no-direct-document-usage': _noDirectDocumentUsage.default,
   'no-set-immediate': _noSetImmediate.default,
-  'prefer-crypto-random-uuid': _preferCryptoRandomUuid.default
+  'prefer-crypto-random-uuid': _preferCryptoRandomUuid.default,
+  'no-barrel-entry-imports': _noBarrelEntryImports.default,
+  'no-barrel-entry-jest-mock': _noBarrelEntryJestMock.default,
+  'no-jest-mock-barrel-files': _noJestMockBarrelFiles.default,
+  'no-relative-barrel-file-imports': _noRelativeBarrelFileImports.default,
+  'no-conversation-assistant-barrel-imports': _noConversationAssistantBarrelImports.default,
+  'visit-example-type-import-required': _visitExampleTypeImportRequired.default,
+  'ensure-use-sync-external-store-server-snapshot': _ensureUseSyncExternalStoreServerSnapshot.default
 };
 var commonConfig = {
   '@atlaskit/platform/ensure-test-runner-arguments': 'error',
   '@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
+  '@atlaskit/platform/ensure-use-sync-external-store-server-snapshot': 'error',
   '@atlaskit/platform/no-invalid-feature-flag-usage': 'error',
   '@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error',
   '@atlaskit/platform/ensure-atlassian-team': 'error',
@@ -116,6 +131,7 @@ var recommendedRules = _objectSpread(_objectSpread({}, commonConfig), {}, {
   '@atlaskit/platform/inline-usage': 'error',
   '@atlaskit/platform/prefer-fg': 'error',
   '@atlaskit/platform/no-alias': 'error',
+  '@atlaskit/platform/valid-gate-name': 'error',
   // end: feature-gating rules
   '@atlaskit/platform/ensure-feature-flag-registration': 'error'
 });

package/dist/cjs/rules/ensure-use-sync-external-store-server-snapshot/index.js

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+var FUNCTION_NAME = 'useSyncExternalStore';
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: "Enforce that ".concat(FUNCTION_NAME, " is called with a third argument (getServerSnapshot) for SSR compatibility"),
+      recommended: true
+    },
+    messages: {
+      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")
+    }
+  },
+  create: function create(context) {
+    return {
+      CallExpression: function CallExpression(node) {
+        var callee = node.callee,
+          args = node.arguments;
+        var isDirectCall = callee.type === 'Identifier' && callee.name === FUNCTION_NAME;
+        var isMemberCall = callee.type === 'MemberExpression' && callee.property.type === 'Identifier' && callee.property.name === FUNCTION_NAME;
+        if (!isDirectCall && !isMemberCall) {
+          return;
+        }
+        if (args.length < 3) {
+          context.report({
+            node: node,
+            messageId: 'missingServerSnapshot'
+          });
+        }
+      }
+    };
+  }
+};
+var _default = exports.default = rule;

package/dist/cjs/rules/feature-gating/valid-gate-name/index.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _constants = require("../../constants");
+var _utils = require("../utils");
+var IMPORT_SOURCES = new Set([].concat((0, _toConsumableArray2.default)(_constants.FEATURE_API_IMPORT_SOURCES), ['@atlassian/jira-feature-flagging-utils', '@atlassian/jira-feature-gate-component']));
+var FUNCTION_NAMES = new Set(['ff', 'fg', 'getFeatureFlagValue', 'componentWithFF', 'componentWithFG', 'passGate', 'withGate', 'expVal', 'expValEquals', 'UNSAFE_noExposureExp', 'mockExp', 'withExp', 'wasExperimentManuallyExposed']);
+
+/**
+ * Valid gate names must only contain lowercase letters (a-z), numbers (0-9),
+ * underscores (_), hyphens (-), and dots (.).
+ * No spaces, capital letters, or other characters are allowed.
+ */
+var VALID_GATE_NAME_PATTERN = /^[a-z0-9_.-]+$/;
+function isValidGateName(name) {
+  return VALID_GATE_NAME_PATTERN.test(name);
+}
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Ensure feature gate names contain only lowercase letters, numbers, underscores, and hyphens'
+    },
+    messages: {
+      invalidGateName: 'Feature gate name "{{name}}" is invalid. Gate names must contain only lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and dots (.).'
+    }
+  },
+  create: function create(context) {
+    return {
+      'CallExpression[callee.type="Identifier"][arguments.length>0][arguments.0.type="Literal"]': function CallExpressionCalleeTypeIdentifierArgumentsLength0Arguments0TypeLiteral(node) {
+        if (node.type !== 'CallExpression') {
+          return;
+        }
+        if (node.callee.type === 'Identifier' && (!FUNCTION_NAMES.has(node.callee.name) || !(0, _utils.isIdentifierImportedFrom)(node.callee.name, IMPORT_SOURCES, context, node))) {
+          return;
+        }
+        var nameArgument = node.arguments[0];
+        if (nameArgument.type !== 'Literal' || typeof nameArgument.value !== 'string') {
+          return;
+        }
+        var gateName = nameArgument.value;
+        if (!isValidGateName(gateName)) {
+          context.report({
+            node: nameArgument,
+            messageId: 'invalidGateName',
+            data: {
+              name: gateName
+            }
+          });
+        }
+      }
+    };
+  }
+};
+var _default = exports.default = rule;