@atlaskit/eslint-plugin-platform 0.2.4 → 0.2.6

package/dist/esm/rules/util/handle-ast-object.js

@@ -0,0 +1,24 @@
+export var getObjectPropertyAsLiteral = function getObjectPropertyAsLiteral(node, property) {
+  var prop = node.properties.find(function (p) {
+    return p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property;
+  });
+
+  // double check for property is to make typescript happy
+  if ((prop === null || prop === void 0 ? void 0 : prop.type) === 'Property' && (prop === null || prop === void 0 ? void 0 : prop.value.type) === 'Literal') {
+    var _prop$value$value;
+    return (_prop$value$value = prop.value.value) !== null && _prop$value$value !== void 0 ? _prop$value$value : null;
+  }
+  return null;
+};
+export var getObjectPropertyAsObject = function getObjectPropertyAsObject(node, property) {
+  var prop = node.properties.find(function (p) {
+    return p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property;
+  });
+
+  // double check for property is to make typescript happy
+  if ((prop === null || prop === void 0 ? void 0 : prop.type) === 'Property' && (prop === null || prop === void 0 ? void 0 : prop.value.type) === 'ObjectExpression') {
+    var _prop$value;
+    return (_prop$value = prop.value) !== null && _prop$value !== void 0 ? _prop$value : null;
+  }
+  return null;
+};

package/dist/types/index.d.ts

@@ -5,9 +5,11 @@ export declare const rules: {
     'ensure-test-runner-arguments': import("eslint").Rule.RuleModule;
     'ensure-test-runner-nested-count': import("eslint").Rule.RuleModule;
     'ensure-atlassian-team': import("eslint").Rule.RuleModule;
+    'ensure-critical-dependency-resolutions': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;
     '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;
 };
 export declare const configs: {
     recommended: {

package/dist/types/rules/ensure-critical-dependency-resolutions/index.d.ts

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

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

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

package/dist/types/rules/util/handle-ast-object.d.ts

@@ -0,0 +1,3 @@
+import type { ObjectExpression, SimpleLiteral, RegExpLiteral, BigIntLiteral } from 'estree';
+export declare const getObjectPropertyAsLiteral: (node: ObjectExpression, property: string) => SimpleLiteral['value'] | RegExpLiteral['value'] | BigIntLiteral['value'];
+export declare const getObjectPropertyAsObject: (node: ObjectExpression, property: string) => ObjectExpression | null;

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

@@ -5,9 +5,11 @@ export declare const rules: {
     'ensure-test-runner-arguments': import("eslint").Rule.RuleModule;
     'ensure-test-runner-nested-count': import("eslint").Rule.RuleModule;
     'ensure-atlassian-team': import("eslint").Rule.RuleModule;
+    'ensure-critical-dependency-resolutions': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;
     '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;
 };
 export declare const configs: {
     recommended: {

package/dist/types-ts4.5/rules/ensure-critical-dependency-resolutions/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/ensure-publish-valid/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/util/handle-ast-object.d.ts

@@ -0,0 +1,3 @@
+import type { ObjectExpression, SimpleLiteral, RegExpLiteral, BigIntLiteral } from 'estree';
+export declare const getObjectPropertyAsLiteral: (node: ObjectExpression, property: string) => SimpleLiteral['value'] | RegExpLiteral['value'] | BigIntLiteral['value'];
+export declare const getObjectPropertyAsObject: (node: ObjectExpression, property: string) => ObjectExpression | null;

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.2.4",
+  "version": "0.2.6",
   "author": "Atlassian Pty Ltd",
   "atlassian": {
     "team": "UIP - Platform Integration Trust (PITa)",
@@ -31,6 +31,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.0.0",
+    "@manypkg/find-root": "^1.1.0",
     "fuse.js": "^6.6.2",
     "read-pkg-up": "^7.0.1"
   },

package/report.api.md

@@ -51,9 +51,11 @@ export const rules: {
   '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-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/index.tsx

@@ -6,7 +6,9 @@ import ensureTestRunnerNestedCount from './rules/ensure-test-runner-nested-count
 import ensureAtlassianTeam from './rules/ensure-atlassian-team';
 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 noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
+import ensurePublishValid from './rules/ensure-publish-valid';
 
 export const rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
@@ -14,9 +16,11 @@ export const rules = {
   'ensure-test-runner-arguments': ensureTestRunnerArguments,
   'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
   'ensure-atlassian-team': ensureAtlassianTeam,
+  'ensure-critical-dependency-resolutions': ensureCriticalDependencyResolutions,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
   'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
+  'ensure-publish-valid': ensurePublishValid,
 };
 
 export const configs = {

package/src/rules/ensure-critical-dependency-resolutions/__test__/unit/rule.test.tsx

@@ -0,0 +1,125 @@
+import { tester } from '../../../../__tests__/utils/_tester';
+import rule from '../../index';
+
+const cwd = process.cwd();
+
+describe('test ensure-critical-dependency-resolutions rule', () => {
+  tester.run('ensure-critical-dependency-resolutions', rule, {
+    valid: [
+      // Root package.json, have all of the correct resolutions
+      {
+        code: `const foo = {
+            "resolutions": {
+                "@types/react": "16.14.15",
+                "typescript": "4.9.5",
+            }
+        }`,
+        filename: `${cwd}/package.json`,
+      },
+      // Root package.json, have all of the correct resolutions with ~
+      {
+        code: `const foo = {
+            "resolutions": {
+                "@types/react": "~16.14.25",
+                "typescript": "~4.9.8",
+            }
+        }`,
+        filename: `${cwd}/package.json`,
+      },
+      // Individual package's package.json. Have part of correct resolutions
+      {
+        code: `const foo = {
+            "resolutions": {
+                "@types/react": "16.14.15",
+            }
+        }`,
+        filename: `${cwd}/package/name/package.json`,
+      },
+      // Individual package's package.json. Not have relevant package resolutions
+      {
+        code: `const foo = {
+            "resolutions": {
+                "@types/abcd": "1.2.3",
+            }
+        }`,
+        filename: `${cwd}/package/name/package.json`,
+      },
+    ],
+    invalid: [
+      // Root package.json. One package is correct, the other is missing
+      {
+        code: `const foo = {
+                "resolutions": {
+                    "typescript": "~4.9.8",
+                }
+            }`,
+        filename: `${cwd}/package.json`,
+        errors: [
+          {
+            messageId: 'invalidPackageResolution',
+          },
+        ],
+      },
+      // Root package.json. Both packages have the wrong version ranges
+      {
+        code: `const foo = {
+            "resolutions": {
+                "@types/react": "16.8.25",
+                "typescript": "4.5.8",
+            }
+        }`,
+        filename: `${cwd}/package.json`,
+        errors: [
+          {
+            messageId: 'invalidPackageResolution',
+          },
+        ],
+      },
+      // Root package.json. One package is correct, the other has wrong version range
+      {
+        code: `const foo = {
+            "resolutions": {
+                "@types/react": "~16.14.25",
+                "typescript": "~4.5.8",
+            }
+        }`,
+        filename: `${cwd}/package.json`,
+        errors: [
+          {
+            messageId: 'invalidPackageResolution',
+          },
+        ],
+      },
+      // Root package.json. One package is correct, the other has ^ in its version
+      {
+        code: `const foo = {
+            "resolutions": {
+                "@types/react": "~16.14.25",
+                "typescript": "^4.9.5",
+            }
+        }`,
+        filename: `${cwd}/package.json`,
+        errors: [
+          {
+            messageId: 'invalidPackageResolution',
+          },
+        ],
+      },
+      // Individual package's package.json. One package is correct, the other is wrong
+      {
+        code: `const foo = {
+            "resolutions": {
+                "@types/react": "16.14.15",
+                "typescript": "4.5.8",
+            }
+        }`,
+        filename: `${cwd}/packages/packge/directory/package.json`,
+        errors: [
+          {
+            messageId: 'invalidPackageResolution',
+          },
+        ],
+      },
+    ],
+  });
+});

package/src/rules/ensure-critical-dependency-resolutions/index.tsx

@@ -0,0 +1,113 @@
+import { findRootSync } from '@manypkg/find-root';
+import type { Rule } from 'eslint';
+import type { ObjectExpression } from 'estree';
+import { getObjectPropertyAsObject } from '../util/handle-ast-object';
+
+// Here we only need to specify the major and minor versions
+// In matchMinorVersion, we will check if the versions in resolutions fall in the right ranges.
+const DESIRED_PKG_VERSIONS: Record<string, string> = {
+  typescript: '4.9',
+  '@types/react': '16.14',
+};
+
+const matchMinorVersion = (
+  desiredVersion: string,
+  versionInResolutions: string,
+): boolean => {
+  const firstChar = versionInResolutions[0];
+  // The version is invalid if it doesn't start with a number or ~
+  if (!/^\d$/.test(firstChar) && firstChar !== '~') {
+    return false;
+  }
+
+  return (
+    versionInResolutions.startsWith(desiredVersion) ||
+    versionInResolutions.startsWith('~' + desiredVersion)
+  );
+};
+
+const verifyResolutionFromObject = (
+  node: ObjectExpression,
+  pkg: string,
+  version: string,
+  optional: boolean,
+): boolean => {
+  // For root package.json, we require the critical packages' resolutions exist and with matching version
+  // For individual package's package.json, it's ok if resolutions don't exist. But if they do, the version should match
+  const resolutionExist = node.properties.some(
+    (p) =>
+      p.type === 'Property' && p.key.type === 'Literal' && p.key.value === pkg,
+  );
+
+  if (!resolutionExist) {
+    return optional;
+  }
+
+  const resolutionExistAndMatch = node.properties.some(
+    (p) =>
+      p.type === 'Property' &&
+      p.key.type === 'Literal' &&
+      p.key.value === pkg &&
+      p.value.type === 'Literal' &&
+      matchMinorVersion(version, p.value.value as string),
+  );
+
+  return resolutionExistAndMatch;
+};
+
+const rule: Rule.RuleModule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'Enforce the versions of critical packages are within desired ranges by checking resolutions section in package.json',
+      recommended: true,
+    },
+    hasSuggestions: false,
+    messages: {
+      invalidPackageResolution: `Make sure the resolutions for the following packages match major and minor version ranges ${JSON.stringify(
+        DESIRED_PKG_VERSIONS,
+      )}`,
+    },
+  },
+  create(context) {
+    const fileName = context.getFilename();
+    return {
+      ObjectExpression: (node: Rule.Node) => {
+        if (
+          !fileName.endsWith('package.json') ||
+          node.type !== 'ObjectExpression'
+        ) {
+          return;
+        }
+
+        const packageResolutions = getObjectPropertyAsObject(
+          node,
+          'resolutions',
+        );
+        const rootDir = findRootSync(process.cwd());
+        const isRootPackageJson = fileName.endsWith(`${rootDir}/package.json`);
+
+        if (packageResolutions !== null) {
+          for (const [key, value] of Object.entries(DESIRED_PKG_VERSIONS)) {
+            if (
+              !verifyResolutionFromObject(
+                packageResolutions as ObjectExpression,
+                key,
+                value,
+                !isRootPackageJson,
+              )
+            ) {
+              return context.report({
+                node,
+                messageId: 'invalidPackageResolution',
+              });
+            }
+          }
+        }
+      },
+    };
+  },
+};
+
+export default rule;

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

@@ -0,0 +1,41 @@
+import { tester } from '../../../../__tests__/utils/_tester';
+import rule from '../../index';
+
+describe('test ensure-publish-valid-rule', () => {
+  tester.run('ensure-publish-valid', rule, {
+    valid: [
+      {
+        code: `const foo = { "name": "@af/test" }`,
+        filename: 'package.json',
+      },
+      {
+        options: [{ exceptions: ['@atlaskit/test'] }],
+        code: `const foo = { "name": "@atlaskit/test" }`,
+        filename: 'package.json',
+      },
+      {
+        code: `const foo = { "name": "@atlaskit/test", "private": false, "publishConfig": { "registry": "https://registry.npmjs.org/" } }`,
+        filename: 'foo/package.json',
+      },
+    ],
+    invalid: [
+      {
+        code: `const foo = { "name": "@atlaskit/test" }`,
+        filename: 'foo/package.json',
+        errors: [
+          {
+            messageId: 'publishConfigRequired',
+            data: { packageName: '@atlaskit/test' },
+          },
+        ],
+      },
+      {
+        code: `const foo = { "name": "@atlaskit/test", "private": true, "publishConfig": { "registry": "https://registry.npmjs.org/" } }`,
+        filename: 'foo/package.json',
+        errors: [
+          { messageId: 'noPrivate', data: { packageName: '@atlaskit/test' } },
+        ],
+      },
+    ],
+  });
+});

package/src/rules/ensure-publish-valid/index.ts

@@ -0,0 +1,95 @@
+import type { Rule } from 'eslint';
+import {
+  getObjectPropertyAsLiteral,
+  getObjectPropertyAsObject,
+} from '../util/handle-ast-object';
+
+type RuleOptions = {
+  // exceptions to this rule, will be ignored
+  exceptions?: string[];
+};
+
+const rule: Rule.RuleModule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'This rule ensures that the package.json for your packages are set up correctly for publishing depending on the package name prefix',
+      recommended: true,
+    },
+    hasSuggestions: false,
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          exceptions: {
+            type: 'array',
+            items: [{ type: 'string' }],
+          },
+        },
+      },
+    ],
+    messages: {
+      publishConfigRequired:
+        '@atlaskit prefix is public! You have to specify a `publishConfig`, (package {{packageName}}) see https://go.atlassian.com/package-namespace',
+      noPrivate:
+        'setting private to true prevents publishing, your package prefix implies you want to publish! (package {{packageName}}) see https://go.atlassian.com/package-namespace',
+    },
+  },
+  create(context) {
+    const { exceptions } = (context.options?.[0] as RuleOptions) ?? {};
+
+    return {
+      ObjectExpression: (node: Rule.Node) => {
+        if (
+          !context.getFilename().endsWith('package.json') ||
+          node.type !== 'ObjectExpression'
+        ) {
+          return;
+        }
+
+        const packageName = getObjectPropertyAsLiteral(node, 'name');
+        const packagePrivate = getObjectPropertyAsLiteral(node, 'private');
+        const packagePublishConfig = getObjectPropertyAsObject(
+          node,
+          'publishConfig',
+        );
+
+        // exit if package is on known exception list
+        if (
+          exceptions &&
+          exceptions.findIndex((name) => name === packageName) !== -1
+        ) {
+          return;
+        }
+
+        if (
+          typeof packageName === 'string' &&
+          packageName.startsWith('@atlaskit')
+        ) {
+          if (typeof packagePrivate === 'boolean' && packagePrivate) {
+            return context.report({
+              node,
+              messageId: 'noPrivate',
+              data: {
+                packageName,
+              },
+            });
+          }
+
+          if (packagePublishConfig === null) {
+            return context.report({
+              node,
+              messageId: 'publishConfigRequired',
+              data: {
+                packageName,
+              },
+            });
+          }
+        }
+      },
+    };
+  },
+};
+
+export default rule;

package/src/rules/util/handle-ast-object.ts

@@ -0,0 +1,44 @@
+import type {
+  ObjectExpression,
+  SimpleLiteral,
+  RegExpLiteral,
+  BigIntLiteral,
+} from 'estree';
+
+export const getObjectPropertyAsLiteral = (
+  node: ObjectExpression,
+  property: string,
+): SimpleLiteral['value'] | RegExpLiteral['value'] | BigIntLiteral['value'] => {
+  const prop = node.properties.find(
+    (p) =>
+      p.type === 'Property' &&
+      p.key.type === 'Literal' &&
+      p.key.value === property,
+  );
+
+  // double check for property is to make typescript happy
+  if (prop?.type === 'Property' && prop?.value.type === 'Literal') {
+    return prop.value.value ?? null;
+  }
+
+  return null;
+};
+
+export const getObjectPropertyAsObject = (
+  node: ObjectExpression,
+  property: string,
+): ObjectExpression | null => {
+  const prop = node.properties.find(
+    (p) =>
+      p.type === 'Property' &&
+      p.key.type === 'Literal' &&
+      p.key.value === property,
+  );
+
+  // double check for property is to make typescript happy
+  if (prop?.type === 'Property' && prop?.value.type === 'ObjectExpression') {
+    return prop.value ?? null;
+  }
+
+  return null;
+};

package/tmp/api-report-tmp.d.ts

@@ -37,9 +37,11 @@ export const rules: {
     '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-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/tsconfig.app.json

@@ -0,0 +1,36 @@
+{
+  "extends": "../../../tsconfig.node.json",
+  "include": ["./src/**/*.ts", "./src/**/*.tsx"],
+  "exclude": [
+    "**/docs/**/*",
+    "**/__tests__/**/*",
+    "**/vr-tests/**/*",
+    "**/__perf__/**/*",
+    "**/*.test.*",
+    "**/test.*",
+    "**/test-*",
+    "**/examples.ts",
+    "**/examples.tsx",
+    "**/examples/*.ts",
+    "**/examples/*.tsx",
+    "**/examples/**/*.ts",
+    "**/examples/**/*.tsx",
+    "**/storybook/**/*",
+    "**/constellation/**/*",
+    ".storybook/*",
+    "./__fixtures__/**/*",
+    "./__generated__/**/*",
+    "./mocks/**/*",
+    "./__mocks__/**/*",
+    "**/mock.*",
+    "**/codemods/**/*.ts",
+    "**/codemods/**/*.tsx"
+  ],
+  "compilerOptions": {
+    "baseUrl": "./",
+    "lib": ["ES2021.String"],
+    "composite": true,
+    "outDir": "../../../tsDist/@atlaskit__eslint-plugin-platform/app"
+  },
+  "references": []
+}

package/tsconfig.dev.json

@@ -0,0 +1,40 @@
+{
+  "extends": "../../../tsconfig.node.json",
+  "include": [
+    "**/docs/**/*",
+    "**/__tests__/**/*",
+    "**/vr-tests/**/*",
+    "**/__perf__/**/*",
+    "**/*.test.*",
+    "**/test.*",
+    "**/test-*",
+    "**/examples.ts",
+    "**/examples.tsx",
+    "**/examples/*.ts",
+    "**/examples/*.tsx",
+    "**/examples/**/*.ts",
+    "**/examples/**/*.tsx",
+    "**/storybook/**/*",
+    "**/constellation/**/*",
+    ".storybook/*",
+    "./__fixtures__/**/*",
+    "./__generated__/**/*",
+    "./mocks/**/*",
+    "./__mocks__/**/*",
+    "**/mock.*",
+    "**/codemods/**/*.ts",
+    "**/codemods/**/*.tsx"
+  ],
+  "exclude": ["./dist/**/*", "./build/**/*", "./node_modules/**/*"],
+  "compilerOptions": {
+    "baseUrl": "./",
+    "lib": ["ES2021.String"],
+    "composite": true,
+    "outDir": "../../../tsDist/@atlaskit__eslint-plugin-platform/dev"
+  },
+  "references": [
+    {
+      "path": "tsconfig.app.json"
+    }
+  ]
+}

package/dist/cjs/version.json

@@ -1,5 +0,0 @@
-{
-	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.2.4",
-	"sideEffects": false
-}

package/dist/es2019/version.json

@@ -1,5 +0,0 @@
-{
-	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.2.4",
-	"sideEffects": false
-}

package/dist/esm/version.json

@@ -1,5 +0,0 @@
-{
-	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.2.4",
-	"sideEffects": false
-}