@monorepolint/rules 0.5.0-alpha.13 → 0.5.0-alpha.130

package/src/nestedWorkspaces.ts

@@ -0,0 +1,60 @@
+/*!
+ * Copyright 2019 Palantir Technologies, Inc.
+ *
+ * Licensed under the MIT license. See LICENSE file in the project root for details.
+ *
+ */
+
+import * as globby from "globby";
+import * as path from "node:path";
+import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
+
+export const Options = r.Undefined;
+
+type Options = r.Static<typeof Options>;
+
+// Enforce that the root package.json contains all of the workspaces in the repo (including nested packages)
+export const nestedWorkspaces = makeRule({
+  name: "nestedWorkspaces",
+  check: (context) => {
+    const rootPackageJson = context.getWorkspaceContext().getPackageJson();
+
+    // Expand a set of globs covering all package.json files in the entire repo (except the root)
+    const packageJsonPaths = globby.globbySync(["*/**/package.json", "!**/node_modules/**"]);
+
+    const workspaces = Array.isArray(rootPackageJson.workspaces)
+      ? rootPackageJson.workspaces
+      : rootPackageJson.workspaces !== undefined
+      ? rootPackageJson.workspaces.packages
+      : undefined;
+
+    if (workspaces === undefined && packageJsonPaths.length > 0) {
+      context.addError({
+        file: context.getPackageJsonPath(),
+        message: 'The "workspace" field is missing, even though there are workspaces in the repository.',
+      });
+      return;
+    }
+
+    // Build a set of globs for each package.json that exists in packages specified by a workspace.
+    const workspacePackageJsons = (workspaces || []).map((item) => `${item}/package.json`);
+
+    // Expand the globs to get an array of all package.json files that are in packages specified by a workspace.
+    const expandedWorkspacesGlobs = globby.globbySync([...workspacePackageJsons, "!**/node_modules/**"]);
+
+    // Ensure there are no package.jsons which are not included in the globbed workspaces set
+    const difference = packageJsonPaths.filter((packageJsonPath) => !expandedWorkspacesGlobs.includes(packageJsonPath));
+
+    if (difference.length !== 0) {
+      const differencesList = difference.map((packageJsonPath) => path.dirname(packageJsonPath)).join(", ");
+      context.addError({
+        file: context.getPackageJsonPath(),
+        message:
+          `The "workspace" field is missing one or more values: ${differencesList}. ` +
+          'You may be able to use a glob to avoid listing each workspace individually, e.g. "packages/nested-workspace/*".',
+      });
+    }
+  },
+  validateOptions: Options.check,
+});

package/src/packageEntry.ts

@@ -5,42 +5,86 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
 import { mutateJson, PackageJson } from "@monorepolint/utils";
-import diff from "jest-diff";
+import { diff } from "jest-diff";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
 
-export const Options = r.Record({
-  entries: r.Dictionary(r.Unknown), // string => unknown
-});
+export const Options = r.Union(
+  r
+    .Record({
+      entries: r.Dictionary(r.Unknown), // string => unknown, enforces existence of keys and their values
+    })
+    .And(
+      r.Partial({
+        entriesExist: r.Undefined,
+      })
+    ),
+  r
+    .Record({
+      entriesExist: r.Array(r.String), // enforces existence of keys, but not values
+    })
+    .And(
+      r.Partial({
+        entries: r.Undefined,
+      })
+    ),
+  r.Record({
+    entries: r.Dictionary(r.Unknown), // string => unknown, enforces existence of keys and their values
+    entriesExist: r.Array(r.String),
+  })
+);
 
 export type Options = r.Static<typeof Options>;
 
-export const packageEntry = {
-  check: function expectPackageEntry(context: Context, options: Options) {
+export const packageEntry = makeRule<Options>({
+  name: "packageEntry",
+  check: (context, options) => {
     const packageJson = context.getPackageJson();
 
-    for (const key of Object.keys(options.entries)) {
-      const value = options.entries[key];
-
-      const entryDiff = diff(JSON.stringify(value) + "\n", (JSON.stringify(packageJson[key]) || "") + "\n");
-      if (
-        (typeof value !== "object" && value !== packageJson[key]) ||
-        (entryDiff == null || !entryDiff.includes("Compared values have no visual difference"))
-      ) {
-        context.addError({
-          file: context.getPackageJsonPath(),
-          message: `Expected standardized entry for '${key}'`,
-          longMessage: entryDiff,
-          fixer: () => {
-            mutateJson<PackageJson>(context.getPackageJsonPath(), input => {
-              input[key] = value;
-              return input;
-            });
-          },
-        });
+    if (options.entries) {
+      for (const key of Object.keys(options.entries)) {
+        const value = options.entries[key];
+
+        const entryDiff = diff(JSON.stringify(value) + "\n", (JSON.stringify(packageJson[key]) || "") + "\n");
+        if (
+          (typeof value !== "object" && value !== packageJson[key]) ||
+          entryDiff == null ||
+          !entryDiff.includes("Compared values have no visual difference")
+        ) {
+          context.addError({
+            file: context.getPackageJsonPath(),
+            message: createStandardizedEntryErrorMessage(key),
+            longMessage: entryDiff,
+            fixer: () => {
+              mutateJson<PackageJson>(context.getPackageJsonPath(), context.host, (input) => {
+                input[key] = value;
+                return input;
+              });
+            },
+          });
+        }
+      }
+    }
+
+    if (options.entriesExist) {
+      for (const key of options.entriesExist) {
+        if (packageJson[key] === undefined) {
+          context.addError({
+            file: context.getPackageJsonPath(),
+            message: createExpectedEntryErrorMessage(key),
+          });
+        }
       }
     }
   },
-  optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+  validateOptions: Options.check,
+});
+
+export function createStandardizedEntryErrorMessage(key: string) {
+  return `Expected standardized entry for '${key}'`;
+}
+
+export function createExpectedEntryErrorMessage(key: string) {
+  return `Expected entry for '${key}' to exist`;
+}

package/src/packageOrder.ts

@@ -5,11 +5,10 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
-import { writeJson } from "@monorepolint/utils";
-import diff from "jest-diff";
+import { Context } from "@monorepolint/config";
+import { diff } from "jest-diff";
 import * as r from "runtypes";
-
+import { makeRule } from "./util/makeRule.js";
 type OrderFunction = (context: Context) => (a: string, b: string) => number;
 
 const Options = r
@@ -28,9 +27,12 @@ const defaultKeyOrder = [
   "contributors",
   "url",
   "license",
+  "type",
+  "exports",
   "private",
   "engines",
   "bin",
+  "types",
   "main",
   "module",
   "typings",
@@ -49,17 +51,18 @@ const defaultKeyOrder = [
   "publishConfig",
 ];
 
-export const packageOrder = {
-  check: function expectPackageOrder(context: Context, opts: Options) {
+export const packageOrder = makeRule<Options>({
+  name: "packageOrder",
+  check: (context, opts) => {
     const packageJson = context.getPackageJson();
     const packagePath = context.getPackageJsonPath();
 
     const order: string[] | OrderFunction = opts === undefined ? defaultKeyOrder : opts.order;
 
-    const compartor = isOrderFunction(order) ? order(context) : createCompartor(order);
+    const comparator = isOrderFunction(order) ? order(context) : createComparator(order);
 
     const actualOrder = Object.keys(packageJson);
-    const expectedOrder = actualOrder.slice().sort(compartor); // sort mutates, so we need to copy the previous result
+    const expectedOrder = actualOrder.slice().sort(comparator); // sort mutates, so we need to copy the previous result
 
     if (!arrayOrderCompare(actualOrder, expectedOrder)) {
       context.addError({
@@ -67,19 +70,20 @@ export const packageOrder = {
         message: "Incorrect order of fields in package.json",
         longMessage: diff(expectedOrder, actualOrder, { expand: true }),
         fixer: () => {
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
           const expectedPackageJson: Record<string, any> = {};
 
-          expectedOrder.forEach(key => {
+          expectedOrder.forEach((key) => {
             expectedPackageJson[key] = packageJson[key];
           });
 
-          writeJson(packagePath, expectedPackageJson);
+          context.host.writeJson(packagePath, expectedPackageJson);
         },
       });
     }
   },
-  optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+  validateOptions: Options.check,
+});
 
 function arrayOrderCompare(a: ReadonlyArray<string>, b: ReadonlyArray<string>) {
   for (let index = 0; index < a.length; index++) {
@@ -91,7 +95,7 @@ function arrayOrderCompare(a: ReadonlyArray<string>, b: ReadonlyArray<string>) {
   return true;
 }
 
-function createCompartor(order: ReadonlyArray<string>) {
+function createComparator(order: ReadonlyArray<string>) {
   return (a: string, b: string) => {
     const aIndex = order.indexOf(a);
     const bIndex = order.indexOf(b);

package/src/packageScript.ts

@@ -5,24 +5,19 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
 import { mutateJson, PackageJson } from "@monorepolint/utils";
-import diff from "jest-diff";
+import { diff } from "jest-diff";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
 
 export const Options = r.Record({
   scripts: r.Dictionary(
     r.Union(
       r.String,
-      r
-        .Record({
-          options: r.Array(r.String.Or(r.Undefined)),
-        })
-        .And(
-          r.Partial({
-            fixValue: r.Union(r.String, r.Undefined, r.Literal(false)),
-          })
-        )
+      r.Record({
+        options: r.Array(r.String.Or(r.Undefined)),
+        fixValue: r.Union(r.String, r.Undefined, r.Literal(false)).optional(),
+      })
     )
   ), // string => string
 });
@@ -31,15 +26,16 @@ export type Options = r.Static<typeof Options>;
 
 export const MSG_NO_SCRIPTS_BLOCK = "No scripts block in package.json";
 
-export const packageScript = {
-  check: function expectPackageScript(context: Context, options: Options) {
+export const packageScript = makeRule<Options>({
+  name: "packageScript",
+  check: (context, options) => {
     const packageJson = context.getPackageJson();
     if (packageJson.scripts === undefined) {
       context.addError({
         file: context.getPackageJsonPath(),
         message: MSG_NO_SCRIPTS_BLOCK,
         fixer: () => {
-          mutateJson<PackageJson>(context.getPackageJsonPath(), input => {
+          mutateJson<PackageJson>(context.getPackageJsonPath(), context.host, (input) => {
             input.scripts = {};
             return input;
           });
@@ -63,7 +59,7 @@ export const packageScript = {
           }
           allowedValues.add(q);
         }
-        fixToEmpty = value.hasOwnProperty("fixValue") && value.fixValue === undefined;
+        fixToEmpty = Object.prototype.hasOwnProperty.call(value, "fixValue") && value.fixValue === undefined;
         fixValue = value.fixValue;
       }
 
@@ -75,7 +71,7 @@ export const packageScript = {
         if (fixValue !== false && (fixValue !== undefined || fixToEmpty === true)) {
           const q = fixValue;
           fixer = () => {
-            mutateJson<PackageJson>(context.getPackageJsonPath(), input => {
+            mutateJson<PackageJson>(context.getPackageJsonPath(), context.host, (input) => {
               if (fixToEmpty && q === undefined) {
                 delete input.scripts![name];
               } else {
@@ -87,7 +83,7 @@ export const packageScript = {
         }
 
         const validOptionsString = Array.from(allowedValues.values())
-          .map(a => (a === undefined ? "(empty)" : `'${a}'`))
+          .map((a) => (a === undefined ? "(empty)" : `'${a}'`))
           .join(", ");
 
         context.addError({
@@ -99,5 +95,5 @@ export const packageScript = {
       }
     }
   },
-  optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+  validateOptions: Options.check,
+});

package/src/public/util.ts

@@ -0,0 +1 @@
+export { makeRule } from "../util/makeRule.js";

package/src/requireDependency.ts

@@ -0,0 +1,71 @@
+/*!
+ * Copyright 2019 Palantir Technologies, Inc.
+ *
+ * Licensed under the MIT license. See LICENSE file in the project root for details.
+ *
+ */
+
+import { Context } from "@monorepolint/config";
+import { mutateJson, PackageJson } from "@monorepolint/utils";
+import { diff } from "jest-diff";
+import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
+
+const Options = r.Partial({
+  dependencies: r.Dictionary(r.String),
+  devDependencies: r.Dictionary(r.String),
+  peerDependencies: r.Dictionary(r.String),
+  optionalDependencies: r.Dictionary(r.String),
+});
+
+type Options = r.Static<typeof Options>;
+
+export const requireDependency = makeRule({
+  name: "requireDependency",
+  check: function expectPackageEntry(context: Context, options: Options) {
+    const packageJson = context.getPackageJson();
+    const packageJsonPath = context.getPackageJsonPath();
+
+    [
+      "dependencies" as const,
+      "devDependencies" as const,
+      "peerDependencies" as const,
+      "optionalDependencies" as const,
+    ].forEach((type) => {
+      if (!options[type]) {
+        return;
+      }
+
+      if (packageJson[type] === undefined) {
+        context.addError({
+          file: packageJsonPath,
+          message: `No ${type} block, cannot add required ${type}.`,
+          fixer: () => {
+            mutateJson<PackageJson>(packageJsonPath, context.host, (input) => {
+              input[type] = options[type];
+              return input;
+            });
+          },
+        });
+        return;
+      }
+
+      for (const [dep, version] of Object.entries(options[type]!)) {
+        if (packageJson[type][dep] !== version) {
+          context.addError({
+            file: packageJsonPath,
+            message: `Expected dependency ${dep}@${version}`,
+            longMessage: diff(`${dep}@${version}\n`, `${dep}@${packageJson[type][dep] || "missing"}\n`)!,
+            fixer: () => {
+              mutateJson<PackageJson>(packageJsonPath, context.host, (input) => {
+                input[type] = { ...input[type], [dep]: version };
+                return input;
+              });
+            },
+          });
+        }
+      }
+    });
+  },
+  validateOptions: Options.check,
+});

package/src/standardTsconfig.ts

@@ -5,20 +5,24 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
-import { getPackageNameToDir } from "@monorepolint/utils";
-import { existsSync, readFileSync, writeFileSync } from "fs";
-import diff from "jest-diff";
-import minimatch from "minimatch";
+import { Context } from "@monorepolint/config";
+import { matchesAnyGlob } from "@monorepolint/utils";
+import { diff } from "jest-diff";
 import * as path from "path";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
+
+const DEFAULT_TSCONFIG_FILENAME = "tsconfig.json";
 
 const Options = r
   .Partial({
+    file: r.String,
     generator: r.Function,
+    tsconfigReferenceFile: r.String,
     template: r.Record({}).Or(r.String),
     templateFile: r.String,
     excludedReferences: r.Array(r.String).Or(r.Undefined),
+    additionalReferences: r.Array(r.String).Or(r.Undefined),
   })
   .withConstraint(({ generator, template, templateFile }) => {
     let count = 0;
@@ -35,15 +39,19 @@ const Options = r
     return count === 1 || "Expect one of { generator, template, templateFile }";
   });
 
-export type Options = r.Static<typeof Options>;
+export interface Options extends r.Static<typeof Options> {}
 
-export const standardTsconfig = {
-  check: function expectStandardTsconfig(context: Context, opts: Options) {
-    const fullPath = path.resolve(context.packageDir, "tsconfig.json");
+export const standardTsconfig = makeRule<Options>({
+  name: "standardTsconfig",
+  check: async (context, opts) => {
+    const tsconfigFileName = opts.file ?? DEFAULT_TSCONFIG_FILENAME;
+    const fullPath = path.resolve(context.packageDir, tsconfigFileName);
     const generator = getGenerator(context, opts);
-    const expectedContent = generator(context);
+    const expectedContent = await generator(context);
 
-    const actualContent = existsSync(fullPath) ? readFileSync(fullPath, "utf-8") : undefined;
+    const actualContent = context.host.exists(fullPath)
+      ? context.host.readFile(fullPath, { encoding: "utf-8" })
+      : undefined;
 
     if (expectedContent === undefined) {
       context.addWarning({
@@ -59,13 +67,15 @@ export const standardTsconfig = {
         message: "Expect file contents to match",
         longMessage: diff(expectedContent, actualContent, { expand: true }),
         fixer: () => {
-          writeFileSync(fullPath, expectedContent);
+          context.host.writeFile(fullPath, expectedContent, {
+            encoding: "utf-8",
+          });
         },
       });
     }
   },
-  optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+  validateOptions: Options.check,
+});
 
 function getGenerator(context: Context, opts: Options) {
   if (opts.generator) {
@@ -73,37 +83,51 @@ function getGenerator(context: Context, opts: Options) {
   } else if (opts.templateFile) {
     const { packageDir: workspacePackageDir } = context.getWorkspaceContext();
     const fullPath = path.resolve(workspacePackageDir, opts.templateFile);
-    const template = JSON.parse(readFileSync(fullPath, "utf-8"));
+    const template = JSON.parse(context.host.readFile(fullPath, { encoding: "utf-8" }));
 
-    return makeGenerator(template, opts.excludedReferences);
+    return makeGenerator(template, opts.excludedReferences, opts.additionalReferences, opts.tsconfigReferenceFile);
   } else if (opts.template) {
-    return makeGenerator(opts.template, opts.excludedReferences);
+    return makeGenerator(opts.template, opts.excludedReferences, opts.additionalReferences, opts.tsconfigReferenceFile);
   } else {
     throw new Error("Unable to make generator");
   }
 }
 
-function makeGenerator(template: any, excludedReferences: ReadonlyArray<string> = []) {
-  return function generator(context: Context) {
+function makeGenerator(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  template: any,
+  excludedReferences: ReadonlyArray<string> | undefined,
+  additionalReferences: ReadonlyArray<string> | undefined,
+  tsconfigReferenceFile?: string
+) {
+  return async function generator(context: Context) {
     template = {
       ...template,
       references: [],
     }; // make a copy and ensure we have a references array
 
-    const nameToDirectory = getPackageNameToDir(context.getWorkspaceContext().packageDir);
+    const nameToDirectory = await context.getWorkspaceContext().getPackageNameToDir();
 
     const packageJson = context.getPackageJson();
     const deps = [...Object.keys(packageJson.dependencies || {}), ...Object.keys(packageJson.devDependencies || {})];
+    for (const dep of deps) {
+      const packageDir = nameToDirectory.get(dep);
+      if (packageDir !== undefined && (excludedReferences === undefined || !matchesAnyGlob(dep, excludedReferences))) {
+        const absoluteReferencePath =
+          tsconfigReferenceFile !== undefined ? path.join(packageDir, tsconfigReferenceFile) : packageDir;
+        template.references.push({
+          path: path.relative(context.packageDir, absoluteReferencePath),
+        });
+      }
+    }
 
-    deps
-      .filter(
-        name => nameToDirectory.has(name) && !excludedReferences.some(excludedRef => minimatch(name, excludedRef))
-      )
-      .forEach(packageName => {
+    if (additionalReferences) {
+      for (const additionalReference of additionalReferences) {
         template.references.push({
-          path: path.relative(context.packageDir, nameToDirectory.get(packageName)!),
+          path: additionalReference,
         });
-      });
+      }
+    }
 
     return JSON.stringify(template, undefined, 2) + "\n";
   };

package/src/util/checkAlpha.ts

@@ -5,9 +5,8 @@
  *
  */
 
-import { Context } from "@monorepolint/core";
-import { writeJson } from "@monorepolint/utils";
-import diff from "jest-diff";
+import { Context } from "@monorepolint/config";
+import { diff } from "jest-diff";
 
 export function checkAlpha(
   context: Context,
@@ -28,18 +27,18 @@ export function checkAlpha(
   if (!arrayOrderCompare(actualOrder, expectedOrder)) {
     context.addError({
       file: packagePath,
-      message: `Incorrect order of ${block} in package.json`,
+      message: createIncorrectOrderErrorMessage(block, packageJson.name!),
       longMessage: diff(expectedOrder, actualOrder, { expand: true }),
       fixer: () => {
         const expectedDependencies: Record<string, string> = {};
 
-        expectedOrder.forEach(dep => {
+        expectedOrder.forEach((dep) => {
           expectedDependencies[dep] = blockToSort[dep];
         });
 
         const newPackageJson = { ...packageJson };
         newPackageJson[block] = expectedDependencies;
-        writeJson(packagePath, newPackageJson);
+        context.host.writeJson(packagePath, newPackageJson);
       },
     });
   }
@@ -54,3 +53,7 @@ function arrayOrderCompare(a: ReadonlyArray<string>, b: ReadonlyArray<string>) {
 
   return true;
 }
+
+export function createIncorrectOrderErrorMessage(block: string, packageName: string) {
+  return `Incorrect order of ${block} in ${packageName}'s package.json`;
+}

package/src/util/makeRule.ts

@@ -0,0 +1,29 @@
+import { Context, RuleEntry, RuleModule } from "@monorepolint/config";
+
+let globalId = 0;
+export function makeRule<X>({
+  name,
+  check,
+  validateOptions,
+  printStats,
+}: {
+  name: string;
+  check: (context: Context, options: X, extra: { id: string }) => Promise<unknown> | unknown;
+  printStats?: () => void;
+  validateOptions: (options: unknown) => asserts options is X;
+}): RuleFunction<X> {
+  return function (ruleEntry) {
+    const id = `${name} :: ${globalId++}`;
+    return {
+      id,
+      // eslint-disable-next-line @typescript-eslint/no-extra-non-null-assertion
+      check: (context) => check(context, ruleEntry.options!!, { id }),
+      name,
+      validateOptions,
+      ruleEntry,
+      printStats,
+    };
+  };
+}
+
+type RuleFunction<T> = (ruleEntry: RuleEntry<T>) => RuleModule<T>;