@atlaskit/eslint-plugin-platform 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @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

package/dist/cjs/index.js

@@ -27,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
@@ -52,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/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

@@ -21,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,
@@ -44,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/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

@@ -24,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,
@@ -47,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/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

@@ -21,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/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

@@ -21,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/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.9.0",
+	"version": "0.10.0",
 	"author": "Atlassian Pty Ltd",
 	"atlassian": {
 		"team": "UIP Dev Infra",

package/src/index.tsx

@@ -21,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 = {
@@ -45,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/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;