@atlaskit/eslint-plugin-platform 2.6.0 → 2.7.1

package/src/rules/ensure-no-private-dependencies/index.ts

@@ -1,64 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import type { Rule } from 'eslint';
-import { getObjectPropertyAsObject, getObjectPropertyAsLiteral } from '../util/handle-ast-object';
-import { getPackagesSync } from '@manypkg/get-packages';
-import { findRootSync } from '@manypkg/find-root';
-
-const root = findRootSync(process.cwd());
-const pkgs = getPackagesSync(root).packages;
-const pkgMap = new Map(pkgs.map((pkg) => [pkg.packageJson.name, pkg]));
-
-const rule: Rule.RuleModule = {
-	meta: {
-		type: 'problem',
-		docs: {
-			description: `Ensures that private dependencies are not used in published packages.`,
-			recommended: true,
-		},
-		hasSuggestions: false,
-		messages: {
-			invalidPrivateDependency: `Published package has private dependency '{{ pkgName }}'. To resolve this error, remove the private dependency or set this package to private.`,
-		},
-	},
-	create(context) {
-		return {
-			ObjectExpression: async (node: Rule.Node) => {
-				// Only run this rule on package.json files
-				if (!context.filename.endsWith('package.json') || node.type !== 'ObjectExpression') {
-					return;
-				}
-
-				// Private dependencies can be used in private packages
-				const isPrivatePkg = getObjectPropertyAsLiteral(node, 'private') === true;
-				if (isPrivatePkg === true) {
-					return;
-				}
-
-				// Check for private dependencies in dependencies and peerDependencies
-				// Note: devDependencies are not checked here as they don't end up in consumer lockfiles
-				const dependencies = getObjectPropertyAsObject(node, 'dependencies');
-				const peerDependencies = getObjectPropertyAsObject(node, 'peerDependencies');
-
-				for (const obj of [dependencies, peerDependencies]) {
-					for (const p of obj?.properties || []) {
-						if (p.type === 'Property' && p.key.type === 'Literal') {
-							const key = p.key.value;
-							if (typeof key === 'string' && pkgMap.has(key)) {
-								const isPrivateDependency = pkgMap.get(key)?.packageJson.private === true;
-								if (isPrivateDependency) {
-									context.report({
-										node,
-										messageId: 'invalidPrivateDependency',
-										data: { pkgName: key },
-									});
-								}
-							}
-						}
-					}
-				}
-			},
-		};
-	},
-};
-
-export default rule;

package/src/rules/ensure-publish-valid/__tests__/unit/rule.test.ts

@@ -1,39 +0,0 @@
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../../index';
-
-describe('test ensure-publish-valid-rule', () => {
-	tester.run('ensure-publish-valid', rule, {
-		valid: [
-			{
-				code: `const foo = { "name": "@af/test" }`,
-				filename: 'package.json',
-			},
-			{
-				options: [{ exceptions: ['@atlaskit/test'] }],
-				code: `const foo = { "name": "@atlaskit/test" }`,
-				filename: 'package.json',
-			},
-			{
-				code: `const foo = { "name": "@atlaskit/test", "private": false, "publishConfig": { "registry": "https://registry.npmjs.org/" } }`,
-				filename: 'foo/package.json',
-			},
-		],
-		invalid: [
-			{
-				code: `const foo = { "name": "@atlaskit/test" }`,
-				filename: 'foo/package.json',
-				errors: [
-					{
-						messageId: 'publishConfigRequired',
-						data: { packageName: '@atlaskit/test' },
-					},
-				],
-			},
-			{
-				code: `const foo = { "name": "@atlaskit/test", "private": true, "publishConfig": { "registry": "https://registry.npmjs.org/" } }`,
-				filename: 'foo/package.json',
-				errors: [{ messageId: 'noPrivate', data: { packageName: '@atlaskit/test' } }],
-			},
-		],
-	});
-});

package/src/rules/ensure-publish-valid/index.ts

@@ -1,81 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import type { Rule } from 'eslint';
-import { getObjectPropertyAsLiteral, getObjectPropertyAsObject } from '../util/handle-ast-object';
-
-type RuleOptions = {
-	// exceptions to this rule, will be ignored
-	exceptions?: string[];
-};
-
-const rule: Rule.RuleModule = {
-	meta: {
-		type: 'problem',
-		docs: {
-			description:
-				'This rule ensures that the package.json for your packages are set up correctly for publishing depending on the package name prefix',
-			recommended: true,
-		},
-		hasSuggestions: false,
-		schema: [
-			{
-				type: 'object',
-				properties: {
-					exceptions: {
-						type: 'array',
-						items: [{ type: 'string' }],
-					},
-				},
-			},
-		],
-		messages: {
-			publishConfigRequired:
-				'@atlaskit prefix is public! You have to specify a `publishConfig`, (package {{packageName}}) see https://go.atlassian.com/package-namespace',
-			noPrivate:
-				'setting private to true prevents publishing, your package prefix implies you want to publish! (package {{packageName}}) see https://go.atlassian.com/package-namespace',
-		},
-	},
-	create(context) {
-		const { exceptions } = (context.options?.[0] as RuleOptions) ?? {};
-
-		return {
-			ObjectExpression: (node: Rule.Node) => {
-				if (!context.getFilename().endsWith('package.json') || node.type !== 'ObjectExpression') {
-					return;
-				}
-
-				const packageName = getObjectPropertyAsLiteral(node, 'name');
-				const packagePrivate = getObjectPropertyAsLiteral(node, 'private');
-				const packagePublishConfig = getObjectPropertyAsObject(node, 'publishConfig');
-
-				// exit if package is on known exception list
-				if (exceptions && exceptions.findIndex((name) => name === packageName) !== -1) {
-					return;
-				}
-
-				if (typeof packageName === 'string' && packageName.startsWith('@atlaskit')) {
-					if (typeof packagePrivate === 'boolean' && packagePrivate) {
-						return context.report({
-							node,
-							messageId: 'noPrivate',
-							data: {
-								packageName,
-							},
-						});
-					}
-
-					if (packagePublishConfig === null) {
-						return context.report({
-							node,
-							messageId: 'publishConfigRequired',
-							data: {
-								packageName,
-							},
-						});
-					}
-				}
-			},
-		};
-	},
-};
-
-export default rule;

package/src/rules/ensure-test-runner-arguments/__tests__/unit/rule.test.tsx

@@ -1,298 +0,0 @@
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../../index';
-
-describe('Feature Flag can only be passed into ffTest as Literal', () => {
-	tester.run('ensure-test-runner-arguments', rule, {
-		valid: [
-			{
-				code: `ffTest('sample.feature.flag', () => {
-          const { getByText } = render(<SampleComponent />);
-          expect(getByText('SampleComponent')).toBeDefined();
-        });`,
-			},
-		],
-		invalid: [
-			{
-				code: `ffTest(myFeatureFlag, () => {
-          const { getByText } = render(<SampleComponent />);
-          expect(getByText('SampleComponent')).toBeDefined();
-        });`,
-				errors: [
-					{
-						messageId: 'onlyInlineFeatureFlag',
-						data: { identifierName: 'myFeatureFlag' },
-					},
-				],
-			},
-		],
-	});
-});
-
-describe('Test functions can only be passed in directly, instead of as variables', () => {
-	tester.run('ensure-test-runner-arguments', rule, {
-		valid: [
-			{
-				code: `ffTest('sample.feature.flag', () => {
-          const { getByText } = render(<SampleComponent />);
-          expect(getByText('SampleComponent')).toBeDefined();
-        });`,
-			},
-			{
-				code: `ffTest('sample.feature.flag', () => {
-          const { getByText } = render(<SampleComponent />);
-          expect(getByText('SampleComponent')).toBeDefined();
-        }, () => {
-          const { getByText } = render(<SampleComponent />);
-          expect(getByText('AnotherSampleComponent')).toBeDefined();
-        });`,
-			},
-		],
-		invalid: [
-			{
-				code: `ffTest('sample.feature.flag', fnToPassIn);`,
-				errors: [
-					{
-						messageId: 'onlyInlineTestFunction',
-						data: { identifierName: 'fnToPassIn' },
-					},
-				],
-			},
-			{
-				code: `ffTest('sample.feature.flag', () => {
-          const { getByText } = render(<SampleComponent />);
-          expect(getByText('SampleComponent')).toBeDefined();
-        }, fnToPassInWhenFlagIsDisabled);`,
-				errors: [
-					{
-						messageId: 'onlyInlineTestFunction',
-						data: { identifierName: 'fnToPassInWhenFlagIsDisabled' },
-					},
-				],
-			},
-			{
-				code: `ffTest('sample.feature.flag', fnToPassInWhenFlagIsEnabled, () => {
-          const { getByText } = render(<SampleComponent />);
-          expect(getByText('SampleComponent')).toBeDefined();
-        },);`,
-				errors: [
-					{
-						messageId: 'onlyInlineTestFunction',
-						data: { identifierName: 'fnToPassInWhenFlagIsEnabled' },
-					},
-				],
-			},
-		],
-	});
-});
-
-describe('Verify existing ff overrides are passed down if test runner is nested', () => {
-	tester.run('ensure-test-runner-arguments', rule, {
-		valid: [
-			{
-				code: `ffTest(
-          'uip.sample.color',
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              ff,
-            ),
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              ff,
-            ),
-        );
-        `,
-			},
-		],
-		invalid: [
-			{
-				code: `ffTest(
-          'uip.sample.color',
-          () =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              ff,
-            ),
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              ff,
-            ),
-        );
-        `,
-				output: `ffTest(
-          'uip.sample.color',
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              ff,
-            ),
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              ff,
-            ),
-        );
-        `,
-				errors: [
-					{
-						messageId: 'passDownExistingFeatureFlagParam',
-					},
-				],
-			},
-			{
-				code: `ffTest(
-          'uip.sample.color',
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-            ),
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              ff,
-            ),
-        );
-        `,
-				output: `ffTest(
-          'uip.sample.color',
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              }, ff,
-            ),
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              ff,
-            ),
-        );
-        `,
-				errors: [
-					{
-						messageId: 'passDownExistingFeatureFlagArgument',
-					},
-				],
-			},
-			{
-				code: `ffTest(
-          'uip.sample.color',
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              ff,
-            ),
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              ffExisting,
-            ),
-        );
-        `,
-				output: `ffTest(
-          'uip.sample.color',
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: red');
-              },
-              ff,
-            ),
-          ff =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              () => {
-                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
-              },
-              ff,
-            ),
-        );
-        `,
-				errors: [
-					{
-						messageId: 'passDownExistingFeatureFlagNamesMatch',
-					},
-				],
-			},
-		],
-	});
-});

package/src/rules/ensure-test-runner-arguments/index.tsx

@@ -1,121 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import type { Rule } from 'eslint';
-
-const TEST_RUNNER_IDENTIFIER = 'ffTest' as const;
-
-const rule: Rule.RuleModule = {
-	meta: {
-		docs: {
-			recommended: false,
-		},
-		type: 'problem',
-		fixable: 'code',
-		messages: {
-			onlyInlineFeatureFlag:
-				'Only pass in feature flag as string literal, please replace {{identifierName}} with its value.',
-			onlyInlineTestFunction:
-				'Only pass in test functions/cases in an inline manner. Test functions/cases should be passed in directly, instead of as variables. Please replace {{identifierName}} with its own definition.',
-			passDownExistingFeatureFlagParam:
-				'An argument symbolising existing FFs needs to be passed down as param when calling nested test runner. See examples in the package which declares this function.',
-			passDownExistingFeatureFlagArgument:
-				'An argument symbolising existing FFs needs to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
-			passDownExistingFeatureFlagNamesMatch:
-				'Argument names not matching when passing down existing feature flags. See examples in the package which declares this function.',
-		},
-	},
-	create(context) {
-		return {
-			[`CallExpression[callee.name=/${TEST_RUNNER_IDENTIFIER}/]`]: (node: Rule.Node) => {
-				if (node.type === 'CallExpression') {
-					const args = node.arguments;
-
-					// Verify FF is passed inline
-					if (args[0] && args[0].type !== 'Literal') {
-						return context.report({
-							node,
-							messageId: 'onlyInlineFeatureFlag',
-							data: {
-								identifierName: args[0].type === 'Identifier' ? args[0].name : '',
-							},
-						});
-					}
-
-					// Verify test functions/cases are passed inline
-					if (args[1] && args[1].type !== 'ArrowFunctionExpression') {
-						return context.report({
-							node,
-							messageId: 'onlyInlineTestFunction',
-							data: {
-								identifierName: args[1].type === 'Identifier' ? args[1].name : '',
-							},
-						});
-					}
-
-					if (args[2] && args[2].type !== 'ArrowFunctionExpression') {
-						return context.report({
-							node,
-							messageId: 'onlyInlineTestFunction',
-							data: {
-								identifierName: args[2].type === 'Identifier' ? args[2].name : '',
-							},
-						});
-					}
-
-					// Verify existing ff overrides are passed down if test runner is nested
-					let upperTestRunner = node.parent?.parent;
-					if (
-						upperTestRunner?.type === 'CallExpression' &&
-						upperTestRunner?.callee.type === 'Identifier' &&
-						upperTestRunner?.callee.name === TEST_RUNNER_IDENTIFIER &&
-						node.parent?.type === 'ArrowFunctionExpression'
-					) {
-						// Not pass in ff to the function that calls test runner
-						if (!node.parent.params[0] || node.parent.params[0].type !== 'Identifier') {
-							return context.report({
-								node: node.parent,
-								messageId: 'passDownExistingFeatureFlagParam',
-								fix: function (fixer) {
-									const parentNodeRange = node.parent.range as [number, number];
-									return [
-										fixer.replaceTextRange([parentNodeRange[0], parentNodeRange[0] + 2], 'ff'),
-										node.arguments[3]
-											? fixer.replaceText(node.arguments[3], 'ff')
-											: fixer.insertTextAfter(node.arguments[2], ', ff'),
-									];
-								},
-							});
-						}
-
-						// Not pass in ff to test runner as 4th argument
-						const paramName = node.parent.params[0].name;
-						if (!node.arguments[3] || node.arguments[3].type !== 'Identifier') {
-							return context.report({
-								node,
-								messageId: 'passDownExistingFeatureFlagArgument',
-								fix: function (fixer) {
-									return node.arguments[3]
-										? fixer.replaceText(node.arguments[3], paramName)
-										: fixer.insertTextAfter(node.arguments[2], `, ${paramName}`);
-								},
-							});
-						}
-						// Pass in the above two, but names don't match
-						const arguName = node.arguments[3].name;
-						if (paramName !== arguName) {
-							return context.report({
-								node: node.parent,
-								messageId: 'passDownExistingFeatureFlagNamesMatch',
-								fix: function (fixer) {
-									return fixer.replaceText(node.arguments[3], paramName);
-								},
-							});
-						}
-					}
-				}
-				return {};
-			},
-		};
-	},
-};
-
-export default rule;