Add manypkg.ignoredRules config option

Thinkmill · May 24, 2021 · dc2b0f9 · dc2b0f9
1 parent 0fecbcb
commit dc2b0f9
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 13 deletions.
diff --git a/.changeset/rare-wasps-appear.md b/.changeset/rare-wasps-appear.md
@@ -0,0 +1,5 @@
+---
+"@manypkg/cli": minor
+---
+
+Added `manypkg.ignoredRules` config option
diff --git a/packages/cli/src/checks/index.ts b/packages/cli/src/checks/index.ts
@@ -7,7 +7,7 @@ import ROOT_HAS_DEV_DEPENDENCIES from "./ROOT_HAS_DEV_DEPENDENCIES";
 import UNSORTED_DEPENDENCIES from "./UNSORTED_DEPENDENCIES";
 import INCORRECT_REPOSITORY_FIELD from "./INCORRECT_REPOSITORY_FIELD";
 
-export let checks = [
+export let checks = {
   EXTERNAL_MISMATCH,
   INTERNAL_MISMATCH,
   INVALID_DEV_AND_PEER_DEPENDENCY_RELATIONSHIP,
@@ -16,4 +16,4 @@ export let checks = [
   ROOT_HAS_DEV_DEPENDENCIES,
   UNSORTED_DEPENDENCIES,
   INCORRECT_REPOSITORY_FIELD
-];
+};
diff --git a/packages/cli/src/checks/utils.ts b/packages/cli/src/checks/utils.ts
@@ -15,7 +15,7 @@ export const DEPENDENCY_TYPES = [
   "peerDependencies"
 ] as const;
 
-export type Options = { defaultBranch?: string };
+export type Options = { defaultBranch?: string; ignoredRules?: string[] };
 
 type RootCheck<ErrorType> = {
   type: "root";

diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -10,28 +10,38 @@ import { upgradeDependency } from "./upgrade";
 import { npmTagAll } from "./npm-tag";
 import spawn from "spawndamnit";
 import pLimit from "p-limit";
-type PackagesWithConfig = Packages & {
-  root: Packages["root"] & {
-    packageJson: Packages["root"]["packageJson"] & {
-      manypkg?: Options;
-    };
+
+type RootPackage = Package & {
+  packageJson: {
+    manypkg?: Options;
   };
 };
+type PackagesWithConfig = Packages & {
+  root: RootPackage;
+};
 
 let defaultOptions = {
   defaultBranch: "master"
 };
 
 let runChecks = (
   allWorkspaces: Map<string, Package>,
-  rootWorkspace: Package,
+  rootWorkspace: RootPackage,
   shouldFix: boolean,
   options: Options
 ) => {
   let hasErrored = false;
   let requiresInstall = false;
+  let ignoredRules = new Set(
+    (rootWorkspace.packageJson.manypkg &&
+      rootWorkspace.packageJson.manypkg.ignoredRules) ||
+      []
+  );
+  for (let [ruleName, check] of Object.entries(checks)) {
+    if (ignoredRules.has(ruleName)) {
+      continue;
+    }
 
-  for (let check of checks) {
     if (check.type === "all") {
       for (let [, workspace] of allWorkspaces) {
         let errors = check.validate(
@@ -124,10 +134,9 @@ async function execCmd(args: string[]) {
     throw new ExitError(1);
   }
   let shouldFix = things[0] === "fix";
-
-  let { packages, root, tool }: PackagesWithConfig = await getPackages(
+  let { packages, root, tool } = (await getPackages(
     process.cwd()
-  );
+  )) as PackagesWithConfig;
 
   let options: Options = {
     ...defaultOptions,