repopo 0.2.2

package/esm/commands/check.js

@@ -0,0 +1,330 @@
+import fs from "node:fs";
+import { EOL as newline } from "node:os";
+import path from "node:path";
+import { Flags } from "@oclif/core";
+import { StringBuilder } from "@rushstack/node-core-library";
+import { GitCommand, RegExpFlag, findGitRoot } from "@tylerbu/cli-api";
+import chalk from "chalk";
+import { cosmiconfig } from "cosmiconfig";
+import { DefaultPolicyConfig } from "../config.js";
+import { DefaultPolicies, isPolicyFixResult, } from "../policy.js";
+/**
+ * Stores performance data for each handler. Used to collect and display performance stats.
+ */
+const handlerPerformanceData = new Map();
+/**
+ * This tool enforces policies across the code base via a series of handler functions. The handler functions are
+ * associated with a regular expression, and all files matching that expression are passed to the handler function.
+ *
+ * By default, the list of files to check comes from `git ls-files. You can also pipe in file names from stdin. For
+ * example:
+ *
+ * `git ls-files -co --exclude-standard --full-name | repopo check --stdin --verbose`
+ */
+export class CheckPolicy extends GitCommand {
+    static summary = "Checks and applies policies to the files in the repository.";
+    static flags = {
+        fix: Flags.boolean({
+            aliases: ["resolve"],
+            description: "Fix errors if possible.",
+            required: false,
+            char: "f",
+        }),
+        policy: RegExpFlag({
+            description: "Filter policies to apply by <regex>. Only policies with a name matching the regex will be applied.",
+            required: false,
+            char: "d",
+        }),
+        excludePolicy: Flags.string({
+            char: "D",
+            description: "Exclude policies by name. Can be specified multiple times to exclude multiple policies.",
+            exclusive: ["policy"],
+            multiple: true,
+        }),
+        path: RegExpFlag({
+            description: "Filter file paths by <regex>.",
+            required: false,
+            char: "p",
+        }),
+        stdin: Flags.boolean({
+            description: "Read list of files from stdin.",
+            required: false,
+        }),
+        ...GitCommand.flags,
+    };
+    processed = 0;
+    count = 0;
+    // private policies: RepoPolicy[] | undefined;
+    commandContext;
+    get defaultConfig() {
+        return DefaultPolicyConfig;
+    }
+    async loadConfig() {
+        const gitRoot = await findGitRoot();
+        // this.configPath ??= this.config.configDir; // path.join(this.config.configDir, "config.ts");
+        const explorer = cosmiconfig(this.config.bin, {
+            searchStrategy: "global",
+        });
+        this.verbose(`Looking for '${this.config.bin}' config at '${gitRoot}'`);
+        const config = await explorer.search(gitRoot);
+        if (config?.config !== undefined) {
+            this.verbose(`Found config at ${config.filepath}`);
+        }
+        if (config?.config === undefined) {
+            this.warning("No config found; using defaults.");
+        }
+        const finalConfig = config?.config ?? this.defaultConfig;
+        if (finalConfig.includeDefaultPolicies === true) {
+            finalConfig.policies ??= [];
+            finalConfig.policies.push(...DefaultPolicies);
+        }
+        return finalConfig;
+    }
+    async init() {
+        await super.init();
+        let policies = this.commandConfig?.policies?.filter((h) => {
+            if (this.flags.excludePolicy === undefined ||
+                this.flags.excludePolicy.length === 0) {
+                return true;
+            }
+            const shouldRun = this.flags.excludePolicy?.includes(h.name) === false;
+            if (!shouldRun) {
+                this.info(`Disabled policy: ${h.name}`);
+            }
+            return shouldRun;
+        }) ?? [];
+        // const pathRegex: RegExp =
+        // 	this.flags.path === undefined ? /.?/ : new RegExp(this.flags.path, "i");
+        if (this.flags.policy !== undefined) {
+            this.info(`Filtering handlers by regex: ${this.flags.policy}`);
+            policies = policies?.filter((h) => this.flags.policy?.test(h.name));
+        }
+        const pathRegex = this.flags.path ?? /.?/;
+        if (this.flags.path !== undefined) {
+            this.info(`Filtering file paths by regex: ${pathRegex}`);
+        }
+        if (this.flags.fix) {
+            this.info("Resolving errors if possible.");
+        }
+        const excludeFiles = this.commandConfig?.excludeFiles?.map((e) => toRegExp(e)) ?? [];
+        const excludePoliciesForFilesRaw = this.commandConfig?.excludePoliciesForFiles;
+        const excludePoliciesForFiles = new Map();
+        if (excludePoliciesForFilesRaw) {
+            for (const [policyName, filters] of Object.entries(excludePoliciesForFilesRaw)) {
+                const regexes = filters.map((e) => toRegExp(e));
+                excludePoliciesForFiles.set(policyName, regexes);
+            }
+        }
+        const gitRoot = await findGitRoot();
+        this.commandContext = {
+            pathRegex,
+            excludeFiles,
+            policies,
+            excludePoliciesForFiles,
+            gitRoot,
+        };
+    }
+    async run() {
+        // list the handlers then exit
+        // if (this.flags.listHandlers) {
+        // 	for (const h of handlersToRun) {
+        // 		this.log(`${h.name}\nresolver: ${h.resolver !== undefined}\n`);
+        // 	}
+        // 	this.log(`${handlersToRun.length} TOTAL POLICY HANDLERS`);
+        // 	this.exit(0);
+        // }
+        const policies = this.commandConfig?.policies ?? [];
+        this.verbose(`${policies.length} policies loaded.`);
+        for (const h of policies) {
+            this.verbose(h.name);
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        // const rawExclusions: string[] =
+        // 	this.flags.exclusions === undefined
+        // 		? manifest.policy?.exclusions
+        // 		: await readJson(this.flags.exclusions);
+        // const exclusions: RegExp[] = rawExclusions.map((e) => new RegExp(e, "i"));
+        // const rawHandlerExclusions = manifest?.policy?.handlerExclusions;
+        // const handlerExclusions: ExcludedPolicyFileMap = {};
+        // if (rawHandlerExclusions) {
+        // 	for (const rule of Object.keys(rawHandlerExclusions)) {
+        // 		handlerExclusions[rule] = rawHandlerExclusions[rule].map(
+        // 			(e) => new RegExp(e, "i"),
+        // 		);
+        // 	}
+        // }
+        const filePathsToCheck = [];
+        // const context = await this.getContext();
+        // const gitRoot = context.repo.resolvedRoot;
+        if (this.flags.stdin) {
+            const stdInput = await readStdin();
+            if (stdInput !== undefined) {
+                filePathsToCheck.push(...stdInput.split("\n"));
+            }
+        }
+        else {
+            // const repo = new Repository({ baseDir: gitRoot });
+            const gitFiles = (await this.git.raw("ls-files", "-co", "--exclude-standard", "--full-name")) ?? "";
+            filePathsToCheck.push(...gitFiles.split("\n"));
+        }
+        if (this.commandContext === undefined) {
+            this.error("Command context was undefined - fatal error.", {
+                exit: 100,
+            });
+        }
+        await this.executePolicy(filePathsToCheck, this.commandContext);
+    }
+    async executePolicy(pathsToCheck, commandContext) {
+        try {
+            for (const pathToCheck of pathsToCheck) {
+                // eslint-disable-next-line no-await-in-loop
+                await this.checkOrExcludeFile(pathToCheck, commandContext);
+            }
+        }
+        finally {
+            this.logStats();
+        }
+    }
+    /**
+     * Routes files to their handlers and resolvers by regex testing their full paths. If a file fails a policy that has a
+     * resolver, the resolver will be invoked as well. Synchronizes the output, exit codes, and resolve
+     * decision for all handlers.
+     */
+    async routeToHandlers(file, commandContext) {
+        const { 
+        // context,
+        policies, excludePoliciesForFiles, gitRoot, } = commandContext;
+        // Use the repo-relative path so that regexes that specify string start (^) will match repo paths.
+        // Replace \ in result with / in case OS is Windows.
+        const relPath = path.relative(gitRoot, file).replace(/\\/g, "/");
+        await Promise.all(policies
+            .filter((handler) => handler.match.test(relPath))
+            // biome-ignore lint/complexity/noExcessiveCognitiveComplexity: <explanation>
+            .map(async (policy) => {
+            // doing exclusion per handler
+            const exclusions = excludePoliciesForFiles.get(policy.name);
+            if (exclusions !== undefined &&
+                !exclusions.every((regex) => !regex.test(relPath))) {
+                this.verbose(`Excluded from '${policy.name}' policy: ${relPath}`);
+                return;
+            }
+            const result = await runWithPerf(policy.name, "handle", async () => policy.handler({
+                file: relPath,
+                root: gitRoot,
+                resolve: this.flags.fix,
+                config: this.commandConfig?.policySettings?.[policy.name],
+            }));
+            if (result === true) {
+                return;
+            }
+            const messages = new StringBuilder();
+            if (isPolicyFixResult(result)) {
+                if (result.resolved) {
+                    messages.append(`Resolved ${policy.name} policy failure for file: ${result.file}`);
+                }
+                else {
+                    messages.append(`Error when trying to fix ${policy.name} policy failure in ${result.file}`);
+                    process.exitCode = 1;
+                }
+            }
+            else {
+                // result must be a PolicyFailureResult; check if there is a standalone resolver.
+                const { resolver } = policy;
+                if (this.flags.fix && resolver !== undefined) {
+                    // Resolve the failure
+                    messages.append(`${newline}attempting to resolve: ${relPath}`);
+                    const resolveResult = await runWithPerf(policy.name, "resolve", async () => resolver({ file: relPath, root: gitRoot }));
+                    if (resolveResult.errorMessage !== undefined &&
+                        resolveResult.errorMessage !== "") {
+                        messages.append(newline + resolveResult.errorMessage);
+                    }
+                    if (!resolveResult.resolved) {
+                        process.exitCode = 1;
+                    }
+                }
+                else {
+                    // No resolver, or fix is false, so we're in the full failure case.
+                    const autoFixable = result.autoFixable
+                        ? chalk.green(" (autofixable)")
+                        : "";
+                    messages.append(`'${policy.name}' policy failure${autoFixable}: ${result.file}`);
+                    messages.append(result.errorMessage === undefined
+                        ? ""
+                        : `${newline}${result.errorMessage}`);
+                    process.exitCode = 1;
+                }
+            }
+            if ((process.exitCode ?? 0) === 0) {
+                this.info(messages.toString());
+            }
+            else {
+                this.warning(messages.toString());
+            }
+        }));
+    }
+    logStats() {
+        this.log(`Statistics: ${this.processed} processed, ${this.count - this.processed} excluded, ${this.count} total`);
+        for (const [action, handlerPerf] of handlerPerformanceData.entries()) {
+            this.log(`Performance for "${action}":`);
+            for (const [handler, dur] of handlerPerf.entries()) {
+                this.log(`\t${handler}: ${dur}ms`);
+            }
+        }
+    }
+    /**
+     * Given a string that represents a path to a file in the repo, determines if the file should be checked, and if so,
+     * routes the file to the appropriate handlers.
+     */
+    async checkOrExcludeFile(inputPath, commandContext) {
+        const { excludeFiles: exclusions, gitRoot, pathRegex } = commandContext;
+        const filePath = path.join(gitRoot, inputPath).trim().replace(/\\/g, "/");
+        if (!(pathRegex.test(inputPath) && fs.existsSync(filePath))) {
+            return;
+        }
+        this.count++;
+        if (!exclusions.every((value) => !value.test(inputPath))) {
+            this.verbose(`Excluded all handlers: ${inputPath}`);
+            return;
+        }
+        try {
+            await this.routeToHandlers(filePath, commandContext);
+        }
+        catch (error) {
+            throw new Error(`Error routing ${filePath} to handler: ${error}`);
+        }
+        this.processed++;
+    }
+}
+async function runWithPerf(name, action, run) {
+    const actionMap = handlerPerformanceData.get(action) ?? new Map();
+    let dur = actionMap.get(name) ?? 0;
+    const start = Date.now();
+    const result = await run();
+    dur += Date.now() - start;
+    actionMap.set(name, dur);
+    handlerPerformanceData.set(action, actionMap);
+    return result;
+}
+async function readStdin() {
+    return new Promise((resolve) => {
+        const stdin = process.stdin;
+        stdin.setEncoding("utf8");
+        let data = "";
+        stdin.on("data", (chunk) => {
+            data += chunk;
+        });
+        stdin.on("end", () => {
+            resolve(data);
+        });
+        if (stdin.isTTY) {
+            resolve("");
+        }
+    });
+}
+function toRegExp(input) {
+    if (typeof input === "string") {
+        return new RegExp(input, "i");
+    }
+    return input;
+}
+//# sourceMappingURL=check.js.map

package/esm/commands/check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.js","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAA0B,WAAW,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAqB,MAAM,cAAc,CAAC;AACtE,OAAO,EACN,eAAe,EAGf,iBAAiB,GACjB,MAAM,cAAc,CAAC;AAyCtB;;GAEG;AACH,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAqC,CAAC;AAE5E;;;;;;;;GAQG;AACH,MAAM,OAAO,WAAY,SAAQ,UAMhC;IACA,MAAM,CAAmB,OAAO,GAC/B,6DAA6D,CAAC;IAE/D,MAAM,CAAmB,KAAK,GAAG;QAChC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC;YAClB,OAAO,EAAE,CAAC,SAAS,CAAC;YACpB,WAAW,EAAE,yBAAyB;YACtC,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,GAAG;SACT,CAAC;QACF,MAAM,EAAE,UAAU,CAAC;YAClB,WAAW,EACV,oGAAoG;YACrG,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,GAAG;SACT,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAC3B,IAAI,EAAE,GAAG;YACT,WAAW,EACV,yFAAyF;YAC1F,SAAS,EAAE,CAAC,QAAQ,CAAC;YACrB,QAAQ,EAAE,IAAI;SACd,CAAC;QACF,IAAI,EAAE,UAAU,CAAC;YAChB,WAAW,EAAE,+BAA+B;YAC5C,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,GAAG;SACT,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACpB,WAAW,EAAE,gCAAgC;YAC7C,QAAQ,EAAE,KAAK;SACf,CAAC;QACF,GAAG,UAAU,CAAC,KAAK;KACV,CAAC;IAEH,SAAS,GAAG,CAAC,CAAC;IACd,KAAK,GAAG,CAAC,CAAC;IAClB,8CAA8C;IACtC,cAAc,CAAwC;IAE9D,IAAoB,aAAa;QAChC,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAEkB,KAAK,CAAC,UAAU;QAClC,MAAM,OAAO,GAAG,MAAM,WAAW,EAAE,CAAC;QACpC,+FAA+F;QAC/F,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YAC7C,cAAc,EAAE,QAAQ;SACxB,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,GAAG,gBAAgB,OAAO,GAAG,CAAC,CAAC;QACxE,MAAM,MAAM,GAAsB,MAAM,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACjE,IAAI,MAAM,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,mBAAmB,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,MAAM,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;QAClD,CAAC;QACD,MAAM,WAAW,GAAiB,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC;QACvE,IAAI,WAAW,CAAC,sBAAsB,KAAK,IAAI,EAAE,CAAC;YACjD,WAAW,CAAC,QAAQ,KAAK,EAAE,CAAC;YAC5B,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,WAAW,CAAC;IACpB,CAAC;IAEe,KAAK,CAAC,IAAI;QACzB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QAEnB,IAAI,QAAQ,GACX,IAAI,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YAC1C,IACC,IAAI,CAAC,KAAK,CAAC,aAAa,KAAK,SAAS;gBACtC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EACpC,CAAC;gBACF,OAAO,IAAI,CAAC;YACb,CAAC;YACD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC;YACvE,IAAI,CAAC,SAAS,EAAE,CAAC;gBAChB,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YACzC,CAAC;YACD,OAAO,SAAS,CAAC;QAClB,CAAC,CAAC,IAAI,EAAE,CAAC;QAEV,4BAA4B;QAC5B,4EAA4E;QAE5E,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACrC,IAAI,CAAC,IAAI,CAAC,gCAAgC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAC/D,QAAQ,GAAG,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC;QAC1C,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,kCAAkC,SAAS,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACpB,IAAI,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,YAAY,GACjB,IAAI,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAEjE,MAAM,0BAA0B,GAC/B,IAAI,CAAC,aAAa,EAAE,uBAAuB,CAAC;QAE7C,MAAM,uBAAuB,GAA0B,IAAI,GAAG,EAAE,CAAC;QACjE,IAAI,0BAA0B,EAAE,CAAC;YAChC,KAAK,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CACjD,0BAA0B,CAC1B,EAAE,CAAC;gBACH,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChD,uBAAuB,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAClD,CAAC;QACF,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,WAAW,EAAE,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG;YACrB,SAAS;YACT,YAAY;YACZ,QAAQ;YACR,uBAAuB;YACvB,OAAO;SACP,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,GAAG;QACxB,8BAA8B;QAC9B,iCAAiC;QACjC,oCAAoC;QACpC,oEAAoE;QACpE,KAAK;QACL,8DAA8D;QAC9D,iBAAiB;QACjB,IAAI;QAEJ,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,IAAI,EAAE,CAAC;QACpD,IAAI,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,MAAM,mBAAmB,CAAC,CAAC;QACpD,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QAED,mEAAmE;QACnE,kCAAkC;QAClC,uCAAuC;QACvC,kCAAkC;QAClC,6CAA6C;QAE7C,6EAA6E;QAE7E,oEAAoE;QAEpE,uDAAuD;QACvD,8BAA8B;QAC9B,2DAA2D;QAC3D,8DAA8D;QAC9D,gCAAgC;QAChC,OAAO;QACP,KAAK;QACL,IAAI;QAEJ,MAAM,gBAAgB,GAAa,EAAE,CAAC;QACtC,2CAA2C;QAC3C,6CAA6C;QAE7C,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,QAAQ,GAAG,MAAM,SAAS,EAAE,CAAC;YAEnC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC5B,gBAAgB,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAChD,CAAC;QACF,CAAC;aAAM,CAAC;YACP,qDAAqD;YACrD,MAAM,QAAQ,GACb,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAClB,UAAU,EACV,KAAK,EACL,oBAAoB,EACpB,aAAa,CACb,CAAC,IAAI,EAAE,CAAC;YAEV,gBAAgB,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,8CAA8C,EAAE;gBAC1D,IAAI,EAAE,GAAG;aACT,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAEO,KAAK,CAAC,aAAa,CAC1B,YAAsB,EACtB,cAAyC;QAEzC,IAAI,CAAC;YACJ,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;gBACxC,4CAA4C;gBAC5C,MAAM,IAAI,CAAC,kBAAkB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;YAC5D,CAAC;QACF,CAAC;gBAAS,CAAC;YACV,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjB,CAAC;IACF,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,eAAe,CAC5B,IAAY,EACZ,cAAyC;QAEzC,MAAM;QACL,WAAW;QACX,QAAQ,EACR,uBAAuB,EACvB,OAAO,GACP,GAAG,cAAc,CAAC;QAEnB,kGAAkG;QAClG,oDAAoD;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAEjE,MAAM,OAAO,CAAC,GAAG,CAChB,QAAQ;aACN,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjD,6EAA6E;aAC5E,GAAG,CAAC,KAAK,EAAE,MAAM,EAAiB,EAAE;YACpC,8BAA8B;YAC9B,MAAM,UAAU,GAAG,uBAAuB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC5D,IACC,UAAU,KAAK,SAAS;gBACxB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EACjD,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,kBAAkB,MAAM,CAAC,IAAI,aAAa,OAAO,EAAE,CAAC,CAAC;gBAClE,OAAO;YACR,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,IAAI,EAAE,CAClE,MAAM,CAAC,OAAO,CAAC;gBACd,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG;gBACvB,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,cAAc,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;aACzD,CAAC,CACF,CAAC;YAEF,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACrB,OAAO;YACR,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;YACrC,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC/B,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;oBACrB,QAAQ,CAAC,MAAM,CACd,YAAY,MAAM,CAAC,IAAI,6BAA6B,MAAM,CAAC,IAAI,EAAE,CACjE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACP,QAAQ,CAAC,MAAM,CACd,4BAA4B,MAAM,CAAC,IAAI,sBAAsB,MAAM,CAAC,IAAI,EAAE,CAC1E,CAAC;oBACF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACtB,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,iFAAiF;gBACjF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;gBAE5B,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC9C,sBAAsB;oBACtB,QAAQ,CAAC,MAAM,CAAC,GAAG,OAAO,0BAA0B,OAAO,EAAE,CAAC,CAAC;oBAC/D,MAAM,aAAa,GAAG,MAAM,WAAW,CACtC,MAAM,CAAC,IAAI,EACX,SAAS,EACT,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACtD,CAAC;oBAEF,IACC,aAAa,CAAC,YAAY,KAAK,SAAS;wBACxC,aAAa,CAAC,YAAY,KAAK,EAAE,EAChC,CAAC;wBACF,QAAQ,CAAC,MAAM,CAAC,OAAO,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;oBACvD,CAAC;oBAED,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;wBAC7B,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;oBACtB,CAAC;gBACF,CAAC;qBAAM,CAAC;oBACP,mEAAmE;oBACnE,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW;wBACrC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC;wBAC/B,CAAC,CAAC,EAAE,CAAC;oBACN,QAAQ,CAAC,MAAM,CACd,IAAI,MAAM,CAAC,IAAI,mBAAmB,WAAW,KAAK,MAAM,CAAC,IAAI,EAAE,CAC/D,CAAC;oBACF,QAAQ,CAAC,MAAM,CACd,MAAM,CAAC,YAAY,KAAK,SAAS;wBAChC,CAAC,CAAC,EAAE;wBACJ,CAAC,CAAC,GAAG,OAAO,GAAG,MAAM,CAAC,YAAY,EAAE,CACrC,CAAC;oBACF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACtB,CAAC;YACF,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;YACnC,CAAC;QACF,CAAC,CAAC,CACH,CAAC;IACH,CAAC;IAEO,QAAQ;QACf,IAAI,CAAC,GAAG,CACP,eAAe,IAAI,CAAC,SAAS,eAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SACnB,cAAc,IAAI,CAAC,KAAK,QAAQ,CAChC,CAAC;QACF,KAAK,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,sBAAsB,CAAC,OAAO,EAAE,EAAE,CAAC;YACtE,IAAI,CAAC,GAAG,CAAC,oBAAoB,MAAM,IAAI,CAAC,CAAC;YACzC,KAAK,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;gBACpD,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,KAAK,GAAG,IAAI,CAAC,CAAC;YACpC,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,kBAAkB,CAC/B,SAAiB,EACjB,cAAyC;QAEzC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,cAAc,CAAC;QAExE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAE1E,IAAI,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YAC7D,OAAO;QACR,CAAC;QAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,OAAO,CAAC,0BAA0B,SAAS,EAAE,CAAC,CAAC;YACpD,OAAO;QACR,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,iBAAiB,QAAQ,gBAAgB,KAAK,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,CAAC,SAAS,EAAE,CAAC;IAClB,CAAC;;AAGF,KAAK,UAAU,WAAW,CACzB,IAAY,EACZ,MAAoB,EACpB,GAAqB;IAErB,MAAM,SAAS,GACd,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,GAAG,EAAkB,CAAC;IACjE,IAAI,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEnC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,MAAM,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC;IAC3B,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;IAE1B,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACzB,sBAAsB,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AACf,CAAC;AAED,KAAK,UAAU,SAAS;IACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAE1B,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YAC1B,IAAI,IAAI,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YACpB,OAAO,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO,CAAC,EAAE,CAAC,CAAC;QACb,CAAC;IACF,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,KAAsB;IACvC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,IAAI,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC","sourcesContent":["import fs from \"node:fs\";\nimport { EOL as newline } from \"node:os\";\nimport path from \"node:path\";\nimport { Flags } from \"@oclif/core\";\nimport { StringBuilder } from \"@rushstack/node-core-library\";\nimport { GitCommand, RegExpFlag, findGitRoot } from \"@tylerbu/cli-api\";\nimport chalk from \"chalk\";\nimport { type CosmiconfigResult, cosmiconfig } from \"cosmiconfig\";\nimport { DefaultPolicyConfig, type PolicyConfig } from \"../config.js\";\nimport {\n\tDefaultPolicies,\n\ttype PolicyName,\n\ttype RepoPolicy,\n\tisPolicyFixResult,\n} from \"../policy.js\";\n\ntype PolicyAction = \"handle\" | \"resolve\";\n\ntype ExcludedPolicyFileMap = Map<PolicyName, RegExp[]>; // Record<PolicyName, RegExp[]>\n\n/**\n * A convenience interface used to pass commonly used parameters to functions in this file.\n */\ninterface CheckPolicyCommandContext {\n\t/**\n\t * A regular expression used to filter selected files.\n\t */\n\tpathRegex: RegExp;\n\n\t/**\n\t * A list of regular expressions used to exclude files from all handlers.\n\t */\n\texcludeFiles: RegExp[];\n\n\t/**\n\t * A list of handlers to apply to selected files.\n\t */\n\tpolicies: RepoPolicy[];\n\n\t/**\n\t * A per-handler list of regular expressions used to exclude files from specific handlers.\n\t */\n\texcludePoliciesForFiles: ExcludedPolicyFileMap;\n\n\t/**\n\t * Path to the root of the git repo.\n\t */\n\tgitRoot: string;\n\n\t/**\n\t * The repo context.\n\t */\n\t// context: Context;\n}\n\n/**\n * Stores performance data for each handler. Used to collect and display performance stats.\n */\nconst handlerPerformanceData = new Map<PolicyAction, Map<string, number>>();\n\n/**\n * This tool enforces policies across the code base via a series of handler functions. The handler functions are\n * associated with a regular expression, and all files matching that expression are passed to the handler function.\n *\n * By default, the list of files to check comes from `git ls-files. You can also pipe in file names from stdin. For\n * example:\n *\n * `git ls-files -co --exclude-standard --full-name | repopo check --stdin --verbose`\n */\nexport class CheckPolicy extends GitCommand<\n\ttypeof CheckPolicy & {\n\t\targs: typeof GitCommand.args;\n\t\tflags: typeof GitCommand.flags;\n\t},\n\tPolicyConfig\n> {\n\tstatic override readonly summary =\n\t\t\"Checks and applies policies to the files in the repository.\";\n\n\tstatic override readonly flags = {\n\t\tfix: Flags.boolean({\n\t\t\taliases: [\"resolve\"],\n\t\t\tdescription: \"Fix errors if possible.\",\n\t\t\trequired: false,\n\t\t\tchar: \"f\",\n\t\t}),\n\t\tpolicy: RegExpFlag({\n\t\t\tdescription:\n\t\t\t\t\"Filter policies to apply by <regex>. Only policies with a name matching the regex will be applied.\",\n\t\t\trequired: false,\n\t\t\tchar: \"d\",\n\t\t}),\n\t\texcludePolicy: Flags.string({\n\t\t\tchar: \"D\",\n\t\t\tdescription:\n\t\t\t\t\"Exclude policies by name. Can be specified multiple times to exclude multiple policies.\",\n\t\t\texclusive: [\"policy\"],\n\t\t\tmultiple: true,\n\t\t}),\n\t\tpath: RegExpFlag({\n\t\t\tdescription: \"Filter file paths by <regex>.\",\n\t\t\trequired: false,\n\t\t\tchar: \"p\",\n\t\t}),\n\t\tstdin: Flags.boolean({\n\t\t\tdescription: \"Read list of files from stdin.\",\n\t\t\trequired: false,\n\t\t}),\n\t\t...GitCommand.flags,\n\t} as const;\n\n\tprivate processed = 0;\n\tprivate count = 0;\n\t// private policies: RepoPolicy[] | undefined;\n\tprivate commandContext: CheckPolicyCommandContext | undefined;\n\n\tpublic override get defaultConfig() {\n\t\treturn DefaultPolicyConfig;\n\t}\n\n\tprotected override async loadConfig(): Promise<PolicyConfig> {\n\t\tconst gitRoot = await findGitRoot();\n\t\t// this.configPath ??= this.config.configDir; // path.join(this.config.configDir, \"config.ts\");\n\t\tconst explorer = cosmiconfig(this.config.bin, {\n\t\t\tsearchStrategy: \"global\",\n\t\t});\n\t\tthis.verbose(`Looking for '${this.config.bin}' config at '${gitRoot}'`);\n\t\tconst config: CosmiconfigResult = await explorer.search(gitRoot);\n\t\tif (config?.config !== undefined) {\n\t\t\tthis.verbose(`Found config at ${config.filepath}`);\n\t\t}\n\t\tif (config?.config === undefined) {\n\t\t\tthis.warning(\"No config found; using defaults.\");\n\t\t}\n\t\tconst finalConfig: PolicyConfig = config?.config ?? this.defaultConfig;\n\t\tif (finalConfig.includeDefaultPolicies === true) {\n\t\t\tfinalConfig.policies ??= [];\n\t\t\tfinalConfig.policies.push(...DefaultPolicies);\n\t\t}\n\n\t\treturn finalConfig;\n\t}\n\n\tpublic override async init(): Promise<void> {\n\t\tawait super.init();\n\n\t\tlet policies =\n\t\t\tthis.commandConfig?.policies?.filter((h) => {\n\t\t\t\tif (\n\t\t\t\t\tthis.flags.excludePolicy === undefined ||\n\t\t\t\t\tthis.flags.excludePolicy.length === 0\n\t\t\t\t) {\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t\tconst shouldRun = this.flags.excludePolicy?.includes(h.name) === false;\n\t\t\t\tif (!shouldRun) {\n\t\t\t\t\tthis.info(`Disabled policy: ${h.name}`);\n\t\t\t\t}\n\t\t\t\treturn shouldRun;\n\t\t\t}) ?? [];\n\n\t\t// const pathRegex: RegExp =\n\t\t// \tthis.flags.path === undefined ? /.?/ : new RegExp(this.flags.path, \"i\");\n\n\t\tif (this.flags.policy !== undefined) {\n\t\t\tthis.info(`Filtering handlers by regex: ${this.flags.policy}`);\n\t\t\tpolicies = policies?.filter((h) => this.flags.policy?.test(h.name));\n\t\t}\n\n\t\tconst pathRegex = this.flags.path ?? /.?/;\n\t\tif (this.flags.path !== undefined) {\n\t\t\tthis.info(`Filtering file paths by regex: ${pathRegex}`);\n\t\t}\n\n\t\tif (this.flags.fix) {\n\t\t\tthis.info(\"Resolving errors if possible.\");\n\t\t}\n\n\t\tconst excludeFiles: RegExp[] =\n\t\t\tthis.commandConfig?.excludeFiles?.map((e) => toRegExp(e)) ?? [];\n\n\t\tconst excludePoliciesForFilesRaw =\n\t\t\tthis.commandConfig?.excludePoliciesForFiles;\n\n\t\tconst excludePoliciesForFiles: ExcludedPolicyFileMap = new Map();\n\t\tif (excludePoliciesForFilesRaw) {\n\t\t\tfor (const [policyName, filters] of Object.entries(\n\t\t\t\texcludePoliciesForFilesRaw,\n\t\t\t)) {\n\t\t\t\tconst regexes = filters.map((e) => toRegExp(e));\n\t\t\t\texcludePoliciesForFiles.set(policyName, regexes);\n\t\t\t}\n\t\t}\n\n\t\tconst gitRoot = await findGitRoot();\n\t\tthis.commandContext = {\n\t\t\tpathRegex,\n\t\t\texcludeFiles,\n\t\t\tpolicies,\n\t\t\texcludePoliciesForFiles,\n\t\t\tgitRoot,\n\t\t};\n\t}\n\n\tpublic override async run(): Promise<void> {\n\t\t// list the handlers then exit\n\t\t// if (this.flags.listHandlers) {\n\t\t// \tfor (const h of handlersToRun) {\n\t\t// \t\tthis.log(`${h.name}\\nresolver: ${h.resolver !== undefined}\\n`);\n\t\t// \t}\n\t\t// \tthis.log(`${handlersToRun.length} TOTAL POLICY HANDLERS`);\n\t\t// \tthis.exit(0);\n\t\t// }\n\n\t\tconst policies = this.commandConfig?.policies ?? [];\n\t\tthis.verbose(`${policies.length} policies loaded.`);\n\t\tfor (const h of policies) {\n\t\t\tthis.verbose(h.name);\n\t\t}\n\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\t// const rawExclusions: string[] =\n\t\t// \tthis.flags.exclusions === undefined\n\t\t// \t\t? manifest.policy?.exclusions\n\t\t// \t\t: await readJson(this.flags.exclusions);\n\n\t\t// const exclusions: RegExp[] = rawExclusions.map((e) => new RegExp(e, \"i\"));\n\n\t\t// const rawHandlerExclusions = manifest?.policy?.handlerExclusions;\n\n\t\t// const handlerExclusions: ExcludedPolicyFileMap = {};\n\t\t// if (rawHandlerExclusions) {\n\t\t// \tfor (const rule of Object.keys(rawHandlerExclusions)) {\n\t\t// \t\thandlerExclusions[rule] = rawHandlerExclusions[rule].map(\n\t\t// \t\t\t(e) => new RegExp(e, \"i\"),\n\t\t// \t\t);\n\t\t// \t}\n\t\t// }\n\n\t\tconst filePathsToCheck: string[] = [];\n\t\t// const context = await this.getContext();\n\t\t// const gitRoot = context.repo.resolvedRoot;\n\n\t\tif (this.flags.stdin) {\n\t\t\tconst stdInput = await readStdin();\n\n\t\t\tif (stdInput !== undefined) {\n\t\t\t\tfilePathsToCheck.push(...stdInput.split(\"\\n\"));\n\t\t\t}\n\t\t} else {\n\t\t\t// const repo = new Repository({ baseDir: gitRoot });\n\t\t\tconst gitFiles =\n\t\t\t\t(await this.git.raw(\n\t\t\t\t\t\"ls-files\",\n\t\t\t\t\t\"-co\",\n\t\t\t\t\t\"--exclude-standard\",\n\t\t\t\t\t\"--full-name\",\n\t\t\t\t)) ?? \"\";\n\n\t\t\tfilePathsToCheck.push(...gitFiles.split(\"\\n\"));\n\t\t}\n\n\t\tif (this.commandContext === undefined) {\n\t\t\tthis.error(\"Command context was undefined - fatal error.\", {\n\t\t\t\texit: 100,\n\t\t\t});\n\t\t}\n\n\t\tawait this.executePolicy(filePathsToCheck, this.commandContext);\n\t}\n\n\tprivate async executePolicy(\n\t\tpathsToCheck: string[],\n\t\tcommandContext: CheckPolicyCommandContext,\n\t): Promise<void> {\n\t\ttry {\n\t\t\tfor (const pathToCheck of pathsToCheck) {\n\t\t\t\t// eslint-disable-next-line no-await-in-loop\n\t\t\t\tawait this.checkOrExcludeFile(pathToCheck, commandContext);\n\t\t\t}\n\t\t} finally {\n\t\t\tthis.logStats();\n\t\t}\n\t}\n\n\t/**\n\t * Routes files to their handlers and resolvers by regex testing their full paths. If a file fails a policy that has a\n\t * resolver, the resolver will be invoked as well. Synchronizes the output, exit codes, and resolve\n\t * decision for all handlers.\n\t */\n\tprivate async routeToHandlers(\n\t\tfile: string,\n\t\tcommandContext: CheckPolicyCommandContext,\n\t): Promise<void> {\n\t\tconst {\n\t\t\t// context,\n\t\t\tpolicies,\n\t\t\texcludePoliciesForFiles,\n\t\t\tgitRoot,\n\t\t} = commandContext;\n\n\t\t// Use the repo-relative path so that regexes that specify string start (^) will match repo paths.\n\t\t// Replace \\ in result with / in case OS is Windows.\n\t\tconst relPath = path.relative(gitRoot, file).replace(/\\\\/g, \"/\");\n\n\t\tawait Promise.all(\n\t\t\tpolicies\n\t\t\t\t.filter((handler) => handler.match.test(relPath))\n\t\t\t\t// biome-ignore lint/complexity/noExcessiveCognitiveComplexity: <explanation>\n\t\t\t\t.map(async (policy): Promise<void> => {\n\t\t\t\t\t// doing exclusion per handler\n\t\t\t\t\tconst exclusions = excludePoliciesForFiles.get(policy.name);\n\t\t\t\t\tif (\n\t\t\t\t\t\texclusions !== undefined &&\n\t\t\t\t\t\t!exclusions.every((regex) => !regex.test(relPath))\n\t\t\t\t\t) {\n\t\t\t\t\t\tthis.verbose(`Excluded from '${policy.name}' policy: ${relPath}`);\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst result = await runWithPerf(policy.name, \"handle\", async () =>\n\t\t\t\t\t\tpolicy.handler({\n\t\t\t\t\t\t\tfile: relPath,\n\t\t\t\t\t\t\troot: gitRoot,\n\t\t\t\t\t\t\tresolve: this.flags.fix,\n\t\t\t\t\t\t\tconfig: this.commandConfig?.policySettings?.[policy.name],\n\t\t\t\t\t\t}),\n\t\t\t\t\t);\n\n\t\t\t\t\tif (result === true) {\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst messages = new StringBuilder();\n\t\t\t\t\tif (isPolicyFixResult(result)) {\n\t\t\t\t\t\tif (result.resolved) {\n\t\t\t\t\t\t\tmessages.append(\n\t\t\t\t\t\t\t\t`Resolved ${policy.name} policy failure for file: ${result.file}`,\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tmessages.append(\n\t\t\t\t\t\t\t\t`Error when trying to fix ${policy.name} policy failure in ${result.file}`,\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\tprocess.exitCode = 1;\n\t\t\t\t\t\t}\n\t\t\t\t\t} else {\n\t\t\t\t\t\t// result must be a PolicyFailureResult; check if there is a standalone resolver.\n\t\t\t\t\t\tconst { resolver } = policy;\n\n\t\t\t\t\t\tif (this.flags.fix && resolver !== undefined) {\n\t\t\t\t\t\t\t// Resolve the failure\n\t\t\t\t\t\t\tmessages.append(`${newline}attempting to resolve: ${relPath}`);\n\t\t\t\t\t\t\tconst resolveResult = await runWithPerf(\n\t\t\t\t\t\t\t\tpolicy.name,\n\t\t\t\t\t\t\t\t\"resolve\",\n\t\t\t\t\t\t\t\tasync () => resolver({ file: relPath, root: gitRoot }),\n\t\t\t\t\t\t\t);\n\n\t\t\t\t\t\t\tif (\n\t\t\t\t\t\t\t\tresolveResult.errorMessage !== undefined &&\n\t\t\t\t\t\t\t\tresolveResult.errorMessage !== \"\"\n\t\t\t\t\t\t\t) {\n\t\t\t\t\t\t\t\tmessages.append(newline + resolveResult.errorMessage);\n\t\t\t\t\t\t\t}\n\n\t\t\t\t\t\t\tif (!resolveResult.resolved) {\n\t\t\t\t\t\t\t\tprocess.exitCode = 1;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\t// No resolver, or fix is false, so we're in the full failure case.\n\t\t\t\t\t\t\tconst autoFixable = result.autoFixable\n\t\t\t\t\t\t\t\t? chalk.green(\" (autofixable)\")\n\t\t\t\t\t\t\t\t: \"\";\n\t\t\t\t\t\t\tmessages.append(\n\t\t\t\t\t\t\t\t`'${policy.name}' policy failure${autoFixable}: ${result.file}`,\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\tmessages.append(\n\t\t\t\t\t\t\t\tresult.errorMessage === undefined\n\t\t\t\t\t\t\t\t\t? \"\"\n\t\t\t\t\t\t\t\t\t: `${newline}${result.errorMessage}`,\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\tprocess.exitCode = 1;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\tif ((process.exitCode ?? 0) === 0) {\n\t\t\t\t\t\tthis.info(messages.toString());\n\t\t\t\t\t} else {\n\t\t\t\t\t\tthis.warning(messages.toString());\n\t\t\t\t\t}\n\t\t\t\t}),\n\t\t);\n\t}\n\n\tprivate logStats(): void {\n\t\tthis.log(\n\t\t\t`Statistics: ${this.processed} processed, ${\n\t\t\t\tthis.count - this.processed\n\t\t\t} excluded, ${this.count} total`,\n\t\t);\n\t\tfor (const [action, handlerPerf] of handlerPerformanceData.entries()) {\n\t\t\tthis.log(`Performance for \"${action}\":`);\n\t\t\tfor (const [handler, dur] of handlerPerf.entries()) {\n\t\t\t\tthis.log(`\\t${handler}: ${dur}ms`);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Given a string that represents a path to a file in the repo, determines if the file should be checked, and if so,\n\t * routes the file to the appropriate handlers.\n\t */\n\tprivate async checkOrExcludeFile(\n\t\tinputPath: string,\n\t\tcommandContext: CheckPolicyCommandContext,\n\t): Promise<void> {\n\t\tconst { excludeFiles: exclusions, gitRoot, pathRegex } = commandContext;\n\n\t\tconst filePath = path.join(gitRoot, inputPath).trim().replace(/\\\\/g, \"/\");\n\n\t\tif (!(pathRegex.test(inputPath) && fs.existsSync(filePath))) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.count++;\n\t\tif (!exclusions.every((value) => !value.test(inputPath))) {\n\t\t\tthis.verbose(`Excluded all handlers: ${inputPath}`);\n\t\t\treturn;\n\t\t}\n\n\t\ttry {\n\t\t\tawait this.routeToHandlers(filePath, commandContext);\n\t\t} catch (error: unknown) {\n\t\t\tthrow new Error(`Error routing ${filePath} to handler: ${error}`);\n\t\t}\n\n\t\tthis.processed++;\n\t}\n}\n\nasync function runWithPerf<T>(\n\tname: string,\n\taction: PolicyAction,\n\trun: () => Promise<T>,\n): Promise<T> {\n\tconst actionMap =\n\t\thandlerPerformanceData.get(action) ?? new Map<string, number>();\n\tlet dur = actionMap.get(name) ?? 0;\n\n\tconst start = Date.now();\n\tconst result = await run();\n\tdur += Date.now() - start;\n\n\tactionMap.set(name, dur);\n\thandlerPerformanceData.set(action, actionMap);\n\treturn result;\n}\n\nasync function readStdin(): Promise<string> {\n\treturn new Promise((resolve) => {\n\t\tconst stdin = process.stdin;\n\t\tstdin.setEncoding(\"utf8\");\n\n\t\tlet data = \"\";\n\t\tstdin.on(\"data\", (chunk) => {\n\t\t\tdata += chunk;\n\t\t});\n\n\t\tstdin.on(\"end\", () => {\n\t\t\tresolve(data);\n\t\t});\n\n\t\tif (stdin.isTTY) {\n\t\t\tresolve(\"\");\n\t\t}\n\t});\n}\n\nfunction toRegExp(input: string | RegExp): RegExp {\n\tif (typeof input === \"string\") {\n\t\treturn new RegExp(input, \"i\");\n\t}\n\treturn input;\n}\n"]}

package/esm/config.d.ts

@@ -0,0 +1,35 @@
+import type { RequireAtLeastOne, SetOptional } from "type-fest";
+import type { PackageJsonPropertiesSettings } from "./policies/PackageJsonProperties.js";
+import type { PolicyName, RepoPolicy } from "./policy.js";
+/**
+ * @alpha
+ */
+export type PerPolicySettings = ({
+    PackageJsonProperties: PackageJsonPropertiesSettings;
+} & Record<PolicyName, unknown>) | undefined;
+/**
+ * @alpha
+ */
+export interface OptionalPolicyConfig {
+    policies?: RepoPolicy[];
+    /**
+     * An array of strings/regular expressions. Paths that match any of these expressions will be completely excluded from
+     * policy.
+     */
+    excludeFiles?: (string | RegExp)[];
+    /**
+     * An object with a policy name as keys that map to an array of strings/regular expressions to
+     * exclude that rule from being checked.
+     */
+    excludePoliciesForFiles?: Record<PolicyName, (string | RegExp)[]>;
+    includeDefaultPolicies?: boolean;
+    policySettings?: PerPolicySettings | undefined;
+}
+/**
+ * A type representing policy configuration.
+ *
+ * @alpha
+ */
+export type PolicyConfig = RequireAtLeastOne<OptionalPolicyConfig, "policies" | "includeDefaultPolicies">;
+export declare const DefaultPolicyConfig: SetOptional<Required<PolicyConfig>, "policies" | "policySettings">;
+//# sourceMappingURL=config.d.ts.map

package/esm/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAChE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACzF,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAC1B,CAAC;IAED,qBAAqB,EAAE,6BAA6B,CAAC;CACpD,GAAG,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,GAChC,SAAS,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IAExB;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAEnC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;IAClE,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC,cAAc,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;CAC/C;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,iBAAiB,CAC3C,oBAAoB,EACpB,UAAU,GAAG,wBAAwB,CACrC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAChC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,UAAU,GAAG,gBAAgB,CAIhE,CAAC"}

package/esm/config.js

@@ -0,0 +1,6 @@
+export const DefaultPolicyConfig = {
+    excludeFiles: [],
+    excludePoliciesForFiles: {},
+    includeDefaultPolicies: true,
+};
+//# sourceMappingURL=config.js.map

package/esm/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AA8CA,MAAM,CAAC,MAAM,mBAAmB,GACqC;IACpE,YAAY,EAAE,EAAE;IAChB,uBAAuB,EAAE,EAAE;IAC3B,sBAAsB,EAAE,IAAI;CAC5B,CAAC","sourcesContent":["import type { RequireAtLeastOne, SetOptional } from \"type-fest\";\nimport type { PackageJsonPropertiesSettings } from \"./policies/PackageJsonProperties.js\";\nimport type { PolicyName, RepoPolicy } from \"./policy.js\";\n\n/**\n * @alpha\n */\nexport type PerPolicySettings =\n\t| ({\n\t\t\t// biome-ignore lint/style/useNamingConvention: key needs to match policy name\n\t\t\tPackageJsonProperties: PackageJsonPropertiesSettings;\n\t  } & Record<PolicyName, unknown>)\n\t| undefined;\n\n/**\n * @alpha\n */\nexport interface OptionalPolicyConfig {\n\tpolicies?: RepoPolicy[];\n\n\t/**\n\t * An array of strings/regular expressions. Paths that match any of these expressions will be completely excluded from\n\t * policy.\n\t */\n\texcludeFiles?: (string | RegExp)[];\n\n\t/**\n\t * An object with a policy name as keys that map to an array of strings/regular expressions to\n\t * exclude that rule from being checked.\n\t */\n\texcludePoliciesForFiles?: Record<PolicyName, (string | RegExp)[]>;\n\tincludeDefaultPolicies?: boolean;\n\n\tpolicySettings?: PerPolicySettings | undefined;\n}\n\n/**\n * A type representing policy configuration.\n *\n * @alpha\n */\nexport type PolicyConfig = RequireAtLeastOne<\n\tOptionalPolicyConfig,\n\t\"policies\" | \"includeDefaultPolicies\"\n>;\n\nexport const DefaultPolicyConfig: // PolicyConfig\nSetOptional<Required<PolicyConfig>, \"policies\" | \"policySettings\"> = {\n\texcludeFiles: [],\n\texcludePoliciesForFiles: {},\n\tincludeDefaultPolicies: true,\n};\n"]}

package/esm/index.d.ts

@@ -0,0 +1,6 @@
+export { run } from "@oclif/core";
+export type { PolicyFailure, PolicyFixResult, PolicyFunctionArguments, PolicyHandler, PolicyName, PolicyStandaloneResolver, RepoPolicy, } from "./policy.js";
+export { DefaultPolicies } from "./policy.js";
+export type { PolicyConfig, OptionalPolicyConfig, PerPolicySettings, } from "./config.js";
+export type { PackageJsonPropertiesSettings, PackageJsonProperty, } from "./policies/PackageJsonProperties.js";
+//# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAElC,YAAY,EACX,aAAa,EACb,eAAe,EACf,uBAAuB,EACvB,aAAa,EACb,UAAU,EACV,wBAAwB,EACxB,UAAU,GACV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,YAAY,EACX,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,GACjB,MAAM,aAAa,CAAC;AACrB,YAAY,EACX,6BAA6B,EAC7B,mBAAmB,GACnB,MAAM,qCAAqC,CAAC"}

package/esm/index.js

@@ -0,0 +1,3 @@
+export { run } from "@oclif/core";
+export { DefaultPolicies } from "./policy.js";
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAWlC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC","sourcesContent":["export { run } from \"@oclif/core\";\n\nexport type {\n\tPolicyFailure,\n\tPolicyFixResult,\n\tPolicyFunctionArguments,\n\tPolicyHandler,\n\tPolicyName,\n\tPolicyStandaloneResolver,\n\tRepoPolicy,\n} from \"./policy.js\";\nexport { DefaultPolicies } from \"./policy.js\";\nexport type {\n\tPolicyConfig,\n\tOptionalPolicyConfig,\n\tPerPolicySettings,\n} from \"./config.js\";\nexport type {\n\tPackageJsonPropertiesSettings,\n\tPackageJsonProperty,\n} from \"./policies/PackageJsonProperties.js\";\n"]}

package/esm/policies/NoJsFileExtensions.d.ts

@@ -0,0 +1,10 @@
+import type { RepoPolicy } from "../policy.js";
+/**
+ * A repo policy that checks for JavaScript source files that just use the .js file extension. Such files may be
+ * interpreted by node as either CommonJS or ESM based on the `type` field in the nearest package.json file. This
+ * can create unexpected behavior for JS files; changing the package.json nearest to one will change how the JS
+ * is processed by node. Using explicit file extensions reduces ambiguity and ensures a CJS file isn't suddenly treated
+ * like an ESM file.
+ */
+export declare const NoJsFileExtensions: RepoPolicy;
+//# sourceMappingURL=NoJsFileExtensions.d.ts.map

package/esm/policies/NoJsFileExtensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NoJsFileExtensions.d.ts","sourceRoot":"","sources":["../../src/policies/NoJsFileExtensions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAiB,UAAU,EAAE,MAAM,cAAc,CAAC;AAE9D;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,UAehC,CAAC"}

package/esm/policies/NoJsFileExtensions.js

@@ -0,0 +1,23 @@
+/**
+ * A repo policy that checks for JavaScript source files that just use the .js file extension. Such files may be
+ * interpreted by node as either CommonJS or ESM based on the `type` field in the nearest package.json file. This
+ * can create unexpected behavior for JS files; changing the package.json nearest to one will change how the JS
+ * is processed by node. Using explicit file extensions reduces ambiguity and ensures a CJS file isn't suddenly treated
+ * like an ESM file.
+ */
+export const NoJsFileExtensions = {
+    name: "NoJsFileExtensions",
+    match: /(^|\/)[^/]+\.js$/i,
+    // biome-ignore lint/suspicious/useAwait: <explanation>
+    handler: async ({ file }) => {
+        // Any match is considered a failure.
+        const result = {
+            name: NoJsFileExtensions.name,
+            file,
+            autoFixable: false,
+            errorMessage: "JavaScript files should have a .cjs or .mjs file extension based on the module format of the file. Rename the file accordingly.",
+        };
+        return result;
+    },
+};
+//# sourceMappingURL=NoJsFileExtensions.js.map

package/esm/policies/NoJsFileExtensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NoJsFileExtensions.js","sourceRoot":"","sources":["../../src/policies/NoJsFileExtensions.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAe;IAC7C,IAAI,EAAE,oBAAoB;IAC1B,KAAK,EAAE,mBAAmB;IAC1B,uDAAuD;IACvD,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;QAC3B,qCAAqC;QACrC,MAAM,MAAM,GAAkB;YAC7B,IAAI,EAAE,kBAAkB,CAAC,IAAI;YAC7B,IAAI;YACJ,WAAW,EAAE,KAAK;YAClB,YAAY,EACX,iIAAiI;SAClI,CAAC;QACF,OAAO,MAAM,CAAC;IACf,CAAC;CACD,CAAC","sourcesContent":["import type { PolicyFailure, RepoPolicy } from \"../policy.js\";\n\n/**\n * A repo policy that checks for JavaScript source files that just use the .js file extension. Such files may be\n * interpreted by node as either CommonJS or ESM based on the `type` field in the nearest package.json file. This\n * can create unexpected behavior for JS files; changing the package.json nearest to one will change how the JS\n * is processed by node. Using explicit file extensions reduces ambiguity and ensures a CJS file isn't suddenly treated\n * like an ESM file.\n */\nexport const NoJsFileExtensions: RepoPolicy = {\n\tname: \"NoJsFileExtensions\",\n\tmatch: /(^|\\/)[^/]+\\.js$/i,\n\t// biome-ignore lint/suspicious/useAwait: <explanation>\n\thandler: async ({ file }) => {\n\t\t// Any match is considered a failure.\n\t\tconst result: PolicyFailure = {\n\t\t\tname: NoJsFileExtensions.name,\n\t\t\tfile,\n\t\t\tautoFixable: false,\n\t\t\terrorMessage:\n\t\t\t\t\"JavaScript files should have a .cjs or .mjs file extension based on the module format of the file. Rename the file accordingly.\",\n\t\t};\n\t\treturn result;\n\t},\n};\n"]}

package/esm/policies/PackageJsonProperties.d.ts

@@ -0,0 +1,21 @@
+import type { RepoPolicy } from "../policy.js";
+/**
+ * @alpha
+ */
+export type PackageJsonProperty = string;
+/**
+ * Policy settings for the PackageJsonProperties repo policy.
+ *
+ * @alpha
+ */
+export interface PackageJsonPropertiesSettings {
+    /**
+     * Sets a package.json property to the string value provided. The string value will be used verbatim.
+     */
+    verbatim: Record<PackageJsonProperty, string>;
+}
+/**
+ * A RepoPolicy that checks that package.json properties in packages match expected values.
+ */
+export declare const PackageJsonProperties: RepoPolicy<PackageJsonPropertiesSettings>;
+//# sourceMappingURL=PackageJsonProperties.d.ts.map

package/esm/policies/PackageJsonProperties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageJsonProperties.d.ts","sourceRoot":"","sources":["../../src/policies/PackageJsonProperties.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAkC,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC7C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;CAC9C;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,UAAU,CAAC,6BAA6B,CAkD1E,CAAC"}

package/esm/policies/PackageJsonProperties.js

@@ -0,0 +1,45 @@
+import { readJson, writeJson } from "fs-extra/esm";
+/**
+ * A RepoPolicy that checks that package.json properties in packages match expected values.
+ */
+export const PackageJsonProperties = {
+    name: "PackageJsonProperties",
+    match: /(^|\/)package\.json/i,
+    handler: async ({ file, config, resolve }) => {
+        if (config === undefined) {
+            return true;
+        }
+        const failResult = {
+            name: PackageJsonProperties.name,
+            file,
+            autoFixable: true,
+        };
+        const { verbatim } = config;
+        const json = (await readJson(file));
+        const messages = [];
+        for (const [propName, value] of Object.entries(verbatim)) {
+            if (json[propName] !== value) {
+                messages.push(`Incorrect package.json field value for '${propName}'. Expected '${value}', got '${json[propName]}'.`);
+            }
+        }
+        if (messages.length > 0) {
+            if (resolve) {
+                const fixResult = {
+                    ...failResult,
+                    resolved: false,
+                };
+                for (const [propName, value] of Object.entries(verbatim)) {
+                    json[propName] = value;
+                }
+                await writeJson(file, json, { spaces: "\t" });
+                fixResult.resolved = true;
+                return fixResult;
+            }
+            // There were errors, and we're not resolving them, so return a fail result
+            failResult.errorMessage = messages.join("\n");
+            return failResult;
+        }
+        return true;
+    },
+};
+//# sourceMappingURL=PackageJsonProperties.js.map

package/esm/policies/PackageJsonProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageJsonProperties.js","sourceRoot":"","sources":["../../src/policies/PackageJsonProperties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAqBnD;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GACjC;IACC,IAAI,EAAE,uBAAuB;IAC7B,KAAK,EAAE,sBAAsB;IAC7B,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE;QAC5C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACb,CAAC;QAED,MAAM,UAAU,GAAkB;YACjC,IAAI,EAAE,qBAAqB,CAAC,IAAI;YAChC,IAAI;YACJ,WAAW,EAAE,IAAI;SACjB,CAAC;QAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAgB,CAAC;QACnD,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1D,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC;gBAC9B,QAAQ,CAAC,IAAI,CACZ,2CAA2C,QAAQ,gBAAgB,KAAK,WAAW,IAAI,CAAC,QAAQ,CAAC,IAAI,CACrG,CAAC;YACH,CAAC;QACF,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,OAAO,EAAE,CAAC;gBACb,MAAM,SAAS,GAAoB;oBAClC,GAAG,UAAU;oBACb,QAAQ,EAAE,KAAK;iBACf,CAAC;gBAEF,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC1D,IAAI,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;gBACxB,CAAC;gBACD,MAAM,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAE9C,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;gBAC1B,OAAO,SAAS,CAAC;YAClB,CAAC;YAED,2EAA2E;YAC3E,UAAU,CAAC,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,OAAO,UAAU,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;CACD,CAAC","sourcesContent":["import { readJson, writeJson } from \"fs-extra/esm\";\nimport type { PackageJson } from \"type-fest\";\nimport type { PolicyFailure, PolicyFixResult, RepoPolicy } from \"../policy.js\";\n\n/**\n * @alpha\n */\nexport type PackageJsonProperty = string;\n\n/**\n * Policy settings for the PackageJsonProperties repo policy.\n *\n * @alpha\n */\nexport interface PackageJsonPropertiesSettings {\n\t/**\n\t * Sets a package.json property to the string value provided. The string value will be used verbatim.\n\t */\n\tverbatim: Record<PackageJsonProperty, string>;\n}\n\n/**\n * A RepoPolicy that checks that package.json properties in packages match expected values.\n */\nexport const PackageJsonProperties: RepoPolicy<PackageJsonPropertiesSettings> =\n\t{\n\t\tname: \"PackageJsonProperties\",\n\t\tmatch: /(^|\\/)package\\.json/i,\n\t\thandler: async ({ file, config, resolve }) => {\n\t\t\tif (config === undefined) {\n\t\t\t\treturn true;\n\t\t\t}\n\n\t\t\tconst failResult: PolicyFailure = {\n\t\t\t\tname: PackageJsonProperties.name,\n\t\t\t\tfile,\n\t\t\t\tautoFixable: true,\n\t\t\t};\n\n\t\t\tconst { verbatim } = config;\n\t\t\tconst json = (await readJson(file)) as PackageJson;\n\t\t\tconst messages: string[] = [];\n\n\t\t\tfor (const [propName, value] of Object.entries(verbatim)) {\n\t\t\t\tif (json[propName] !== value) {\n\t\t\t\t\tmessages.push(\n\t\t\t\t\t\t`Incorrect package.json field value for '${propName}'. Expected '${value}', got '${json[propName]}'.`,\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (messages.length > 0) {\n\t\t\t\tif (resolve) {\n\t\t\t\t\tconst fixResult: PolicyFixResult = {\n\t\t\t\t\t\t...failResult,\n\t\t\t\t\t\tresolved: false,\n\t\t\t\t\t};\n\n\t\t\t\t\tfor (const [propName, value] of Object.entries(verbatim)) {\n\t\t\t\t\t\tjson[propName] = value;\n\t\t\t\t\t}\n\t\t\t\t\tawait writeJson(file, json, { spaces: \"\\t\" });\n\n\t\t\t\t\tfixResult.resolved = true;\n\t\t\t\t\treturn fixResult;\n\t\t\t\t}\n\n\t\t\t\t// There were errors, and we're not resolving them, so return a fail result\n\t\t\t\tfailResult.errorMessage = messages.join(\"\\n\");\n\t\t\t\treturn failResult;\n\t\t\t}\n\n\t\t\treturn true;\n\t\t},\n\t};\n"]}

package/esm/policies/PackageJsonRepoDirectoryProperty.d.ts

@@ -0,0 +1,7 @@
+import type { RepoPolicy } from "../policy.js";
+/**
+ * A RepoPolicy that checks that the repository.directory property in package.json is set correctly. If the repository
+ * field is a string instead of an object the package will be ignored.
+ */
+export declare const PackageJsonRepoDirectoryProperty: RepoPolicy;
+//# sourceMappingURL=PackageJsonRepoDirectoryProperty.d.ts.map

package/esm/policies/PackageJsonRepoDirectoryProperty.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageJsonRepoDirectoryProperty.d.ts","sourceRoot":"","sources":["../../src/policies/PackageJsonRepoDirectoryProperty.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAkC,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/E;;;GAGG;AACH,eAAO,MAAM,gCAAgC,EAAE,UA2C9C,CAAC"}