@atlaskit/eslint-plugin-platform 2.7.0 → 2.7.2

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

@@ -1,308 +0,0 @@
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../../index';
-
-describe('Warning about too many nested test runners', () => {
-	tester.run('ensure-test-runner-nested-count', rule, {
-		valid: [
-			{
-				code: `describe('1 FF', () => {
-          ffTest('uip.sample.color', () => {
-            const { getByText } = render(<SampleComponent />);
-            expect(getByText('SampleComponent')).toBeDefined();
-          });
-        });`,
-			},
-			{
-				code: `describe('2 FFs', () => {
-          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,
-              ),
-          );
-        });`,
-			},
-			{
-				code: `ffTest(
-          'uip.sample.color',
-          (ff) =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {},
-              () => {},
-              ff,
-            ),
-          (ff) =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {},
-              () => {},
-              ff,
-            ),
-        );`,
-			},
-			{
-				code: `ffTest(
-          'uip.sample.color',
-          (ff) =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  () => {},
-                  () => {},
-                  ff,
-                ),
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  () => {},
-                  () => {},
-                  ff,
-                ),
-              ff,
-            ),
-          (ff) =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              () => {},
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  () => {},
-                  () => {},
-                  ff,
-                ),
-              ff,
-            ),
-        );`,
-			},
-			{
-				code: `
-        ffTest(
-          'uip.sample.color',
-          (ff) =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  () => {},
-                  () => {},
-                  ff,
-                ),
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  () => {},
-                  () => {},
-                  ff,
-                ),
-              ff,
-            ),
-          (ff) =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  (ff) =>
-                    ffTest(
-                      'uip.sample.opacity',
-                      () => {},
-                      () => {},
-                      ff,
-                    ),
-                  () => {},
-                  ff,
-                ),
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  () => {},
-                  (ff) =>
-                    ffTest(
-                      'uip.sample.opacity',
-                      () => {},
-                      () => {},
-                      ff,
-                    ),
-                  ff,
-                ),
-              ff,
-            ),
-        );`,
-			},
-		],
-		invalid: [
-			{
-				code: `
-        describe('5 FFs', () => {
-          ffTest(
-            'uip.sample.color',
-            (ff) =>
-              ffTest(
-                'uip.sample.backgroundColor',
-                (ff) =>
-                  ffTest(
-                    'uip.sample.display',
-                    () => {},
-                    () => {},
-                    ff,
-                  ),
-                (ff) =>
-                  ffTest(
-                    'uip.sample.display',
-                    () => {},
-                    () => {},
-                    ff,
-                  ),
-                ff,
-              ),
-            (ff) =>
-              ffTest(
-                'uip.sample.backgroundColor',
-                (ff) =>
-                  ffTest(
-                    'uip.sample.display',
-                    (ff) =>
-                      ffTest(
-                        'uip.sample.opacity',
-                        (ff) =>
-                          ffTest(
-                            'uip.sample.font',
-                            () => {},
-                            () => {},
-                            ff,
-                          ),
-                        () => {},
-                        ff,
-                      ),
-                    () => {},
-                    ff,
-                  ),
-                (ff) =>
-                  ffTest(
-                    'uip.sample.display',
-                    () => {},
-                    (ff) =>
-                      ffTest(
-                        'uip.sample.opacity',
-                        () => {},
-                        () => {},
-                        ff,
-                      ),
-                    ff,
-                  ),
-                ff,
-              ),
-          );
-        });`,
-				errors: [
-					{
-						messageId: 'tooManyNestedTestRunner',
-						data: {
-							nestedTestRunner: 5,
-						},
-					},
-				],
-			},
-			{
-				code: `
-        ffTest(
-          'uip.sample.color',
-          (ff) =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  () => {},
-                  () => {},
-                  ff,
-                ),
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  () => {},
-                  () => {},
-                  ff,
-                ),
-              ff,
-            ),
-          (ff) =>
-            ffTest(
-              'uip.sample.backgroundColor',
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  (ff) =>
-                    ffTest(
-                      'uip.sample.opacity',
-                      (ff) =>
-                        ffTest(
-                          'uip.sample.font',
-                          (ff) =>
-                            ffTest(
-                              'uip.sample.border',
-                              () => {},
-                              () => {},
-                              ff,
-                            ),
-                          () => {},
-                          ff,
-                        ),
-                      () => {},
-                      ff,
-                    ),
-                  () => {},
-                  ff,
-                ),
-              (ff) =>
-                ffTest(
-                  'uip.sample.display',
-                  () => {},
-                  (ff) =>
-                    ffTest(
-                      'uip.sample.opacity',
-                      () => {},
-                      () => {},
-                      ff,
-                    ),
-                  ff,
-                ),
-              ff,
-            ),
-        );`,
-				errors: [
-					{
-						messageId: 'tooManyNestedTestRunner',
-						data: {
-							nestedTestRunner: 6,
-						},
-					},
-				],
-			},
-		],
-	});
-});

package/src/rules/ensure-test-runner-nested-count/index.tsx

@@ -1,82 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import type { Rule } from 'eslint';
-import type { SimpleCallExpression } from 'estree';
-
-const NESTED_LIMIT: number = 4;
-const TEST_RUNNER_IDENTIFIER = 'ffTest' as const;
-
-const getDepthOfNestedRunner = (node: SimpleCallExpression & Rule.NodeParentExtension): number => {
-	// Calculate the depth of a binary tree, using a queue to track path
-	let queue: (typeof node)[] = [];
-	queue.push(node);
-	let depth = 0;
-	while (queue.length > 0) {
-		let nodeCount = queue.length;
-		while (nodeCount > 0) {
-			let currentNode = queue.shift() as typeof node;
-			if (
-				currentNode.arguments[1].type === 'ArrowFunctionExpression' &&
-				currentNode.arguments[1].body.type === 'CallExpression' &&
-				currentNode.arguments[1].body.callee.type === 'Identifier' &&
-				currentNode.arguments[1].body.callee.name === TEST_RUNNER_IDENTIFIER
-			) {
-				queue.push({
-					...currentNode.arguments[1].body,
-					parent: currentNode.parent,
-				});
-			}
-			if (
-				currentNode.arguments[2]?.type === 'ArrowFunctionExpression' &&
-				currentNode.arguments[2].body.type === 'CallExpression' &&
-				currentNode.arguments[2].body.callee.type === 'Identifier' &&
-				currentNode.arguments[2].body.callee.name === TEST_RUNNER_IDENTIFIER
-			) {
-				queue.push({
-					...currentNode.arguments[2].body,
-					parent: currentNode.parent,
-				});
-			}
-			nodeCount--;
-		}
-		depth++;
-	}
-	return depth;
-};
-
-const rule: Rule.RuleModule = {
-	meta: {
-		docs: {
-			recommended: false,
-		},
-		type: 'problem',
-		messages: {
-			tooManyNestedTestRunner:
-				'{{nestedTestRunner}} test runners are nested. Feature flags may need a clean-up',
-		},
-	},
-	create(context) {
-		return {
-			// Find the most outside test runner, could be inside a describe or not
-			[`Program > * > CallExpression[callee.name=/${TEST_RUNNER_IDENTIFIER}/], CallExpression[callee.name=/describe/] > * > * > * > CallExpression[callee.name=/${TEST_RUNNER_IDENTIFIER}/]`]:
-				(node: Rule.Node) => {
-					if (node.type === 'CallExpression') {
-						// Calculate the depth of nested test runners, counting from the most outside
-						const depth = getDepthOfNestedRunner(node);
-
-						if (depth > NESTED_LIMIT) {
-							return context.report({
-								node,
-								messageId: 'tooManyNestedTestRunner',
-								data: {
-									nestedTestRunner: depth.toString(),
-								},
-							});
-						}
-					}
-					return {};
-				},
-		};
-	},
-};
-
-export default rule;

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

@@ -1,159 +0,0 @@
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../../index';
-
-const cwd = process.cwd();
-
-const mockValidBinPaths = [
-	`${cwd}/packages/foo/run-ts.bin`,
-	`${cwd}/packages/foo/scripts/run-ts.bin`,
-	`${cwd}/packages/foo/bar/run-ts.ts`,
-	`${cwd}/packages/foo/bar/scripts/run-ts.ts`,
-	`${cwd}/packages/baz/run-ts.js`,
-	`${cwd}/packages/baz/scripts/run-ts.js`,
-];
-
-jest.mock('fs', () => {
-	const actual = jest.requireActual('fs');
-	return {
-		...actual,
-		statSync: jest.fn((p: string) => ({
-			isFile: jest.fn(() => mockValidBinPaths.includes(p)),
-			isDirectory: jest.fn(() => actual.statSync(p).isDirectory()),
-		})),
-	};
-});
-
-describe('test ensure-valid-bin-values rule', () => {
-	tester.run('ensure-valid-bin-values', rule, {
-		valid: [
-			// .bin files are valid
-			{
-				code: `const foo = {
-            "bin": {
-              "run-ts": "./run-ts.bin",
-            }
-        }`,
-				filename: `${cwd}/packages/foo/package.json`,
-			},
-			{
-				code: `const foo = {
-            "bin": {
-              "run-ts": "./scripts/run-ts.bin",
-            }
-        }`,
-				filename: `${cwd}/packages/foo/package.json`,
-			},
-			// .ts files are valid
-			{
-				code: `const foo = {
-            "bin": {
-              "run-ts": "./run-ts.ts",
-            }
-        }`,
-				filename: `${cwd}/packages/foo/bar/package.json`,
-			},
-			{
-				code: `const foo = {
-            "bin": {
-              "run-ts": "./scripts/run-ts.ts",
-            }
-        }`,
-				filename: `${cwd}/packages/foo/bar/package.json`,
-			},
-			// .js files are valid
-			{
-				code: `const foo = {
-            "bin": {
-              "run-ts": "./run-ts.js",
-            }
-        }`,
-				filename: `${cwd}/packages/baz/package.json`,
-			},
-			{
-				code: `const foo = {
-        	"bin": {
-              "run-ts": "./scripts/run-ts.js",
-            }
-        }`,
-				filename: `${cwd}/packages/baz/package.json`,
-			},
-			// dist paths are valid
-			{
-				code: `const foo = {
-        	"bin": {
-              "run-ts": "./dist/run-ts.js",
-            }
-        }`,
-				filename: `${cwd}/packages/baz/package.json`,
-			},
-		],
-		invalid: [
-			// Pointing to anything other than a file is invalid
-			{
-				code: `const foo = {
-          "bin": {
-              "run-ts": "./bin",
-            }
-        }`,
-				filename: `${cwd}/packages/foo/package.json`,
-				errors: [
-					{
-						messageId: 'invalidBinValue',
-					},
-				],
-			},
-			{
-				code: `const foo = {
-          "bin": {
-              "run-ts": "./scripts/index",
-            }
-        }`,
-				filename: `${cwd}/packages/foo/package.json`,
-				errors: [
-					{
-						messageId: 'invalidBinValue',
-					},
-				],
-			},
-			{
-				code: `const foo = {
-          "bin": {
-              "run-ts": "./scripts/bin",
-            }
-        }`,
-				filename: `${cwd}/packages/foo/package.json`,
-				errors: [
-					{
-						messageId: 'invalidBinValue',
-					},
-				],
-			},
-			{
-				code: `const foo = {
-          "bin": {
-              "run-ts": "./",
-            }
-        }`,
-				filename: `${cwd}/packages/foo/package.json`,
-				errors: [
-					{
-						messageId: 'invalidBinValue',
-					},
-				],
-			},
-			{
-				code: `const foo = {
-          "bin": {
-              "run-ts": "",
-            }
-        }`,
-				filename: `${cwd}/packages/foo/package.json`,
-				errors: [
-					{
-						messageId: 'invalidBinValue',
-					},
-				],
-			},
-		],
-	});
-});

package/src/rules/ensure-valid-bin-values/index.ts

@@ -1,70 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import fs from 'fs';
-import { resolve, dirname } from 'path';
-import type { Rule } from 'eslint';
-import type { ObjectExpression } from 'estree';
-import { getObjectPropertyAsObject } from '../util/handle-ast-object';
-
-const cwd = process.cwd();
-
-function checkIsAllBinValuesAreValid(node: ObjectExpression, packageDir: string) {
-	const binObj = getObjectPropertyAsObject(node, 'bin');
-
-	if (!binObj || !Array.isArray(binObj.properties)) {
-		return true;
-	}
-
-	return binObj.properties.every((p) => {
-		if (p.type === 'Property' && p.value.type === 'Literal') {
-			try {
-				const binValue = String(p.value.value);
-				const pathToBin = resolve(cwd, packageDir, binValue);
-				// Ignore bin values that point to dist as these files don't always exist
-				if (binValue.startsWith('./dist/')) {
-					return true;
-				}
-				return fs.statSync(pathToBin).isFile();
-			} catch (err) {
-				return false;
-			}
-		}
-		// If it's not a property or doesn't have a literal value, consider it invalid
-		return false;
-	});
-}
-
-const rule: Rule.RuleModule = {
-	meta: {
-		type: 'problem',
-		docs: {
-			description: `Ensures bin values in package.json files are valid.`,
-			recommended: true,
-		},
-		hasSuggestions: false,
-		messages: {
-			invalidBinValue: `Invalid bin value. Ensure that the value points to a file and not a directory.`,
-		},
-	},
-	create(context) {
-		const fileName = context.getFilename();
-		return {
-			ObjectExpression: (node: Rule.Node) => {
-				if (!fileName.endsWith('package.json') || node.type !== 'ObjectExpression') {
-					return;
-				}
-
-				const isAllBinValuesValid = checkIsAllBinValuesAreValid(node, dirname(fileName));
-				if (isAllBinValuesValid) {
-					return;
-				}
-
-				return context.report({
-					node,
-					messageId: 'invalidBinValue',
-				});
-			},
-		};
-	},
-};
-
-export default rule;