@atlaskit/eslint-plugin-platform 0.8.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.10.0
+
+### Minor Changes
+
+- [#151601](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/151601)
+  [`d619298dc0279`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/d619298dc0279) -
+  Adds `use-entrypoints-in-examples` rule which prevents the use of relative imports from `src` in
+  examples. Instead they should use public entrypoints to ensure they reflect public API.
+
+## 0.9.0
+
+### Minor Changes
+
+- [#146603](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/146603)
+  [`73a0361be46a2`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/73a0361be46a2) -
+  Created new rule `@atlaskit/platform/ensure-valid-bin-values` which validates bin values in
+  package.json files are valid point to files, not directories.
+
 ## 0.8.0
 
 ### Minor Changes

package/dist/cjs/index.js

@@ -16,6 +16,7 @@ var _noInvalidFeatureFlagUsage = _interopRequireDefault(require("./rules/no-inva
 var _ensureFeatureFlagPrefix = _interopRequireDefault(require("./rules/ensure-feature-flag-prefix"));
 var _ensureCriticalDependencyResolutions = _interopRequireDefault(require("./rules/ensure-critical-dependency-resolutions"));
 var _ensureValidWorkspaceProtocolUsage = _interopRequireDefault(require("./rules/ensure-valid-workspace-protocol-usage"));
+var _ensureValidBinValues = _interopRequireDefault(require("./rules/ensure-valid-bin-values"));
 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"));
@@ -26,6 +27,7 @@ var _noPreconditioning = _interopRequireDefault(require("./rules/no-precondition
 var _inlineUsage = _interopRequireDefault(require("./rules/inline-usage"));
 var _preferFg = _interopRequireDefault(require("./rules/prefer-fg"));
 var _noAlias = _interopRequireDefault(require("./rules/no-alias"));
+var _useEntrypointsInExamples = _interopRequireDefault(require("./rules/use-entrypoints-in-examples"));
 var _useRecommendedUtils = _interopRequireDefault(require("./rules/use-recommended-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; } // eslint-disable-next-line import/no-extraneous-dependencies
@@ -37,6 +39,7 @@ var rules = exports.rules = {
   'ensure-atlassian-team': _ensureAtlassianTeam.default,
   'ensure-critical-dependency-resolutions': _ensureCriticalDependencyResolutions.default,
   'ensure-valid-workspace-protocol-usage': _ensureValidWorkspaceProtocolUsage.default,
+  'ensure-valid-bin-values': _ensureValidBinValues.default,
   'no-duplicate-dependencies': _noDuplicateDependencies.default,
   'no-invalid-feature-flag-usage': _noInvalidFeatureFlagUsage.default,
   'no-pre-post-install-scripts': _noPrePostInstalls.default,
@@ -50,6 +53,7 @@ var rules = exports.rules = {
   'inline-usage': _inlineUsage.default,
   'prefer-fg': _preferFg.default,
   'no-alias': _noAlias.default,
+  'use-entrypoints-in-examples': _useEntrypointsInExamples.default,
   'use-recommended-utils': _useRecommendedUtils.default
 };
 var configs = exports.configs = {

package/dist/cjs/rules/ensure-valid-bin-values/index.js

@@ -0,0 +1,68 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _fs = _interopRequireDefault(require("fs"));
+var _path = require("path");
+var _handleAstObject = require("../util/handle-ast-object");
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+var cwd = process.cwd();
+function checkIsAllBinValuesAreValid(node, packageDir) {
+  var binObj = (0, _handleAstObject.getObjectPropertyAsObject)(node, 'bin');
+  if (!binObj || !Array.isArray(binObj.properties)) {
+    return true;
+  }
+  return binObj.properties.every(function (p) {
+    if (p.type === 'Property' && p.value.type === 'Literal') {
+      try {
+        var binValue = String(p.value.value);
+        var pathToBin = (0, _path.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.default.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;
+  });
+}
+var rule = {
+  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: function create(context) {
+    var fileName = context.getFilename();
+    return {
+      ObjectExpression: function ObjectExpression(node) {
+        if (!fileName.endsWith('package.json') || node.type !== 'ObjectExpression') {
+          return;
+        }
+        var isAllBinValuesValid = checkIsAllBinValuesAreValid(node, (0, _path.dirname)(fileName));
+        if (isAllBinValuesValid) {
+          return;
+        }
+        return context.report({
+          node: node,
+          messageId: 'invalidBinValue'
+        });
+      }
+    };
+  }
+};
+var _default = exports.default = rule;

package/dist/cjs/rules/use-entrypoints-in-examples/index.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var rule = {
+  meta: {
+    docs: {
+      url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/use-entrypoints-in-examples/README.md',
+      description: 'Encourage usage of package entrypoints in examples.'
+    },
+    messages: {
+      useEntrypointsInExamples: 'Use the package entrypoints instead of importing from src. This ensures examples reflect public API.\n\nFor example, use `@atlaskit/button/new` instead of `../../src/new`'
+    },
+    type: 'problem'
+  },
+  create: function create(context) {
+    /**
+     * Even if it's enabled on non-example files it will ignore them.
+     *
+     * This is a defensive check, the rule should be configured to only run on examples.
+     */
+    if (!context.filename.includes('/examples/')) {
+      return {};
+    }
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        var moduleName = node.source.value;
+        if (typeof moduleName !== 'string') {
+          return;
+        }
+        if (/^(\.\.\/)+src(\/|$)/.test(moduleName)) {
+          context.report({
+            node: node.source,
+            messageId: 'useEntrypointsInExamples'
+          });
+        }
+      }
+    };
+  }
+};
+var _default = exports.default = rule;

package/dist/es2019/index.js

@@ -10,6 +10,7 @@ import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import ensureCriticalDependencyResolutions from './rules/ensure-critical-dependency-resolutions';
 import ensureValidWorkspaceProtocolUsage from './rules/ensure-valid-workspace-protocol-usage';
+import ensureValidBinValues from './rules/ensure-valid-bin-values';
 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';
@@ -20,6 +21,7 @@ import noPreconditioning from './rules/no-preconditioning';
 import inlineUsage from './rules/inline-usage';
 import preferFG from './rules/prefer-fg';
 import noAlias from './rules/no-alias';
+import useEntrypointsInExamples from './rules/use-entrypoints-in-examples';
 import useRecommendedUtils from './rules/use-recommended-utils';
 export const rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
@@ -29,6 +31,7 @@ export const rules = {
   'ensure-atlassian-team': ensureAtlassianTeam,
   'ensure-critical-dependency-resolutions': ensureCriticalDependencyResolutions,
   'ensure-valid-workspace-protocol-usage': ensureValidWorkspaceProtocolUsage,
+  'ensure-valid-bin-values': ensureValidBinValues,
   'no-duplicate-dependencies': noDuplicateDependencies,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
@@ -42,6 +45,7 @@ export const rules = {
   'inline-usage': inlineUsage,
   'prefer-fg': preferFG,
   'no-alias': noAlias,
+  'use-entrypoints-in-examples': useEntrypointsInExamples,
   'use-recommended-utils': useRecommendedUtils
 };
 export const configs = {

package/dist/es2019/rules/ensure-valid-bin-values/index.js

@@ -0,0 +1,60 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import fs from 'fs';
+import { resolve, dirname } from 'path';
+import { getObjectPropertyAsObject } from '../util/handle-ast-object';
+const cwd = process.cwd();
+function checkIsAllBinValuesAreValid(node, packageDir) {
+  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 = {
+  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 => {
+        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;

package/dist/es2019/rules/use-entrypoints-in-examples/index.js

@@ -0,0 +1,37 @@
+const rule = {
+  meta: {
+    docs: {
+      url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/use-entrypoints-in-examples/README.md',
+      description: 'Encourage usage of package entrypoints in examples.'
+    },
+    messages: {
+      useEntrypointsInExamples: 'Use the package entrypoints instead of importing from src. This ensures examples reflect public API.\n\nFor example, use `@atlaskit/button/new` instead of `../../src/new`'
+    },
+    type: 'problem'
+  },
+  create(context) {
+    /**
+     * Even if it's enabled on non-example files it will ignore them.
+     *
+     * This is a defensive check, the rule should be configured to only run on examples.
+     */
+    if (!context.filename.includes('/examples/')) {
+      return {};
+    }
+    return {
+      ImportDeclaration(node) {
+        const moduleName = node.source.value;
+        if (typeof moduleName !== 'string') {
+          return;
+        }
+        if (/^(\.\.\/)+src(\/|$)/.test(moduleName)) {
+          context.report({
+            node: node.source,
+            messageId: 'useEntrypointsInExamples'
+          });
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/esm/index.js

@@ -13,6 +13,7 @@ import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import ensureCriticalDependencyResolutions from './rules/ensure-critical-dependency-resolutions';
 import ensureValidWorkspaceProtocolUsage from './rules/ensure-valid-workspace-protocol-usage';
+import ensureValidBinValues from './rules/ensure-valid-bin-values';
 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';
@@ -23,6 +24,7 @@ import noPreconditioning from './rules/no-preconditioning';
 import inlineUsage from './rules/inline-usage';
 import preferFG from './rules/prefer-fg';
 import noAlias from './rules/no-alias';
+import useEntrypointsInExamples from './rules/use-entrypoints-in-examples';
 import useRecommendedUtils from './rules/use-recommended-utils';
 export var rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
@@ -32,6 +34,7 @@ export var rules = {
   'ensure-atlassian-team': ensureAtlassianTeam,
   'ensure-critical-dependency-resolutions': ensureCriticalDependencyResolutions,
   'ensure-valid-workspace-protocol-usage': ensureValidWorkspaceProtocolUsage,
+  'ensure-valid-bin-values': ensureValidBinValues,
   'no-duplicate-dependencies': noDuplicateDependencies,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
@@ -45,6 +48,7 @@ export var rules = {
   'inline-usage': inlineUsage,
   'prefer-fg': preferFG,
   'no-alias': noAlias,
+  'use-entrypoints-in-examples': useEntrypointsInExamples,
   'use-recommended-utils': useRecommendedUtils
 };
 export var configs = {

package/dist/esm/rules/ensure-valid-bin-values/index.js

@@ -0,0 +1,60 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import fs from 'fs';
+import { resolve, dirname } from 'path';
+import { getObjectPropertyAsObject } from '../util/handle-ast-object';
+var cwd = process.cwd();
+function checkIsAllBinValuesAreValid(node, packageDir) {
+  var binObj = getObjectPropertyAsObject(node, 'bin');
+  if (!binObj || !Array.isArray(binObj.properties)) {
+    return true;
+  }
+  return binObj.properties.every(function (p) {
+    if (p.type === 'Property' && p.value.type === 'Literal') {
+      try {
+        var binValue = String(p.value.value);
+        var 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;
+  });
+}
+var rule = {
+  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: function create(context) {
+    var fileName = context.getFilename();
+    return {
+      ObjectExpression: function ObjectExpression(node) {
+        if (!fileName.endsWith('package.json') || node.type !== 'ObjectExpression') {
+          return;
+        }
+        var isAllBinValuesValid = checkIsAllBinValuesAreValid(node, dirname(fileName));
+        if (isAllBinValuesValid) {
+          return;
+        }
+        return context.report({
+          node: node,
+          messageId: 'invalidBinValue'
+        });
+      }
+    };
+  }
+};
+export default rule;

package/dist/esm/rules/use-entrypoints-in-examples/index.js

@@ -0,0 +1,37 @@
+var rule = {
+  meta: {
+    docs: {
+      url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/use-entrypoints-in-examples/README.md',
+      description: 'Encourage usage of package entrypoints in examples.'
+    },
+    messages: {
+      useEntrypointsInExamples: 'Use the package entrypoints instead of importing from src. This ensures examples reflect public API.\n\nFor example, use `@atlaskit/button/new` instead of `../../src/new`'
+    },
+    type: 'problem'
+  },
+  create: function create(context) {
+    /**
+     * Even if it's enabled on non-example files it will ignore them.
+     *
+     * This is a defensive check, the rule should be configured to only run on examples.
+     */
+    if (!context.filename.includes('/examples/')) {
+      return {};
+    }
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        var moduleName = node.source.value;
+        if (typeof moduleName !== 'string') {
+          return;
+        }
+        if (/^(\.\.\/)+src(\/|$)/.test(moduleName)) {
+          context.report({
+            node: node.source,
+            messageId: 'useEntrypointsInExamples'
+          });
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ export declare const rules: {
     'ensure-atlassian-team': import("eslint").Rule.RuleModule;
     'ensure-critical-dependency-resolutions': import("eslint").Rule.RuleModule;
     'ensure-valid-workspace-protocol-usage': import("eslint").Rule.RuleModule;
+    'ensure-valid-bin-values': import("eslint").Rule.RuleModule;
     'no-duplicate-dependencies': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;
     'no-pre-post-install-scripts': import("eslint").Rule.RuleModule;
@@ -20,6 +21,7 @@ export declare const rules: {
     'inline-usage': import("eslint").Rule.RuleModule;
     'prefer-fg': import("eslint").Rule.RuleModule;
     'no-alias': import("eslint").Rule.RuleModule;
+    'use-entrypoints-in-examples': import("eslint").Rule.RuleModule;
     'use-recommended-utils': import("eslint").Rule.RuleModule;
 };
 export declare const configs: {

package/dist/types/rules/ensure-valid-bin-values/index.d.ts

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

package/dist/types/rules/use-entrypoints-in-examples/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

@@ -7,6 +7,7 @@ export declare const rules: {
     'ensure-atlassian-team': import("eslint").Rule.RuleModule;
     'ensure-critical-dependency-resolutions': import("eslint").Rule.RuleModule;
     'ensure-valid-workspace-protocol-usage': import("eslint").Rule.RuleModule;
+    'ensure-valid-bin-values': import("eslint").Rule.RuleModule;
     'no-duplicate-dependencies': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;
     'no-pre-post-install-scripts': import("eslint").Rule.RuleModule;
@@ -20,6 +21,7 @@ export declare const rules: {
     'inline-usage': import("eslint").Rule.RuleModule;
     'prefer-fg': import("eslint").Rule.RuleModule;
     'no-alias': import("eslint").Rule.RuleModule;
+    'use-entrypoints-in-examples': import("eslint").Rule.RuleModule;
     'use-recommended-utils': import("eslint").Rule.RuleModule;
 };
 export declare const configs: {

package/dist/types-ts4.5/rules/ensure-valid-bin-values/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/rules/use-entrypoints-in-examples/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.8.0",
+	"version": "0.10.0",
 	"author": "Atlassian Pty Ltd",
 	"atlassian": {
 		"team": "UIP Dev Infra",

package/src/index.tsx

@@ -10,6 +10,7 @@ import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import ensureCriticalDependencyResolutions from './rules/ensure-critical-dependency-resolutions';
 import ensureValidWorkspaceProtocolUsage from './rules/ensure-valid-workspace-protocol-usage';
+import ensureValidBinValues from './rules/ensure-valid-bin-values';
 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';
@@ -20,6 +21,7 @@ import noPreconditioning from './rules/no-preconditioning';
 import inlineUsage from './rules/inline-usage';
 import preferFG from './rules/prefer-fg';
 import noAlias from './rules/no-alias';
+import useEntrypointsInExamples from './rules/use-entrypoints-in-examples';
 import useRecommendedUtils from './rules/use-recommended-utils';
 
 export const rules = {
@@ -30,6 +32,7 @@ export const rules = {
 	'ensure-atlassian-team': ensureAtlassianTeam,
 	'ensure-critical-dependency-resolutions': ensureCriticalDependencyResolutions,
 	'ensure-valid-workspace-protocol-usage': ensureValidWorkspaceProtocolUsage,
+	'ensure-valid-bin-values': ensureValidBinValues,
 	'no-duplicate-dependencies': noDuplicateDependencies,
 	'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
 	'no-pre-post-install-scripts': noPreAndPostInstallScripts,
@@ -43,6 +46,7 @@ export const rules = {
 	'inline-usage': inlineUsage,
 	'prefer-fg': preferFG,
 	'no-alias': noAlias,
+	'use-entrypoints-in-examples': useEntrypointsInExamples,
 	'use-recommended-utils': useRecommendedUtils,
 };
 

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

@@ -0,0 +1,158 @@
+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((stat: string) => ({
+			isFile: jest.fn(() => mockValidBinPaths.includes(stat)),
+		})),
+	};
+});
+
+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

@@ -0,0 +1,70 @@
+// 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;

package/src/rules/use-entrypoints-in-examples/README.md

@@ -0,0 +1,27 @@
+Using public entrypoints in our examples ensures that they reflect public API.
+
+It also has benefits for:
+
+- readability
+- bundle and code analysis
+
+## Examples
+
+This rule marks imports as violations when they reach into the `src` folder through relative file
+paths.
+
+### Incorrect
+
+```js
+import Button from '../../../src';
+
+import { IconButton } from '../../../src/new';
+```
+
+### Correct
+
+```js
+import Button from '@atlaskit/button';
+
+import { ExampleHelper } from '../not-src';
+```

package/src/rules/use-entrypoints-in-examples/__tests__/rule.test.tsx

@@ -0,0 +1,34 @@
+import { tester } from '../../../__tests__/utils/_tester';
+import rule from '../index';
+
+const exampleFilename = 'packages/design-system/button/examples/0-basic.tsx';
+const nonExampleFilename = 'packages/design-system/button/scripts/my-script.tsx';
+
+tester.run('use-entrypoints-in-examples', rule, {
+	valid: [
+		{
+			code: `import Button from '@atlaskit/button';`,
+			filename: exampleFilename,
+		},
+		{
+			code: `import { ExampleHelper } from '../not-src';`,
+			filename: exampleFilename,
+		},
+		{
+			code: `import Button from '../src';`,
+			filename: nonExampleFilename,
+		},
+	],
+	invalid: [
+		{
+			code: `import Button from '../../../src';`,
+			filename: exampleFilename,
+			errors: [{ messageId: 'useEntrypointsInExamples' }],
+		},
+		{
+			code: `import { IconButton } from '../../../src/new';`,
+			filename: exampleFilename,
+			errors: [{ messageId: 'useEntrypointsInExamples' }],
+		},
+	],
+});

package/src/rules/use-entrypoints-in-examples/index.tsx

@@ -0,0 +1,43 @@
+import type { Rule } from 'eslint';
+
+const rule: Rule.RuleModule = {
+	meta: {
+		docs: {
+			url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/use-entrypoints-in-examples/README.md',
+			description: 'Encourage usage of package entrypoints in examples.',
+		},
+		messages: {
+			useEntrypointsInExamples:
+				'Use the package entrypoints instead of importing from src. This ensures examples reflect public API.\n\nFor example, use `@atlaskit/button/new` instead of `../../src/new`',
+		},
+		type: 'problem',
+	},
+	create(context) {
+		/**
+		 * Even if it's enabled on non-example files it will ignore them.
+		 *
+		 * This is a defensive check, the rule should be configured to only run on examples.
+		 */
+		if (!context.filename.includes('/examples/')) {
+			return {};
+		}
+
+		return {
+			ImportDeclaration(node) {
+				const moduleName = node.source.value;
+				if (typeof moduleName !== 'string') {
+					return;
+				}
+
+				if (/^(\.\.\/)+src(\/|$)/.test(moduleName)) {
+					context.report({
+						node: node.source,
+						messageId: 'useEntrypointsInExamples',
+					});
+				}
+			},
+		};
+	},
+};
+
+export default rule;