@atlaskit/eslint-plugin-platform 2.7.0 → 2.7.1

package/src/rules/ensure-feature-flag-registration/index.tsx

@@ -1,106 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import type { Rule } from 'eslint';
-import { getMetadataForFilename, getterIdentifierToFlagTypeMap } from '../util/registration-utils';
-
-const rule: Rule.RuleModule = {
-	meta: {
-		docs: {
-			recommended: false,
-		},
-		type: 'problem',
-		messages: {
-			registrationSectionMissing:
-				'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
-			featureFlagMissing: `Please add a "{{ featureFlag }}" section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details`,
-			changeFeatureFlag: `Change flag key to "{{ closestFlag }}" already defined in package.json`,
-			featureFlagIncorrectType: `Please change the type for "{{ featureFlag }}" to "{{ expectedType }}" in the section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details"`,
-		},
-
-		hasSuggestions: true,
-	},
-	create(context) {
-		return Object.fromEntries(
-			(
-				Object.keys(getterIdentifierToFlagTypeMap) as (keyof typeof getterIdentifierToFlagTypeMap)[]
-			).map((getterIdentifier) => [
-				`CallExpression[callee.name=/${getterIdentifier}/]`,
-				(node: Rule.Node) => {
-					// to make typescript happy
-					if (node.type === 'CallExpression') {
-						const args = node.arguments;
-
-						const filename = context.getFilename();
-						const { pkgJson: packageJson, fuse } = getMetadataForFilename(filename);
-						const platformFeatureFlags = packageJson['platform-feature-flags'];
-
-						if (!platformFeatureFlags) {
-							return context.report({
-								node: node,
-								messageId: 'registrationSectionMissing',
-							});
-						}
-
-						if (args.length === 1 && args[0].type === 'Literal' && args[0].raw) {
-							const featureFlag = args[0].value as string;
-							const featureFlagRegistration = platformFeatureFlags[featureFlag];
-
-							const expectedType = getterIdentifierToFlagTypeMap[getterIdentifier];
-
-							// ensure the flag type matches what is registered
-							if (
-								featureFlagRegistration != null &&
-								expectedType != null &&
-								featureFlagRegistration?.type !== expectedType
-							) {
-								return context.report({
-									node: args[0],
-									messageId: 'featureFlagIncorrectType',
-									data: {
-										featureFlag,
-										expectedType,
-									},
-								});
-							}
-
-							if (!featureFlagRegistration) {
-								// find the closest match in existing section for suggestion text
-								let closestMatchFix: Rule.SuggestionReportDescriptor | null = null;
-
-								if (fuse) {
-									const closestFlagMatches = fuse.search(featureFlag);
-									if (closestFlagMatches.length > 0) {
-										const closestFlag = closestFlagMatches[0].item;
-
-										closestMatchFix = {
-											messageId: 'changeFeatureFlag',
-											data: {
-												closestFlag,
-											},
-											fix: (fixer) => {
-												return fixer.replaceText(node.arguments[0], `'${closestFlag}'`);
-											},
-										};
-									}
-								}
-
-								return context.report({
-									node: args[0],
-									messageId: 'featureFlagMissing',
-									data: {
-										featureFlag,
-									},
-									// only suggest if we have a close flag to match
-									...(closestMatchFix != null ? { suggest: [closestMatchFix] } : {}),
-								});
-							}
-						}
-					}
-
-					return {};
-				},
-			]),
-		);
-	},
-};
-
-export default rule;

package/src/rules/ensure-native-and-af-exports-synced/__tests__/unit/rule.test.tsx

@@ -1,199 +0,0 @@
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../../index';
-import { type PackageJson } from 'read-pkg-up';
-
-let mockPath = 'packages/test/package.json';
-
-let mockPackageJson: PackageJson = {};
-jest.mock('read-pkg-up', () => ({
-	sync: () => ({
-		path: mockPath,
-		packageJson: mockPackageJson,
-	}),
-}));
-
-describe('valid test cases', () => {
-	describe('allows @atlaskit/tokens babel-plugin entrypoint', () => {
-		beforeEach(() => {
-			mockPackageJson = {
-				name: '@atlaskit/tokens',
-				'af:exports': {
-					'./babel-plugin': './src/entry-points/babel-plugin.tsx',
-				},
-				exports: {
-					'./babel-plugin': './babel-plugin.js',
-				},
-			};
-		});
-		tester.run('ensure-native-and-af-exports-synced', rule, {
-			valid: [{ code: '' }],
-			invalid: [],
-		});
-	});
-
-	describe('passes for valid directory export', () => {
-		beforeEach(() => {
-			mockPackageJson = {
-				name: '@atlaskit/tokens',
-				'af:exports': {
-					'./glyph': './glyph',
-					'./test/icon': './test/icon',
-					'./button': './button',
-					'.': './src',
-				},
-				exports: {
-					'./glyph/*': './glyph/*',
-					'./test/icon/*': './test/icon/*',
-					'./button/*': './button/*.js',
-					'./*': './src/*',
-				},
-			};
-		});
-		tester.run('ensure-native-and-af-exports-synced', rule, {
-			valid: [
-				{
-					code: '',
-					filename: 'packages/test/package.json',
-				},
-			],
-			invalid: [],
-		});
-	});
-
-	describe('passes for index.js files', () => {
-		beforeEach(() => {
-			mockPackageJson = {
-				name: '@atlaskit/tokens',
-				'af:exports': {
-					'.': './src/index.tsx',
-					'./gas-v3': './src/gas-v3/index.ts',
-					'./reader': './src/reader/reader.ts',
-					'./writer': './src/writer/writer.ts',
-					'./report': './src/report/report.ts',
-				},
-				exports: {
-					'.': './index.js',
-					'./gas-v3': './gas-v3/index.js',
-					'./reader': './reader/index.js',
-					'./writer': './writer/index.js',
-					'./report': './report/index.js',
-				},
-			};
-		});
-		tester.run('ensure-native-and-af-exports-synced', rule, {
-			valid: [
-				{
-					code: '',
-					filename: 'packages/test/package.json',
-				},
-			],
-			invalid: [],
-		});
-	});
-
-	describe('should pass for multiple valid entrypoints', () => {
-		beforeEach(() => {
-			mockPackageJson = {
-				name: '@atlaskit/tokens',
-				'af:exports': {
-					'.': './src/index.tsx',
-					'./rename-mapping': './src/entry-points/rename-mapping.tsx',
-					'./babel-plugin': './src/entry-points/babel-plugin.tsx',
-					'./glyph': './glyph',
-					'./button': './button',
-				},
-				exports: {
-					'.': './index.js',
-					'./rename-mapping': './src/entry-points/rename-mapping.tsx',
-					'./babel-plugin': './src/entry-points/babel-plugin.tsx',
-					'./glyph/*': './glyph/*',
-					'./button/*': './button/*.js',
-				},
-			};
-		});
-		tester.run('ensure-native-and-af-exports-synced', rule, {
-			valid: [
-				{
-					code: '',
-					filename: 'packages/test/package.json',
-				},
-			],
-			invalid: [],
-		});
-	});
-});
-
-describe('invalid test cases', () => {
-	describe('should fail for mismatched invalid entrypoints', () => {
-		beforeEach(() => {
-			mockPackageJson = {
-				name: '@atlaskit/test',
-				'af:exports': {
-					'.': './src/index.ts',
-				},
-				exports: {
-					'.': './test/index.ts',
-				},
-			};
-		});
-		tester.run('ensure-native-and-af-exports-synced', rule, {
-			valid: [],
-			invalid: [
-				{
-					code: '',
-					filename: 'packages/test/package.json',
-					errors: [{ messageId: 'unexpectedExportsValue' }],
-				},
-			],
-		});
-	});
-
-	describe('should fail for missing entrypoints', () => {
-		beforeEach(() => {
-			mockPackageJson = {
-				name: '@atlaskit/tokens',
-				'af:exports': {
-					'.': './src/index.ts',
-					'./button': './button',
-				},
-				exports: {
-					'.': './src/index.ts',
-				},
-			};
-		});
-		tester.run('ensure-native-and-af-exports-synced', rule, {
-			valid: [],
-			invalid: [
-				{
-					code: '',
-					filename: 'packages/test/package.json',
-					errors: [{ messageId: 'missingExportsKey' }],
-				},
-			],
-		});
-	});
-
-	describe('should fail for invalid directory export', () => {
-		beforeEach(() => {
-			mockPackageJson = {
-				name: '@atlaskit/tokens',
-				'af:exports': {
-					'./button': './button',
-				},
-				exports: {
-					'./button/*': './src/button/*',
-				},
-			};
-		});
-		tester.run('ensure-native-and-af-exports-synced', rule, {
-			valid: [],
-			invalid: [
-				{
-					code: '',
-					filename: 'packages/test/package.json',
-					errors: [{ messageId: 'unexpectedExportsValue' }],
-				},
-			],
-		});
-	});
-});

package/src/rules/ensure-native-and-af-exports-synced/index.tsx

@@ -1,188 +0,0 @@
-import type { Rule } from 'eslint';
-import path from 'path';
-
-import { getMetadataForFilename } from '../util/registration-utils';
-
-interface ExportsValidationExceptions {
-	[key: string]: { ignoredAfExportKeys: string[] };
-}
-
-const exportsValidationExceptions: ExportsValidationExceptions = {
-	'@af/yarn-workspace': {
-		ignoredAfExportKeys: ['./lock-parser'],
-	},
-	'@atlaskit/tokens': {
-		ignoredAfExportKeys: ['./babel-plugin'],
-	},
-	'@atlaskit/storybook-addon-design-system': {
-		ignoredAfExportKeys: ['.'],
-	},
-};
-
-const rule: Rule.RuleModule = {
-	meta: {
-		docs: {
-			recommended: false,
-		},
-		type: 'problem',
-		messages: {
-			missingExportsProperty: `The exports property must be defined for {{pkgName}}; it most likely can just be a duplicate of the "af:exports" property. See http://go/eslint-exports for details`,
-			missingExportsKey: `Missing package.json exports key "{{expectedKey}}" in {{pkgName}}. The exports entry should be "{{expectedKey}}": "{{expectedValue}}". See http://go/eslint-exports for details`,
-			unexpectedExportsKey: `Unexpected package.json exports key "{{key}}" in {{pkgName}}. The exports entry should be "{{expectedKey}}": "{{expectedValue}}". See http://go/eslint-exports for details`,
-			unexpectedExportsValue: `Unexpected package.json exports value in {{pkgName}} for the "{{key}}" key. The exports entry should be "{{key}}": "{{expectedValue}}". See http://go/eslint-exports for details`,
-		},
-	},
-
-	create(context) {
-		const fileName = context.getFilename();
-
-		if (!fileName.endsWith('package.json')) {
-			return {};
-		}
-
-		const { pkgJson: packageJson } = getMetadataForFilename(fileName);
-
-		const pkgName = packageJson.name;
-
-		if (!pkgName || !packageJson['af:exports']) {
-			return {};
-		}
-
-		if (!packageJson['exports']) {
-			context.report({
-				node: context.getSourceCode().ast,
-				messageId: 'missingExportsProperty',
-				data: { pkgName },
-			});
-			return {};
-		}
-
-		const afExports: { [key: string]: any } = packageJson['af:exports'];
-		const nativeExports: { [key: string]: any } = packageJson['exports'];
-
-		return {
-			Program(node) {
-				for (const [afExportsKey, afExportsValue] of Object.entries(afExports)) {
-					if (exportsValidationExceptions[pkgName]?.ignoredAfExportKeys.includes(afExportsKey)) {
-						continue;
-					}
-
-					const exportKeyViolations = getExportKeyViolation(
-						afExportsKey,
-						afExportsValue,
-						nativeExports,
-					);
-
-					if (exportKeyViolations) {
-						context.report({
-							data: { ...exportKeyViolations, key: afExportsKey, pkgName },
-							node,
-							messageId: exportKeyViolations.messageId,
-						});
-
-						continue;
-					}
-
-					const exportValueViolations = getExportValueViolation(
-						afExportsKey,
-						afExportsValue,
-						nativeExports,
-					);
-
-					if (exportValueViolations) {
-						context.report({
-							data: { ...exportValueViolations, pkgName },
-							node,
-							messageId: 'unexpectedExportsValue',
-						});
-
-						continue;
-					}
-				}
-			},
-		};
-	},
-};
-
-function getExportKeyViolation(
-	afExportsKey: string,
-	afExportsValue: string,
-	nativeExports: { [key: string]: any },
-) {
-	const afExportsValueHasExtension = path.extname(afExportsValue) !== '';
-
-	if (afExportsValueHasExtension && !nativeExports.hasOwnProperty(afExportsKey)) {
-		return {
-			messageId: 'missingExportsKey',
-			expectedKey: afExportsKey,
-			expectedValue: afExportsValue,
-		};
-	}
-
-	if (!afExportsValueHasExtension && nativeExports.hasOwnProperty(afExportsKey)) {
-		return {
-			messageId: 'unexpectedExportsKey',
-			expectedKey: `${afExportsKey}/*`,
-			expectedValue: `${afExportsValue}/*`,
-		};
-	}
-
-	if (!afExportsValueHasExtension && !nativeExports.hasOwnProperty(`${afExportsKey}/*`)) {
-		return {
-			messageId: 'missingExportsKey',
-			expectedKey: `${afExportsKey}/*`,
-			expectedValue: `${afExportsValue}/*`,
-		};
-	}
-}
-
-function getNativeExportsValue(
-	afExportsKey: string,
-	afExportsValueHasExtension: boolean,
-	nativeExports: { [key: string]: any },
-) {
-	const nativeExportsKey = afExportsValueHasExtension ? afExportsKey : `${afExportsKey}/*`;
-
-	if (typeof nativeExports[nativeExportsKey] === 'object') {
-		return nativeExports[nativeExportsKey].default;
-	}
-
-	return nativeExports[nativeExportsKey];
-}
-
-function getExportValueViolation(
-	afExportsKey: string,
-	afExportsValue: string,
-	nativeExports: { [key: string]: any },
-) {
-	const afExportsValueHasExtension = path.extname(afExportsValue) !== '';
-
-	const nativeExportsValue = getNativeExportsValue(
-		afExportsKey,
-		afExportsValueHasExtension,
-		nativeExports,
-	);
-
-	// Some entrypoints have been updated to an index.js file that registers ts-node
-	// Use path.basename to get the file name to see if it is equal to 'index.js'
-	if (afExportsValueHasExtension && path.basename(nativeExportsValue) === 'index.js') {
-		return;
-	}
-
-	if (afExportsValueHasExtension && nativeExportsValue !== afExportsValue) {
-		return {
-			key: afExportsKey,
-			expectedValue: afExportsValue,
-		};
-	}
-
-	// af:exports entrypoints without a file extension export the whole directory so check to ensure the exports value includes the wildcard
-	if (!afExportsValueHasExtension && !nativeExportsValue.startsWith(`${afExportsValue}/*`)) {
-		return {
-			key: `${afExportsKey}/*`,
-			expectedValue: `${afExportsValue}/*`,
-		};
-	}
-}
-
-export default rule;

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

@@ -1,212 +0,0 @@
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../../index';
-
-const cwd = process.cwd();
-
-jest.mock('@manypkg/find-root');
-
-jest.mock('@manypkg/get-packages', () => ({
-	getPackagesSync: () => {
-		return {
-			packages: [
-				// Private packages
-				{
-					packageJson: {
-						name: '@af/private-pkg',
-						private: true,
-					},
-				},
-				{
-					packageJson: {
-						name: '@atlassian/private-pkg',
-						private: true,
-					},
-				},
-				{
-					packageJson: {
-						name: '@atlassiansox/private-pkg',
-						private: true,
-					},
-				},
-				// Public packages
-				{
-					packageJson: {
-						name: '@atlassian/public-pkg',
-						publishConfig: { registry: 'https://pkg-registry.com' },
-					},
-				},
-				{
-					packageJson: {
-						name: '@atlassiansox/public-pkg',
-						publishConfig: { registry: 'https://pkg-registry.com' },
-					},
-				},
-				{
-					packageJson: {
-						name: '@atlaskit/public-pkg',
-						publishConfig: { registry: 'https://pkg-registry.com' },
-					},
-				},
-			],
-		};
-	},
-}));
-
-const getErrorMessage = (pkgName: string) =>
-	`Published package has private dependency '${pkgName}'. To resolve this error, remove the private dependency or set this package to private.`;
-
-describe('test ensure-no-private-dependencies', () => {
-	tester.run('ensure-no-private-dependencies', rule, {
-		valid: [
-			// Private and public dependencies are allowed in private '@af' scoped packages
-			{
-				code: `const foo = {
-				"name:": "@af/test",
-				"private": true,
-				"dependencies": {
-					"@af/private-pkg": "workspace:*",
-					"@af/public-pkg": "workspace:*",
-					"@atlassian/private-pkg": "workspace:*",
-					"@atlassian/public-pkg": "workspace:*",
-					"@atlassiansox/private-pkg": "workspace:*",
-					"@atlassiansox/public-pkg": "workspace:*",
-					"react": "root:*"
-				}
-			}`,
-				filename: `${cwd}/packages/fpp/package.json`,
-			},
-			// Private and public dependencies are allowed in private '@atlassian' scoped packages
-			{
-				code: `const foo = {
-				"name:": "@atlassian/test",
-				"private": true,
-				"dependencies": {
-					"@af/private-pkg": "workspace:*",
-					"@af/public-pkg": "workspace:*",
-					"@atlassian/private-pkg": "workspace:*",
-					"@atlassian/public-pkg": "workspace:*",
-					"@atlassiansox/private-pkg": "workspace:*",
-					"@atlassiansox/public-pkg": "workspace:*",
-					"react": "root:*"
-				}
-			}`,
-				filename: `${cwd}/packages/fpp/package.json`,
-			},
-			// Private dependencies are allowed in private '@atlassiansox' scoped packages
-			{
-				code: `const foo = {
-	        "name:": "@atlassiansox/test",
-	        "private": true,
-	        "dependencies": {
-	          "@af/private-pkg": "workspace:*",
-	          "@atlassian/private-pkg": "workspace:*",
- 	          "@atlassiansox/private-pkg": "workspace:*",
- 	          "react": "root:*"
-	        }
-	      }`,
-				filename: `${cwd}/packages/foo/package.json`,
-			},
-			// Private and public dependencies are allowed in private '@atlassiansox' scoped packages
-			{
-				code: `const foo = {
-				"name:": "@atlassiansox/test",
-				"private": true,
-				"dependencies": {
-	        "@af/private-pkg": "workspace:*",
-	        "@af/public-pkg": "workspace:*",
-	        "@atlassian/private-pkg": "workspace:*",
-	        "@atlassian/public-pkg": "workspace:*",
-	        "@atlassiansox/private-pkg": "workspace:*",
-	        "@atlassiansox/public-pkg": "workspace:*",
-	        "react": "root:*"
-				}
-			}`,
-				filename: `${cwd}/packages/fpp/package.json`,
-			},
-		],
-		invalid: [
-			// Disallow private dependencies in public '@atlaskit' scoped packages
-			{
-				code: `const foo = {
-	        "name": "@atlaskit/test",
-	        "publishConfig": { "registry": "https://pkg-registry.com" },
-	        "dependencies": {
-	          "@af/private-pkg": "workspace:*",
-	          "@atlassian/private-pkg": "workspace:*",
- 	          "@atlassiansox/private-pkg": "workspace:*",
- 	          "react": "root:*"
-	        }
-				}`,
-				filename: `${cwd}/packages/foo/package.json`,
-				errors: [
-					{
-						message:
-							"Published package has private dependency '@af/private-pkg'. To resolve this error, remove the private dependency or set this package to private.",
-					},
-					{
-						message:
-							"Published package has private dependency '@atlassian/private-pkg'. To resolve this error, remove the private dependency or set this package to private.",
-					},
-					{
-						message:
-							"Published package has private dependency '@atlassiansox/private-pkg'. To resolve this error, remove the private dependency or set this package to private.",
-					},
-				],
-			},
-			// Disallow private dependencies in public '@atlassian' scoped packages
-			{
-				code: `const foo = {
-	        "name": "@atlassian/test",
-	        "publishConfig": { "registry": "https://registry.npmjs.org/" },
-	        "dependencies": {
-	          "@af/private-pkg": "workspace:*",
-	          "@atlassian/private-pkg": "workspace:*",
- 	          "@atlassiansox/private-pkg": "workspace:*"
-	        }
-	        }`,
-				filename: `${cwd}/packages/foo/package.json`,
-				errors: [
-					{ message: getErrorMessage('@af/private-pkg') },
-					{ message: getErrorMessage('@atlassian/private-pkg') },
-					{ message: getErrorMessage('@atlassiansox/private-pkg') },
-				],
-			},
-			// Disallow private dependencies in public '@atlassiansox' scoped packages
-			{
-				code: `const foo = {
-					"name": "@atlassian/test3",
-					"publishConfig": { "registry": "https://registry.npmjs.org/" },
-					"dependencies": {
-	          "@af/private-pkg": "workspace:*",
-	          "@atlassian/private-pkg": "workspace:*",
- 	          "@atlassiansox/private-pkg": "workspace:*"
-					}
-					}`,
-				filename: `${cwd}/packages/foo/package.json`,
-				errors: [
-					{ message: getErrorMessage('@af/private-pkg') },
-					{ message: getErrorMessage('@atlassian/private-pkg') },
-					{ message: getErrorMessage('@atlassiansox/private-pkg') },
-				],
-			},
-			// Disallow private peer dependencies
-			{
-				code: `const foo = {
-	        "name": "@atlaskit/test",
-	        "publishConfig": { "registry": "https://registry.npmjs.org/" },
-	        "peerDependencies": {
-	          "@af/private-pkg": "workspace:*",
-	          "@atlassian/private-pkg": "workspace:*",
- 	          "@atlassiansox/private-pkg": "workspace:*"
-	        }
-					}`,
-				filename: `${cwd}/packages/foo/package.json`,
-				errors: [
-					{ message: getErrorMessage('@af/private-pkg') },
-					{ message: getErrorMessage('@atlassian/private-pkg') },
-					{ message: getErrorMessage('@atlassiansox/private-pkg') },
-				],
-			},
-		],
-	});
-});