@atlaskit/eslint-plugin-platform 2.5.0 → 2.6.0

package/dist/esm/index.js

@@ -30,6 +30,26 @@ import useEntrypointsInExamples from './rules/use-entrypoints-in-examples';
 import useRecommendedUtils from './rules/feature-gating/use-recommended-utils';
 import expandBackgroundShorthand from './rules/compiled/expand-background-shorthand';
 import expandSpacingShorthand from './rules/compiled/expand-spacing-shorthand';
+import noSparseCheckout from './rules/no-sparse-checkout';
+import noDirectDocumentUsage from './rules/no-direct-document-usage';
+import { join, normalize } from 'node:path';
+import { readFileSync } from 'node:fs';
+var jiraRoot;
+try {
+  var findUp = require('find-up');
+  findUp.sync(function (dir) {
+    var productsJsonPath = join(dir, 'products.json');
+    if (findUp.sync.exists(productsJsonPath)) {
+      var productJson = JSON.parse(readFileSync(productsJsonPath, 'utf-8'));
+      if (productJson.Jira) {
+        jiraRoot = normalize(join(dir, productJson.Jira.path));
+        return findUp.stop;
+      }
+    }
+  });
+} catch (_unused) {
+  // we aren't running inside of AFM, so we can ignore this.
+}
 var packageJson = require('@atlaskit/eslint-plugin-platform/package.json');
 var rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
@@ -58,7 +78,9 @@ var rules = {
   'prefer-fg': preferFG,
   'no-alias': noAlias,
   'use-entrypoints-in-examples': useEntrypointsInExamples,
-  'use-recommended-utils': useRecommendedUtils
+  'use-recommended-utils': useRecommendedUtils,
+  'no-sparse-checkout': noSparseCheckout,
+  'no-direct-document-usage': noDirectDocumentUsage
 };
 var commonConfig = {
   '@atlaskit/platform/ensure-test-runner-arguments': 'error',
@@ -67,6 +89,7 @@ var commonConfig = {
   '@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error',
   '@atlaskit/platform/ensure-atlassian-team': 'error',
   '@atlaskit/platform/no-module-level-eval-nav4': 'error',
+  '@atlaskit/platform/no-direct-document-usage': 'warn',
   // Compiled: rules that are not included via `@compiled/recommended
   '@atlaskit/platform/expand-border-shorthand': 'error',
   '@atlaskit/platform/expand-background-shorthand': 'error',
@@ -95,6 +118,7 @@ var recommendedRules = _objectSpread(_objectSpread({}, commonConfig), {}, {
 var jiraRules = commonConfig;
 var jsonPrefix = '/* eslint-disable quote-props, comma-dangle, quotes, semi, eol-last, @typescript-eslint/semi, no-template-curly-in-string */ module.exports = ';
 var jsonPrefixForFlatConfig = '/* eslint-disable quote-props, comma-dangle, quotes, semi, eol-last, no-template-curly-in-string */ module.exports = ';
+var jsonPrefixForJira = 'module.exports = ';
 var name = packageJson.name,
   version = packageJson.version;
 var plugin = {
@@ -141,7 +165,14 @@ var plugin = {
   },
   processors: {
     'package-json-processor': {
-      preprocess: function preprocess(source) {
+      preprocess: function preprocess(source, filename) {
+        // we only need to check for jiraRoot because it uses a different
+        // ESLint version and produces fake errors due to how this processor handles JSON
+        if (jiraRoot && filename.startsWith(jiraRoot)) {
+          // augment the json into a js file
+          return [jsonPrefixForJira + source.trim()];
+        }
+
         // augment the json into a js file
         return [jsonPrefix + source.trim()];
       },
@@ -164,7 +195,13 @@ var plugin = {
     // This processor is used for ESLint FlatConfig,
     // once we roll out FlatConfig, we can remove the above processor
     'package-json-processor-for-flat-config': {
-      preprocess: function preprocess(source) {
+      // we only need to check for jiraRoot because it uses a different
+      // ESLint version and produces fake errors due to how this processor handles JSON
+      preprocess: function preprocess(source, filename) {
+        if (jiraRoot && filename.startsWith(jiraRoot)) {
+          // augment the json into a js file
+          return [jsonPrefixForJira + source.trim()];
+        }
         // augment the json into a js file
         return [jsonPrefixForFlatConfig + source.trim()];
       },

package/dist/esm/rules/ensure-native-and-af-exports-synced/index.js

@@ -6,6 +6,9 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import path from 'path';
 import { getMetadataForFilename } from '../util/registration-utils';
 var exportsValidationExceptions = {
+  '@af/yarn-workspace': {
+    ignoredAfExportKeys: ['./lock-parser']
+  },
   '@atlaskit/tokens': {
     ignoredAfExportKeys: ['./babel-plugin']
   },

package/dist/esm/rules/ensure-valid-platform-yarn-protocol-usage/index.js

@@ -49,7 +49,7 @@ var rule = {
     },
     hasSuggestions: false,
     messages: {
-      invalidWorkspaceProtocolUsage: "The 'workspace:^' or 'workspace:~' protocol is Used. To resolve this error, please use the 'workspace:*' protocol instead.",
+      invalidWorkspaceProtocolUsage: "The 'workspace:^'protocol is Used. To resolve this error, please use the 'workspace:*' protocol instead.",
       invalidRootProtocolUsage: "The 'root:' protocol is not allowed in platform packages. To resolve this error, replace the 'root:' protocol with specific package versions (e.g. '^1.0.0')."
     }
   },

package/dist/esm/rules/feature-gating/no-preconditioning/index.js

@@ -49,7 +49,7 @@ var rule = {
       url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/no-preconditioning/README.md'
     },
     messages: {
-      useConfig: 'Do not precondition gates or experiments with another gate. Configure this in Statsig instead to reduce unnecessary code and simplify cleanup.',
+      useConfig: 'Do not precondition gates or experiments with another gate. Configure this in Statsig instead to reduce unnecessary code, simplify cleanup and to ensure accurate exposures in Statsig.',
       incorrectExposure: 'Evaluate gates or experiments at the end of your logical expression to ensure exposure is tracked correctly.'
     }
   },

package/dist/esm/rules/no-direct-document-usage/index.js

@@ -0,0 +1,97 @@
+import { skipForExampleFiles, skipForTestFiles } from '../util/file-exclusions';
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Enforce using getDocument from @atlaskit/browser-apis instead of direct document usage',
+      recommended: true
+    },
+    messages: {
+      useGetDocument: 'Use getDocument from @atlaskit/browser-apis instead of direct document usage'
+    },
+    schema: []
+  },
+  create: function create(context) {
+    var hasGetDocumentImport = false;
+    var filename = context.filename;
+
+    // Skip test files
+    var skipResult = skipForTestFiles(context);
+    if (skipResult) {
+      return skipResult;
+    }
+
+    // Skip example files
+    var skipResult2 = skipForExampleFiles(context);
+    if (skipResult2) {
+      return skipResult2;
+    }
+
+    // Skip the getDocument.ts file itself
+    if (filename.endsWith('getDocument.ts')) {
+      return {};
+    }
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        if (node.source.value === '@atlaskit/browser-apis' && node.specifiers.some(function (specifier) {
+          return specifier.type === 'ImportSpecifier' && specifier.imported.name === 'getDocument';
+        })) {
+          hasGetDocumentImport = true;
+        }
+      },
+      Identifier: function Identifier(node) {
+        if (node.name === 'document' && !hasGetDocumentImport) {
+          var parent = node.parent;
+
+          // Skip if 'document' is used as a property key in an object literal
+          if ((parent === null || parent === void 0 ? void 0 : parent.type) === 'Property' && parent.key === node) {
+            return;
+          }
+
+          // Skip if 'document' is used as a shorthand property value
+          if ((parent === null || parent === void 0 ? void 0 : parent.type) === 'Property' && parent.value === node && parent.shorthand) {
+            return;
+          }
+
+          // Skip if 'document' is used as a property being accessed in a member expression
+          if ((parent === null || parent === void 0 ? void 0 : parent.type) === 'MemberExpression' && parent.property === node && !parent.computed) {
+            return;
+          }
+
+          // Skip if 'document' is being declared as a variable
+          if ((parent === null || parent === void 0 ? void 0 : parent.type) === 'VariableDeclarator' && parent.id === node) {
+            return;
+          }
+
+          // Skip if 'document' is a function name
+          if ((parent === null || parent === void 0 ? void 0 : parent.type) === 'FunctionDeclaration' && 'id' in parent && parent.id === node) {
+            return;
+          }
+          if ((parent === null || parent === void 0 ? void 0 : parent.type) === 'FunctionExpression' && 'id' in parent && parent.id === node) {
+            return;
+          }
+
+          // Skip if 'document' is a method name in a class or object
+          if ((parent === null || parent === void 0 ? void 0 : parent.type) === 'MethodDefinition' && parent.key === node) {
+            return;
+          }
+
+          // Skip if 'document' is being assigned to (shadowing the global)
+          if ((parent === null || parent === void 0 ? void 0 : parent.type) === 'AssignmentExpression' && parent.left === node) {
+            return;
+          }
+
+          // Skip if 'document' is in a destructuring pattern (could be destructuring from an object)
+          if ((parent === null || parent === void 0 ? void 0 : parent.type) === 'ObjectPattern' || (parent === null || parent === void 0 ? void 0 : parent.type) === 'ArrayPattern') {
+            return;
+          }
+          context.report({
+            node: node,
+            messageId: 'useGetDocument'
+          });
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/esm/rules/no-sparse-checkout/index.js

@@ -0,0 +1,37 @@
+// We will be removing sparse checkout from pipelines in CI completely due to the load it causes on BBC.
+// We will be incrementally removing sparse-checkout from the files below as it is probably unnecessasry.
+// If you must add an exception below, please go through the chopper process before doing so
+var sparseCheckoutExceptions = ['bitbucket-pipelines/pipelines/custom/run-issue-automat.ts', 'bitbucket-pipelines/pipelines/custom/marketplace/utils.ts', 'bitbucket-pipelines/pipelines/custom/confluence/utils/index.ts', 'bitbucket-pipelines/pipelines/custom/afm-tools/upload-afm-dependency-graph-cache.ts', 'bitbucket-pipelines/pipelines/custom/afm-tools/default-afm-tools.ts', 'bitbucket-pipelines/pipelines/custom/marketplace/utils.ts', 'bitbucket-pipelines/pipelines/custom/afm-git-hooks.ts', 'bitbucket-pipelines/pipelines/custom/update-codeowners-and-teams-gen.ts', 'bitbucket-pipelines/pipelines/custom/run-issue-automat.ts'];
+var rule = {
+  meta: {
+    docs: {
+      recommended: false
+    },
+    type: 'problem',
+    messages: {
+      noSparseCheckout: 'Sparse checkout is not allowed in pipeline configurations. Use git-alternates instead by setting sparseCheckout to false or add this file to exceptions.'
+    }
+  },
+  create: function create(context) {
+    var fileName = context.filename;
+    if (sparseCheckoutExceptions.some(function (exception) {
+      return fileName.endsWith(exception);
+    })) {
+      return {};
+    }
+    return {
+      // Look for calls to afmClone or objects that match AFMCloneConfig type
+      'CallExpression[callee.object.name=alias][callee.property.name=afmClone] ObjectExpression Property': function CallExpressionCalleeObjectNameAliasCalleePropertyNameAfmClone_ObjectExpression_Property(node) {
+        if (node.key.type === 'Identifier' && node.key.name === 'sparseCheckout') {
+          if (node.value.type === 'Literal' && node.value.value === true) {
+            context.report({
+              node: node,
+              messageId: 'noSparseCheckout'
+            });
+          }
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/esm/rules/util/file-exclusions.js

@@ -0,0 +1,39 @@
+/**
+ * Common patterns for test files that should be excluded from rules
+ */
+var TEST_FILE_PATTERNS = ['__tests__', 'test', 'spec'];
+
+/**
+ * Checks if a file should be excluded from rules based on test file patterns
+ * @param filename The filename to check
+ * @returns true if the file should be excluded, false otherwise
+ */
+var isTestFile = function isTestFile(filename) {
+  return TEST_FILE_PATTERNS.some(function (pattern) {
+    return filename.includes(pattern);
+  });
+};
+
+/**
+ * Helper function to skip rules for test files
+ * @param context The ESLint rule context
+ * @returns An empty RuleListener if the file is a test file, undefined otherwise
+ */
+export var skipForTestFiles = function skipForTestFiles(context) {
+  if (isTestFile(context.filename)) {
+    return {};
+  }
+  return undefined;
+};
+
+/**
+ * Helper function to skip rules for example files
+ * @param context The ESLint rule context
+ * @returns An empty RuleListener if the file is an example file, undefined otherwise
+ */
+export var skipForExampleFiles = function skipForExampleFiles(context) {
+  if (context.filename.includes('example')) {
+    return {};
+  }
+  return undefined;
+};

package/dist/types/index.d.ts

@@ -27,6 +27,8 @@ declare const rules: {
     'no-alias': import("eslint").Rule.RuleModule;
     'use-entrypoints-in-examples': import("eslint").Rule.RuleModule;
     'use-recommended-utils': import("eslint").Rule.RuleModule;
+    'no-sparse-checkout': import("eslint").Rule.RuleModule;
+    'no-direct-document-usage': import("eslint").Rule.RuleModule;
 };
 declare const plugin: {
     meta: {
@@ -61,6 +63,8 @@ declare const plugin: {
         'no-alias': import("eslint").Rule.RuleModule;
         'use-entrypoints-in-examples': import("eslint").Rule.RuleModule;
         'use-recommended-utils': import("eslint").Rule.RuleModule;
+        'no-sparse-checkout': import("eslint").Rule.RuleModule;
+        'no-direct-document-usage': import("eslint").Rule.RuleModule;
     };
     configs: {
         recommended: {
@@ -82,6 +86,7 @@ declare const plugin: {
                 '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
+                '@atlaskit/platform/no-direct-document-usage': "warn";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -114,6 +119,7 @@ declare const plugin: {
                 '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
+                '@atlaskit/platform/no-direct-document-usage': "warn";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -133,6 +139,7 @@ declare const plugin: {
                 '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
+                '@atlaskit/platform/no-direct-document-usage': "warn";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -155,6 +162,7 @@ declare const plugin: {
                 '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
+                '@atlaskit/platform/no-direct-document-usage': "warn";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -191,6 +199,7 @@ declare const configs: {
             '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
+            '@atlaskit/platform/no-direct-document-usage': "warn";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -223,6 +232,7 @@ declare const configs: {
             '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
+            '@atlaskit/platform/no-direct-document-usage': "warn";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -242,6 +252,7 @@ declare const configs: {
             '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
+            '@atlaskit/platform/no-direct-document-usage': "warn";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -264,6 +275,7 @@ declare const configs: {
             '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
+            '@atlaskit/platform/no-direct-document-usage': "warn";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";

package/dist/types/rules/no-direct-document-usage/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types/rules/no-sparse-checkout/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types/rules/util/file-exclusions.d.ts

@@ -0,0 +1,13 @@
+import type { Rule } from 'eslint';
+/**
+ * Helper function to skip rules for test files
+ * @param context The ESLint rule context
+ * @returns An empty RuleListener if the file is a test file, undefined otherwise
+ */
+export declare const skipForTestFiles: (context: Rule.RuleContext) => Rule.RuleListener | undefined;
+/**
+ * Helper function to skip rules for example files
+ * @param context The ESLint rule context
+ * @returns An empty RuleListener if the file is an example file, undefined otherwise
+ */
+export declare const skipForExampleFiles: (context: Rule.RuleContext) => Rule.RuleListener | undefined;

package/dist/types-ts4.5/index.d.ts

@@ -27,6 +27,8 @@ declare const rules: {
     'no-alias': import("eslint").Rule.RuleModule;
     'use-entrypoints-in-examples': import("eslint").Rule.RuleModule;
     'use-recommended-utils': import("eslint").Rule.RuleModule;
+    'no-sparse-checkout': import("eslint").Rule.RuleModule;
+    'no-direct-document-usage': import("eslint").Rule.RuleModule;
 };
 declare const plugin: {
     meta: {
@@ -61,6 +63,8 @@ declare const plugin: {
         'no-alias': import("eslint").Rule.RuleModule;
         'use-entrypoints-in-examples': import("eslint").Rule.RuleModule;
         'use-recommended-utils': import("eslint").Rule.RuleModule;
+        'no-sparse-checkout': import("eslint").Rule.RuleModule;
+        'no-direct-document-usage': import("eslint").Rule.RuleModule;
     };
     configs: {
         recommended: {
@@ -85,6 +89,7 @@ declare const plugin: {
                 '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
+                '@atlaskit/platform/no-direct-document-usage': "warn";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -123,6 +128,7 @@ declare const plugin: {
                 '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
+                '@atlaskit/platform/no-direct-document-usage': "warn";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -145,6 +151,7 @@ declare const plugin: {
                 '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
+                '@atlaskit/platform/no-direct-document-usage': "warn";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -170,6 +177,7 @@ declare const plugin: {
                 '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
                 '@atlaskit/platform/ensure-atlassian-team': "error";
                 '@atlaskit/platform/no-module-level-eval-nav4': "error";
+                '@atlaskit/platform/no-direct-document-usage': "warn";
                 '@atlaskit/platform/expand-border-shorthand': "error";
                 '@atlaskit/platform/expand-background-shorthand': "error";
                 '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -212,6 +220,7 @@ declare const configs: {
             '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
+            '@atlaskit/platform/no-direct-document-usage': "warn";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -250,6 +259,7 @@ declare const configs: {
             '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
+            '@atlaskit/platform/no-direct-document-usage': "warn";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -272,6 +282,7 @@ declare const configs: {
             '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
+            '@atlaskit/platform/no-direct-document-usage': "warn";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";
@@ -297,6 +308,7 @@ declare const configs: {
             '@atlaskit/platform/no-invalid-storybook-decorator-usage': "error";
             '@atlaskit/platform/ensure-atlassian-team': "error";
             '@atlaskit/platform/no-module-level-eval-nav4': "error";
+            '@atlaskit/platform/no-direct-document-usage': "warn";
             '@atlaskit/platform/expand-border-shorthand': "error";
             '@atlaskit/platform/expand-background-shorthand': "error";
             '@atlaskit/platform/expand-spacing-shorthand': "error";

package/dist/types-ts4.5/rules/no-direct-document-usage/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types-ts4.5/rules/no-sparse-checkout/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types-ts4.5/rules/util/file-exclusions.d.ts

@@ -0,0 +1,13 @@
+import type { Rule } from 'eslint';
+/**
+ * Helper function to skip rules for test files
+ * @param context The ESLint rule context
+ * @returns An empty RuleListener if the file is a test file, undefined otherwise
+ */
+export declare const skipForTestFiles: (context: Rule.RuleContext) => Rule.RuleListener | undefined;
+/**
+ * Helper function to skip rules for example files
+ * @param context The ESLint rule context
+ * @returns An empty RuleListener if the file is an example file, undefined otherwise
+ */
+export declare const skipForExampleFiles: (context: Rule.RuleContext) => Rule.RuleListener | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
 	"description": "The essential plugin for use with Atlassian frontend platform tools",
-	"version": "2.5.0",
+	"version": "2.6.0",
 	"author": "Atlassian Pty Ltd",
 	"atlassian": {
 		"team": "Build Infra",
@@ -45,6 +45,15 @@
 		"@atlassian/ts-loader": "^0.1.0",
 		"@types/eslint": "^8.56.6",
 		"eslint": "^8.57.0",
+		"find-up": "^4 || ^5",
 		"outdent": "^0.5.0"
+	},
+	"peerDependencies": {
+		"find-up": "^4 || ^5"
+	},
+	"peerDependenciesMeta": {
+		"find-up": {
+			"optional": true
+		}
 	}
 }

package/src/index.tsx

@@ -28,6 +28,30 @@ import useEntrypointsInExamples from './rules/use-entrypoints-in-examples';
 import useRecommendedUtils from './rules/feature-gating/use-recommended-utils';
 import expandBackgroundShorthand from './rules/compiled/expand-background-shorthand';
 import expandSpacingShorthand from './rules/compiled/expand-spacing-shorthand';
+import noSparseCheckout from './rules/no-sparse-checkout';
+import noDirectDocumentUsage from './rules/no-direct-document-usage';
+import { join, normalize } from 'node:path';
+import { readFileSync } from 'node:fs';
+
+let jiraRoot: string | undefined;
+
+try {
+	const findUp = require('find-up') as typeof import('find-up');
+	findUp.sync((dir) => {
+		const productsJsonPath = join(dir, 'products.json');
+		if (findUp.sync.exists(productsJsonPath)) {
+			const productJson: Record<string, { path: string }> = JSON.parse(
+				readFileSync(productsJsonPath, 'utf-8'),
+			);
+			if (productJson.Jira) {
+				jiraRoot = normalize(join(dir, productJson.Jira.path));
+				return findUp.stop;
+			}
+		}
+	});
+} catch {
+	// we aren't running inside of AFM, so we can ignore this.
+}
 
 const packageJson: {
 	name: string;
@@ -63,6 +87,8 @@ const rules = {
 	'no-alias': noAlias,
 	'use-entrypoints-in-examples': useEntrypointsInExamples,
 	'use-recommended-utils': useRecommendedUtils,
+	'no-sparse-checkout': noSparseCheckout,
+	'no-direct-document-usage': noDirectDocumentUsage,
 };
 
 const commonConfig = {
@@ -72,6 +98,7 @@ const commonConfig = {
 	'@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error',
 	'@atlaskit/platform/ensure-atlassian-team': 'error',
 	'@atlaskit/platform/no-module-level-eval-nav4': 'error',
+	'@atlaskit/platform/no-direct-document-usage': 'warn',
 	// Compiled: rules that are not included via `@compiled/recommended
 	'@atlaskit/platform/expand-border-shorthand': 'error',
 	'@atlaskit/platform/expand-background-shorthand': 'error',
@@ -112,6 +139,8 @@ const jsonPrefix =
 const jsonPrefixForFlatConfig =
 	'/* eslint-disable quote-props, comma-dangle, quotes, semi, eol-last, no-template-curly-in-string */ module.exports = ';
 
+const jsonPrefixForJira = 'module.exports = ';
+
 const { name, version } = packageJson;
 const plugin = {
 	meta: {
@@ -151,7 +180,14 @@ const plugin = {
 	},
 	processors: {
 		'package-json-processor': {
-			preprocess: (source: string) => {
+			preprocess: (source, filename) => {
+				// we only need to check for jiraRoot because it uses a different
+				// ESLint version and produces fake errors due to how this processor handles JSON
+				if (jiraRoot && filename.startsWith(jiraRoot)) {
+					// augment the json into a js file
+					return [jsonPrefixForJira + source.trim()];
+				}
+
 				// augment the json into a js file
 				return [jsonPrefix + source.trim()];
 			},
@@ -177,7 +213,13 @@ const plugin = {
 		// This processor is used for ESLint FlatConfig,
 		// once we roll out FlatConfig, we can remove the above processor
 		'package-json-processor-for-flat-config': {
-			preprocess: (source: string) => {
+			// we only need to check for jiraRoot because it uses a different
+			// ESLint version and produces fake errors due to how this processor handles JSON
+			preprocess: (source, filename) => {
+				if (jiraRoot && filename.startsWith(jiraRoot)) {
+					// augment the json into a js file
+					return [jsonPrefixForJira + source.trim()];
+				}
 				// augment the json into a js file
 				return [jsonPrefixForFlatConfig + source.trim()];
 			},

package/src/rules/ensure-native-and-af-exports-synced/index.tsx

@@ -8,6 +8,9 @@ interface ExportsValidationExceptions {
 }
 
 const exportsValidationExceptions: ExportsValidationExceptions = {
+	'@af/yarn-workspace': {
+		ignoredAfExportKeys: ['./lock-parser'],
+	},
 	'@atlaskit/tokens': {
 		ignoredAfExportKeys: ['./babel-plugin'],
 	},

package/src/rules/ensure-valid-bin-values/__tests__/unit/rule.test.ts

@@ -16,8 +16,9 @@ jest.mock('fs', () => {
 	const actual = jest.requireActual('fs');
 	return {
 		...actual,
-		statSync: jest.fn((stat: string) => ({
-			isFile: jest.fn(() => mockValidBinPaths.includes(stat)),
+		statSync: jest.fn((p: string) => ({
+			isFile: jest.fn(() => mockValidBinPaths.includes(p)),
+			isDirectory: jest.fn(() => actual.statSync(p).isDirectory()),
 		})),
 	};
 });

package/src/rules/ensure-valid-platform-yarn-protocol-usage/index.ts

@@ -39,7 +39,7 @@ const rule: Rule.RuleModule = {
 		},
 		hasSuggestions: false,
 		messages: {
-			invalidWorkspaceProtocolUsage: `The 'workspace:^' or 'workspace:~' protocol is Used. To resolve this error, please use the 'workspace:*' protocol instead.`,
+			invalidWorkspaceProtocolUsage: `The 'workspace:^'protocol is Used. To resolve this error, please use the 'workspace:*' protocol instead.`,
 			invalidRootProtocolUsage: `The 'root:' protocol is not allowed in platform packages. To resolve this error, replace the 'root:' protocol with specific package versions (e.g. '^1.0.0').`,
 		},
 	},