@atlaskit/eslint-plugin-platform 2.5.0 → 2.6.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/eslint-plugin-platform
 
+## 2.6.0
+
+### Minor Changes
+
+- [#168806](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/168806)
+  [`e4f94f422b9f1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e4f94f422b9f1) -
+  New linting rule to prevent direct "document" usage. This prevents failed tests when document is
+  not defined in the testing environment
+
 ## 2.5.0
 
 ### Minor Changes

package/afm-cc/tsconfig.json

@@ -3,7 +3,7 @@
     "compilerOptions": {
         "target": "es5",
         "composite": true,
-        "outDir": "../dist",
+        "outDir": "../../../../../confluence/tsDist/@atlaskit__eslint-plugin-platform",
         "rootDir": "../"
     },
     "include": [

package/dist/cjs/index.js

@@ -34,8 +34,28 @@ var _useEntrypointsInExamples = _interopRequireDefault(require("./rules/use-entr
 var _useRecommendedUtils = _interopRequireDefault(require("./rules/feature-gating/use-recommended-utils"));
 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 _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; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; } // eslint-disable-next-line import/no-extraneous-dependencies
+var jiraRoot;
+try {
+  var findUp = require('find-up');
+  findUp.sync(function (dir) {
+    var productsJsonPath = (0, _nodePath.join)(dir, 'products.json');
+    if (findUp.sync.exists(productsJsonPath)) {
+      var productJson = JSON.parse((0, _nodeFs.readFileSync)(productsJsonPath, 'utf-8'));
+      if (productJson.Jira) {
+        jiraRoot = (0, _nodePath.normalize)((0, _nodePath.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 = exports.rules = {
   'ensure-feature-flag-registration': _ensureFeatureFlagRegistration.default,
@@ -64,7 +84,9 @@ var rules = exports.rules = {
   'prefer-fg': _preferFg.default,
   'no-alias': _noAlias.default,
   'use-entrypoints-in-examples': _useEntrypointsInExamples.default,
-  'use-recommended-utils': _useRecommendedUtils.default
+  'use-recommended-utils': _useRecommendedUtils.default,
+  'no-sparse-checkout': _noSparseCheckout.default,
+  'no-direct-document-usage': _noDirectDocumentUsage.default
 };
 var commonConfig = {
   '@atlaskit/platform/ensure-test-runner-arguments': 'error',
@@ -73,6 +95,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',
@@ -101,6 +124,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 = exports.plugin = {
@@ -147,7 +171,14 @@ var plugin = exports.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()];
       },
@@ -170,7 +201,13 @@ var plugin = exports.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/cjs/rules/ensure-native-and-af-exports-synced/index.js

@@ -13,6 +13,9 @@ var _registrationUtils = require("../util/registration-utils");
 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; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var exportsValidationExceptions = {
+  '@af/yarn-workspace': {
+    ignoredAfExportKeys: ['./lock-parser']
+  },
   '@atlaskit/tokens': {
     ignoredAfExportKeys: ['./babel-plugin']
   },

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

@@ -53,7 +53,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/cjs/rules/feature-gating/no-preconditioning/index.js

@@ -55,7 +55,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/cjs/rules/no-direct-document-usage/index.js

@@ -0,0 +1,103 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _fileExclusions = require("../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 = (0, _fileExclusions.skipForTestFiles)(context);
+    if (skipResult) {
+      return skipResult;
+    }
+
+    // Skip example files
+    var skipResult2 = (0, _fileExclusions.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'
+          });
+        }
+      }
+    };
+  }
+};
+var _default = exports.default = rule;

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

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+// 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'
+            });
+          }
+        }
+      }
+    };
+  }
+};
+var _default = exports.default = rule;

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

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.skipForTestFiles = exports.skipForExampleFiles = void 0;
+/**
+ * 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
+ */
+var skipForTestFiles = exports.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
+ */
+var skipForExampleFiles = exports.skipForExampleFiles = function skipForExampleFiles(context) {
+  if (context.filename.includes('example')) {
+    return {};
+  }
+  return undefined;
+};

package/dist/es2019/index.js

@@ -27,6 +27,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';
+let jiraRoot;
+try {
+  const findUp = require('find-up');
+  findUp.sync(dir => {
+    const productsJsonPath = join(dir, 'products.json');
+    if (findUp.sync.exists(productsJsonPath)) {
+      const productJson = 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 = require('@atlaskit/eslint-plugin-platform/package.json');
 const rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
@@ -55,7 +75,9 @@ const 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
 };
 const commonConfig = {
   '@atlaskit/platform/ensure-test-runner-arguments': 'error',
@@ -64,6 +86,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',
@@ -93,6 +116,7 @@ const recommendedRules = {
 const jiraRules = commonConfig;
 const jsonPrefix = '/* eslint-disable quote-props, comma-dangle, quotes, semi, eol-last, @typescript-eslint/semi, no-template-curly-in-string */ module.exports = ';
 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
@@ -141,7 +165,14 @@ const plugin = {
   },
   processors: {
     'package-json-processor': {
-      preprocess: source => {
+      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()];
       },
@@ -168,7 +199,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 => {
+      // 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/dist/es2019/rules/ensure-native-and-af-exports-synced/index.js

@@ -1,6 +1,9 @@
 import path from 'path';
 import { getMetadataForFilename } from '../util/registration-utils';
 const exportsValidationExceptions = {
+  '@af/yarn-workspace': {
+    ignoredAfExportKeys: ['./lock-parser']
+  },
   '@atlaskit/tokens': {
     ignoredAfExportKeys: ['./babel-plugin']
   },

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

@@ -36,7 +36,7 @@ const 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/es2019/rules/feature-gating/no-preconditioning/index.js

@@ -50,7 +50,7 @@ const 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/es2019/rules/no-direct-document-usage/index.js

@@ -0,0 +1,95 @@
+import { skipForExampleFiles, skipForTestFiles } from '../util/file-exclusions';
+const 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(context) {
+    let hasGetDocumentImport = false;
+    const filename = context.filename;
+
+    // Skip test files
+    const skipResult = skipForTestFiles(context);
+    if (skipResult) {
+      return skipResult;
+    }
+
+    // Skip example files
+    const skipResult2 = skipForExampleFiles(context);
+    if (skipResult2) {
+      return skipResult2;
+    }
+
+    // Skip the getDocument.ts file itself
+    if (filename.endsWith('getDocument.ts')) {
+      return {};
+    }
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value === '@atlaskit/browser-apis' && node.specifiers.some(specifier => specifier.type === 'ImportSpecifier' && specifier.imported.name === 'getDocument')) {
+          hasGetDocumentImport = true;
+        }
+      },
+      Identifier(node) {
+        if (node.name === 'document' && !hasGetDocumentImport) {
+          const 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,
+            messageId: 'useGetDocument'
+          });
+        }
+      }
+    };
+  }
+};
+export default rule;

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

@@ -0,0 +1,35 @@
+// 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
+const 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'];
+const 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(context) {
+    const fileName = context.filename;
+    if (sparseCheckoutExceptions.some(exception => 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': node => {
+        if (node.key.type === 'Identifier' && node.key.name === 'sparseCheckout') {
+          if (node.value.type === 'Literal' && node.value.value === true) {
+            context.report({
+              node,
+              messageId: 'noSparseCheckout'
+            });
+          }
+        }
+      }
+    };
+  }
+};
+export default rule;

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

@@ -0,0 +1,37 @@
+/**
+ * Common patterns for test files that should be excluded from rules
+ */
+const 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
+ */
+const isTestFile = filename => {
+  return TEST_FILE_PATTERNS.some(pattern => 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 const 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 const skipForExampleFiles = context => {
+  if (context.filename.includes('example')) {
+    return {};
+  }
+  return undefined;
+};