@atlaskit/eslint-plugin-platform 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.5.0
+
+### Minor Changes
+
+- [#81166](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/81166) [`a249a1bd29a6`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/a249a1bd29a6) - Upgrade ESLint to version 8
+
 ## 0.4.1
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -17,6 +17,7 @@ var _ensureFeatureFlagPrefix = _interopRequireDefault(require("./rules/ensure-fe
 var _ensureCriticalDependencyResolutions = _interopRequireDefault(require("./rules/ensure-critical-dependency-resolutions"));
 var _noInvalidStorybookDecoratorUsage = _interopRequireDefault(require("./rules/no-invalid-storybook-decorator-usage"));
 var _ensurePublishValid = _interopRequireDefault(require("./rules/ensure-publish-valid"));
+var _ensureNativeAndAfExportsSynced = _interopRequireDefault(require("./rules/ensure-native-and-af-exports-synced"));
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; } // eslint-disable-next-line import/no-extraneous-dependencies
 var rules = exports.rules = {
@@ -30,7 +31,8 @@ var rules = exports.rules = {
   'no-invalid-feature-flag-usage': _noInvalidFeatureFlagUsage.default,
   'no-pre-post-install-scripts': _noPrePostInstalls.default,
   'no-invalid-storybook-decorator-usage': _noInvalidStorybookDecoratorUsage.default,
-  'ensure-publish-valid': _ensurePublishValid.default
+  'ensure-publish-valid': _ensurePublishValid.default,
+  'ensure-native-and-af-exports-synced': _ensureNativeAndAfExportsSynced.default
 };
 var configs = exports.configs = {
   recommended: {

package/dist/cjs/rules/ensure-native-and-af-exports-synced/index.js

@@ -0,0 +1,146 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _path = _interopRequireDefault(require("path"));
+var _registrationUtils = require("../util/registration-utils");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var exportsValidationExceptions = {
+  '@atlassian/sizemap': {
+    ignoredAfExportKeys: ['.', './lmdb-cache-manager']
+  },
+  '@atlaskit/tokens': {
+    ignoredAfExportKeys: ['./babel-plugin']
+  }
+};
+var rule = {
+  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: function create(context) {
+    var fileName = context.getFilename();
+    if (!fileName.endsWith('package.json')) {
+      return {};
+    }
+    var _getMetadataForFilena = (0, _registrationUtils.getMetadataForFilename)(fileName),
+      packageJson = _getMetadataForFilena.pkgJson;
+    var pkgName = packageJson.name;
+
+    // TODO: remove '|| !packageJson['exports']' once all package.json files have 'exports'
+    if (!pkgName || !packageJson['af:exports'] || !packageJson['exports']) {
+      return {};
+    }
+
+    // TODO: Add back in once all package.json files have 'exports'
+    // if (!packageJson['exports']) {
+    //   context.report({
+    //     node: context.getSourceCode().ast,
+    //     messageId: 'missingExportsProperty',
+    //     data: { pkgName },
+    //   });
+    //   return {};
+    // }
+
+    var afExports = packageJson['af:exports'];
+    var nativeExports = packageJson['exports'];
+    return {
+      Program: function Program(node) {
+        for (var _i = 0, _Object$entries = Object.entries(afExports); _i < _Object$entries.length; _i++) {
+          var _exportsValidationExc;
+          var _Object$entries$_i = (0, _slicedToArray2.default)(_Object$entries[_i], 2),
+            afExportsKey = _Object$entries$_i[0],
+            afExportsValue = _Object$entries$_i[1];
+          if ((_exportsValidationExc = exportsValidationExceptions[pkgName]) !== null && _exportsValidationExc !== void 0 && _exportsValidationExc.ignoredAfExportKeys.includes(afExportsKey)) {
+            continue;
+          }
+          var exportKeyViolations = getExportKeyViolation(afExportsKey, afExportsValue, nativeExports);
+          if (exportKeyViolations) {
+            context.report({
+              data: _objectSpread(_objectSpread({}, exportKeyViolations), {}, {
+                key: afExportsKey,
+                pkgName: pkgName
+              }),
+              node: node,
+              messageId: exportKeyViolations.messageId
+            });
+            continue;
+          }
+          var exportValueViolations = getExportValueViolation(pkgName, afExportsKey, afExportsValue, nativeExports);
+          if (exportValueViolations) {
+            context.report({
+              data: _objectSpread(_objectSpread({}, exportValueViolations), {}, {
+                pkgName: pkgName
+              }),
+              node: node,
+              messageId: 'unexpectedExportsValue'
+            });
+            continue;
+          }
+        }
+      }
+    };
+  }
+};
+function getExportKeyViolation(afExportsKey, afExportsValue, nativeExports) {
+  var afExportsValueHasExtension = _path.default.extname(afExportsValue);
+  if (afExportsValueHasExtension && !nativeExports.hasOwnProperty(afExportsKey)) {
+    return {
+      messageId: 'missingExportsKey',
+      expectedKey: afExportsKey,
+      expectedValue: afExportsValue
+    };
+  }
+  if (!afExportsValueHasExtension && nativeExports.hasOwnProperty(afExportsKey)) {
+    return {
+      messageId: 'unexpectedExportsKey',
+      expectedKey: "".concat(afExportsKey, "/*"),
+      expectedValue: "".concat(afExportsValue, "/*")
+    };
+  }
+  if (!afExportsValueHasExtension && !nativeExports.hasOwnProperty("".concat(afExportsKey, "/*"))) {
+    return {
+      messageId: 'missingExportsKey',
+      expectedKey: "".concat(afExportsKey, "/*"),
+      expectedValue: "".concat(afExportsValue, "/*")
+    };
+  }
+}
+function getExportValueViolation(pkgName, afExportsKey, afExportsValue, nativeExports) {
+  var afExportsValueHasExtension = _path.default.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.default.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["".concat(afExportsKey, "/*")].startsWith("".concat(afExportsValue, "/*"))) {
+    return {
+      key: "".concat(afExportsKey, "/*"),
+      expectedValue: "".concat(afExportsValue, "/*")
+    };
+  }
+}
+var _default = exports.default = rule;

package/dist/es2019/index.js

@@ -11,6 +11,7 @@ import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import ensureCriticalDependencyResolutions from './rules/ensure-critical-dependency-resolutions';
 import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
 import ensurePublishValid from './rules/ensure-publish-valid';
+import ensureNativeAndAfExportsSynced from './rules/ensure-native-and-af-exports-synced';
 export const rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
   'ensure-feature-flag-prefix': ensureFeatureFlagPrefix,
@@ -22,7 +23,8 @@ export const rules = {
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
   'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
-  'ensure-publish-valid': ensurePublishValid
+  'ensure-publish-valid': ensurePublishValid,
+  'ensure-native-and-af-exports-synced': ensureNativeAndAfExportsSynced
 };
 export const configs = {
   recommended: {

package/dist/es2019/rules/ensure-native-and-af-exports-synced/index.js

@@ -0,0 +1,135 @@
+import path from 'path';
+import { getMetadataForFilename } from '../util/registration-utils';
+const exportsValidationExceptions = {
+  '@atlassian/sizemap': {
+    ignoredAfExportKeys: ['.', './lmdb-cache-manager']
+  },
+  '@atlaskit/tokens': {
+    ignoredAfExportKeys: ['./babel-plugin']
+  }
+};
+const rule = {
+  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;
+
+    // TODO: remove '|| !packageJson['exports']' once all package.json files have 'exports'
+    if (!pkgName || !packageJson['af:exports'] || !packageJson['exports']) {
+      return {};
+    }
+
+    // TODO: Add back in once all package.json files have 'exports'
+    // if (!packageJson['exports']) {
+    //   context.report({
+    //     node: context.getSourceCode().ast,
+    //     messageId: 'missingExportsProperty',
+    //     data: { pkgName },
+    //   });
+    //   return {};
+    // }
+
+    const afExports = packageJson['af:exports'];
+    const nativeExports = packageJson['exports'];
+    return {
+      Program(node) {
+        for (const [afExportsKey, afExportsValue] of Object.entries(afExports)) {
+          var _exportsValidationExc;
+          if ((_exportsValidationExc = exportsValidationExceptions[pkgName]) !== null && _exportsValidationExc !== void 0 && _exportsValidationExc.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;
+          }
+        }
+      }
+    };
+  }
+};
+function getExportKeyViolation(afExportsKey, afExportsValue, nativeExports) {
+  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 getExportValueViolation(pkgName, afExportsKey, afExportsValue, nativeExports) {
+  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}/*`
+    };
+  }
+}
+export default rule;

package/dist/esm/index.js

@@ -14,6 +14,7 @@ import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import ensureCriticalDependencyResolutions from './rules/ensure-critical-dependency-resolutions';
 import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
 import ensurePublishValid from './rules/ensure-publish-valid';
+import ensureNativeAndAfExportsSynced from './rules/ensure-native-and-af-exports-synced';
 export var rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
   'ensure-feature-flag-prefix': ensureFeatureFlagPrefix,
@@ -25,7 +26,8 @@ export var rules = {
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
   'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
-  'ensure-publish-valid': ensurePublishValid
+  'ensure-publish-valid': ensurePublishValid,
+  'ensure-native-and-af-exports-synced': ensureNativeAndAfExportsSynced
 };
 export var configs = {
   recommended: {

package/dist/esm/rules/ensure-native-and-af-exports-synced/index.js

@@ -0,0 +1,139 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import path from 'path';
+import { getMetadataForFilename } from '../util/registration-utils';
+var exportsValidationExceptions = {
+  '@atlassian/sizemap': {
+    ignoredAfExportKeys: ['.', './lmdb-cache-manager']
+  },
+  '@atlaskit/tokens': {
+    ignoredAfExportKeys: ['./babel-plugin']
+  }
+};
+var rule = {
+  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: function create(context) {
+    var fileName = context.getFilename();
+    if (!fileName.endsWith('package.json')) {
+      return {};
+    }
+    var _getMetadataForFilena = getMetadataForFilename(fileName),
+      packageJson = _getMetadataForFilena.pkgJson;
+    var pkgName = packageJson.name;
+
+    // TODO: remove '|| !packageJson['exports']' once all package.json files have 'exports'
+    if (!pkgName || !packageJson['af:exports'] || !packageJson['exports']) {
+      return {};
+    }
+
+    // TODO: Add back in once all package.json files have 'exports'
+    // if (!packageJson['exports']) {
+    //   context.report({
+    //     node: context.getSourceCode().ast,
+    //     messageId: 'missingExportsProperty',
+    //     data: { pkgName },
+    //   });
+    //   return {};
+    // }
+
+    var afExports = packageJson['af:exports'];
+    var nativeExports = packageJson['exports'];
+    return {
+      Program: function Program(node) {
+        for (var _i = 0, _Object$entries = Object.entries(afExports); _i < _Object$entries.length; _i++) {
+          var _exportsValidationExc;
+          var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+            afExportsKey = _Object$entries$_i[0],
+            afExportsValue = _Object$entries$_i[1];
+          if ((_exportsValidationExc = exportsValidationExceptions[pkgName]) !== null && _exportsValidationExc !== void 0 && _exportsValidationExc.ignoredAfExportKeys.includes(afExportsKey)) {
+            continue;
+          }
+          var exportKeyViolations = getExportKeyViolation(afExportsKey, afExportsValue, nativeExports);
+          if (exportKeyViolations) {
+            context.report({
+              data: _objectSpread(_objectSpread({}, exportKeyViolations), {}, {
+                key: afExportsKey,
+                pkgName: pkgName
+              }),
+              node: node,
+              messageId: exportKeyViolations.messageId
+            });
+            continue;
+          }
+          var exportValueViolations = getExportValueViolation(pkgName, afExportsKey, afExportsValue, nativeExports);
+          if (exportValueViolations) {
+            context.report({
+              data: _objectSpread(_objectSpread({}, exportValueViolations), {}, {
+                pkgName: pkgName
+              }),
+              node: node,
+              messageId: 'unexpectedExportsValue'
+            });
+            continue;
+          }
+        }
+      }
+    };
+  }
+};
+function getExportKeyViolation(afExportsKey, afExportsValue, nativeExports) {
+  var 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: "".concat(afExportsKey, "/*"),
+      expectedValue: "".concat(afExportsValue, "/*")
+    };
+  }
+  if (!afExportsValueHasExtension && !nativeExports.hasOwnProperty("".concat(afExportsKey, "/*"))) {
+    return {
+      messageId: 'missingExportsKey',
+      expectedKey: "".concat(afExportsKey, "/*"),
+      expectedValue: "".concat(afExportsValue, "/*")
+    };
+  }
+}
+function getExportValueViolation(pkgName, afExportsKey, afExportsValue, nativeExports) {
+  var 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["".concat(afExportsKey, "/*")].startsWith("".concat(afExportsValue, "/*"))) {
+    return {
+      key: "".concat(afExportsKey, "/*"),
+      expectedValue: "".concat(afExportsValue, "/*")
+    };
+  }
+}
+export default rule;

package/dist/types/index.d.ts

@@ -11,6 +11,7 @@ export declare const rules: {
     'no-pre-post-install-scripts': import("eslint").Rule.RuleModule;
     'no-invalid-storybook-decorator-usage': import("eslint").Rule.RuleModule;
     'ensure-publish-valid': import("eslint").Rule.RuleModule;
+    'ensure-native-and-af-exports-synced': import("eslint").Rule.RuleModule;
 };
 export declare const configs: {
     recommended: {

package/dist/types/rules/ensure-native-and-af-exports-synced/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types-ts4.5/index.d.ts

@@ -11,6 +11,7 @@ export declare const rules: {
     'no-pre-post-install-scripts': import("eslint").Rule.RuleModule;
     'no-invalid-storybook-decorator-usage': import("eslint").Rule.RuleModule;
     'ensure-publish-valid': import("eslint").Rule.RuleModule;
+    'ensure-native-and-af-exports-synced': import("eslint").Rule.RuleModule;
 };
 export declare const configs: {
     recommended: {

package/dist/types-ts4.5/rules/ensure-native-and-af-exports-synced/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/eslint-plugin-platform",
   "description": "The essential plugin for use with Atlassian frontend platform tools",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "author": "Atlassian Pty Ltd",
   "atlassian": {
     "team": "UIP - Platform Integration Trust (PITa)",
@@ -38,7 +38,7 @@
   "devDependencies": {
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/eslint": "^8.4.5",
-    "eslint": "^7.7.0",
+    "eslint": "^8.49.0",
     "tsconfig-paths": "^4.2.0"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"

package/src/__tests__/utils/_tester.tsx

@@ -18,7 +18,7 @@ import { RuleTester } from 'eslint';
 };
 
 export const tester = new RuleTester({
-  parser: require.resolve('babel-eslint'),
+  parser: require.resolve('@babel/eslint-parser'),
   parserOptions: {
     ecmaVersion: 6,
     sourceType: 'module',

package/src/index.tsx

@@ -11,6 +11,7 @@ import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import ensureCriticalDependencyResolutions from './rules/ensure-critical-dependency-resolutions';
 import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
 import ensurePublishValid from './rules/ensure-publish-valid';
+import ensureNativeAndAfExportsSynced from './rules/ensure-native-and-af-exports-synced';
 
 export const rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
@@ -24,6 +25,7 @@ export const rules = {
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
   'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
   'ensure-publish-valid': ensurePublishValid,
+  'ensure-native-and-af-exports-synced': ensureNativeAndAfExportsSynced,
 };
 
 export const configs = {

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

@@ -0,0 +1,199 @@
+import { tester } from '../../../../__tests__/utils/_tester';
+import rule from '../../index';
+import { 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

@@ -0,0 +1,193 @@
+import type { Rule } from 'eslint';
+import path from 'path';
+
+import { getMetadataForFilename } from '../util/registration-utils';
+
+interface ExportsValidationExceptions {
+  [key: string]: { ignoredAfExportKeys: string[] };
+}
+
+const exportsValidationExceptions: ExportsValidationExceptions = {
+  '@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;
+
+    // TODO: remove '|| !packageJson['exports']' once all package.json files have 'exports'
+    if (!pkgName || !packageJson['af:exports'] || !packageJson['exports']) {
+      return {};
+    }
+
+    // TODO: Add back in once all package.json files have 'exports'
+    // 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;
+          }
+        }
+      },
+    };
+  },
+};
+
+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 getExportValueViolation(
+  pkgName: string,
+  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}/*`,
+    };
+  }
+}
+
+export default rule;