@atlaskit/eslint-plugin-platform 2.6.0 → 2.7.1

package/src/index.tsx

@@ -1,251 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import compiledPlugin from '@compiled/eslint-plugin';
-import type { ESLint, Linter } from 'eslint';
-import ensureFeatureFlagRegistration from './rules/ensure-feature-flag-registration';
-import noPreAndPostInstallScripts from './rules/no-pre-post-installs';
-import ensureTestRunnerArguments from './rules/ensure-test-runner-arguments';
-import ensureTestRunnerNestedCount from './rules/ensure-test-runner-nested-count';
-import ensureAtlassianTeam from './rules/ensure-atlassian-team';
-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 ensureValidPlatformYarnProtocolUsage from './rules/ensure-valid-platform-yarn-protocol-usage';
-import ensureValidBinValues from './rules/ensure-valid-bin-values';
-import ensureNoPrivateDependencies from './rules/ensure-no-private-dependencies';
-import expandBorderShorthand from './rules/compiled/expand-border-shorthand';
-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/feature-gating/no-module-level-eval';
-import noModuleLevelEvalNav4 from './rules/feature-gating/no-module-level-eval-nav4';
-import staticFeatureFlags from './rules/feature-gating/static-feature-flags';
-import noPreconditioning from './rules/feature-gating/no-preconditioning';
-import inlineUsage from './rules/feature-gating/inline-usage';
-import preferFG from './rules/feature-gating/prefer-fg';
-import noAlias from './rules/feature-gating/no-alias';
-import useEntrypointsInExamples from './rules/use-entrypoints-in-examples';
-import useRecommendedUtils from './rules/feature-gating/use-recommended-utils';
-import expandBackgroundShorthand from './rules/compiled/expand-background-shorthand';
-import expandSpacingShorthand from './rules/compiled/expand-spacing-shorthand';
-import noSparseCheckout from './rules/no-sparse-checkout';
-import noDirectDocumentUsage from './rules/no-direct-document-usage';
-import { join, normalize } from 'node:path';
-import { readFileSync } from 'node:fs';
-
-let jiraRoot: string | undefined;
-
-try {
-	const findUp = require('find-up') as typeof import('find-up');
-	findUp.sync((dir) => {
-		const productsJsonPath = join(dir, 'products.json');
-		if (findUp.sync.exists(productsJsonPath)) {
-			const productJson: Record<string, { path: string }> = JSON.parse(
-				readFileSync(productsJsonPath, 'utf-8'),
-			);
-			if (productJson.Jira) {
-				jiraRoot = normalize(join(dir, productJson.Jira.path));
-				return findUp.stop;
-			}
-		}
-	});
-} catch {
-	// we aren't running inside of AFM, so we can ignore this.
-}
-
-const packageJson: {
-	name: string;
-	version: string;
-	// eslint-disable-next-line import/no-extraneous-dependencies
-} = require('@atlaskit/eslint-plugin-platform/package.json');
-
-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,
-	'ensure-valid-platform-yarn-protocol-usage': ensureValidPlatformYarnProtocolUsage,
-	'ensure-valid-bin-values': ensureValidBinValues,
-	'ensure-no-private-dependencies': ensureNoPrivateDependencies,
-	'expand-border-shorthand': expandBorderShorthand,
-	'expand-background-shorthand': expandBackgroundShorthand,
-	'expand-spacing-shorthand': expandSpacingShorthand,
-	'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,
-	'no-module-level-eval-nav4': noModuleLevelEvalNav4,
-	'static-feature-flags': staticFeatureFlags,
-	'no-preconditioning': noPreconditioning,
-	'inline-usage': inlineUsage,
-	'prefer-fg': preferFG,
-	'no-alias': noAlias,
-	'use-entrypoints-in-examples': useEntrypointsInExamples,
-	'use-recommended-utils': useRecommendedUtils,
-	'no-sparse-checkout': noSparseCheckout,
-	'no-direct-document-usage': noDirectDocumentUsage,
-};
-
-const commonConfig = {
-	'@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-nav4': 'error',
-	'@atlaskit/platform/no-direct-document-usage': 'warn',
-	// Compiled: rules that are not included via `@compiled/recommended
-	'@atlaskit/platform/expand-border-shorthand': 'error',
-	'@atlaskit/platform/expand-background-shorthand': 'error',
-	'@atlaskit/platform/expand-spacing-shorthand': 'error',
-	'@compiled/jsx-pragma': [
-		'error',
-		{
-			importSources: ['@atlaskit/css'],
-			onlyRunIfImportingCompiled: true,
-			runtime: 'classic',
-		},
-	],
-} satisfies Linter.RulesRecord;
-
-const recommendedRules = {
-	...commonConfig,
-	// See platform/packages/platform/eslint-plugin/src/rules/feature-gating/README.md
-	// These rules are specific to `platform` and seem a WIP; jira and confluence currently have their own rules
-	'@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',
-	// end: feature-gating rules
-	'@atlaskit/platform/ensure-feature-flag-registration': 'error',
-	'@atlaskit/platform/ensure-feature-flag-prefix': [
-		'warn',
-		{ allowedPrefixes: ['platform.', 'platform_'] },
-	],
-} satisfies Linter.RulesRecord;
-
-const jiraRules = commonConfig;
-
-const jsonPrefix =
-	'/* 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 = ';
-
-const jsonPrefixForJira = 'module.exports = ';
-
-const { name, version } = packageJson;
-const plugin = {
-	meta: {
-		name,
-		version,
-	},
-	rules,
-	configs: {
-		recommended: {
-			plugins: ['@atlaskit/platform', '@compiled'],
-			rules: recommendedRules,
-		},
-		'recommended/flat': {
-			plugins: {
-				get '@atlaskit/platform'(): ESLint.Plugin {
-					return plugin;
-				},
-				// @ts-expect-error there's an issue with the types for @compiled/eslint-plugin ('no-css-prop-without-css-function' specifically)
-				'@compiled': { meta: compiledPlugin.meta, rules: compiledPlugin.rules } as ESLint.Plugin,
-			},
-			rules: recommendedRules,
-		},
-		jira: {
-			plugins: ['@atlaskit/platform', '@compiled'],
-			rules: jiraRules,
-		},
-		'jira/flat': {
-			plugins: {
-				get '@atlaskit/platform'(): ESLint.Plugin {
-					return plugin;
-				},
-				// @ts-expect-error there's an issue with the types for @compiled/eslint-plugin ('no-css-prop-without-css-function' specifically)
-				'@compiled': { meta: compiledPlugin.meta, rules: compiledPlugin.rules } as ESLint.Plugin,
-			},
-			rules: jiraRules,
-		},
-	},
-	processors: {
-		'package-json-processor': {
-			preprocess: (source, filename) => {
-				// we only need to check for jiraRoot because it uses a different
-				// ESLint version and produces fake errors due to how this processor handles JSON
-				if (jiraRoot && filename.startsWith(jiraRoot)) {
-					// augment the json into a js file
-					return [jsonPrefixForJira + source.trim()];
-				}
-
-				// 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': {
-			// we only need to check for jiraRoot because it uses a different
-			// ESLint version and produces fake errors due to how this processor handles JSON
-			preprocess: (source, filename) => {
-				if (jiraRoot && filename.startsWith(jiraRoot)) {
-					// augment the json into a js file
-					return [jsonPrefixForJira + source.trim()];
-				}
-				// 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 = jsonPrefixForFlatConfig.length;
-					return {
-						...message,
-						fix: {
-							...fix,
-							range: [fix.range[0] - offset, fix.range[1] - offset],
-						},
-					};
-				});
-			},
-			supportsAutofix: true,
-		} as Linter.Processor,
-	},
-} satisfies ESLint.Plugin;
-const configs = plugin.configs;
-const processors = plugin.processors;
-
-export { configs, plugin, processors, rules };
-export default plugin;

package/src/rules/compiled/README.md

@@ -1,3 +0,0 @@
-# Atlassian platform ESLint Plugin > Compiled rules
-
-TODO

package/src/rules/compiled/expand-background-shorthand/README.md

@@ -1,23 +0,0 @@
-# `expand-background-shorthand`
-
-This ESLint rule enforces the expansion of the CSS `background` shorthand property into
-its longhand equivalent `backgroundColor`, where the `background`'s value is an Atlassian
-Design System color token and the function call originates from `@compiled/react` or `@atlaskit/css`.
-
-## Rule details
-
-👎 Examples of **incorrect** code for this rule:
-
-```js
-const styles = css({
-	background: token('color.background.neutral.hovered'),
-});
-```
-
-👍 Examples of **correct** code for this rule:
-
-```js
-const styles = css({
-	backgroundColor: token('color.background.neutral.hovered'),
-});
-```

package/src/rules/compiled/expand-background-shorthand/__tests__/rule.test.ts

@@ -1,160 +0,0 @@
-import { outdent } from 'outdent';
-import { tester } from '../../../../__tests__/utils/_tester';
-import { expandBackgroundShorthand } from '../index';
-
-const included_packages_calls_and_imports = [
-	['css', 'css', '@atlaskit/css'],
-	['css', 'css', '@compiled/react'],
-	['styled', 'styled.div', '@compiled/react'],
-];
-const exempt_packages_calls_and_imports = [
-	['css', '@atlaskit/primitives'],
-	['css', '@emotion'],
-	['css', 'styled-components'],
-	['xcss', '@atlaskit/primitives'],
-];
-tester.run('expand-background-shorthand', expandBackgroundShorthand, {
-	valid: [
-		...exempt_packages_calls_and_imports.map(([pkg, imp]) => ({
-			name: `do not have to handle non-Compiled packages (${pkg}, ${imp})`,
-			code: outdent`
-			import {${pkg}} from '${imp}';
-			const styles = ${pkg}({
-				background: token('color.background.accent.gray.subtlest')
-			});
-		`,
-		})),
-		{
-			name: 'no background shorthand',
-			code: outdent`
-			import {css} from '@compiled/react';
-			const styles = css({
-				backgroundColor: token('color.background.neutral.hovered'),
-			});
-			const styles2 = css({
-				backgroundColor: token('color.border', colors.N40),
-			});
-			const styles3 = css({
-				backgroundColor: token('color.background.inverse.subtle', '#00000029'),
-			});
-			const styles4 = css({
-				backgroundColor: token('color.background.brand.bold', 'lightblue'),
-			});
-			`,
-		},
-		// Other background shorthands that do not have token is out of scope for now
-		{
-			name: 'background shorthand without token',
-			code: outdent`
-			import {css} from '@compiled/react';
-			const styles = css({
-				background: 'transparent'
-			});
-			const styles2 = css({
-				background: url('image.png')
-			});
-			const styles3 = css({
-				background: 0
-			});
-			`,
-		},
-		// Usages of token within a template string are not used, so ESLint rule does not handle this case
-		{
-			name: 'background shorthand in a template literal as string text',
-			code: outdent`
-			import {css} from '@compiled/react';
-			const styles = css({
-				background: \`token('color.background.brand.bold', 'lightblue')\`,
-			});
-			`,
-		},
-		{
-			name: 'background as key in cssMap call (cssMap, @compiled/react)',
-			code: outdent`
-			import { cssMap } from '@compiled/react';
-			const colorMap = cssMap({
-				background: {
-					color: token('some.token')
-				},
-				foreground: {
-					color: token('some.other.token')
-				},
-			});
-			`,
-		},
-	],
-	invalid: [
-		...included_packages_calls_and_imports.map(([pkg, call, imp]) => ({
-			name: `simple case (${call}, ${imp})`,
-			code: outdent`
-			import {${pkg}} from '${imp}';
-			const styles = ${call}({
-				background: token('color.background.accent.gray.subtlest'),
-			});
-			`,
-			output: outdent`
-			import {${pkg}} from '${imp}';
-			const styles = ${call}({
-				backgroundColor: token('color.background.accent.gray.subtlest'),
-			});
-            `,
-			errors: [{ messageId: 'expandBackgroundShorthand' }],
-		})),
-		{
-			name: `simple case (styled, @compiled/react)`,
-			code: outdent`
-			import { styled } from '@compiled/react';
-			const Button = styled.div({
-				paddingTop: '10px',
-			});
-			const StyledButton = styled(Button)({
-				background: token('elevation.surface', colors.N0),
-			});
-			`,
-			output: outdent`
-			import { styled } from '@compiled/react';
-			const Button = styled.div({
-				paddingTop: '10px',
-			});
-			const StyledButton = styled(Button)({
-				backgroundColor: token('elevation.surface', colors.N0),
-			});
-            `,
-			errors: [{ messageId: 'expandBackgroundShorthand' }],
-		},
-		{
-			name: `simple case (cssMap, @compiled/react)`,
-			code: outdent`
-			import { cssMap } from '@compiled/react';
-			const backgroundMap = cssMap({
-				firstBackground: { background: token('some.token') },
-				secondBackground: { background: token('some.other.token') },
-			});
-			`,
-			output: outdent`
-			import { cssMap } from '@compiled/react';
-			const backgroundMap = cssMap({
-				firstBackground: { backgroundColor: token('some.token') },
-				secondBackground: { backgroundColor: token('some.other.token') },
-			});
-            `,
-			errors: Array.from(Array(2), () => ({ messageId: 'expandBackgroundShorthand' })),
-		},
-		{
-			name: `compiled import with alias`,
-			code: outdent`
-			import { styled as styled2 } from '@compiled/react';
-			const style = styled2.span({
-				background: token('color.background.neutral.subtle', '#fff'),
-			});
-			`,
-			output: outdent`
-			import { styled as styled2 } from '@compiled/react';
-			const style = styled2.span({
-				backgroundColor: token('color.background.neutral.subtle', '#fff'),
-			});
-            `,
-			errors: [{ messageId: 'expandBackgroundShorthand' }],
-		},
-	],
-});

package/src/rules/compiled/expand-background-shorthand/index.tsx

@@ -1,43 +0,0 @@
-import type { Rule } from 'eslint';
-import type { Property, Node } from 'estree';
-import { isCompiledAPI } from '../../util/compiled-utils';
-
-// Checks if node is a call expression with identifier 'token'
-const isTokenCallExpression = (node: Node) => {
-	if (node.type === 'CallExpression') {
-		if (node.callee.type === 'Identifier' && node.callee.name === 'token') {
-			return true;
-		}
-	}
-	return false;
-};
-
-export const expandBackgroundShorthand: Rule.RuleModule = {
-	meta: {
-		docs: {
-			url: 'https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master/platform/packages/platform/eslint-plugin/src/rules/compiled/expand-background-shorthand/',
-		},
-		messages: {
-			expandBackgroundShorthand: 'Use backgroundColor instead of background shorthand',
-		},
-		type: 'problem',
-		fixable: 'code',
-	},
-	create(context) {
-		return {
-			'Property[key.name="background"]': function (node: Property) {
-				if (isCompiledAPI(context, node) && isTokenCallExpression(node.value)) {
-					context.report({
-						node,
-						messageId: 'expandBackgroundShorthand',
-						fix(fixer) {
-							return fixer.replaceText(node.key, `backgroundColor`);
-						},
-					});
-				}
-			},
-		};
-	},
-};
-
-export default expandBackgroundShorthand;

package/src/rules/compiled/expand-border-shorthand/README.md

@@ -1,51 +0,0 @@
-# `shorthand-property-sorting`
-
-This ESLint rule enforces the expansion of CSS `border` shorthand property, into its longhand
-equivalents `borderStyle`, `borderWidth`, `borderColor`, for packages that originates from
-`@compiled/react`, and `@atlaskit/css`.
-
-## Rule details
-
-👎 Examples of **incorrect** code for this rule:
-
-```js
-const styles = css({
-	border: '1px solid black',
-});
-
-const styles = css({
-	border: '1px solid',
-});
-
-const styles = css({
-	border: '1px',
-});
-```
-
-👍 Examples of **correct** code for this rule:
-
-```js
-const styles = css({
-	borderWidth: '1px',
-	borderStyle: 'solid',
-	borderColor: 'black',
-});
-```
-
-```js
-const styles = css({
-	border: '0', // exempted from our ESLint rule
-});
-
-const styles = css({
-	border: 'none', // exempted from our ESLint rule
-});
-
-const styles = css({
-	border: 'unset', // exempted from our ESLint rule
-});
-
-const styles = css({
-	border: 'none !important', // exempted from our ESLint rule
-});
-```