@atlaskit/eslint-plugin-platform 0.2.6 → 0.4.0

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

@@ -1,13 +1,14 @@
 import { findRootSync } from '@manypkg/find-root';
+// eslint-disable-next-line import/no-extraneous-dependencies
 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 DESIRED_PKG_VERSIONS: Record<string, string[]> = {
+  typescript: ['4.9'],
+  '@types/react': ['16.14', '18.2'],
 };
 
 const matchMinorVersion = (
@@ -89,14 +90,16 @@ const rule: Rule.RuleModule = {
         const isRootPackageJson = fileName.endsWith(`${rootDir}/package.json`);
 
         if (packageResolutions !== null) {
-          for (const [key, value] of Object.entries(DESIRED_PKG_VERSIONS)) {
+          for (const [key, values] of Object.entries(DESIRED_PKG_VERSIONS)) {
             if (
-              !verifyResolutionFromObject(
-                packageResolutions as ObjectExpression,
-                key,
-                value,
-                !isRootPackageJson,
-              )
+              !values.some((value) => {
+                return verifyResolutionFromObject(
+                  packageResolutions as ObjectExpression,
+                  key,
+                  value,
+                  !isRootPackageJson,
+                );
+              })
             ) {
               return context.report({
                 node,

package/src/rules/ensure-feature-flag-prefix/index.tsx

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import type { Rule } from 'eslint';
 import {
   getMetadataForFilename,

package/src/rules/ensure-feature-flag-registration/index.tsx

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import type { Rule } from 'eslint';
 import {
   getMetadataForFilename,

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

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import type { Rule } from 'eslint';
 import {
   getObjectPropertyAsLiteral,

package/src/rules/ensure-test-runner-arguments/index.tsx

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import type { Rule } from 'eslint';
 
 const TEST_RUNNER_IDENTIFIER = 'ffTest' as const;

package/src/rules/ensure-test-runner-nested-count/index.tsx

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import type { Rule } from 'eslint';
 import type { SimpleCallExpression } from 'estree';
 

package/src/rules/no-duplicate-dependencies/__tests__/unit/rule.test.ts

@@ -0,0 +1,116 @@
+import { tester } from '../../../../__tests__/utils/_tester';
+import rule from '../../index';
+
+describe('test no-duplicate-dependencies rule', () => {
+  tester.run('no-duplicate-dependencies-rule', rule, {
+    valid: [
+      {
+        code: `
+          module.exports = {
+            "dependencies": {
+              "foo": "^1.0.0",
+              "bar": "^2.0.0"
+            }
+          };
+        `,
+        filename: 'dependencies.json',
+      },
+      {
+        code: `
+          module.exports = {
+            "devDependencies": {
+              "foo": "^1.0.0",
+              "bar": "^2.0.0"
+            }
+          };
+        `,
+        filename: 'devDependencies.json',
+      },
+      {
+        code: `
+          module.exports = {
+            "dependencies": {
+              "foo": "^1.0.0",
+              "bar": "^2.0.0"
+            },
+            "devDependencies": {
+              "baz": "^3.0.0",
+              "qux": "^4.0.0"
+            }
+          };
+        `,
+        filename: 'devAndDependencies.json',
+      },
+    ],
+    invalid: [
+      {
+        code: `
+          module.exports = {
+            "dependencies": {
+              "foo": "^1.0.0",
+              "bar": "^2.0.0"
+            },
+            "devDependencies": {
+              "foo": "^1.0.0",
+              "baz": "^3.0.0",
+              "qux": "^4.0.0"
+            }
+          };
+        `,
+        output: `
+          module.exports = {
+            "dependencies": {
+              "foo": "^1.0.0",
+              "bar": "^2.0.0"
+            },
+            "devDependencies": {
+              "baz": "^3.0.0",
+              "qux": "^4.0.0"
+            }
+          };
+        `,
+        errors: [
+          {
+            data: {
+              name: 'foo',
+            },
+            messageId: 'unexpectedDuplicateDependency',
+          },
+        ],
+        filename: 'duplicateDependenciesFirst.json',
+      },
+      {
+        code: `
+          module.exports = {
+            "dependencies": {
+              "bar": "^1.0.0"
+            },
+            "devDependencies": {
+              "foo": "^2.0.0",
+              "bar": "^1.0.0"
+            }
+          };
+        `,
+        output: `
+          module.exports = {
+            "dependencies": {
+              "bar": "^1.0.0"
+            },
+            "devDependencies": {
+              "foo": "^2.0.0"
+            }
+          };
+        `,
+        errors: [
+          {
+            data: {
+              name: 'bar',
+            },
+            messageId: 'unexpectedDuplicateDependency',
+          },
+        ],
+        filename: 'duplicateDependenciesLast.json',
+      },
+    ],
+  });
+});

package/src/rules/no-duplicate-dependencies/index.ts

@@ -0,0 +1,84 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import type { Rule } from 'eslint';
+
+const rule: Rule.RuleModule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'This rule disallows a dependency to be defined in both dependencies and devDependencies',
+      recommended: false,
+    },
+    fixable: 'code',
+    messages: {
+      unexpectedDuplicateDependency: 'Unexpected duplicate dependency {{name}}',
+    },
+  },
+  create(context) {
+    const dependencies = new Map();
+    const devDependencies = new Map();
+
+    return {
+      'ObjectExpression Property[key.value=dependencies] Property': (
+        node: Rule.Node,
+      ) => {
+        // @ts-expect-error
+        dependencies.set(node.key.value, node.key);
+      },
+      'ObjectExpression Property[key.value=devDependencies] Property': (
+        node: Rule.Node,
+      ) => {
+        // @ts-expect-error
+        devDependencies.set(node.key.value, node.key);
+      },
+      'Program:exit': () => {
+        for (const [dependency, node] of devDependencies) {
+          if (dependencies.has(dependency)) {
+            context.report({
+              data: {
+                name: dependency,
+              },
+              fix(fixer) {
+                const sourceCode = context.getSourceCode();
+                const property = node.parent;
+                const isLastLine =
+                  sourceCode.getTokenAfter(property)?.value === '}';
+                const end = property.loc.end;
+
+                if (!isLastLine) {
+                  return fixer.removeRange([
+                    sourceCode.getIndexFromLoc({
+                      line: property.loc.start.line,
+                      column: 0,
+                    }),
+                    sourceCode.getIndexFromLoc({
+                      line: end.line + 1,
+                      column: 0,
+                    }),
+                  ]);
+                }
+
+                const previousToken = sourceCode.getTokenBefore(property)!;
+
+                return fixer.removeRange([
+                  sourceCode.getIndexFromLoc({
+                    line: previousToken.loc.end.line,
+                    column: previousToken.loc.end.column - 1,
+                  }),
+                  sourceCode.getIndexFromLoc({
+                    line: end.line,
+                    column: end.column,
+                  }),
+                ]);
+              },
+              messageId: 'unexpectedDuplicateDependency',
+              node,
+            });
+          }
+        }
+      },
+    };
+  },
+};
+
+export default rule;

package/src/rules/no-invalid-feature-flag-usage/index.tsx

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import type { Rule } from 'eslint';
 import type { Node, Expression } from 'estree';
 

package/src/rules/no-invalid-storybook-decorator-usage/index.tsx

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import type { Rule } from 'eslint';
 
 const STORYBOOK_DECORATOR_IDENTIFIER = 'withPlatformFeatureFlags' as const;

package/src/rules/no-pre-post-installs/index.ts

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import type { Rule } from 'eslint';
 
 const rule: Rule.RuleModule = {

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

@@ -38,6 +38,7 @@ export const rules: {
     '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;

package/tsconfig.app.json

@@ -32,5 +32,6 @@
     "composite": true,
     "outDir": "../../../tsDist/@atlaskit__eslint-plugin-platform/app"
   },
-  "references": []
+  "references": [],
+  "files": []
 }

package/tsconfig.dev.json

@@ -36,5 +36,6 @@
     {
       "path": "tsconfig.app.json"
     }
-  ]
+  ],
+  "files": []
 }