@atlaskit/eslint-plugin-platform 0.6.1 → 0.7.0

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

@@ -4,188 +4,182 @@ import path from 'path';
 import { getMetadataForFilename } from '../util/registration-utils';
 
 interface ExportsValidationExceptions {
-  [key: string]: { ignoredAfExportKeys: string[] };
+	[key: string]: { ignoredAfExportKeys: string[] };
 }
 
 const exportsValidationExceptions: ExportsValidationExceptions = {
-  '@atlassian/sizemap': {
-    ignoredAfExportKeys: ['.', './lmdb-cache-manager'],
-  },
-  '@atlaskit/tokens': {
-    ignoredAfExportKeys: ['./babel-plugin'],
-  },
+	'@atlassian/sizemap': {
+		ignoredAfExportKeys: ['.', './lmdb-cache-manager'],
+	},
+	'@atlaskit/tokens': {
+		ignoredAfExportKeys: ['./babel-plugin'],
+	},
 };
 
 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(
-            pkgName,
-            afExportsKey,
-            afExportsValue,
-            nativeExports,
-          );
-
-          if (exportValueViolations) {
-            context.report({
-              data: { ...exportValueViolations, pkgName },
-              node,
-              messageId: 'unexpectedExportsValue',
-            });
-
-            continue;
-          }
-        }
-      },
-    };
-  },
+	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 },
+	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}/*`,
-    };
-  }
+	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(
-  pkgName: string,
-  afExportsKey: string,
-  afExportsValue: string,
-  nativeExports: { [key: string]: any },
+	afExportsKey: string,
+	afExportsValue: string,
+	nativeExports: { [key: string]: any },
 ) {
-  const afExportsValueHasExtension = path.extname(afExportsValue);
-
-  // 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(nativeExports[afExportsKey]) === 'index.js'
-  ) {
-    return;
-  }
-
-  if (
-    afExportsValueHasExtension &&
-    nativeExports[afExportsKey] !== 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 &&
-    !nativeExports[`${afExportsKey}/*`].startsWith(`${afExportsValue}/*`)
-  ) {
-    return {
-      key: `${afExportsKey}/*`,
-      expectedValue: `${afExportsValue}/*`,
-    };
-  }
+	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-publish-valid/__tests__/unit/rule.test.ts

@@ -2,40 +2,38 @@ 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' } },
-        ],
-      },
-    ],
-  });
+	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,96 +1,81 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
 import type { Rule } from 'eslint';
-import {
-  getObjectPropertyAsLiteral,
-  getObjectPropertyAsObject,
-} from '../util/handle-ast-object';
+import { getObjectPropertyAsLiteral, getObjectPropertyAsObject } from '../util/handle-ast-object';
 
 type RuleOptions = {
-  // exceptions to this rule, will be ignored
-  exceptions?: string[];
+	// 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) ?? {};
+	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;
-        }
+		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',
-        );
+				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;
-        }
+				// 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 (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,
-              },
-            });
-          }
-        }
-      },
-    };
-  },
+					if (packagePublishConfig === null) {
+						return context.report({
+							node,
+							messageId: 'publishConfigRequired',
+							data: {
+								packageName,
+							},
+						});
+					}
+				}
+			},
+		};
+	},
 };
 
 export default rule;