@atlaskit/eslint-plugin-platform 0.6.1 → 0.7.0

package/dist/types-ts4.5/rules/util/registration-utils.d.ts

@@ -3,6 +3,7 @@ import Fuse from 'fuse.js';
 export declare const getterIdentifierToFlagTypeMap: {
     readonly getBooleanFF: "boolean";
     readonly ffTest: "boolean";
+    readonly fg: "boolean";
 };
 export type PlatformFeatureFlagRegistrationSection = {
     [key: string]: {

package/dist/types-ts4.5/rules/utils.d.ts

@@ -0,0 +1,7 @@
+import type { Rule, Scope } from 'eslint';
+export declare function isIdentifierImportedFrom(identifierName: string, sources: Set<string>, context: Rule.RuleContext): boolean;
+export declare function isAPIimport(functionName: string, context: Rule.RuleContext): boolean;
+export declare function getDef(name: string, context: Rule.RuleContext): Scope.Definition | null | undefined;
+export type Node<T extends Rule.Node['type']> = Extract<Rule.Node, {
+    type: T;
+}>;

package/index.js

@@ -6,19 +6,19 @@ const path = require('path');
 const paths = require('tsconfig-paths');
 
 if (!require.extensions['.ts']) {
-  // ts-node can only handle being registered once, see https://github.com/TypeStrong/ts-node/issues/409
-  require('ts-node').register({
-    project: path.join(__dirname, 'tsconfig.json'),
-  });
+	// ts-node can only handle being registered once, see https://github.com/TypeStrong/ts-node/issues/409
+	require('ts-node').register({
+		project: path.join(__dirname, 'tsconfig.json'),
+	});
 }
 
 try {
-  // We programatically register tsconfig paths here so it picks up the tsconfig here
-  // instead of in root CWD.
-  paths.register(paths.loadConfig(__dirname));
+	// We programatically register tsconfig paths here so it picks up the tsconfig here
+	// instead of in root CWD.
+	paths.register(paths.loadConfig(__dirname));
 } catch (e) {
-  // eslint-disable-next-line no-console
-  console.log(e);
+	// eslint-disable-next-line no-console
+	console.log(e);
 }
 
 module.exports = require('./src/index');

package/package.json

@@ -1,45 +1,44 @@
 {
-  "name": "@atlaskit/eslint-plugin-platform",
-  "description": "The essential plugin for use with Atlassian frontend platform tools",
-  "version": "0.6.1",
-  "author": "Atlassian Pty Ltd",
-  "atlassian": {
-    "team": "UIP - Platform Integration Trust (PITa)",
-    "releaseModel": "continuous",
-    "inPublicMirror": true
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "module:es2019": "dist/es2019/index.js",
-  "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.5 <4.9": {
-      "*": [
-        "dist/types-ts4.5/*",
-        "dist/types-ts4.5/index.d.ts"
-      ]
-    }
-  },
-  "sideEffects": false,
-  "atlaskit:src": "src/index.tsx",
-  "af:exports": {
-    ".": "./src/index.tsx"
-  },
-  "dependencies": {
-    "@babel/runtime": "^7.0.0",
-    "@manypkg/find-root": "^1.1.0",
-    "fuse.js": "^6.6.2",
-    "read-pkg-up": "^7.0.1"
-  },
-  "devDependencies": {
-    "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
-    "@types/eslint": "^8.4.5",
-    "eslint": "^8.49.0",
-    "tsconfig-paths": "^4.2.0"
-  },
-  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
-}
+	"name": "@atlaskit/eslint-plugin-platform",
+	"description": "The essential plugin for use with Atlassian frontend platform tools",
+	"version": "0.7.0",
+	"author": "Atlassian Pty Ltd",
+	"atlassian": {
+		"team": "UIP - Platform Integration Trust (PITa)",
+		"releaseModel": "continuous",
+		"inPublicMirror": true
+	},
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": false,
+	"atlaskit:src": "src/index.tsx",
+	"af:exports": {
+		".": "./src/index.tsx"
+	},
+	"dependencies": {
+		"@babel/runtime": "^7.0.0",
+		"@manypkg/find-root": "^1.1.0",
+		"fuse.js": "^6.6.2",
+		"read-pkg-up": "^7.0.1"
+	},
+	"devDependencies": {
+		"@types/eslint": "^8.56.6",
+		"eslint": "^8.49.0",
+		"outdent": "^0.5.0",
+		"tsconfig-paths": "^4.2.0"
+	}
+}

package/report.api.md

@@ -2,7 +2,8 @@
 
 ## API Report File for "@atlaskit/eslint-plugin-platform"
 
-> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using
+> [API Extractor](https://api-extractor.com/).
 > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ### Table of contents
@@ -20,43 +21,43 @@ import { Rule } from 'eslint';
 
 // @public (undocumented)
 export const configs: {
-  recommended: {
-    plugins: string[];
-    rules: {
-      '@atlaskit/platform/ensure-feature-flag-registration': string;
-      '@atlaskit/platform/ensure-feature-flag-prefix': (
-        | string
-        | {
-            allowedPrefixes: string[];
-          }
-      )[];
-      '@atlaskit/platform/ensure-test-runner-arguments': string;
-      '@atlaskit/platform/ensure-test-runner-nested-count': string;
-      '@atlaskit/platform/no-invalid-feature-flag-usage': string;
-      '@atlaskit/platform/no-invalid-storybook-decorator-usage': string;
-      '@atlaskit/platform/ensure-atlassian-team': string;
-    };
-  };
+	recommended: {
+		plugins: string[];
+		rules: {
+			'@atlaskit/platform/ensure-feature-flag-registration': string;
+			'@atlaskit/platform/ensure-feature-flag-prefix': (
+				| string
+				| {
+						allowedPrefixes: string[];
+				  }
+			)[];
+			'@atlaskit/platform/ensure-test-runner-arguments': string;
+			'@atlaskit/platform/ensure-test-runner-nested-count': string;
+			'@atlaskit/platform/no-invalid-feature-flag-usage': string;
+			'@atlaskit/platform/no-invalid-storybook-decorator-usage': string;
+			'@atlaskit/platform/ensure-atlassian-team': string;
+		};
+	};
 };
 
 // @public (undocumented)
 export const processors: {
-  'package-json-processor': Linter.Processor<Linter.ProcessorFile | string>;
+	'package-json-processor': Linter.Processor<Linter.ProcessorFile | string>;
 };
 
 // @public (undocumented)
 export const rules: {
-  'ensure-feature-flag-registration': Rule.RuleModule;
-  'ensure-feature-flag-prefix': Rule.RuleModule;
-  'ensure-test-runner-arguments': Rule.RuleModule;
-  'ensure-test-runner-nested-count': Rule.RuleModule;
-  'ensure-atlassian-team': Rule.RuleModule;
-  'ensure-critical-dependency-resolutions': Rule.RuleModule;
-  'no-duplicate-dependencies': Rule.RuleModule;
-  'no-invalid-feature-flag-usage': Rule.RuleModule;
-  'no-pre-post-install-scripts': Rule.RuleModule;
-  'no-invalid-storybook-decorator-usage': Rule.RuleModule;
-  'ensure-publish-valid': Rule.RuleModule;
+	'ensure-feature-flag-registration': Rule.RuleModule;
+	'ensure-feature-flag-prefix': Rule.RuleModule;
+	'ensure-test-runner-arguments': Rule.RuleModule;
+	'ensure-test-runner-nested-count': Rule.RuleModule;
+	'ensure-atlassian-team': Rule.RuleModule;
+	'ensure-critical-dependency-resolutions': Rule.RuleModule;
+	'no-duplicate-dependencies': Rule.RuleModule;
+	'no-invalid-feature-flag-usage': Rule.RuleModule;
+	'no-pre-post-install-scripts': Rule.RuleModule;
+	'no-invalid-storybook-decorator-usage': Rule.RuleModule;
+	'ensure-publish-valid': Rule.RuleModule;
 };
 
 // (No @packageDocumentation comment for this package)

package/src/__tests__/utils/_tester.tsx

@@ -3,24 +3,24 @@
 import { RuleTester } from 'eslint';
 
 (RuleTester as any).describe = (text: string, method: Function) => {
-  const origHasAssertions = expect.hasAssertions;
-  describe(text, () => {
-    beforeAll(() => {
-      // Stub out expect.hasAssertions beforeEach from jest-presetup.js
-      expect.hasAssertions = () => {};
-    });
-    afterAll(() => {
-      expect.hasAssertions = origHasAssertions;
-    });
+	const origHasAssertions = expect.hasAssertions;
+	describe(text, () => {
+		beforeAll(() => {
+			// Stub out expect.hasAssertions beforeEach from jest-presetup.js
+			expect.hasAssertions = () => {};
+		});
+		afterAll(() => {
+			expect.hasAssertions = origHasAssertions;
+		});
 
-    method();
-  });
+		method();
+	});
 };
 
 export const tester = new RuleTester({
-  parser: require.resolve('@babel/eslint-parser'),
-  parserOptions: {
-    ecmaVersion: 6,
-    sourceType: 'module',
-  },
+	parser: require.resolve('@babel/eslint-parser'),
+	parserOptions: {
+		ecmaVersion: 6,
+		sourceType: 'module',
+	},
 });

package/src/index.tsx

@@ -9,69 +9,120 @@ import noDuplicateDependencies from './rules/no-duplicate-dependencies';
 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 ensureValidEmotionCssProp from './rules/ensure-valid-emotion-css-prop';
 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';
+import noModuleLevelEval from './rules/no-module-level-eval';
+import staticFeatureFlags from './rules/static-feature-flags';
+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 useRecommendedUtils from './rules/use-recommended-utils';
 
 export const rules = {
-  'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
-  'ensure-feature-flag-prefix': ensureFeatureFlagPrefix,
-  'ensure-test-runner-arguments': ensureTestRunnerArguments,
-  'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
-  'ensure-atlassian-team': ensureAtlassianTeam,
-  'ensure-critical-dependency-resolutions': ensureCriticalDependencyResolutions,
-  'no-duplicate-dependencies': noDuplicateDependencies,
-  'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
-  'no-pre-post-install-scripts': noPreAndPostInstallScripts,
-  'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
-  'ensure-publish-valid': ensurePublishValid,
-  'ensure-native-and-af-exports-synced': ensureNativeAndAfExportsSynced,
+	'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
+	'ensure-feature-flag-prefix': ensureFeatureFlagPrefix,
+	'ensure-test-runner-arguments': ensureTestRunnerArguments,
+	'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
+	'ensure-atlassian-team': ensureAtlassianTeam,
+	'ensure-critical-dependency-resolutions': ensureCriticalDependencyResolutions,
+	'ensure-valid-emotion-css-prop': ensureValidEmotionCssProp,
+	'no-duplicate-dependencies': noDuplicateDependencies,
+	'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
+	'no-pre-post-install-scripts': noPreAndPostInstallScripts,
+	'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
+	'ensure-publish-valid': ensurePublishValid,
+	'ensure-native-and-af-exports-synced': ensureNativeAndAfExportsSynced,
+	'no-module-level-eval': noModuleLevelEval,
+	'static-feature-flags': staticFeatureFlags,
+	'no-preconditioning': noPreconditioning,
+	'inline-usage': inlineUsage,
+	'prefer-fg': preferFG,
+	'no-alias': noAlias,
+	'use-recommended-utils': useRecommendedUtils,
 };
 
 export const configs = {
-  recommended: {
-    plugins: ['@atlaskit/platform'],
-    rules: {
-      '@atlaskit/platform/ensure-feature-flag-registration': 'error',
-      '@atlaskit/platform/ensure-feature-flag-prefix': [
-        'error',
-        { allowedPrefixes: ['platform.'] },
-      ],
-      '@atlaskit/platform/ensure-test-runner-arguments': 'error',
-      '@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
-      '@atlaskit/platform/no-invalid-feature-flag-usage': 'error',
-      '@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error',
-      '@atlaskit/platform/ensure-atlassian-team': 'error',
-    },
-  },
+	recommended: {
+		plugins: ['@atlaskit/platform'],
+		rules: {
+			'@atlaskit/platform/ensure-feature-flag-registration': 'error',
+			'@atlaskit/platform/ensure-feature-flag-prefix': [
+				'error',
+				{ allowedPrefixes: ['platform.'] },
+			],
+			'@atlaskit/platform/ensure-test-runner-arguments': 'error',
+			'@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
+			'@atlaskit/platform/no-invalid-feature-flag-usage': 'error',
+			'@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error',
+			'@atlaskit/platform/ensure-atlassian-team': 'error',
+			'@atlaskit/platform/no-module-level-eval': 'error',
+			'@atlaskit/platform/static-feature-flags': 'error',
+			'@atlaskit/platform/no-preconditioning': 'error',
+			'@atlaskit/platform/inline-usage': 'error',
+			'@atlaskit/platform/prefer-fg': 'error',
+			'@atlaskit/platform/no-alias': 'error',
+		},
+	},
 };
 
 const jsonPrefix =
-  '/* eslint-disable quote-props, comma-dangle, quotes, semi, eol-last, @typescript-eslint/semi, no-template-curly-in-string */ module.exports = ';
+	'/* eslint-disable quote-props, comma-dangle, quotes, semi, eol-last, @typescript-eslint/semi, no-template-curly-in-string */ module.exports = ';
+
+const jsonPrefixForFlatConfig =
+	'/* eslint-disable quote-props, comma-dangle, quotes, semi, eol-last, no-template-curly-in-string */ module.exports = ';
 
 export const processors = {
-  'package-json-processor': {
-    preprocess: (source: string) => {
-      // augment the json into a js file
-      return [jsonPrefix + source.trim()];
-    },
-    postprocess: (messages) => {
-      return messages[0].map((message) => {
-        const { fix } = message;
-        if (!fix) {
-          return message;
-        }
+	'package-json-processor': {
+		preprocess: (source: string) => {
+			// augment the json into a js file
+			return [jsonPrefix + source.trim()];
+		},
+		postprocess: (messages) => {
+			return messages[0].map((message) => {
+				const { fix } = message;
+				if (!fix) {
+					return message;
+				}
+
+				const offset = jsonPrefix.length;
+				return {
+					...message,
+					fix: {
+						...fix,
+						range: [fix.range[0] - offset, fix.range[1] - offset],
+					},
+				};
+			});
+		},
+		supportsAutofix: true,
+	} as Linter.Processor,
+	// This processor is used for ESLint FlatConfig,
+	// once we roll out FlatConfig, we can remove the above processor
+	'package-json-processor-for-flat-config': {
+		preprocess: (source: string) => {
+			// augment the json into a js file
+			return [jsonPrefixForFlatConfig + source.trim()];
+		},
+		postprocess: (messages) => {
+			return messages[0].map((message) => {
+				const { fix } = message;
+				if (!fix) {
+					return message;
+				}
 
-        const offset = jsonPrefix.length;
-        return {
-          ...message,
-          fix: {
-            ...fix,
-            range: [fix.range[0] - offset, fix.range[1] - offset],
-          },
-        };
-      });
-    },
-    supportsAutofix: true,
-  } as Linter.Processor,
+				const offset = jsonPrefixForFlatConfig.length;
+				return {
+					...message,
+					fix: {
+						...fix,
+						range: [fix.range[0] - offset, fix.range[1] - offset],
+					},
+				};
+			});
+		},
+		supportsAutofix: true,
+	} as Linter.Processor,
 };

package/src/rules/constants.tsx

@@ -0,0 +1,20 @@
+// List of libraries that we maintain or have worked on
+// - eg `@atlaskit/feature-gate-js-client` shouldn't be included in here
+export const FEATURE_API_IMPORT_SOURCES = new Set([
+	'@atlassian/jira-feature-flagging',
+	'@atlassian/jira-feature-flagging-using-meta',
+	'@atlassian/jira-feature-gating',
+	'@atlassian/jira-feature-experiments',
+	'@atlaskit/platform-feature-flags',
+]);
+
+export const FEATURE_MOCKS_IMPORT_SOURCES = new Set([
+	'@atlassian/jira-feature-flagging-mocks',
+	'@atlassian/jira-feature-gates-test-mocks',
+	'@atlassian/jira-feature-gates-storybook-mocks',
+]);
+
+export const FEATURE_UTILS_IMPORT_SOURCES = new Set([
+	'@atlassian/jira-feature-flagging-utils',
+	'@atlassian/jira-feature-gate-component',
+]);

package/src/rules/ensure-atlassian-team/__tests__/unit/rule.test.ts

@@ -2,23 +2,23 @@ import { tester } from '../../../../__tests__/utils/_tester';
 import rule from '../../index';
 
 describe('test no-pre-post-installs rule', () => {
-  tester.run('no-pre-post-installs', rule, {
-    valid: [
-      {
-        code: `const foo = {}`,
-        filename: 'package.json',
-      },
-      {
-        code: `const foo = { "atlassian": { "team": "bar" } }`,
-        filename: 'foo/package.json',
-      },
-    ],
-    invalid: [
-      {
-        code: `const foo = { "atlassian": {} }`,
-        filename: 'foo/package.json',
-        errors: [{ messageId: 'atlassianTeamRequired' }],
-      },
-    ],
-  });
+	tester.run('no-pre-post-installs', rule, {
+		valid: [
+			{
+				code: `const foo = {}`,
+				filename: 'package.json',
+			},
+			{
+				code: `const foo = { "atlassian": { "team": "bar" } }`,
+				filename: 'foo/package.json',
+			},
+		],
+		invalid: [
+			{
+				code: `const foo = { "atlassian": {} }`,
+				filename: 'foo/package.json',
+				errors: [{ messageId: 'atlassianTeamRequired' }],
+			},
+		],
+	});
 });

package/src/rules/ensure-atlassian-team/index.ts

@@ -2,63 +2,50 @@
 import type { Rule } from 'eslint';
 
 const rule: Rule.RuleModule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description:
-        'This rule ensures that the internal packages have a responsible team attached.',
-      recommended: true,
-    },
-    hasSuggestions: false,
-    messages: {
-      atlassianTeamRequired: 'The atlassian.team property is required',
-    },
-  },
-  create(context) {
-    return {
-      ObjectExpression: (node: Rule.Node) => {
-        if (
-          !context.getFilename().endsWith('package.json') ||
-          node.type !== 'ObjectExpression'
-        ) {
-          return;
-        }
+	meta: {
+		type: 'problem',
+		docs: {
+			description: 'This rule ensures that the internal packages have a responsible team attached.',
+			recommended: true,
+		},
+		hasSuggestions: false,
+		messages: {
+			atlassianTeamRequired: 'The atlassian.team property is required',
+		},
+	},
+	create(context) {
+		return {
+			ObjectExpression: (node: Rule.Node) => {
+				if (!context.getFilename().endsWith('package.json') || node.type !== 'ObjectExpression') {
+					return;
+				}
 
-        const atlassianProp = node.properties.find(
-          (p) =>
-            p.type === 'Property' &&
-            p.key.type === 'Literal' &&
-            p.key.value === 'atlassian',
-        );
+				const atlassianProp = node.properties.find(
+					(p) => p.type === 'Property' && p.key.type === 'Literal' && p.key.value === 'atlassian',
+				);
 
-        if (!atlassianProp) {
-          return;
-        }
+				if (!atlassianProp) {
+					return;
+				}
 
-        if (
-          atlassianProp.type !== 'Property' ||
-          atlassianProp.value.type !== 'ObjectExpression'
-        ) {
-          return;
-        }
+				if (atlassianProp.type !== 'Property' || atlassianProp.value.type !== 'ObjectExpression') {
+					return;
+				}
 
-        const teamProp = atlassianProp.value.properties.find(
-          (p) =>
-            p.type === 'Property' &&
-            p.key.type === 'Literal' &&
-            p.key.value === 'team',
-        );
+				const teamProp = atlassianProp.value.properties.find(
+					(p) => p.type === 'Property' && p.key.type === 'Literal' && p.key.value === 'team',
+				);
 
-        // this just checks for existence, we can potentially cross-reference it with teams.json to make sure its valid in the future.
-        if (!teamProp) {
-          return context.report({
-            node,
-            messageId: 'atlassianTeamRequired',
-          });
-        }
-      },
-    };
-  },
+				// this just checks for existence, we can potentially cross-reference it with teams.json to make sure its valid in the future.
+				if (!teamProp) {
+					return context.report({
+						node,
+						messageId: 'atlassianTeamRequired',
+					});
+				}
+			},
+		};
+	},
 };
 
 export default rule;