@atlaskit/eslint-plugin-platform 0.14.0 → 1.1.0

package/src/rules/compiled/expand-border-shorthand/index.ts

@@ -22,6 +22,9 @@ const separateBorderProperties = (
 	if (EXCLUDED_VALUES.includes(borderString)) {
 		return;
 	}
+	if (borderString.includes('var(--')) {
+		return;
+	}
 
 	context.report({
 		node: property,
@@ -44,7 +47,7 @@ const isCompiledAPI = (importDeclaration: ImportDeclaration, callExpression: Cal
 	}
 
 	return importDeclaration.specifiers.some(
-		(specifier) => specifier.type === 'ImportSpecifier' && specifier.imported.name === functionName,
+		(specifier) => specifier.type === 'ImportSpecifier' && specifier.local.name === functionName,
 	);
 };
 
@@ -74,21 +77,12 @@ export const expandBorderShorthand: Rule.RuleModule = {
 				if (importDeclaration) {
 					if (isCompiledAPI(importDeclaration, callExpression)) {
 						if (node.value.type === 'Literal' && node.value.value !== null) {
-							if (typeof node.value.value === 'string') {
-								const borderString = node.value.value;
-								separateBorderProperties(borderString, node, context);
-							} else if (node.value.raw) {
-								const borderString = node.value.raw;
+							const borderString =
+								typeof node.value.value === 'string' ? node.value.value : node.value.raw;
+							if (borderString) {
 								separateBorderProperties(borderString, node, context);
 							}
 						} else if (node.value.type === 'TemplateLiteral') {
-							if (node.value.quasis.length > 1 || node.value.expressions.length > 0) {
-								context.report({
-									node,
-									messageId: 'expandBorderShorthand',
-								});
-								return;
-							}
 							if (node.value.quasis.length === 1 && node.value.quasis[0].value.cooked) {
 								const borderQuasis: string = node.value.quasis[0].value.cooked;
 								separateBorderProperties(borderQuasis, node, context);

package/src/rules/feature-gating/inline-usage/index.tsx

@@ -27,7 +27,7 @@ const validateCallExpression = (
 	const shouldWarn =
 		callee.type === 'Identifier' &&
 		targetedFunctionsSwitch.has(callee.name) &&
-		isAPIimport(callee.name, context);
+		isAPIimport(callee.name, context, node);
 
 	if (shouldWarn) {
 		const defDeclaration = findDefinitionDeclaration(node.parent);

package/src/rules/feature-gating/no-alias/index.tsx

@@ -59,7 +59,12 @@ const rule: Rule.RuleModule = {
 						return;
 					}
 
-					const isReassignment = isIdentifierImportedFrom(node.init.name, IMPORT_SOURCES, context);
+					const isReassignment = isIdentifierImportedFrom(
+						node.init.name,
+						IMPORT_SOURCES,
+						context,
+						node,
+					);
 
 					if (isReassignment) {
 						context.report({

package/src/rules/feature-gating/no-module-level-eval/index.tsx

@@ -1,8 +1,10 @@
 import type { Rule } from 'eslint';
-import { isAPIimport, type Node } from '../utils';
+import type { Node } from 'estree';
+import { isAPIimport } from '../utils';
+import { getScope } from '../../util/context-compat';
 
-const isInFunctionLevel = (context: Rule.RuleContext) => {
-	let scope: any = context.getScope();
+const isInFunctionLevel = (context: Rule.RuleContext, node: Node) => {
+	let scope: any = getScope(context, node);
 
 	while (scope?.type !== 'module' && scope?.type !== 'global') {
 		if (scope.type === 'function') {
@@ -32,12 +34,12 @@ const rule: Rule.RuleModule = {
 	},
 	create(context) {
 		return {
-			'CallExpression[callee.type="Identifier"]': (node: Node<any>) => {
+			'CallExpression[callee.type="Identifier"]': (node: Node) => {
 				if (
 					node.type === 'CallExpression' &&
 					node.callee.type === 'Identifier' &&
-					isAPIimport(node.callee.name, context) &&
-					!isInFunctionLevel(context)
+					isAPIimport(node.callee.name, context, node) &&
+					!isInFunctionLevel(context, node)
 				) {
 					context.report({
 						messageId: 'noModuleLevelEval',

package/src/rules/feature-gating/no-module-level-eval-nav4/index.tsx

@@ -1,5 +1,6 @@
 import type { Rule } from 'eslint';
-import { type Node } from '../utils';
+import type { Node } from 'estree';
+import { getScope } from '../../util/context-compat';
 
 const featureLibraryFunctions = new Set([
 	/*
@@ -21,8 +22,8 @@ const featureLibraryFunctions = new Set([
 	'getWillShowNav4UserOptOut',
 ]);
 
-const isInFunctionLevel = (context: Rule.RuleContext) => {
-	let scope: any = context.getScope();
+const isInFunctionLevel = (context: Rule.RuleContext, node: Node) => {
+	let scope: any = getScope(context, node);
 
 	while (scope?.type !== 'module' && scope?.type !== 'global') {
 		if (scope.type === 'function') {
@@ -52,12 +53,12 @@ const rule: Rule.RuleModule = {
 	},
 	create(context) {
 		return {
-			'CallExpression[callee.type="Identifier"]': (node: Node<any>) => {
+			'CallExpression[callee.type="Identifier"]': (node: Node) => {
 				if (
 					node.type === 'CallExpression' &&
 					node.callee.type === 'Identifier' &&
 					featureLibraryFunctions.has(node.callee.name) &&
-					!isInFunctionLevel(context)
+					!isInFunctionLevel(context, node)
 				) {
 					context.report({
 						messageId: 'noModuleLevelEval',

package/src/rules/feature-gating/no-preconditioning/index.tsx

@@ -24,7 +24,7 @@ const getGateType = (node: Rule.Node, context: Rule.RuleContext): string => {
 			callee.type === 'Identifier' &&
 			// Experiments cannot have other experiments as preconditions, only gates
 			(callee.name === 'fg' || isExpUsage(callee.name)) &&
-			isAPIimport(callee.name, context);
+			isAPIimport(callee.name, context, node);
 
 		return isFeatureGate ? callee.name : '';
 	}

package/src/rules/feature-gating/prefer-fg/index.tsx

@@ -1,7 +1,9 @@
 import type { Rule } from 'eslint';
 
 import { FEATURE_API_IMPORT_SOURCES } from '../../constants';
-import { type Node } from '../utils';
+import type { Node } from '../utils';
+import type { Program } from 'estree';
+import { getScope } from '../../util/context-compat';
 
 const validateUsage = (
 	node: Node<'CallExpression'>,
@@ -9,9 +11,9 @@ const validateUsage = (
 	context: Rule.RuleContext,
 	changeMap: Map<any, any>,
 ) => {
-	const resolved = context
-		.getScope()
-		.references.find((ref) => ref.identifier.name === utilName)?.resolved;
+	const resolved = getScope(context, node).references.find(
+		(ref) => ref.identifier.name === utilName,
+	)?.resolved;
 
 	const importSpecifierDefinition = resolved?.defs.find(
 		(def: any) =>
@@ -69,10 +71,10 @@ const rule: Rule.RuleModule = {
 				changeMap = changeMap || new Map();
 				validateUsage(node, 'getBooleanFF', context, changeMap);
 			},
-			'Program:exit': () => {
+			'Program:exit': (node: Program) => {
 				if (changeMap?.size) {
 					changeMap.forEach((changeCounts, importDeclaration) => {
-						const [moduleScope] = context.getScope().childScopes;
+						const [moduleScope] = getScope(context, node).childScopes;
 						const importSpecifiers = new Set(
 							importDeclaration.specifiers.map(({ imported }: any) => imported.name),
 						);

package/src/rules/feature-gating/static-feature-flags/index.tsx

@@ -70,14 +70,14 @@ const rule: Rule.RuleModule = {
 				if (
 					node.callee.type === 'Identifier' &&
 					(!targetedFunctionsSwitch.has(node.callee.name) ||
-						!isIdentifierImportedFrom(node.callee.name, IMPORT_SOURCES, context))
+						!isIdentifierImportedFrom(node.callee.name, IMPORT_SOURCES, context, node))
 				) {
 					return;
 				}
 
 				const nameArgument = node.arguments[0];
 				if (nameArgument.type === 'Identifier') {
-					const def = getDef(nameArgument.name, context);
+					const def = getDef(nameArgument.name, context, node);
 					if (def != null && def.type === 'Variable') {
 						const { value } = def.node.init as any;
 

package/src/rules/feature-gating/use-recommended-utils/index.tsx

@@ -24,7 +24,7 @@ const rule: Rule.RuleModule = {
 			) => {
 				if (
 					node.object.type === 'Identifier' &&
-					isIdentifierImportedFrom(node.object.name, BANNED_IMPORTS_SET, context)
+					isIdentifierImportedFrom(node.object.name, BANNED_IMPORTS_SET, context, node)
 				) {
 					context.report({
 						messageId: 'useRecommended',
@@ -42,7 +42,7 @@ const rule: Rule.RuleModule = {
 			) => {
 				if (
 					node.object.type === 'Identifier' &&
-					isIdentifierImportedFrom(node.object.name, BANNED_IMPORTS_SET, context)
+					isIdentifierImportedFrom(node.object.name, BANNED_IMPORTS_SET, context, node)
 				) {
 					context.report({
 						messageId: 'notSupported',

package/src/rules/feature-gating/utils.tsx

@@ -1,15 +1,17 @@
 import { FEATURE_API_IMPORT_SOURCES } from '../constants';
 import type { Rule, Scope } from 'eslint';
+import type { Node as EstreeNode } from 'estree';
+import { getScope } from '../util/context-compat';
 
 export function isIdentifierImportedFrom(
 	identifierName: string,
 	sources: Set<string>,
 	context: Rule.RuleContext,
+	node: EstreeNode,
 ) {
 	if (sources.size > 0) {
 		return (
-			context
-				.getScope()
+			getScope(context, node)
 				.references.find((ref) => ref.identifier.name === identifierName)
 				?.resolved?.defs.some(
 					(def) =>
@@ -21,13 +23,13 @@ export function isIdentifierImportedFrom(
 	return false;
 }
 
-export function isAPIimport(functionName: string, context: Rule.RuleContext) {
-	return isIdentifierImportedFrom(functionName, FEATURE_API_IMPORT_SOURCES, context);
+export function isAPIimport(functionName: string, context: Rule.RuleContext, node: EstreeNode) {
+	return isIdentifierImportedFrom(functionName, FEATURE_API_IMPORT_SOURCES, context, node);
 }
 
 // returns the definition node of a variable if it's declared within the scope of the file
-export function getDef(name: string, context: Rule.RuleContext) {
-	let scope: Scope.Scope | null = context.getScope();
+export function getDef(name: string, context: Rule.RuleContext, node: EstreeNode) {
+	let scope: Scope.Scope | null = getScope(context, node);
 
 	while (scope && scope.type !== 'global') {
 		for (const variable of scope.variables) {

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

@@ -0,0 +1,28 @@
+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
+ */
+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.
+ * @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();
+};

package/tsconfig.app.json

@@ -33,6 +33,9 @@
 		"outDir": "../../../tsDist/@atlaskit__eslint-plugin-platform/app"
 	},
 	"references": [
+		{
+			"path": "../../design-system/eslint-utils/tsconfig.app.json"
+		},
 		{
 			"path": "../../monorepo-tooling/ts-loader/tsconfig.app.json"
 		}