@atlaskit/eslint-plugin-platform 2.0.0 → 2.0.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/eslint-plugin-platform
 
+## 2.0.2
+
+### Patch Changes
+
+- [#182128](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/182128)
+  [`c00cde6230838`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c00cde6230838) -
+  fix v9 support regression
+- Updated dependencies
+
+## 2.0.1
+
+### Patch Changes
+
+- [`2034d96c50c40`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/2034d96c50c40) -
+  fixed backwards compatibility with older versions of eslint
+
 ## 2.0.0
 
 ### Major Changes

package/dist/cjs/rules/compiled/expand-background-shorthand/index.js

@@ -11,7 +11,7 @@ var isCompiledAPI = function isCompiledAPI(context, node) {
   var importSources = (0, _isSupportedImport.getImportSources)(context);
   var _getScope = (0, _contextCompat.getScope)(context, node),
     references = _getScope.references;
-  var ancestors = context.getAncestors();
+  var ancestors = (0, _contextCompat.getAncestors)(context, node);
   if (ancestors.some(function (ancestor) {
     return ancestor.type === 'CallExpression' && ancestor.callee && ((0, _isSupportedImport.isCompiled)(ancestor.callee, references, importSources) || (0, _isSupportedImport.isAtlasKitCSS)(ancestor.callee, references, importSources));
   })) {

package/dist/cjs/rules/util/context-compat.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getScope = void 0;
+exports.getScope = exports.getAncestors = void 0;
 /**
  * TODO: Consider whether this should be replaced by ESLint's compat library.
  * Either way, this should be removed once we no longer need to support ESLint versions less than 8.40.
@@ -24,10 +24,24 @@ var getSourceCode = function getSourceCode(context) {
  * A compatibility layer to support older versions of ESLint.
  * `context.sourceCode.getScope()` is the preferred way to access Scope, as
  * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getscope()
  * @param context - The ESLint rule context
  * @param node - The node to get the scope for
  */
 var getScope = exports.getScope = function getScope(context, node) {
-  var _getSourceCode$getSco, _getSourceCode;
-  return (_getSourceCode$getSco = (_getSourceCode = getSourceCode(context)) === null || _getSourceCode === void 0 ? void 0 : _getSourceCode.getScope(node)) !== null && _getSourceCode$getSco !== void 0 ? _getSourceCode$getSco : context.getScope();
+  var _getSourceCode$getSco, _getSourceCode, _getSourceCode$getSco2;
+  return (_getSourceCode$getSco = (_getSourceCode = getSourceCode(context)) === null || _getSourceCode === void 0 || (_getSourceCode$getSco2 = _getSourceCode.getScope) === null || _getSourceCode$getSco2 === void 0 ? void 0 : _getSourceCode$getSco2.call(_getSourceCode, node)) !== null && _getSourceCode$getSco !== void 0 ? _getSourceCode$getSco : context.getScope();
+};
+
+/**
+ * A compatibility layer to support older versions of ESLint.
+ * `context.sourceCode.getAncestors()` is the preferred way to access Ancestors, as
+ * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getancestors()
+ * @param context - The ESLint rule context
+ * @param node - The node to get the scope for
+ */
+var getAncestors = exports.getAncestors = function getAncestors(context, node) {
+  var _getSourceCode$getAnc, _getSourceCode2, _getSourceCode2$getAn;
+  return (_getSourceCode$getAnc = (_getSourceCode2 = getSourceCode(context)) === null || _getSourceCode2 === void 0 || (_getSourceCode2$getAn = _getSourceCode2.getAncestors) === null || _getSourceCode2$getAn === void 0 ? void 0 : _getSourceCode2$getAn.call(_getSourceCode2, node)) !== null && _getSourceCode$getAnc !== void 0 ? _getSourceCode$getAnc : context.getAncestors();
 };

package/dist/es2019/rules/compiled/expand-background-shorthand/index.js

@@ -1,5 +1,5 @@
 import { getImportSources, isCompiled, isAtlasKitCSS } from '@atlaskit/eslint-utils/is-supported-import';
-import { getScope } from '../../util/context-compat';
+import { getAncestors, getScope } from '../../util/context-compat';
 
 // Checks if the function that holds the border property is using an import package that this rule is targeting
 const isCompiledAPI = (context, node) => {
@@ -7,7 +7,7 @@ const isCompiledAPI = (context, node) => {
   const {
     references
   } = getScope(context, node);
-  const ancestors = context.getAncestors();
+  const ancestors = getAncestors(context, node);
   if (ancestors.some(ancestor => ancestor.type === 'CallExpression' && ancestor.callee && (isCompiled(ancestor.callee, references, importSources) || isAtlasKitCSS(ancestor.callee, references, importSources)))) {
     return true;
   }

package/dist/es2019/rules/util/context-compat.js

@@ -18,10 +18,24 @@ const getSourceCode = context => {
  * A compatibility layer to support older versions of ESLint.
  * `context.sourceCode.getScope()` is the preferred way to access Scope, as
  * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getscope()
  * @param context - The ESLint rule context
  * @param node - The node to get the scope for
  */
 export const getScope = (context, node) => {
-  var _getSourceCode$getSco, _getSourceCode;
-  return (_getSourceCode$getSco = (_getSourceCode = getSourceCode(context)) === null || _getSourceCode === void 0 ? void 0 : _getSourceCode.getScope(node)) !== null && _getSourceCode$getSco !== void 0 ? _getSourceCode$getSco : context.getScope();
+  var _getSourceCode$getSco, _getSourceCode, _getSourceCode$getSco2;
+  return (_getSourceCode$getSco = (_getSourceCode = getSourceCode(context)) === null || _getSourceCode === void 0 ? void 0 : (_getSourceCode$getSco2 = _getSourceCode.getScope) === null || _getSourceCode$getSco2 === void 0 ? void 0 : _getSourceCode$getSco2.call(_getSourceCode, node)) !== null && _getSourceCode$getSco !== void 0 ? _getSourceCode$getSco : context.getScope();
+};
+
+/**
+ * A compatibility layer to support older versions of ESLint.
+ * `context.sourceCode.getAncestors()` is the preferred way to access Ancestors, as
+ * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getancestors()
+ * @param context - The ESLint rule context
+ * @param node - The node to get the scope for
+ */
+export const getAncestors = (context, node) => {
+  var _getSourceCode$getAnc, _getSourceCode2, _getSourceCode2$getAn;
+  return (_getSourceCode$getAnc = (_getSourceCode2 = getSourceCode(context)) === null || _getSourceCode2 === void 0 ? void 0 : (_getSourceCode2$getAn = _getSourceCode2.getAncestors) === null || _getSourceCode2$getAn === void 0 ? void 0 : _getSourceCode2$getAn.call(_getSourceCode2, node)) !== null && _getSourceCode$getAnc !== void 0 ? _getSourceCode$getAnc : context.getAncestors();
 };

package/dist/esm/rules/compiled/expand-background-shorthand/index.js

@@ -1,12 +1,12 @@
 import { getImportSources, isCompiled, isAtlasKitCSS } from '@atlaskit/eslint-utils/is-supported-import';
-import { getScope } from '../../util/context-compat';
+import { getAncestors, getScope } from '../../util/context-compat';
 
 // Checks if the function that holds the border property is using an import package that this rule is targeting
 var isCompiledAPI = function isCompiledAPI(context, node) {
   var importSources = getImportSources(context);
   var _getScope = getScope(context, node),
     references = _getScope.references;
-  var ancestors = context.getAncestors();
+  var ancestors = getAncestors(context, node);
   if (ancestors.some(function (ancestor) {
     return ancestor.type === 'CallExpression' && ancestor.callee && (isCompiled(ancestor.callee, references, importSources) || isAtlasKitCSS(ancestor.callee, references, importSources));
   })) {

package/dist/esm/rules/util/context-compat.js

@@ -18,10 +18,24 @@ var getSourceCode = function getSourceCode(context) {
  * A compatibility layer to support older versions of ESLint.
  * `context.sourceCode.getScope()` is the preferred way to access Scope, as
  * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getscope()
  * @param context - The ESLint rule context
  * @param node - The node to get the scope for
  */
 export var getScope = function getScope(context, node) {
-  var _getSourceCode$getSco, _getSourceCode;
-  return (_getSourceCode$getSco = (_getSourceCode = getSourceCode(context)) === null || _getSourceCode === void 0 ? void 0 : _getSourceCode.getScope(node)) !== null && _getSourceCode$getSco !== void 0 ? _getSourceCode$getSco : context.getScope();
+  var _getSourceCode$getSco, _getSourceCode, _getSourceCode$getSco2;
+  return (_getSourceCode$getSco = (_getSourceCode = getSourceCode(context)) === null || _getSourceCode === void 0 || (_getSourceCode$getSco2 = _getSourceCode.getScope) === null || _getSourceCode$getSco2 === void 0 ? void 0 : _getSourceCode$getSco2.call(_getSourceCode, node)) !== null && _getSourceCode$getSco !== void 0 ? _getSourceCode$getSco : context.getScope();
+};
+
+/**
+ * A compatibility layer to support older versions of ESLint.
+ * `context.sourceCode.getAncestors()` is the preferred way to access Ancestors, as
+ * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getancestors()
+ * @param context - The ESLint rule context
+ * @param node - The node to get the scope for
+ */
+export var getAncestors = function getAncestors(context, node) {
+  var _getSourceCode$getAnc, _getSourceCode2, _getSourceCode2$getAn;
+  return (_getSourceCode$getAnc = (_getSourceCode2 = getSourceCode(context)) === null || _getSourceCode2 === void 0 || (_getSourceCode2$getAn = _getSourceCode2.getAncestors) === null || _getSourceCode2$getAn === void 0 ? void 0 : _getSourceCode2$getAn.call(_getSourceCode2, node)) !== null && _getSourceCode$getAnc !== void 0 ? _getSourceCode$getAnc : context.getAncestors();
 };

package/dist/types/rules/util/context-compat.d.ts

@@ -4,7 +4,17 @@ import type { Node } from 'estree';
  * A compatibility layer to support older versions of ESLint.
  * `context.sourceCode.getScope()` is the preferred way to access Scope, as
  * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getscope()
  * @param context - The ESLint rule context
  * @param node - The node to get the scope for
  */
 export declare const getScope: (context: Rule.RuleContext, node: Node) => Scope.Scope;
+/**
+ * A compatibility layer to support older versions of ESLint.
+ * `context.sourceCode.getAncestors()` is the preferred way to access Ancestors, as
+ * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getancestors()
+ * @param context - The ESLint rule context
+ * @param node - The node to get the scope for
+ */
+export declare const getAncestors: (context: Rule.RuleContext, node: Node) => Node[];

package/dist/types-ts4.5/rules/util/context-compat.d.ts

@@ -4,7 +4,17 @@ import type { Node } from 'estree';
  * A compatibility layer to support older versions of ESLint.
  * `context.sourceCode.getScope()` is the preferred way to access Scope, as
  * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getscope()
  * @param context - The ESLint rule context
  * @param node - The node to get the scope for
  */
 export declare const getScope: (context: Rule.RuleContext, node: Node) => Scope.Scope;
+/**
+ * A compatibility layer to support older versions of ESLint.
+ * `context.sourceCode.getAncestors()` is the preferred way to access Ancestors, as
+ * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getancestors()
+ * @param context - The ESLint rule context
+ * @param node - The node to get the scope for
+ */
+export declare const getAncestors: (context: Rule.RuleContext, node: Node) => Node[];

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.0.0",
+	"version": "2.0.2",
 	"author": "Atlassian Pty Ltd",
 	"atlassian": {
 		"team": "Build Infra",
@@ -31,9 +31,9 @@
 		".": "./src/index.tsx"
 	},
 	"dependencies": {
-		"@atlaskit/eslint-utils": "^1.7.0",
+		"@atlaskit/eslint-utils": "^1.8.0",
 		"@babel/runtime": "^7.0.0",
-		"@compiled/eslint-plugin": "^0.17.0",
+		"@compiled/eslint-plugin": "^0.18.2",
 		"@manypkg/find-root": "^1.1.0",
 		"fuse.js": "^6.6.2",
 		"read-pkg-up": "^7.0.1"

package/src/rules/compiled/expand-background-shorthand/index.tsx

@@ -5,13 +5,13 @@ import {
 	isCompiled,
 	isAtlasKitCSS,
 } from '@atlaskit/eslint-utils/is-supported-import';
-import { getScope } from '../../util/context-compat';
+import { getAncestors, getScope } from '../../util/context-compat';
 
 // Checks if the function that holds the border property is using an import package that this rule is targeting
 const isCompiledAPI = (context: Rule.RuleContext, node: Node): boolean => {
 	const importSources = getImportSources(context);
 	const { references } = getScope(context, node);
-	const ancestors = context.getAncestors();
+	const ancestors = getAncestors(context, node);
 	if (
 		ancestors.some(
 			(ancestor) =>

package/src/rules/util/__tests__/context-compat.test.ts

@@ -0,0 +1,122 @@
+import type { Rule, Scope, SourceCode } from 'eslint';
+import type { Node } from 'estree';
+
+import { getAncestors, getScope } from '../context-compat';
+
+describe('context-compat', () => {
+	describe('getAncestors', () => {
+		let context: Rule.RuleContext;
+		let node: Node;
+		let sourceCode: SourceCode;
+		let ancestors: Node[];
+
+		beforeEach(() => {
+			node = {} as Node;
+			ancestors = [];
+			sourceCode = {
+				getAncestors: jest.fn().mockReturnValue(ancestors),
+			} as unknown as SourceCode;
+		});
+
+		it('should return ancestor nodes from context.sourceCode.getAncestors if available', () => {
+			context = {
+				sourceCode,
+			} as unknown as Rule.RuleContext;
+
+			const result = getAncestors(context, node);
+			expect(result).toBe(ancestors);
+			expect(sourceCode.getAncestors).toHaveBeenCalledWith(node);
+		});
+
+		it('should return ancestors from context.getSourceCode().getAncestors if context.sourceCode is not available', () => {
+			context = {
+				getSourceCode: jest.fn().mockReturnValue(sourceCode),
+			} as unknown as Rule.RuleContext;
+
+			const result = getAncestors(context, node);
+			expect(result).toBe(ancestors);
+			expect(context.getSourceCode).toHaveBeenCalled();
+			expect(sourceCode.getAncestors).toHaveBeenCalledWith(node);
+		});
+
+		it('should return scope from context.getAncestors if neither context.sourceCode nor context.getSourceCode().getAncestors is available', () => {
+			context = {
+				getSourceCode: jest.fn().mockReturnValue({}),
+				getAncestors: jest.fn().mockReturnValue(ancestors),
+			} as unknown as Rule.RuleContext;
+
+			const result = getAncestors(context, node);
+			expect(result).toBe(ancestors);
+			expect(context.getAncestors).toHaveBeenCalled();
+		});
+
+		it('should return scope from context.getAncestors if context.sourceCode does not have getAncestors', () => {
+			context = {
+				sourceCode: {},
+				getAncestors: jest.fn().mockReturnValue(ancestors),
+			} as unknown as Rule.RuleContext;
+
+			const result = getAncestors(context, node);
+			expect(result).toBe(ancestors);
+			expect(context.getAncestors).toHaveBeenCalled();
+		});
+	});
+
+	describe('getScope', () => {
+		let context: Rule.RuleContext;
+		let node: Node;
+		let sourceCode: SourceCode;
+		let scope: Scope.Scope;
+
+		beforeEach(() => {
+			node = {} as Node;
+			scope = {} as Scope.Scope;
+			sourceCode = {
+				getScope: jest.fn().mockReturnValue(scope),
+			} as unknown as SourceCode;
+		});
+
+		it('should return scope from context.sourceCode.getScope if available', () => {
+			context = {
+				sourceCode,
+			} as unknown as Rule.RuleContext;
+
+			const result = getScope(context, node);
+			expect(result).toBe(scope);
+			expect(sourceCode.getScope).toHaveBeenCalledWith(node);
+		});
+
+		it('should return scope from context.getSourceCode().getScope if context.sourceCode is not available', () => {
+			context = {
+				getSourceCode: jest.fn().mockReturnValue(sourceCode),
+			} as unknown as Rule.RuleContext;
+
+			const result = getScope(context, node);
+			expect(result).toBe(scope);
+			expect(context.getSourceCode).toHaveBeenCalled();
+			expect(sourceCode.getScope).toHaveBeenCalledWith(node);
+		});
+
+		it('should return scope from context.getScope if neither context.sourceCode nor context.getSourceCode().getScope is available', () => {
+			context = {
+				getSourceCode: jest.fn().mockReturnValue({}),
+				getScope: jest.fn().mockReturnValue(scope),
+			} as unknown as Rule.RuleContext;
+
+			const result = getScope(context, node);
+			expect(result).toBe(scope);
+			expect(context.getScope).toHaveBeenCalled();
+		});
+
+		it('should return scope from context.getScope if context.sourceCode does not have getScope', () => {
+			context = {
+				sourceCode: {},
+				getScope: jest.fn().mockReturnValue(scope),
+			} as unknown as Rule.RuleContext;
+
+			const result = getScope(context, node);
+			expect(result).toBe(scope);
+			expect(context.getScope).toHaveBeenCalled();
+		});
+	});
+});

package/src/rules/util/context-compat.ts

@@ -20,9 +20,22 @@ const getSourceCode = (context: Rule.RuleContext): SourceCode => {
  * A compatibility layer to support older versions of ESLint.
  * `context.sourceCode.getScope()` is the preferred way to access Scope, as
  * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getscope()
  * @param context - The ESLint rule context
  * @param node - The node to get the scope for
  */
 export const getScope = (context: Rule.RuleContext, node: Node): Scope.Scope => {
-	return getSourceCode(context)?.getScope(node) ?? context.getScope();
+	return getSourceCode(context)?.getScope?.(node) ?? context.getScope();
+};
+
+/**
+ * A compatibility layer to support older versions of ESLint.
+ * `context.sourceCode.getAncestors()` is the preferred way to access Ancestors, as
+ * `context.getScope()` was removed in v9.
+ * https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/#context.getancestors()
+ * @param context - The ESLint rule context
+ * @param node - The node to get the scope for
+ */
+export const getAncestors = (context: Rule.RuleContext, node: Node): Node[] => {
+	return getSourceCode(context)?.getAncestors?.(node) ?? context.getAncestors();
 };