@atlaskit/eslint-plugin-platform 2.8.0 → 2.9.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @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

package/dist/cjs/index.js

@@ -41,6 +41,8 @@ var _noBarrelEntryJestMock = _interopRequireDefault(require("./rules/import/no-b
 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; }
@@ -96,11 +98,14 @@ var rules = exports.rules = {
   '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
+  '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',

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;