@atlaskit/eslint-plugin-platform 2.7.0 → 2.7.1

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

@@ -1,122 +0,0 @@
-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/compiled-utils.ts

@@ -1,27 +0,0 @@
-import type { Node } from 'estree';
-import { getAncestors, getScope } from './context-compat';
-import type { Rule } from 'eslint';
-import {
-	getImportSources,
-	isCompiled,
-	isAtlasKitCSS,
-} from '@atlaskit/eslint-utils/is-supported-import';
-
-// Checks if the function that holds the property is using a Compiled import package that this rule is targeting
-export const isCompiledAPI = (context: Rule.RuleContext, node: Node): boolean => {
-	const importSources = getImportSources(context);
-	const { references } = getScope(context, node);
-	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;
-	}
-	return false;
-};

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

@@ -1,41 +0,0 @@
-import type { Rule, Scope, SourceCode } from 'eslint';
-import type { Node } from 'estree';
-
-/**
- * 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.
- */
-
-/**
- * A compatibility layer to support older versions of ESLint.
- * `context.sourceCode` is the preferred way to access SourceCode, as
- * `context.getSourceCode()` is deprecated in v8 and removed in v9.
- * @param context - The ESLint rule context
- */
-export const getSourceCode = (context: Rule.RuleContext): SourceCode => {
-	return context.sourceCode ?? context.getSourceCode();
-};
-
-/**
- * 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();
-};
-
-/**
- * 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();
-};

package/src/rules/util/file-exclusions.ts

@@ -1,39 +0,0 @@
-import type { Rule } from 'eslint';
-
-/**
- * Common patterns for test files that should be excluded from rules
- */
-const TEST_FILE_PATTERNS = ['__tests__', 'test', 'spec'] as const;
-
-/**
- * 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: string): boolean => {
-	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: Rule.RuleContext): Rule.RuleListener | undefined => {
-	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: Rule.RuleContext): Rule.RuleListener | undefined => {
-	if (context.filename.includes('example')) {
-		return {};
-	}
-	return undefined;
-};

package/src/rules/util/handle-ast-object.ts

@@ -1,33 +0,0 @@
-import type { ObjectExpression, SimpleLiteral, RegExpLiteral, BigIntLiteral } from 'estree';
-
-export const getObjectPropertyAsLiteral = (
-	node: ObjectExpression,
-	property: string,
-): SimpleLiteral['value'] | RegExpLiteral['value'] | BigIntLiteral['value'] => {
-	const prop = node.properties.find(
-		(p) => p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property,
-	);
-
-	// double check for property is to make typescript happy
-	if (prop?.type === 'Property' && prop?.value.type === 'Literal') {
-		return prop.value.value ?? null;
-	}
-
-	return null;
-};
-
-export const getObjectPropertyAsObject = (
-	node: ObjectExpression,
-	property: string,
-): ObjectExpression | null => {
-	const prop = node.properties.find(
-		(p) => p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property,
-	);
-
-	// double check for property is to make typescript happy
-	if (prop?.type === 'Property' && prop?.value.type === 'ObjectExpression') {
-		return prop.value ?? null;
-	}
-
-	return null;
-};

package/src/rules/util/registration-utils.ts

@@ -1,59 +0,0 @@
-import readPkgUp from 'read-pkg-up';
-import path from 'path';
-import Fuse from 'fuse.js';
-
-// defines a "getter" to "type" map, if more types are required for feature flags (like string) add it here!
-// if you don't want to verify the type use `null` as the value
-export const getterIdentifierToFlagTypeMap = {
-	getBooleanFF: 'boolean' as const,
-	ffTest: 'boolean' as const,
-	fg: 'boolean' as const,
-} as const;
-
-export type PlatformFeatureFlagRegistrationSection = {
-	[key: string]: {
-		// get the values of the object above
-		type: (typeof getterIdentifierToFlagTypeMap)[keyof typeof getterIdentifierToFlagTypeMap];
-	};
-};
-
-export type EnhancedPackageJson = readPkgUp.PackageJson & {
-	'platform-feature-flags'?: PlatformFeatureFlagRegistrationSection;
-};
-
-export type PkgJsonMetaData = {
-	pkgJson: EnhancedPackageJson;
-	fuse: Fuse<string> | null;
-};
-// make sure we cache reading the package.json so we don't end up reading it for every instance of this rule.
-const pkgJsonCache = new Map<string, PkgJsonMetaData>();
-// get the ancestor package.json for a given file
-export const getMetadataForFilename = (filename: string): PkgJsonMetaData => {
-	const splitFilename = filename.split(path.sep);
-	for (let i = 0; i < splitFilename.length; i++) {
-		// attempt to search using the filename in the cache to see if we've read the package.json for a sibling file before
-		const searchPath = path.join(...splitFilename.splice(0, i));
-		const cachedMetaData = pkgJsonCache.get(searchPath);
-
-		if (cachedMetaData) {
-			return cachedMetaData;
-		}
-	}
-
-	const { packageJson, path: pkgJsonPath } = readPkgUp.sync({
-		cwd: filename,
-		normalize: false,
-	})!;
-
-	const pkgJson = packageJson as EnhancedPackageJson;
-
-	const fuse =
-		packageJson['platform-feature-flags'] == null
-			? null
-			: new Fuse(Object.keys(pkgJson['platform-feature-flags']!));
-
-	const metaData = { pkgJson, fuse };
-
-	pkgJsonCache.set(pkgJsonPath, metaData);
-	return metaData;
-};

package/tsconfig.app.json

@@ -1,43 +0,0 @@
-{
-	"extends": "../../../tsconfig.node.json",
-	"include": ["./src/**/*.ts", "./src/**/*.tsx"],
-	"exclude": [
-		"**/docs/**/*",
-		"**/__tests__/**/*",
-		"**/vr-tests/**/*",
-		"**/__perf__/**/*",
-		"**/*.test.*",
-		"**/test.*",
-		"**/test-*",
-		"**/examples.ts",
-		"**/examples.tsx",
-		"**/examples/*.ts",
-		"**/examples/*.tsx",
-		"**/examples/**/*.ts",
-		"**/examples/**/*.tsx",
-		"**/storybook/**/*",
-		"**/constellation/**/*",
-		".storybook/*",
-		"./__fixtures__/**/*",
-		"./__generated__/**/*",
-		"./mocks/**/*",
-		"./__mocks__/**/*",
-		"**/mock.*",
-		"**/codemods/**/*.ts",
-		"**/codemods/**/*.tsx"
-	],
-	"compilerOptions": {
-		"lib": ["ES2021.String"],
-		"composite": true,
-		"outDir": "../../../tsDist/@atlaskit__eslint-plugin-platform/app"
-	},
-	"references": [
-		{
-			"path": "../../design-system/eslint-utils/tsconfig.app.json"
-		},
-		{
-			"path": "../../monorepo-tooling/ts-loader/tsconfig.app.json"
-		}
-	],
-	"files": []
-}

package/tsconfig.dev.json

@@ -1,40 +0,0 @@
-{
-	"extends": "../../../tsconfig.node.json",
-	"include": [
-		"**/docs/**/*",
-		"**/__tests__/**/*",
-		"**/vr-tests/**/*",
-		"**/__perf__/**/*",
-		"**/*.test.*",
-		"**/test.*",
-		"**/test-*",
-		"**/examples.ts",
-		"**/examples.tsx",
-		"**/examples/*.ts",
-		"**/examples/*.tsx",
-		"**/examples/**/*.ts",
-		"**/examples/**/*.tsx",
-		"**/storybook/**/*",
-		"**/constellation/**/*",
-		".storybook/*",
-		"./__fixtures__/**/*",
-		"./__generated__/**/*",
-		"./mocks/**/*",
-		"./__mocks__/**/*",
-		"**/mock.*",
-		"**/codemods/**/*.ts",
-		"**/codemods/**/*.tsx"
-	],
-	"exclude": ["./dist/**/*", "./build/**/*", "./node_modules/**/*"],
-	"compilerOptions": {
-		"lib": ["ES2021.String"],
-		"composite": true,
-		"outDir": "../../../tsDist/@atlaskit__eslint-plugin-platform/dev"
-	},
-	"references": [
-		{
-			"path": "./tsconfig.app.json"
-		}
-	],
-	"files": []
-}

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "extends": "../../../tsconfig.node.json",
-  "include": [
-    "__tests__/**/*.ts",
-    "__tests__/**/*.tsx",
-    "docs/**/*.ts",
-    "docs/**/*.tsx",
-    "examples/**/*.ts",
-    "examples/**/*.tsx",
-    "src/**/*.ts",
-    "src/**/*.tsx",
-    "scripts"
-  ],
-  "compilerOptions": {
-    "lib": ["ES2021.String"]
-  },
-  "ts-node": {
-    // It is faster to skip typechecking.
-    "transpileOnly": true,
-    // We must load files for third party defs - https://typestrong.org/ts-node/docs/types
-    "files": true,
-  }
-}