repopo 0.4.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,84 @@
 # repopo
 
+## 0.6.0
+
+### Minor Changes
+
+- Configuration changes _[`#224`](https://github.com/tylerbutler/tools-monorepo/pull/224) [`2b7db34`](https://github.com/tylerbutler/tools-monorepo/commit/2b7db343d74ab2e518ab2f232f47ea365ca784b8) [@tylerbutler](https://github.com/tylerbutler)_
+
+  The configuration for repopo has changed a lot in this release. The goal is to improve the typing of config and make it
+  easier to configure things in one place.
+
+  Policies are now declared as `PolicyDefinition`, and are then combined with a configuration (if the policy has
+  configuration) using `makePolicy` to form a `PolicyInstance`, which is the primary type used internally.
+
+  Generators now generate `PolicyDefinition`s, and can be used directly inline with `makePolicy`.
+
+- Export policies from /policies entrypoint only _[`#224`](https://github.com/tylerbutler/tools-monorepo/pull/224) [`2b7db34`](https://github.com/tylerbutler/tools-monorepo/commit/2b7db343d74ab2e518ab2f232f47ea365ca784b8) [@tylerbutler](https://github.com/tylerbutler)_
+
+  Policies included with repopo are now exported from `repopo/policies`.
+
+### Patch Changes
+
+- Update package metadata _[`#221`](https://github.com/tylerbutler/tools-monorepo/pull/221) [`9e5225a`](https://github.com/tylerbutler/tools-monorepo/commit/9e5225abfb67af1575af13dff60830d8da28eafd) [@tylerbutler](https://github.com/tylerbutler)_
+
+<details><summary>Updated 2 dependencies</summary>
+
+<small>
+
+[`9e5225a`](https://github.com/tylerbutler/tools-monorepo/commit/9e5225abfb67af1575af13dff60830d8da28eafd)
+
+</small>
+
+- `@tylerbu/fundamentals@0.2.2`
+- `@tylerbu/cli-api@0.7.2`
+
+</details>
+
+## 0.5.0
+
+### Minor Changes
+
+- Export all default policies _[`#213`](https://github.com/tylerbutler/tools-monorepo/pull/213) [`3fc530b`](https://github.com/tylerbutler/tools-monorepo/commit/3fc530bad66259339547b3d8ec12b9265daea9a5) [@tylerbutler](https://github.com/tylerbutler)_
+
+  repopo now exports all included policies individually so users can opt in and out of them in their config.
+
+- New policies _[`#31`](https://github.com/tylerbutler/tools-monorepo/pull/31) [`c97a565`](https://github.com/tylerbutler/tools-monorepo/commit/c97a56518d9726667531aa71de9445fed8d56b96) [@tylerbutler](https://github.com/tylerbutler)_
+
+  - JsTsFileHeaders
+  - HtmlFileHeaders
+  - PackageScripts
+
+- API changes: _[`#120`](https://github.com/tylerbutler/tools-monorepo/pull/120) [`1108950`](https://github.com/tylerbutler/tools-monorepo/commit/1108950a7732dcc3ac9b8da10bd014bfec6c45b7) [@tylerbutler](https://github.com/tylerbutler)_
+
+  - **Breaking change**: `PolicyConfig` was renamed to `RepopoConfig`.
+  - **Breaking change**: Removed several flags from the check command.
+
+  Other changes:
+
+  - Refactor check command for clarity (more to do)
+
+- Functions to more easily create package.json handlers _[`#190`](https://github.com/tylerbutler/tools-monorepo/pull/190) [`84c4185`](https://github.com/tylerbutler/tools-monorepo/commit/84c4185e76186c3489a4b70e3a3015ba289df139) [@tylerbutler](https://github.com/tylerbutler)_
+
+  repopo now provides functions that can be used to generate policies for common files like package.json.
+
+### Patch Changes
+
+- Update dependencies _[`#217`](https://github.com/tylerbutler/tools-monorepo/pull/217) [`dcec014`](https://github.com/tylerbutler/tools-monorepo/commit/dcec014dfb70e5804a7535b5b8b9a3406f3e623d) [@tylerbutler](https://github.com/tylerbutler)_
+
+<details><summary>Updated 2 dependencies</summary>
+
+<small>
+
+[`dcec014`](https://github.com/tylerbutler/tools-monorepo/commit/dcec014dfb70e5804a7535b5b8b9a3406f3e623d)
+
+</small>
+
+- `@tylerbu/fundamentals@0.2.1`
+- `@tylerbu/cli-api@0.7.1`
+
+</details>
+
 ## 0.4.0
 
 ### Minor Changes

package/README.md

@@ -7,12 +7,13 @@ file in your git repo, with a straightforward way to write your own policies.
 * [repopo - police the files in your git repo with extensible policies](#repopo---police-the-files-in-your-git-repo-with-extensible-policies)
 * [Configuring policies](#configuring-policies)
 * [Included policies](#included-policies)
-* [Usage](#usage)
+* [Policy generators](#policy-generators)
+* [CLI Usage](#cli-usage)
 <!-- tocstop -->
 
 # Configuring policies
 
-Repopo and its policies can be configured in a repopo.config.ts (or .cjs, or .mjs) file in the root of the repo. Using a
+Repopo and its policies can be configured in a `repopo.config.ts` (or `.cjs`, or `.mjs`) file in the root of the repo. Using a
 TypeScript configuration file is recommended.
 
 The policy config must export a default object of the type `PolicyConfig`.
@@ -23,19 +24,25 @@ By default, all files in the repo are checked. You can exclude files completely
 d `excludeFiles` setting. It should be an array of strings/regular expressions. Paths that match any of these
 expressions will be completely excluded from all policies.
 
-You can exclude files from individual policies as well. To do this, set the `excludePoliciesForFiles` setting. It should
-be an object with keys that match policy names. The value is an array of strings/regular expressions. Paths that match
-any of these expressions will be excluded from that policy only.
+You can exclude files from individual policies as well by configuring the `excludeFiles` setting when calling
+`makePolicy`.
 
 ## Configuring individual policies
 
-Individual policies can be configured using the `policySettings` setting. Use the policy name as the key, with the
-policy settings as the value.
+Individual policies can be configured by passing configuration settings to a `PolicyDefinition` in `makePolicy`.
 
 # Included policies
 
 repopo includes the following policies. All of the included policies are enabled by default.
 
+## HtmlFileHeaders and JsTsFileHeaders
+
+These policies set a common file header for JavaScript/TypeScript and HTML files.
+
+### Configuration
+
+TODO
+
 ## NoJsFileExtensions
 
 The NoJsFileExtensions policy checks for JavaScript source files that just use the .js file extension. Such files may be
@@ -61,6 +68,10 @@ const config: PolicyConfig = {
 				license: "MIT",
 				author: "Tyler Butler <tyler@tylerbutler.com>",
 				bugs: "https://github.com/tylerbutler/tools-monorepo/issues",
+				repository: {
+					type: "git",
+					url: "git+https://github.com/tylerbutler/tools-monorepo.git",
+				}
 			}
 		}
 	}
@@ -72,7 +83,17 @@ const config: PolicyConfig = {
 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.
 
-# Usage
+# Policy generators
+
+There are some filetypes that often have policies applied to them, like package.json. You can use the policy generator
+functions to generate policies for those filetypes. Using the generators is not required; they simply reduce the amount
+of boilerplate code you have to write for a policy.
+
+## generatePackagePolicy
+
+Use `generatePackagePolicy` to generate policies for package.json files.
+
+# CLI Usage
 
 <!-- commands -->
 * [`repopo check`](#repopo-check)
@@ -84,16 +105,15 @@ Checks and applies policies to the files in the repository.
 
 ```
 USAGE
-  $ repopo check [-f] [--stdin] [-D <value>... | -d <value>] [-p <value>]
+  $ repopo check [-v | --quiet] [-f] [--stdin]
 
 FLAGS
-  -D, --excludePolicy=<value>...  Exclude policies by name. Can be specified multiple times to exclude multiple
-                                  policies.
-  -d, --policy=<value>            Filter policies to apply by <regex>. Only policies with a name matching the regex will
-                                  be applied.
-  -f, --fix                       Fix errors if possible.
-  -p, --path=<value>              Filter file paths by <regex>.
-      --stdin                     Read list of files from stdin.
+  -f, --fix    Fix errors if possible.
+      --stdin  Read list of files from stdin.
+
+LOGGING FLAGS
+  -v, --verbose  Enable verbose logging.
+      --quiet    Disable all logging.
 ```
 
 _See code: [src/commands/check.ts](https://github.com/tylerbutler/tools-monorepo/blob/main/packages/repopo/src/commands/check.ts)_
@@ -104,14 +124,11 @@ Lists the policies configured to run.
 
 ```
 USAGE
-  $ repopo list [-D <value>... | -d <value>] [-p <value>]
+  $ repopo list [-v | --quiet]
 
-FLAGS
-  -D, --excludePolicy=<value>...  Exclude policies by name. Can be specified multiple times to exclude multiple
-                                  policies.
-  -d, --policy=<value>            Filter policies to apply by <regex>. Only policies with a name matching the regex will
-                                  be applied.
-  -p, --path=<value>              Filter file paths by <regex>.
+LOGGING FLAGS
+  -v, --verbose  Enable verbose logging.
+      --quiet    Disable all logging.
 ```
 
 _See code: [src/commands/list.ts](https://github.com/tylerbutler/tools-monorepo/blob/main/packages/repopo/src/commands/list.ts)_

package/THIRD-PARTY-LICENSES.txt

@@ -27,7 +27,7 @@ OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHE
 
 The following npm package may be included in this product:
 
- - @rushstack/node-core-library@5.9.0
+ - @rushstack/node-core-library@5.13.1
 
 This package contains the following license:
 
@@ -60,7 +60,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 The following npm package may be included in this product:
 
- - @fluid-tools/build-infrastructure@0.52.0
+ - @fluid-tools/build-infrastructure@0.56.0
 
 This package contains the following license:
 
@@ -114,13 +114,24 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 The following npm package may be included in this product:
 
- - sort-package-json@2.14.0
+ - simple-git@3.27.0
 
 This package contains the following license:
 
+MIT
+
+-----------
+
+The following npm packages may be included in this product:
+
+ - @oclif/core@4.3.0
+ - @oclif/plugin-help@6.2.27
+
+These packages each contain the following license:
+
 MIT License
 
-Copyright (c) 2015 Keith Cirkel
+Copyright (c) 2018 Salesforce.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -142,16 +153,15 @@ SOFTWARE.
 
 -----------
 
-The following npm packages may be included in this product:
+The following npm package may be included in this product:
 
- - @oclif/core@4.2.3
- - @oclif/plugin-help@6.2.21
+ - microdiff@1.5.0
 
-These packages each contain the following license:
+This package contains the following license:
 
 MIT License
 
-Copyright (c) 2018 Salesforce.com
+Copyright (c) 2021 AsyncBanana
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -175,13 +185,13 @@ SOFTWARE.
 
 The following npm package may be included in this product:
 
- - sort-tsconfig@0.2.0
+ - defu@6.1.4
 
 This package contains the following license:
 
 MIT License
 
-Copyright (c) 2023 Tyler Butler <tyler@tylerbutler.com>
+Copyright (c) Pooya Parsa <pooya@pi0.io>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/esm/api.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api.d.ts.map

package/esm/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":""}

package/esm/api.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api.js.map

package/esm/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"","sourcesContent":[""]}

package/esm/baseCommand.d.ts

@@ -1,52 +1,22 @@
-import { GitCommand } from "@tylerbu/cli-api";
-import type { PolicyConfig } from "./config.js";
-import { type PolicyHandlerPerfStats } from "./perf.js";
-import { type PolicyName, type RepoPolicy } from "./policy.js";
+import { CommandWithConfig, type CommandWithContext, type RequiresGit } from "@tylerbu/cli-api";
+import { type SimpleGit } from "simple-git";
+import { type RepopoConfig } from "./config.js";
+import type { RepopoCommandContext } from "./context.js";
 /**
- * A convenience interface used to pass commonly used parameters between functions.
- */
-export interface PolicyCommandContext {
-    /**
-     * A regular expression used to filter selected files.
-     */
-    pathRegex: RegExp;
-    /**
-     * A list of regular expressions used to exclude files from all handlers.
-     */
-    excludeFiles: RegExp[];
-    /**
-     * A list of handlers to apply to selected files.
-     */
-    policies: RepoPolicy[];
-    /**
-     * A per-handler list of regular expressions used to exclude files from specific handlers.
-     */
-    excludePoliciesForFiles: ExcludedPolicyFileMap;
-    /**
-     * Path to the root of the git repo.
-     */
-    gitRoot: string;
-    /**
-     * Performance information for each handler.
-     */
-    perfStats: PolicyHandlerPerfStats;
-}
-/**
- * This command lists all the policies configured to run.
+ * This class is the base for all repopo commands. It contains common flags and config loading.
  */
 export declare abstract class BaseRepopoCommand<T extends typeof BaseRepopoCommand & {
-    args: typeof GitCommand.args;
-    flags: typeof GitCommand.flags;
-}> extends GitCommand<T, PolicyConfig> {
+    args: typeof CommandWithConfig.args;
+    flags: typeof CommandWithConfig.flags;
+}> extends CommandWithConfig<T, RepopoConfig> implements CommandWithContext<RepopoCommandContext>, RequiresGit {
+    protected defaultConfig: RepopoConfig;
     static readonly flags: {
         readonly config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        readonly policy: import("@oclif/core/interfaces").OptionFlag<RegExp | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        readonly excludePolicy: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        readonly path: import("@oclif/core/interfaces").OptionFlag<RegExp | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    private context;
-    protected getContext(): PolicyCommandContext;
+    private _git;
+    get git(): SimpleGit;
     init(): Promise<void>;
+    private _context;
+    getContext(): Promise<RepopoCommandContext>;
 }
-export type ExcludedPolicyFileMap = Map<PolicyName, RegExp[]>;
 //# sourceMappingURL=baseCommand.d.ts.map

package/esm/baseCommand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseCommand.d.ts","sourceRoot":"","sources":["../src/baseCommand.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAA2B,MAAM,kBAAkB,CAAC;AAEvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,KAAK,sBAAsB,EAAgB,MAAM,WAAW,CAAC;AACtE,OAAO,EAAmB,KAAK,UAAU,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAIhF;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,UAAU,EAAE,CAAC;IAEvB;;OAEG;IACH,uBAAuB,EAAE,qBAAqB,CAAC;IAE/C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,sBAAsB,CAAC;CAClC;AAED;;GAEG;AACH,8BAAsB,iBAAiB,CACtC,CAAC,SAAS,OAAO,iBAAiB,GAAG;IACpC,IAAI,EAAE,OAAO,UAAU,CAAC,IAAI,CAAC;IAC7B,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CAC/B,CACA,SAAQ,UAAU,CAAC,CAAC,EAAE,YAAY,CAAC;IACpC,gBAAyB,KAAK;gCAlCF,wBAAwB,wCAExC,wBAGP;;;;MAiDM;IAEX,OAAO,CAAC,OAAO,CAAmC;IAElD,SAAS,CAAC,UAAU,IAAI,oBAAoB;IAOtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAoD3C;AAED,MAAM,MAAM,qBAAqB,GAAG,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC"}
+{"version":3,"file":"baseCommand.d.ts","sourceRoot":"","sources":["../src/baseCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,iBAAiB,EACjB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,KAAK,SAAS,EAAa,MAAM,YAAY,CAAC;AACvD,OAAO,EAAuB,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,KAAK,EAAyB,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAKhF;;GAEG;AACH,8BAAsB,iBAAiB,CACrC,CAAC,SAAS,OAAO,iBAAiB,GAAG;IACpC,IAAI,EAAE,OAAO,iBAAiB,CAAC,IAAI,CAAC;IACpC,KAAK,EAAE,OAAO,iBAAiB,CAAC,KAAK,CAAC;CACtC,CAEF,SAAQ,iBAAiB,CAAC,CAAC,EAAE,YAAY,CACzC,YAAW,kBAAkB,CAAC,oBAAoB,CAAC,EAAE,WAAW;IAEhE,UAAmB,aAAa,eAAuB;IAEvD,gBAAyB,KAAK;gCAb2D,wBAE5E,wCACD,wBAAwB;MAYzB;IAEX,OAAO,CAAC,IAAI,CAAwB;IACpC,IAAW,GAAG,IAAI,SAAS,CAK1B;IAEqB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAyB3C,OAAO,CAAC,QAAQ,CAAmC;IAGtC,UAAU,IAAI,OAAO,CAAC,oBAAoB,CAAC;CAMxD"}

package/esm/baseCommand.js

@@ -1,87 +1,51 @@
-import { Flags } from "@oclif/core";
-import { GitCommand, RegExpFlag, findGitRoot } from "@tylerbu/cli-api";
+import { CommandWithConfig, } from "@tylerbu/cli-api";
+import { findGitRootSync } from "@tylerbu/fundamentals/git";
+import { simpleGit } from "simple-git";
+import { DefaultPolicyConfig } from "./config.js";
+import { makePolicy } from "./makePolicy.js";
 import { newPerfStats } from "./perf.js";
 import { DefaultPolicies } from "./policy.js";
-const DEFAULT_PATH_REGEX = /.?/;
 /**
- * This command lists all the policies configured to run.
+ * This class is the base for all repopo commands. It contains common flags and config loading.
  */
-export class BaseRepopoCommand extends GitCommand {
+export class BaseRepopoCommand extends CommandWithConfig {
+    defaultConfig = DefaultPolicyConfig;
     static flags = {
-        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",
-        }),
-        ...GitCommand.flags,
+        ...CommandWithConfig.flags,
     };
-    context;
-    getContext() {
-        if (this.context === undefined) {
-            throw new Error("context undefined");
+    _git;
+    get git() {
+        if (this._git === undefined) {
+            throw new Error("git property is undefined");
         }
-        return this.context;
+        return this._git;
     }
     async init() {
         await super.init();
-        const { flags } = this;
-        const config = this.commandConfig;
-        let policies = config?.policies ?? DefaultPolicies;
-        policies =
-            policies.filter((h) => {
-                if (flags.excludePolicy === undefined ||
-                    flags.excludePolicy.length === 0) {
-                    return true;
-                }
-                const shouldRun = flags.excludePolicy?.includes(h.name) === false;
-                if (!shouldRun) {
-                    this.info(`Disabled policy: ${h.name}`);
-                }
-                return shouldRun;
-            }) ?? [];
-        if (flags.policy !== undefined) {
-            this.info(`Filtering handlers by regex: ${flags.policy}`);
-            policies = policies.filter((h) => flags.policy?.test(h.name));
-        }
-        const excludeFiles = config?.excludeFiles?.map((e) => toRegExp(e)) ?? [];
-        const excludePoliciesForFilesRaw = config?.excludePoliciesForFiles;
+        const excludeFiles = this.commandConfig?.excludeFiles?.map((e) => new RegExp(e, "i")) ?? [];
         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();
-        const pathRegex = this.flags.path ?? DEFAULT_PATH_REGEX;
-        if (this.flags.path !== undefined) {
-            this.info(`Filtering file paths by regex: ${pathRegex}`);
+        for (const policy of this.commandConfig?.policies ?? []) {
+            const regexes = policy.excludeFiles?.map((e) => new RegExp(e, "i")) ?? [];
+            excludePoliciesForFiles.set(policy.name, regexes);
         }
-        this.context = {
-            pathRegex,
-            excludeFiles,
-            policies,
+        const gitRoot = findGitRootSync();
+        this._git = simpleGit({ baseDir: gitRoot });
+        this._context = {
+            excludeFromAll: excludeFiles,
+            policies: this.commandConfig?.policies ??
+                DefaultPolicies.map((p) => makePolicy(p)),
             excludePoliciesForFiles,
             gitRoot,
             perfStats: newPerfStats(),
         };
     }
-}
-function toRegExp(input) {
-    if (typeof input === "string") {
-        return new RegExp(input, "i");
+    _context;
+    // biome-ignore lint/suspicious/useAwait: interface defines this as async
+    async getContext() {
+        if (this._context === undefined) {
+            throw new Error("Context not initialized.");
+        }
+        return this._context;
     }
-    return input;
 }
 //# sourceMappingURL=baseCommand.js.map

package/esm/baseCommand.js.map

@@ -1 +1 @@
-{"version":3,"file":"baseCommand.js","sourceRoot":"","sources":["../src/baseCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGvE,OAAO,EAA+B,YAAY,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,eAAe,EAAoC,MAAM,aAAa,CAAC;AAEhF,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAqChC;;GAEG;AACH,MAAM,OAAgB,iBAKpB,SAAQ,UAA2B;IACpC,MAAM,CAAmB,KAAK,GAAG;QAChC,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,GAAG,UAAU,CAAC,KAAK;KACV,CAAC;IAEH,OAAO,CAAmC;IAExC,UAAU;QACnB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAEe,KAAK,CAAC,IAAI;QACzB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC;QAClC,IAAI,QAAQ,GAAG,MAAM,EAAE,QAAQ,IAAI,eAAe,CAAC;QACnD,QAAQ;YACP,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;gBACrB,IACC,KAAK,CAAC,aAAa,KAAK,SAAS;oBACjC,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAC/B,CAAC;oBACF,OAAO,IAAI,CAAC;gBACb,CAAC;gBACD,MAAM,SAAS,GAAG,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC;gBAClE,IAAI,CAAC,SAAS,EAAE,CAAC;oBAChB,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBACzC,CAAC;gBACD,OAAO,SAAS,CAAC;YAClB,CAAC,CAAC,IAAI,EAAE,CAAC;QACV,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,gCAAgC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAC1D,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,YAAY,GACjB,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACrD,MAAM,0BAA0B,GAAG,MAAM,EAAE,uBAAuB,CAAC;QACnE,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;QACD,MAAM,OAAO,GAAG,MAAM,WAAW,EAAE,CAAC;QAEpC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,kBAAkB,CAAC;QACxD,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,kCAAkC,SAAS,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,OAAO,GAAG;YACd,SAAS;YACT,YAAY;YACZ,QAAQ;YACR,uBAAuB;YACvB,OAAO;YACP,SAAS,EAAE,YAAY,EAAE;SACzB,CAAC;IACH,CAAC;;AAKF,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 { Flags } from \"@oclif/core\";\nimport { GitCommand, RegExpFlag, findGitRoot } from \"@tylerbu/cli-api\";\n\nimport type { PolicyConfig } from \"./config.js\";\nimport { type PolicyHandlerPerfStats, newPerfStats } from \"./perf.js\";\nimport { DefaultPolicies, type PolicyName, type RepoPolicy } from \"./policy.js\";\n\nconst DEFAULT_PATH_REGEX = /.?/;\n\n/**\n * A convenience interface used to pass commonly used parameters between functions.\n */\nexport interface PolicyCommandContext {\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 * Performance information for each handler.\n\t */\n\tperfStats: PolicyHandlerPerfStats;\n}\n\n/**\n * This command lists all the policies configured to run.\n */\nexport abstract class BaseRepopoCommand<\n\tT extends typeof BaseRepopoCommand & {\n\t\targs: typeof GitCommand.args;\n\t\tflags: typeof GitCommand.flags;\n\t},\n> extends GitCommand<T, PolicyConfig> {\n\tstatic override readonly flags = {\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\t...GitCommand.flags,\n\t} as const;\n\n\tprivate context: PolicyCommandContext | undefined;\n\n\tprotected getContext(): PolicyCommandContext {\n\t\tif (this.context === undefined) {\n\t\t\tthrow new Error(\"context undefined\");\n\t\t}\n\t\treturn this.context;\n\t}\n\n\tpublic override async init(): Promise<void> {\n\t\tawait super.init();\n\t\tconst { flags } = this;\n\t\tconst config = this.commandConfig;\n\t\tlet policies = config?.policies ?? DefaultPolicies;\n\t\tpolicies =\n\t\t\tpolicies.filter((h) => {\n\t\t\t\tif (\n\t\t\t\t\tflags.excludePolicy === undefined ||\n\t\t\t\t\tflags.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 = 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\t\tif (flags.policy !== undefined) {\n\t\t\tthis.info(`Filtering handlers by regex: ${flags.policy}`);\n\t\t\tpolicies = policies.filter((h) => flags.policy?.test(h.name));\n\t\t}\n\n\t\tconst excludeFiles: RegExp[] =\n\t\t\tconfig?.excludeFiles?.map((e) => toRegExp(e)) ?? [];\n\t\tconst excludePoliciesForFilesRaw = config?.excludePoliciesForFiles;\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\t\tconst gitRoot = await findGitRoot();\n\n\t\tconst pathRegex = this.flags.path ?? DEFAULT_PATH_REGEX;\n\t\tif (this.flags.path !== undefined) {\n\t\t\tthis.info(`Filtering file paths by regex: ${pathRegex}`);\n\t\t}\n\n\t\tthis.context = {\n\t\t\tpathRegex,\n\t\t\texcludeFiles,\n\t\t\tpolicies,\n\t\t\texcludePoliciesForFiles,\n\t\t\tgitRoot,\n\t\t\tperfStats: newPerfStats(),\n\t\t};\n\t}\n}\n\nexport type ExcludedPolicyFileMap = Map<PolicyName, RegExp[]>;\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"]}
+{"version":3,"file":"baseCommand.js","sourceRoot":"","sources":["../src/baseCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,iBAAiB,GAGjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAkB,SAAS,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAqB,MAAM,aAAa,CAAC;AAErE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C;;GAEG;AACH,MAAM,OAAgB,iBAMrB,SAAQ,iBAAkC;IAGvB,aAAa,GAAG,mBAAmB,CAAC;IAEvD,MAAM,CAAmB,KAAK,GAAG;QAChC,GAAG,iBAAiB,CAAC,KAAK;KACjB,CAAC;IAEH,IAAI,CAAwB;IACpC,IAAW,GAAG;QACb,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IAEe,KAAK,CAAC,IAAI;QACzB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QAEnB,MAAM,YAAY,GACjB,IAAI,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAExE,MAAM,uBAAuB,GAA0B,IAAI,GAAG,EAAE,CAAC;QACjE,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE,QAAQ,IAAI,EAAE,EAAE,CAAC;YACzD,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YAC1E,uBAAuB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,OAAO,GAAG,eAAe,EAAE,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG;YACf,cAAc,EAAE,YAAY;YAC5B,QAAQ,EACP,IAAI,CAAC,aAAa,EAAE,QAAQ;gBAC5B,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAC1C,uBAAuB;YACvB,OAAO;YACP,SAAS,EAAE,YAAY,EAAE;SACzB,CAAC;IACH,CAAC;IAEO,QAAQ,CAAmC;IAEnD,yEAAyE;IAClE,KAAK,CAAC,UAAU;QACtB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC","sourcesContent":["import {\n\tCommandWithConfig,\n\ttype CommandWithContext,\n\ttype RequiresGit,\n} from \"@tylerbu/cli-api\";\nimport { findGitRootSync } from \"@tylerbu/fundamentals/git\";\nimport { type SimpleGit, simpleGit } from \"simple-git\";\nimport { DefaultPolicyConfig, type RepopoConfig } from \"./config.js\";\nimport type { ExcludedPolicyFileMap, RepopoCommandContext } from \"./context.js\";\nimport { makePolicy } from \"./makePolicy.js\";\nimport { newPerfStats } from \"./perf.js\";\nimport { DefaultPolicies } from \"./policy.js\";\n\n/**\n * This class is the base for all repopo commands. It contains common flags and config loading.\n */\nexport abstract class BaseRepopoCommand<\n\t\tT extends typeof BaseRepopoCommand & {\n\t\t\targs: typeof CommandWithConfig.args;\n\t\t\tflags: typeof CommandWithConfig.flags;\n\t\t},\n\t>\n\textends CommandWithConfig<T, RepopoConfig>\n\timplements CommandWithContext<RepopoCommandContext>, RequiresGit\n{\n\tprotected override defaultConfig = DefaultPolicyConfig;\n\n\tstatic override readonly flags = {\n\t\t...CommandWithConfig.flags,\n\t} as const;\n\n\tprivate _git: SimpleGit | undefined;\n\tpublic get git(): SimpleGit {\n\t\tif (this._git === undefined) {\n\t\t\tthrow new Error(\"git property is undefined\");\n\t\t}\n\t\treturn this._git;\n\t}\n\n\tpublic override async init(): Promise<void> {\n\t\tawait super.init();\n\n\t\tconst excludeFiles: RegExp[] =\n\t\t\tthis.commandConfig?.excludeFiles?.map((e) => new RegExp(e, \"i\")) ?? [];\n\n\t\tconst excludePoliciesForFiles: ExcludedPolicyFileMap = new Map();\n\t\tfor (const policy of this.commandConfig?.policies ?? []) {\n\t\t\tconst regexes = policy.excludeFiles?.map((e) => new RegExp(e, \"i\")) ?? [];\n\t\t\texcludePoliciesForFiles.set(policy.name, regexes);\n\t\t}\n\n\t\tconst gitRoot = findGitRootSync();\n\t\tthis._git = simpleGit({ baseDir: gitRoot });\n\t\tthis._context = {\n\t\t\texcludeFromAll: excludeFiles,\n\t\t\tpolicies:\n\t\t\t\tthis.commandConfig?.policies ??\n\t\t\t\tDefaultPolicies.map((p) => makePolicy(p)),\n\t\t\texcludePoliciesForFiles,\n\t\t\tgitRoot,\n\t\t\tperfStats: newPerfStats(),\n\t\t};\n\t}\n\n\tprivate _context: RepopoCommandContext | undefined;\n\n\t// biome-ignore lint/suspicious/useAwait: interface defines this as async\n\tpublic async getContext(): Promise<RepopoCommandContext> {\n\t\tif (this._context === undefined) {\n\t\t\tthrow new Error(\"Context not initialized.\");\n\t\t}\n\t\treturn this._context;\n\t}\n}\n"]}

package/esm/commands/check.d.ts

@@ -15,28 +15,33 @@ export declare class CheckPolicy<T extends typeof BaseRepopoCommand & {
     static readonly summary = "Checks and applies policies to the files in the repository.";
     static readonly flags: {
         readonly config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        readonly policy: import("@oclif/core/interfaces").OptionFlag<RegExp | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        readonly excludePolicy: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        readonly path: import("@oclif/core/interfaces").OptionFlag<RegExp | undefined, import("@oclif/core/interfaces").CustomOptions>;
         readonly fix: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         readonly stdin: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    private processed;
-    private count;
-    defaultConfig: import("../config.js").PolicyConfig;
-    init(): Promise<void>;
     run(): Promise<void>;
-    private executePolicy;
     /**
-     * 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.
+     * Executes all policies against the provided paths.
+     *
+     * @param pathsToCheck - All paths that should be checked. Paths should be relative to the repository root.
+     * @param context - The context.
      */
-    private routeToHandlers;
+    private checkAllFiles;
     /**
      * 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.
+     *
+     * @param relPath - A git repo-relative path to a file.
      */
     private checkOrExcludeFile;
+    private routeToPolicies;
+    private runPolicyOnFile;
+    private isPolicyExcluded;
+    private executePolicyHandler;
+    private handlePolicyResult;
+    private handleFixResult;
+    private handleFailureResult;
+    private attemptResolution;
+    private logPolicyFailure;
+    private logMessages;
 }
 //# sourceMappingURL=check.d.ts.map

package/esm/commands/check.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAOA,OAAO,EACN,iBAAiB,EAEjB,MAAM,mBAAmB,CAAC;AAK3B;;;;;;;;GAQG;AACH,qBAAa,WAAW,CACvB,CAAC,SAAS,OAAO,iBAAiB,GAAG;IACpC,IAAI,EAAE,OAAO,WAAW,CAAC,IAAI,CAAC;IAC9B,KAAK,EAAE,OAAO,WAAW,CAAC,KAAK,CAAC;CAChC,CACA,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAC7B,gBAAyB,OAAO,iEAC+B;IAE/D,gBAAyB,KAAK;gCAhBf,wBAAwB,wCAAwC,wBAAwB;;;;;;MA4B5F;IAEX,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,KAAK,CAAK;IAEF,aAAa,sCAAuB;IAE9B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAQrB,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;YAuC5B,aAAa;IAc3B;;;;OAIG;YACW,eAAe;IA0G7B;;;OAGG;YACW,kBAAkB;CA0BhC"}
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAYtD;;;;;;;;GAQG;AACH,qBAAa,WAAW,CACvB,CAAC,SAAS,OAAO,iBAAiB,GAAG;IACpC,IAAI,EAAE,OAAO,WAAW,CAAC,IAAI,CAAC;IAC9B,KAAK,EAAE,OAAO,WAAW,CAAC,KAAK,CAAC;CAChC,CACA,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAC7B,gBAAyB,OAAO,iEAC+B;IAE/D,gBAAyB,KAAK;gCAjBiB,wBAAwB,wCACvE,wBAAsB;;;MA4BX;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAwD1C;;;;;OAKG;YACW,aAAa;IAe3B;;;;;OAKG;YACW,kBAAkB;YAkBlB,eAAe;YA4Bf,eAAe;IAsC7B,OAAO,CAAC,gBAAgB;YAYV,oBAAoB;YAsBpB,kBAAkB;IAwBhC,OAAO,CAAC,eAAe;YAoBT,mBAAmB;YAyBnB,iBAAiB;IAyB/B,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,WAAW;CAOnB"}