@atlaskit/eslint-plugin-platform 2.7.0 → 2.7.1

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

@@ -1,103 +0,0 @@
-import type { Rule } from 'eslint';
-import { FEATURE_API_IMPORT_SOURCES } from '../../constants';
-import { getDef, isIdentifierImportedFrom, type Node } from '../utils';
-
-const IMPORT_SOURCES = new Set([
-	...FEATURE_API_IMPORT_SOURCES,
-	'@atlassian/jira-feature-flagging-utils',
-	'@atlassian/jira-feature-gate-component',
-	'@atlassian/jira-feature-gates-test-mocks',
-	'@atlassian/jira-feature-gates-storybook-mocks',
-]);
-
-// Any functions not in this list should be skipped for performance.
-const FUNCTION_NAMES = new Set([
-	'ff',
-	'fg',
-	'getFeatureFlagValue',
-	'getMultivariateFeatureFlag',
-	'componentWithFF',
-	'componentWithFG',
-	'passGate',
-	'withGate',
-	'expVal',
-	'expValEquals',
-	'UNSAFE_noExposureExp',
-	'mockExp',
-	'withExp',
-	'wasExperimentManuallyExposed',
-]);
-
-const STATSIG_ONLY_FUNCTION_NAMES = new Set([
-	'fg',
-	'componentWithFG',
-	'passGate',
-	'withGate',
-	'expVal',
-	'expValEquals',
-	'UNSAFE_noExposureExp',
-	'mockExp',
-	'withExp',
-	'wasExperimentManuallyExposed',
-]);
-
-const rule: Rule.RuleModule = {
-	meta: {
-		type: 'problem',
-		docs: {
-			url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/static-feature-flags/README.md',
-			description: 'Ensure feature flags or gates are static string literals',
-		},
-		fixable: 'code',
-		messages: {
-			FFLiteral:
-				'Use static string literal for `featureFlagName`. See https://team.atlassian.com/project/ATLAS-46997/about',
-		},
-	},
-	create(context) {
-		const targetedFunctionsSwitch =
-			context.options[0] === 'ssOnly' ? STATSIG_ONLY_FUNCTION_NAMES : FUNCTION_NAMES;
-
-		return {
-			// When they're not literals, show a message
-			'CallExpression[callee.type="Identifier"][arguments.length>0][arguments.0.type!="Literal"]': (
-				node: Node<any>,
-			) => {
-				if (node.type !== 'CallExpression') {
-					return;
-				}
-
-				if (
-					node.callee.type === 'Identifier' &&
-					(!targetedFunctionsSwitch.has(node.callee.name) ||
-						!isIdentifierImportedFrom(node.callee.name, IMPORT_SOURCES, context, node))
-				) {
-					return;
-				}
-
-				const nameArgument = node.arguments[0];
-				if (nameArgument.type === 'Identifier') {
-					const def = getDef(nameArgument.name, context, node);
-					if (def != null && def.type === 'Variable') {
-						const { value } = def.node.init as any;
-
-						context.report({
-							node: nameArgument,
-							messageId: 'FFLiteral',
-							fix: (fixer) => fixer.replaceText(nameArgument, `'${value}'`),
-						});
-
-						return;
-					}
-				}
-
-				context.report({
-					node: nameArgument,
-					messageId: 'FFLiteral',
-				});
-			},
-		};
-	},
-};
-
-export default rule;

package/src/rules/feature-gating/use-recommended-utils/README.md

@@ -1,67 +0,0 @@
-# Use `fg` instead of `FeatureGates.checkGate` (feature-flags/use-recommended-utils)
-
-`fg` method is recommended over `FeatureGates.checkGate`. The former is a wrapper to
-`FeatureGates.checkGate` with unit testing mocking capabilities.
-
-## Examples
-
-### Feature Gates
-
-👎 Examples of **incorrect** code for this rule: Gate is accessed with `FeatureGates.checkGate`
-
-```tsx
-import FeatureGates from '@atlaskit/feature-gate-js-client';
-
-export const getThing = () => {
-	if (FeatureGates.checkGate('my_gate')) {
-		return getNewThing();
-	}
-
-	return getOldThing();
-};
-```
-
-👍 Examples of **correct** code for this rule: Gate is accessed with `fg`
-
-```tsx
-import { fg } from '@atlassian/jira-feature-gating';
-
-export const getThing = () => {
-	if (fg('my_gate')) {
-		return getNewThing();
-	}
-
-	return getOldThing();
-};
-```
-
-### Experiments
-
-👎 Examples of **incorrect** code for this rule: experiment is accessed with
-`FeatureGates.getExperimentValue`
-
-```tsx
-import FeatureGates from '@atlaskit/feature-gate-js-client';
-
-export const getThing = () => {
-	if (FeatureGates.getExperimentValue('my_experiment', 'is_enabled', false)) {
-		return newThing();
-	}
-
-	return oldThing();
-};
-```
-
-👍 Examples of **correct** code for this rule: experiment is accessed with `expVal`
-
-```tsx
-import { expVal } from '@atlassian/jira-feature-experiments';
-
-export const getThing = () => {
-	if (expVal('my_experiment', 'is_enabled', false)) {
-		return newThing();
-	}
-
-	return oldThing();
-};
-```

package/src/rules/feature-gating/use-recommended-utils/__tests__/rule.test.tsx

@@ -1,78 +0,0 @@
-import outdent from 'outdent';
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../index';
-
-tester.run('feature-flags/use-recommended-utils', rule, {
-	valid: [
-		{
-			name: 'Other `FeatureGate` methods are allowed',
-			code: outdent`
-                import FeatureGates from '@atlaskit/feature-gate-js-client';
-
-                FeatureGates.initialize();
-            `,
-		},
-		{
-			name: 'Use `fg` to access gates',
-			code: outdent`
-                import { fg } from '@atlassian/jira-feature-gating';
-
-                export const Component = () => {
-                    return fg('my_gate') ? <HelloWorld /> : null;
-                };
-            `,
-		},
-		{
-			name: 'Use `expVal` to access experiments',
-			code: outdent`
-            import { expVal } from '@atlassian/jira-feature-experiments';
-
-            export const getThing = () => {
-                if (expVal('my_experiment', 'is_enabled', false)) {
-                    return newThing();
-                }
-
-                return oldThing();
-            };
-            `,
-		},
-	],
-	invalid: [
-		{
-			name: '`checkGate` is not allowed',
-			code: outdent`
-                import FeatureGates from '@atlaskit/feature-gate-js-client';
-
-                export const Component = () => {
-                    return FeatureGates.checkGate('my_gate') ? <HelloWorld /> : null;
-                };
-            `,
-			errors: [
-				{
-					message:
-						'Please do not use FeatureGates.checkGate, use `fg` from `@atlaskit/platform-feature-flags` instead.',
-				},
-			],
-		},
-		{
-			name: '`getExperimentValue` is not allowed',
-			code: outdent`
-                import FeatureGates from '@atlaskit/feature-gate-js-client';
-
-                export const getThing = () => {
-                    if (FeatureGates.getExperimentValue('my_experiment', 'is_enabled', false)) {
-                        return newThing();
-                    }
-
-                    return oldThing();
-                };
-            `,
-			errors: [
-				{
-					message:
-						'Experimentation is not suported in platform feature flags, reach out to #help-statsig-switcheroo.',
-				},
-			],
-		},
-	],
-});

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

@@ -1,57 +0,0 @@
-import type { Rule } from 'eslint';
-import { isIdentifierImportedFrom, type Node } from '../utils';
-
-const BANNED_IMPORTS_SET = new Set(['@atlaskit/feature-gate-js-client']);
-
-const rule: Rule.RuleModule = {
-	meta: {
-		docs: {
-			url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/use-recommended-utils/README.md',
-			description: 'Prefer using the feature flag abstraction over direct statsig library.',
-		},
-		messages: {
-			notSupported:
-				'Experimentation is not suported in platform feature flags, reach out to #help-statsig-switcheroo.',
-			useRecommended:
-				'Please do not use FeatureGates.{{util}}, use {{recommended}} from {{lib}} instead.',
-		},
-		type: 'problem',
-	},
-	create(context) {
-		return {
-			'CallExpression > MemberExpression:matches([property.name="checkGate"])': (
-				node: Node<'MemberExpression'>,
-			) => {
-				if (
-					node.object.type === 'Identifier' &&
-					isIdentifierImportedFrom(node.object.name, BANNED_IMPORTS_SET, context, node)
-				) {
-					context.report({
-						messageId: 'useRecommended',
-						node,
-						data: {
-							lib: '`@atlaskit/platform-feature-flags`',
-							util: (node.property as any).name,
-							recommended: '`fg`',
-						},
-					});
-				}
-			},
-			'CallExpression > MemberExpression:matches([property.name="getExperimentValue"])': (
-				node: Node<'MemberExpression'>,
-			) => {
-				if (
-					node.object.type === 'Identifier' &&
-					isIdentifierImportedFrom(node.object.name, BANNED_IMPORTS_SET, context, node)
-				) {
-					context.report({
-						messageId: 'notSupported',
-						node,
-					});
-				}
-			},
-		};
-	},
-};
-
-export default rule;

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

@@ -1,48 +0,0 @@
-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 (
-			getScope(context, node)
-				.references.find((ref) => ref.identifier.name === identifierName)
-				?.resolved?.defs.some(
-					(def) =>
-						def.parent?.type === 'ImportDeclaration' && sources.has(def.parent.source.value + ''),
-				) ?? false
-		);
-	}
-
-	return false;
-}
-
-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, node: EstreeNode) {
-	let scope: Scope.Scope | null = getScope(context, node);
-
-	while (scope && scope.type !== 'global') {
-		for (const variable of scope.variables) {
-			if (variable.name === name) {
-				const definition = variable.defs.find(
-					(def) => def.node && def.node.type === 'VariableDeclarator',
-				);
-				return definition;
-			}
-		}
-		scope = scope.upper;
-	}
-	return null;
-}
-
-export type Node<T extends Rule.Node['type']> = Extract<Rule.Node, { type: T }>;

package/src/rules/no-direct-document-usage/index.tsx

@@ -1,111 +0,0 @@
-import type { Rule } from 'eslint';
-import { skipForExampleFiles, skipForTestFiles } from '../util/file-exclusions';
-
-const rule: Rule.RuleModule = {
-	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.type === 'Identifier' &&
-							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?.type === 'Property' && parent.key === node) {
-						return;
-					}
-
-					// Skip if 'document' is used as a shorthand property value
-					if (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?.type === 'MemberExpression' && parent.property === node && !parent.computed) {
-						return;
-					}
-
-					// Skip if 'document' is being declared as a variable
-					if (parent?.type === 'VariableDeclarator' && parent.id === node) {
-						return;
-					}
-
-					// Skip if 'document' is a function name
-					if (parent?.type === 'FunctionDeclaration' && 'id' in parent && parent.id === node) {
-						return;
-					}
-
-					if (parent?.type === 'FunctionExpression' && 'id' in parent && parent.id === node) {
-						return;
-					}
-
-					// Skip if 'document' is a method name in a class or object
-					if (parent?.type === 'MethodDefinition' && parent.key === node) {
-						return;
-					}
-
-					// Skip if 'document' is being assigned to (shadowing the global)
-					if (parent?.type === 'AssignmentExpression' && parent.left === node) {
-						return;
-					}
-
-					// Skip if 'document' is in a destructuring pattern (could be destructuring from an object)
-					if (parent?.type === 'ObjectPattern' || parent?.type === 'ArrayPattern') {
-						return;
-					}
-
-					context.report({
-						node,
-						messageId: 'useGetDocument',
-					});
-				}
-			},
-		};
-	},
-};
-
-export default rule;

package/src/rules/no-duplicate-dependencies/__tests__/unit/rule.test.ts

@@ -1,116 +0,0 @@
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../../index';
-
-describe('test no-duplicate-dependencies rule', () => {
-	tester.run('no-duplicate-dependencies-rule', rule, {
-		valid: [
-			{
-				code: `
-          module.exports = {
-            "dependencies": {
-              "foo": "^1.0.0",
-              "bar": "^2.0.0"
-            }
-          };
-        `,
-				filename: 'dependencies.json',
-			},
-			{
-				code: `
-          module.exports = {
-            "devDependencies": {
-              "foo": "^1.0.0",
-              "bar": "^2.0.0"
-            }
-          };
-        `,
-				filename: 'devDependencies.json',
-			},
-			{
-				code: `
-          module.exports = {
-            "dependencies": {
-              "foo": "^1.0.0",
-              "bar": "^2.0.0"
-            },
-            "devDependencies": {
-              "baz": "^3.0.0",
-              "qux": "^4.0.0"
-            }
-          };
-        `,
-				filename: 'devAndDependencies.json',
-			},
-		],
-		invalid: [
-			{
-				code: `
-          module.exports = {
-            "dependencies": {
-              "foo": "^1.0.0",
-              "bar": "^2.0.0"
-            },
-            "devDependencies": {
-              "foo": "^1.0.0",
-              "baz": "^3.0.0",
-              "qux": "^4.0.0"
-            }
-          };
-        `,
-				output: `
-          module.exports = {
-            "dependencies": {
-              "foo": "^1.0.0",
-              "bar": "^2.0.0"
-            },
-            "devDependencies": {
-              "baz": "^3.0.0",
-              "qux": "^4.0.0"
-            }
-          };
-        `,
-				errors: [
-					{
-						data: {
-							name: 'foo',
-						},
-						messageId: 'unexpectedDuplicateDependency',
-					},
-				],
-				filename: 'duplicateDependenciesFirst.json',
-			},
-			{
-				code: `
-          module.exports = {
-            "dependencies": {
-              "bar": "^1.0.0"
-            },
-            "devDependencies": {
-              "foo": "^2.0.0",
-              "bar": "^1.0.0"
-            }
-          };
-        `,
-				output: `
-          module.exports = {
-            "dependencies": {
-              "bar": "^1.0.0"
-            },
-            "devDependencies": {
-              "foo": "^2.0.0"
-            }
-          };
-        `,
-				errors: [
-					{
-						data: {
-							name: 'bar',
-						},
-						messageId: 'unexpectedDuplicateDependency',
-					},
-				],
-				filename: 'duplicateDependenciesLast.json',
-			},
-		],
-	});
-});

package/src/rules/no-duplicate-dependencies/index.ts

@@ -1,79 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import type { Rule } from 'eslint';
-
-const rule: Rule.RuleModule = {
-	meta: {
-		type: 'problem',
-		docs: {
-			description:
-				'This rule disallows a dependency to be defined in both dependencies and devDependencies',
-			recommended: false,
-		},
-		fixable: 'code',
-		messages: {
-			unexpectedDuplicateDependency: 'Unexpected duplicate dependency {{name}}',
-		},
-	},
-	create(context) {
-		const dependencies = new Map();
-		const devDependencies = new Map();
-
-		return {
-			'ObjectExpression Property[key.value=dependencies] Property': (node: Rule.Node) => {
-				// @ts-expect-error
-				dependencies.set(node.key.value, node.key);
-			},
-			'ObjectExpression Property[key.value=devDependencies] Property': (node: Rule.Node) => {
-				// @ts-expect-error
-				devDependencies.set(node.key.value, node.key);
-			},
-			'Program:exit': () => {
-				for (const [dependency, node] of devDependencies) {
-					if (dependencies.has(dependency)) {
-						context.report({
-							data: {
-								name: dependency,
-							},
-							fix(fixer) {
-								const sourceCode = context.getSourceCode();
-								const property = node.parent;
-								const isLastLine = sourceCode.getTokenAfter(property)?.value === '}';
-								const end = property.loc.end;
-
-								if (!isLastLine) {
-									return fixer.removeRange([
-										sourceCode.getIndexFromLoc({
-											line: property.loc.start.line,
-											column: 0,
-										}),
-										sourceCode.getIndexFromLoc({
-											line: end.line + 1,
-											column: 0,
-										}),
-									]);
-								}
-
-								const previousToken = sourceCode.getTokenBefore(property)!;
-
-								return fixer.removeRange([
-									sourceCode.getIndexFromLoc({
-										line: previousToken.loc.end.line,
-										column: previousToken.loc.end.column - 1,
-									}),
-									sourceCode.getIndexFromLoc({
-										line: end.line,
-										column: end.column,
-									}),
-								]);
-							},
-							messageId: 'unexpectedDuplicateDependency',
-							node,
-						});
-					}
-				}
-			},
-		};
-	},
-};
-
-export default rule;