repopo 0.3.2 → 0.5.0

package/esm/policy.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @alpha
+ */
+export type DefaultPolicyConfigType = object | unknown;
 /**
  * A type representing a policy name.
  *
@@ -5,13 +9,29 @@
  */
 export type PolicyName = string;
 /**
+ * Arguments passed to policy functions.
+ *
  * @alpha
  */
-export interface PolicyFunctionArguments<C = unknown | undefined> {
+export interface PolicyFunctionArguments<C> {
+    /**
+     * Path to the file, relative to the repo root.
+     */
     file: string;
+    /**
+     * Absolute path to the root of the repo.
+     */
     root: string;
+    /**
+     * If true, the handler should resolve any violations automatically if possible.
+     */
     resolve: boolean;
-    config?: C;
+    /**
+     * @remarks
+     *
+     * Note that the handler function receives the config as an argument.
+     */
+    config?: C | undefined;
 }
 /**
  * A policy handler is a function that is called to check policy against a file.
@@ -24,7 +44,7 @@ export type PolicyHandler<C = unknown | undefined> = (args: PolicyFunctionArgume
  *
  * @alpha
  */
-export type PolicyStandaloneResolver<C = unknown | undefined> = (args: Omit<PolicyFunctionArguments<C>, "resolve">) => PolicyFixResult;
+export type PolicyStandaloneResolver<C = DefaultPolicyConfigType | undefined> = (args: Omit<PolicyFunctionArguments<C>, "resolve">) => Promise<PolicyFixResult>;
 /**
  * A RepoPolicy checks and applies policies to files in the repository.
  *
@@ -38,7 +58,7 @@ export type PolicyStandaloneResolver<C = unknown | undefined> = (args: Omit<Poli
  *
  * @alpha
  */
-export interface RepoPolicy<C = any | undefined> {
+export interface RepoPolicy<C extends DefaultPolicyConfigType = unknown | undefined> {
     /**
      * The name of the policy; displayed in UI and used in settings.
      */
@@ -69,14 +89,12 @@ export interface RepoPolicy<C = any | undefined> {
      */
     resolver?: PolicyStandaloneResolver<C> | undefined;
 }
-export declare class RepoPolicyClass implements RepoPolicy {
-    readonly name: string;
-    readonly match: RegExp;
-    handler: PolicyHandler;
-    resolver?: PolicyStandaloneResolver | undefined;
-    static createRepoPolicy(name: string, match: RegExp, handler: PolicyHandler, resolver?: PolicyStandaloneResolver): RepoPolicyClass;
-    constructor(name: string, match: RegExp, handler: PolicyHandler, resolver?: PolicyStandaloneResolver | undefined);
-}
+/**
+ * A policy handler especially for policies that target package.json.
+ *
+ * @alpha
+ */
+export type PackageJsonHandler<J, C> = (json: J, args: PolicyFunctionArguments<C>) => Promise<true | PolicyFailure | PolicyFixResult>;
 /**
  * A policy failure.
  *
@@ -117,5 +135,5 @@ export declare function isPolicyFixResult(toCheck: any): toCheck is PolicyFixRes
  *
  * @alpha
  */
-export declare const DefaultPolicies: RepoPolicy[];
+export declare const DefaultPolicies: RepoPolicy<any>[];
 //# sourceMappingURL=policy.d.ts.map

package/esm/policy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"policy.d.ts","sourceRoot":"","sources":["../src/policy.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,CAAC,CAAC;CACX;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS,IAAI,CACpD,IAAI,EAAE,uBAAuB,CAAC,CAAC,CAAC,KAC5B,OAAO,CAAC,IAAI,GAAG,aAAa,GAAG,eAAe,CAAC,CAAC;AAOrD;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS,IAAI,CAC/D,IAAI,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAC7C,eAAe,CAAC;AAIrB;;;;;;;;;;;;GAYG;AAGH,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,GAAG,GAAG,SAAS;IAC9C;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;OAOG;IACH,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAE1B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CACnD;AAED,qBAAa,eAAgB,YAAW,UAAU;aAWhC,IAAI,EAAE,MAAM;aACZ,KAAK,EAAE,MAAM;IACtB,OAAO,EAAE,aAAa;IACtB,QAAQ,CAAC,EAAE,wBAAwB;WAb7B,gBAAgB,CAC7B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,aAAa,EACtB,QAAQ,CAAC,EAAE,wBAAwB,GACjC,eAAe;gBAKD,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACtB,OAAO,EAAE,aAAa,EACtB,QAAQ,CAAC,EAAE,wBAAwB,YAAA;CAI3C;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAGD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,eAAe,CAK1E;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,UAAU,EAMvC,CAAC"}
+{"version":3,"file":"policy.d.ts","sourceRoot":"","sources":["../src/policy.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,OAAO,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;;;GAIG;AAEH,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACzC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;CACvB;AAED;;;;GAIG;AAEH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS,IAAI,CACpD,IAAI,EAAE,uBAAuB,CAAC,CAAC,CAAC,KAC5B,OAAO,CAAC,IAAI,GAAG,aAAa,GAAG,eAAe,CAAC,CAAC;AAOrD;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,GAAG,uBAAuB,GAAG,SAAS,IAC3E,CACC,IAAI,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAC7C,OAAO,CAAC,eAAe,CAAC,CAAC;AAI/B;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,UAAU,CAC1B,CAAC,SAAS,uBAAuB,GAAG,OAAO,GAAG,SAAS;IAEvD;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;OAOG;IAEH,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAE1B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CACnD;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CACtC,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,uBAAuB,CAAC,CAAC,CAAC,KAC5B,OAAO,CAAC,IAAI,GAAG,aAAa,GAAG,eAAe,CAAC,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAGD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,eAAe,CAK1E;AAED;;;;GAIG;AAGH,eAAO,MAAM,eAAe,EAAE,UAAU,CAAC,GAAG,CAAC,EAQnC,CAAC"}

package/esm/policy.js

@@ -1,24 +1,9 @@
+import { HtmlFileHeaders } from "./policies.js";
+import { JsTsFileHeaders } from "./policies/JsTsFileHeaders.js";
 import { NoJsFileExtensions } from "./policies/NoJsFileExtensions.js";
 import { PackageJsonProperties } from "./policies/PackageJsonProperties.js";
 import { PackageJsonRepoDirectoryProperty } from "./policies/PackageJsonRepoDirectoryProperty.js";
-import { PackageJsonSortedPolicy } from "./policies/PackageJsonSortedPolicy.js";
-import { SortTsconfigs } from "./policies/SortTsconfigs.js";
-export class RepoPolicyClass {
-    name;
-    match;
-    handler;
-    resolver;
-    static createRepoPolicy(name, match, handler, resolver) {
-        return new RepoPolicyClass(name, match, handler, resolver);
-    }
-    constructor(name, match, handler, resolver) {
-        this.name = name;
-        this.match = match;
-        this.handler = handler;
-        this.resolver = resolver;
-        // empty
-    }
-}
+import { PackageScripts } from "./policies/PackageScripts.js";
 // biome-ignore lint/suspicious/noExplicitAny: type guard
 export function isPolicyFixResult(toCheck) {
     if (typeof toCheck !== "object") {
@@ -31,11 +16,14 @@ export function isPolicyFixResult(toCheck) {
  *
  * @alpha
  */
+// biome-ignore lint/suspicious/noExplicitAny: FIXME
 export const DefaultPolicies = [
+    HtmlFileHeaders,
+    JsTsFileHeaders,
     NoJsFileExtensions,
     PackageJsonRepoDirectoryProperty,
     PackageJsonProperties,
-    PackageJsonSortedPolicy,
-    SortTsconfigs,
+    // PackageJsonSorted,
+    PackageScripts,
 ];
 //# sourceMappingURL=policy.js.map

package/esm/policy.js.map

@@ -1 +1 @@
-{"version":3,"file":"policy.js","sourceRoot":"","sources":["../src/policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,gCAAgC,EAAE,MAAM,gDAAgD,CAAC;AAClG,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AA+F5D,MAAM,OAAO,eAAe;IAWV;IACA;IACT;IACA;IAbD,MAAM,CAAC,gBAAgB,CAC7B,IAAY,EACZ,KAAa,EACb,OAAsB,EACtB,QAAmC;QAEnC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,YACiB,IAAY,EACZ,KAAa,EACtB,OAAsB,EACtB,QAAmC;QAH1B,SAAI,GAAJ,IAAI,CAAQ;QACZ,UAAK,GAAL,KAAK,CAAQ;QACtB,YAAO,GAAP,OAAO,CAAe;QACtB,aAAQ,GAAR,QAAQ,CAA2B;QAE1C,QAAQ;IACT,CAAC;CACD;AAyCD,yDAAyD;AACzD,MAAM,UAAU,iBAAiB,CAAC,OAAY;IAC7C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,UAAU,IAAI,OAAO,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAiB;IAC5C,kBAAkB;IAClB,gCAAgC;IAChC,qBAAqB;IACrB,uBAAuB;IACvB,aAAa;CACb,CAAC","sourcesContent":["import { NoJsFileExtensions } from \"./policies/NoJsFileExtensions.js\";\nimport { PackageJsonProperties } from \"./policies/PackageJsonProperties.js\";\nimport { PackageJsonRepoDirectoryProperty } from \"./policies/PackageJsonRepoDirectoryProperty.js\";\nimport { PackageJsonSortedPolicy } from \"./policies/PackageJsonSortedPolicy.js\";\nimport { SortTsconfigs } from \"./policies/SortTsconfigs.js\";\n\n/**\n * A type representing a policy name.\n *\n * @alpha\n */\nexport type PolicyName = string;\n\n/**\n * @alpha\n */\nexport interface PolicyFunctionArguments<C = unknown | undefined> {\n\tfile: string;\n\troot: string;\n\tresolve: boolean;\n\tconfig?: C;\n}\n\n/**\n * A policy handler is a function that is called to check policy against a file.\n *\n * @alpha\n */\nexport type PolicyHandler<C = unknown | undefined> = (\n\targs: PolicyFunctionArguments<C>,\n) => Promise<true | PolicyFailure | PolicyFixResult>;\n\n// export type PolicyCheckOnly = (\n// \tfile: string,\n// \troot: string,\n// ) => Promise<true | PolicyFailure | PolicyFixResult>;\n\n/**\n * A standalone function that can be called to resolve a policy failure.\n *\n * @alpha\n */\nexport type PolicyStandaloneResolver<C = unknown | undefined> = (\n\targs: Omit<PolicyFunctionArguments<C>, \"resolve\">,\n) => PolicyFixResult;\n\n// function isPolicyHandler(input: PolicyHandler | PolicyCheckOnly): input is PolicyHandler\n\n/**\n * A RepoPolicy checks and applies policies to files in the repository.\n *\n * Each policy has a name and a match regex for matching which files it should apply to. Every file in th repo is\n * enumerated and if it matches the regex for a policy, that policy is applied.\n *\n * Each policy includes a handler function that checks a file against the policy and can optionally resolve any problems\n * (automated resolutions depend on the policy implementation).\n *\n * @typeParam C - type of configuration object used by the policy\n *\n * @alpha\n */\n\n// biome-ignore lint/suspicious/noExplicitAny: TODO - figure out if this can work with unknown or in another typesafe manner\nexport interface RepoPolicy<C = any | undefined> {\n\t/**\n\t * The name of the policy; displayed in UI and used in settings.\n\t */\n\tname: PolicyName;\n\n\t/**\n\t * A more detailed description of the policy and its intended function.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * A regular expression that is used to match files in the repo.\n\t */\n\tmatch: RegExp;\n\n\t/**\n\t * A handler function that checks if a file is compliant with the policy.\n\t *\n\t * @param file - Repo-relative path to the file to check.\n\t * @param root - Absolute path to the root of the repo.\n\t * @param resolve - If true, automated policy fixes will be applied. Not all policies support automated fixes.\n\t * @returns True if the file passed the policy; otherwise a PolicyFailure object will be returned.\n\t */\n\thandler: PolicyHandler<C>;\n\n\t/**\n\t * A resolver function that can be used to automatically address the policy violation.\n\t *\n\t * @param file - Repo-relative path to the file to check.\n\t * @param root - Absolute path to the root of the repo.\n\t * @returns true if the file passed the policy; otherwise a PolicyFailure object will be returned.\n\t */\n\tresolver?: PolicyStandaloneResolver<C> | undefined;\n}\n\nexport class RepoPolicyClass implements RepoPolicy {\n\tpublic static createRepoPolicy(\n\t\tname: string,\n\t\tmatch: RegExp,\n\t\thandler: PolicyHandler,\n\t\tresolver?: PolicyStandaloneResolver,\n\t): RepoPolicyClass {\n\t\treturn new RepoPolicyClass(name, match, handler, resolver);\n\t}\n\n\tpublic constructor(\n\t\tpublic readonly name: string,\n\t\tpublic readonly match: RegExp,\n\t\tpublic handler: PolicyHandler,\n\t\tpublic resolver?: PolicyStandaloneResolver,\n\t) {\n\t\t// empty\n\t}\n}\n\n/**\n * A policy failure.\n *\n * @alpha\n */\nexport interface PolicyFailure {\n\t/**\n\t * Name of the policy that failed.\n\t */\n\tname: PolicyName;\n\n\t/**\n\t * Path to the file that failed the policy.\n\t */\n\tfile: string;\n\n\t/**\n\t * Set to `true` if the policy can be fixed automatically.\n\t */\n\tautoFixable?: boolean | undefined;\n\n\t/**\n\t * An optional error message accompanying the failure.\n\t */\n\terrorMessage?: string | undefined;\n}\n\n/**\n * The result of an automatic fix for a failing policy.\n *\n * @alpha\n */\nexport interface PolicyFixResult extends PolicyFailure {\n\t/**\n\t * Set to true if the failure was resolved by the automated fixer.\n\t */\n\tresolved: boolean;\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: type guard\nexport function isPolicyFixResult(toCheck: any): toCheck is PolicyFixResult {\n\tif (typeof toCheck !== \"object\") {\n\t\treturn false;\n\t}\n\treturn \"resolved\" in toCheck;\n}\n\n/**\n * Default policies included with repopo.\n *\n * @alpha\n */\nexport const DefaultPolicies: RepoPolicy[] = [\n\tNoJsFileExtensions,\n\tPackageJsonRepoDirectoryProperty,\n\tPackageJsonProperties,\n\tPackageJsonSortedPolicy,\n\tSortTsconfigs,\n];\n"]}
+{"version":3,"file":"policy.js","sourceRoot":"","sources":["../src/policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,gCAAgC,EAAE,MAAM,gDAAgD,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AA4K9D,yDAAyD;AACzD,MAAM,UAAU,iBAAiB,CAAC,OAAY;IAC7C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,UAAU,IAAI,OAAO,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AAEH,oDAAoD;AACpD,MAAM,CAAC,MAAM,eAAe,GAAsB;IACjD,eAAe;IACf,eAAe;IACf,kBAAkB;IAClB,gCAAgC;IAChC,qBAAqB;IACrB,qBAAqB;IACrB,cAAc;CACL,CAAC","sourcesContent":["import { HtmlFileHeaders } from \"./policies.js\";\nimport { JsTsFileHeaders } from \"./policies/JsTsFileHeaders.js\";\nimport { NoJsFileExtensions } from \"./policies/NoJsFileExtensions.js\";\nimport { PackageJsonProperties } from \"./policies/PackageJsonProperties.js\";\nimport { PackageJsonRepoDirectoryProperty } from \"./policies/PackageJsonRepoDirectoryProperty.js\";\nimport { PackageScripts } from \"./policies/PackageScripts.js\";\n\n/**\n * @alpha\n */\nexport type DefaultPolicyConfigType = object | unknown;\n\n/**\n * A type representing a policy name.\n *\n * @alpha\n */\nexport type PolicyName = string;\n\n/**\n * Arguments passed to policy functions.\n *\n * @alpha\n */\n\nexport interface PolicyFunctionArguments<C> {\n\t/**\n\t * Path to the file, relative to the repo root.\n\t */\n\tfile: string;\n\n\t/**\n\t * Absolute path to the root of the repo.\n\t */\n\troot: string;\n\n\t/**\n\t * If true, the handler should resolve any violations automatically if possible.\n\t */\n\tresolve: boolean;\n\n\t/**\n\t * @remarks\n\t *\n\t * Note that the handler function receives the config as an argument.\n\t */\n\tconfig?: C | undefined;\n}\n\n/**\n * A policy handler is a function that is called to check policy against a file.\n *\n * @alpha\n */\n\nexport type PolicyHandler<C = unknown | undefined> = (\n\targs: PolicyFunctionArguments<C>,\n) => Promise<true | PolicyFailure | PolicyFixResult>;\n\n// export type PolicyCheckOnly = (\n// \tfile: string,\n// \troot: string,\n// ) => Promise<true | PolicyFailure | PolicyFixResult>;\n\n/**\n * A standalone function that can be called to resolve a policy failure.\n *\n * @alpha\n */\nexport type PolicyStandaloneResolver<C = DefaultPolicyConfigType | undefined> =\n\t(\n\t\targs: Omit<PolicyFunctionArguments<C>, \"resolve\">,\n\t) => Promise<PolicyFixResult>;\n\n// function isPolicyHandler(input: PolicyHandler | PolicyCheckOnly): input is PolicyHandler\n\n/**\n * A RepoPolicy checks and applies policies to files in the repository.\n *\n * Each policy has a name and a match regex for matching which files it should apply to. Every file in th repo is\n * enumerated and if it matches the regex for a policy, that policy is applied.\n *\n * Each policy includes a handler function that checks a file against the policy and can optionally resolve any problems\n * (automated resolutions depend on the policy implementation).\n *\n * @typeParam C - type of configuration object used by the policy\n *\n * @alpha\n */\nexport interface RepoPolicy<\n\tC extends DefaultPolicyConfigType = unknown | undefined,\n> {\n\t/**\n\t * The name of the policy; displayed in UI and used in settings.\n\t */\n\tname: PolicyName;\n\n\t/**\n\t * A more detailed description of the policy and its intended function.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * A regular expression that is used to match files in the repo.\n\t */\n\tmatch: RegExp;\n\n\t/**\n\t * A handler function that checks if a file is compliant with the policy.\n\t *\n\t * @param file - Repo-relative path to the file to check.\n\t * @param root - Absolute path to the root of the repo.\n\t * @param resolve - If true, automated policy fixes will be applied. Not all policies support automated fixes.\n\t * @returns True if the file passed the policy; otherwise a PolicyFailure object will be returned.\n\t */\n\n\thandler: PolicyHandler<C>;\n\n\t/**\n\t * A resolver function that can be used to automatically address the policy violation.\n\t *\n\t * @param file - Repo-relative path to the file to check.\n\t * @param root - Absolute path to the root of the repo.\n\t * @returns true if the file passed the policy; otherwise a PolicyFailure object will be returned.\n\t */\n\tresolver?: PolicyStandaloneResolver<C> | undefined;\n}\n\n/**\n * A policy handler especially for policies that target package.json.\n *\n * @alpha\n */\nexport type PackageJsonHandler<J, C> = (\n\tjson: J,\n\targs: PolicyFunctionArguments<C>,\n) => Promise<true | PolicyFailure | PolicyFixResult>;\n\n/**\n * A policy failure.\n *\n * @alpha\n */\nexport interface PolicyFailure {\n\t/**\n\t * Name of the policy that failed.\n\t */\n\tname: PolicyName;\n\n\t/**\n\t * Path to the file that failed the policy.\n\t */\n\tfile: string;\n\n\t/**\n\t * Set to `true` if the policy can be fixed automatically.\n\t */\n\tautoFixable?: boolean | undefined;\n\n\t/**\n\t * An optional error message accompanying the failure.\n\t */\n\terrorMessage?: string | undefined;\n}\n\n/**\n * The result of an automatic fix for a failing policy.\n *\n * @alpha\n */\nexport interface PolicyFixResult extends PolicyFailure {\n\t/**\n\t * Set to true if the failure was resolved by the automated fixer.\n\t */\n\tresolved: boolean;\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: type guard\nexport function isPolicyFixResult(toCheck: any): toCheck is PolicyFixResult {\n\tif (typeof toCheck !== \"object\") {\n\t\treturn false;\n\t}\n\treturn \"resolved\" in toCheck;\n}\n\n/**\n * Default policies included with repopo.\n *\n * @alpha\n */\n\n// biome-ignore lint/suspicious/noExplicitAny: FIXME\nexport const DefaultPolicies: RepoPolicy<any>[] = [\n\tHtmlFileHeaders,\n\tJsTsFileHeaders,\n\tNoJsFileExtensions,\n\tPackageJsonRepoDirectoryProperty,\n\tPackageJsonProperties,\n\t// PackageJsonSorted,\n\tPackageScripts,\n] as const;\n"]}

package/esm/policyGenerators/generateFileHeaderPolicy.d.ts

@@ -0,0 +1,45 @@
+import type { RepoPolicy } from "../policy.js";
+/**
+ * @alpha
+ */
+export interface FileHeaderPolicyConfig {
+    /**
+     * The text to use as the header.
+     */
+    headerText: string;
+    /**
+     * An optional string that will be appended to the headerText.
+     */
+    autoGenText?: string;
+}
+/**
+ * @alpha
+ */
+export interface FileHeaderGeneratorConfig extends Partial<FileHeaderPolicyConfig> {
+    match: RegExp;
+    /**
+     * Regex matching header prefix (e.g. `/*!\r?\n`)
+     */
+    headerStart?: RegExp;
+    /**
+     * Regex matching beginning of each line (e.g. ' * ')
+     */
+    lineStart: RegExp;
+    /**
+     * Regex matching the end of each line (e.g., `\r?\n`)
+     */
+    lineEnd: RegExp;
+    /**
+     * Regex matching the header postfix.
+     */
+    headerEnd?: RegExp;
+    replacer: (content: string, config: FileHeaderPolicyConfig) => string;
+}
+/**
+ * Given a `FileHeaderGeneratorConfig`, produces a function that detects correct file headers
+ * and returns an error string if the header is missing or incorrect.
+ *
+ * @alpha
+ */
+export declare function generateFileHeaderPolicy(name: string, config: FileHeaderGeneratorConfig): RepoPolicy<FileHeaderPolicyConfig>;
+//# sourceMappingURL=generateFileHeaderPolicy.d.ts.map

package/esm/policyGenerators/generateFileHeaderPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateFileHeaderPolicy.d.ts","sourceRoot":"","sources":["../../src/policyGenerators/generateFileHeaderPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAkC,UAAU,EAAE,MAAM,cAAc,CAAC;AAI/E;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,yBAChB,SAAQ,OAAO,CAAC,sBAAsB,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,KAAK,MAAM,CAAC;CACtE;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACvC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,yBAAyB,GAC/B,UAAU,CAAC,sBAAsB,CAAC,CAiEpC"}

package/esm/policyGenerators/generateFileHeaderPolicy.js

@@ -0,0 +1,61 @@
+import { readFile, writeFile } from "node:fs/promises";
+import { EOL as newline } from "node:os";
+import { extname } from "pathe";
+const trailingSpaces = /\s*\\r\?\\n/;
+/**
+ * Given a `FileHeaderGeneratorConfig`, produces a function that detects correct file headers
+ * and returns an error string if the header is missing or incorrect.
+ *
+ * @alpha
+ */
+export function generateFileHeaderPolicy(name, config) {
+    const pre = config.headerStart?.source ?? "";
+    const start = config.lineStart.source;
+    const end = config.lineEnd.source;
+    const post = config.headerEnd?.source ?? "";
+    // Helper which constructs a matching RegExp from a given multiline string.
+    // (See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping)
+    const toRegex = (text) => text
+        .split(newline)
+        .map((line) => `${start}${line.replace(/[$()*+.?[\\\]^{|}]/g, "\\$&")}${end}`)
+        .join("")
+        .replace(trailingSpaces, "\\r?\\n"); // Trim trailing spaces at end-of-line.
+    // Detection regex matches the header start (if any), followed by lines in 'headerText',
+    // optionally followed by lines in the 'autoGenText', and finally the header end (if any).
+    const regex = new RegExp(`^${pre}${toRegex(config.headerText ?? "")}(${toRegex(config.autoGenText ?? "")})?${post}`);
+    return {
+        name,
+        match: config.match,
+        handler: async ({ file, resolve, config: policyConfig }) => {
+            if (policyConfig === undefined) {
+                return true;
+            }
+            const failResult = {
+                name,
+                file,
+                autoFixable: true,
+            };
+            // TODO: Consider reading only the first 512B or so since headers are typically
+            // at the beginning of the file.
+            const content = await readFile(file, { encoding: "utf8" });
+            const failed = !regex.test(content);
+            if (failed) {
+                failResult.errorMessage = `${extname(file)} file missing header`;
+            }
+            if (failed) {
+                if (resolve) {
+                    const newContent = config.replacer(content, policyConfig);
+                    await writeFile(file, newContent);
+                    const fixResult = {
+                        ...failResult,
+                        resolved: true,
+                    };
+                    return fixResult;
+                }
+                return failResult;
+            }
+            return true;
+        },
+    };
+}
+//# sourceMappingURL=generateFileHeaderPolicy.js.map

package/esm/policyGenerators/generateFileHeaderPolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateFileHeaderPolicy.js","sourceRoot":"","sources":["../../src/policyGenerators/generateFileHeaderPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAGhC,MAAM,cAAc,GAAG,aAAa,CAAC;AA+CrC;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACvC,IAAY,EACZ,MAAiC;IAEjC,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,MAAM,IAAI,EAAE,CAAC;IAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;IACtC,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;IAClC,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,EAAE,MAAM,IAAI,EAAE,CAAC;IAE5C,2EAA2E;IAC3E,mGAAmG;IACnG,MAAM,OAAO,GAAG,CAAC,IAAY,EAAU,EAAE,CACxC,IAAI;SACF,KAAK,CAAC,OAAO,CAAC;SACd,GAAG,CACH,CAAC,IAAI,EAAE,EAAE,CACR,GAAG,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,GAAG,GAAG,EAAE,CAC/D;SACA,IAAI,CAAC,EAAE,CAAC;SACR,OAAO,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC,uCAAuC;IAE9E,wFAAwF;IACxF,0FAA0F;IAC1F,MAAM,KAAK,GAAG,IAAI,MAAM,CACvB,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,KAAK,IAAI,EAAE,CAC1F,CAAC;IAEF,OAAO;QACN,IAAI;QACJ,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE;YAC1D,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO,IAAI,CAAC;YACb,CAAC;YAED,MAAM,UAAU,GAAkB;gBACjC,IAAI;gBACJ,IAAI;gBACJ,WAAW,EAAE,IAAI;aACjB,CAAC;YAEF,+EAA+E;YAC/E,gCAAgC;YAChC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEpC,IAAI,MAAM,EAAE,CAAC;gBACZ,UAAU,CAAC,YAAY,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC;YAClE,CAAC;YAED,IAAI,MAAM,EAAE,CAAC;gBACZ,IAAI,OAAO,EAAE,CAAC;oBACb,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;oBAC1D,MAAM,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;oBAElC,MAAM,SAAS,GAAoB;wBAClC,GAAG,UAAU;wBACb,QAAQ,EAAE,IAAI;qBACd,CAAC;oBAEF,OAAO,SAAS,CAAC;gBAClB,CAAC;gBACD,OAAO,UAAU,CAAC;YACnB,CAAC;YAED,OAAO,IAAI,CAAC;QACb,CAAC;KACD,CAAC;AACH,CAAC","sourcesContent":["import { readFile, writeFile } from \"node:fs/promises\";\nimport { EOL as newline } from \"node:os\";\nimport { extname } from \"pathe\";\nimport type { PolicyFailure, PolicyFixResult, RepoPolicy } from \"../policy.js\";\n\nconst trailingSpaces = /\\s*\\\\r\\?\\\\n/;\n\n/**\n * @alpha\n */\nexport interface FileHeaderPolicyConfig {\n\t/**\n\t * The text to use as the header.\n\t */\n\theaderText: string;\n\n\t/**\n\t * An optional string that will be appended to the headerText.\n\t */\n\tautoGenText?: string;\n}\n\n/**\n * @alpha\n */\nexport interface FileHeaderGeneratorConfig\n\textends Partial<FileHeaderPolicyConfig> {\n\tmatch: RegExp;\n\n\t/**\n\t * Regex matching header prefix (e.g. `/*!\\r?\\n`)\n\t */\n\theaderStart?: RegExp;\n\n\t/**\n\t * Regex matching beginning of each line (e.g. ' * ')\n\t */\n\tlineStart: RegExp;\n\n\t/**\n\t * Regex matching the end of each line (e.g., `\\r?\\n`)\n\t */\n\tlineEnd: RegExp;\n\n\t/**\n\t * Regex matching the header postfix.\n\t */\n\theaderEnd?: RegExp;\n\n\treplacer: (content: string, config: FileHeaderPolicyConfig) => string;\n}\n\n/**\n * Given a `FileHeaderGeneratorConfig`, produces a function that detects correct file headers\n * and returns an error string if the header is missing or incorrect.\n *\n * @alpha\n */\nexport function generateFileHeaderPolicy(\n\tname: string,\n\tconfig: FileHeaderGeneratorConfig,\n): RepoPolicy<FileHeaderPolicyConfig> {\n\tconst pre = config.headerStart?.source ?? \"\";\n\tconst start = config.lineStart.source;\n\tconst end = config.lineEnd.source;\n\tconst post = config.headerEnd?.source ?? \"\";\n\n\t// Helper which constructs a matching RegExp from a given multiline string.\n\t// (See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping)\n\tconst toRegex = (text: string): string =>\n\t\ttext\n\t\t\t.split(newline)\n\t\t\t.map(\n\t\t\t\t(line) =>\n\t\t\t\t\t`${start}${line.replace(/[$()*+.?[\\\\\\]^{|}]/g, \"\\\\$&\")}${end}`,\n\t\t\t)\n\t\t\t.join(\"\")\n\t\t\t.replace(trailingSpaces, \"\\\\r?\\\\n\"); // Trim trailing spaces at end-of-line.\n\n\t// Detection regex matches the header start (if any), followed by lines in 'headerText',\n\t// optionally followed by lines in the 'autoGenText', and finally the header end (if any).\n\tconst regex = new RegExp(\n\t\t`^${pre}${toRegex(config.headerText ?? \"\")}(${toRegex(config.autoGenText ?? \"\")})?${post}`,\n\t);\n\n\treturn {\n\t\tname,\n\t\tmatch: config.match,\n\t\thandler: async ({ file, resolve, config: policyConfig }) => {\n\t\t\tif (policyConfig === undefined) {\n\t\t\t\treturn true;\n\t\t\t}\n\n\t\t\tconst failResult: PolicyFailure = {\n\t\t\t\tname,\n\t\t\t\tfile,\n\t\t\t\tautoFixable: true,\n\t\t\t};\n\n\t\t\t// TODO: Consider reading only the first 512B or so since headers are typically\n\t\t\t// at the beginning of the file.\n\t\t\tconst content = await readFile(file, { encoding: \"utf8\" });\n\t\t\tconst failed = !regex.test(content);\n\n\t\t\tif (failed) {\n\t\t\t\tfailResult.errorMessage = `${extname(file)} file missing header`;\n\t\t\t}\n\n\t\t\tif (failed) {\n\t\t\t\tif (resolve) {\n\t\t\t\t\tconst newContent = config.replacer(content, policyConfig);\n\t\t\t\t\tawait writeFile(file, newContent);\n\n\t\t\t\t\tconst fixResult: PolicyFixResult = {\n\t\t\t\t\t\t...failResult,\n\t\t\t\t\t\tresolved: true,\n\t\t\t\t\t};\n\n\t\t\t\t\treturn fixResult;\n\t\t\t\t}\n\t\t\t\treturn failResult;\n\t\t\t}\n\n\t\t\treturn true;\n\t\t},\n\t};\n}\n"]}

package/esm/policyGenerators/generatePackagePolicy.d.ts

@@ -0,0 +1,9 @@
+import type { PackageJson } from "type-fest";
+import type { PackageJsonHandler, RepoPolicy } from "../policy.js";
+/**
+ * Define a repo policy for package.json files.
+ *
+ * @alpha
+ */
+export declare function generatePackagePolicy<J = PackageJson, C = undefined>(name: string, packagePolicy: PackageJsonHandler<J, C>): RepoPolicy<C>;
+//# sourceMappingURL=generatePackagePolicy.d.ts.map

package/esm/policyGenerators/generatePackagePolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generatePackagePolicy.d.ts","sourceRoot":"","sources":["../../src/policyGenerators/generatePackagePolicy.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAInE;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,SAAS,EACnE,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAErC,UAAU,CAAC,CAAC,CAAC,CAUf"}

package/esm/policyGenerators/generatePackagePolicy.js

@@ -0,0 +1,20 @@
+import jsonfile from "jsonfile";
+import { PackageJsonRegexMatch } from "../policies/constants.js";
+const { readFile: readJson } = jsonfile;
+/**
+ * Define a repo policy for package.json files.
+ *
+ * @alpha
+ */
+export function generatePackagePolicy(name, packagePolicy) {
+    // const func = () => handler(json, args);
+    return {
+        name,
+        match: PackageJsonRegexMatch,
+        handler: async (innerArgs) => {
+            const json = await readJson(innerArgs.file);
+            return packagePolicy(json, innerArgs);
+        },
+    };
+}
+//# sourceMappingURL=generatePackagePolicy.js.map

package/esm/policyGenerators/generatePackagePolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generatePackagePolicy.js","sourceRoot":"","sources":["../../src/policyGenerators/generatePackagePolicy.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAGjE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC;AAExC;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CACpC,IAAY,EACZ,aAAuC;IAGvC,0CAA0C;IAC1C,OAAO;QACN,IAAI;QACJ,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;YAC5B,MAAM,IAAI,GAAM,MAAM,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC/C,OAAO,aAAa,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACvC,CAAC;KACD,CAAC;AACH,CAAC","sourcesContent":["import jsonfile from \"jsonfile\";\nimport type { PackageJson } from \"type-fest\";\nimport { PackageJsonRegexMatch } from \"../policies/constants.js\";\nimport type { PackageJsonHandler, RepoPolicy } from \"../policy.js\";\n\nconst { readFile: readJson } = jsonfile;\n\n/**\n * Define a repo policy for package.json files.\n *\n * @alpha\n */\nexport function generatePackagePolicy<J = PackageJson, C = undefined>(\n\tname: string,\n\tpackagePolicy: PackageJsonHandler<J, C>,\n\t// args: PolicyFunctionArguments<C>,\n): RepoPolicy<C> {\n\t// const func = () => handler(json, args);\n\treturn {\n\t\tname,\n\t\tmatch: PackageJsonRegexMatch,\n\t\thandler: async (innerArgs) => {\n\t\t\tconst json: J = await readJson(innerArgs.file);\n\t\t\treturn packagePolicy(json, innerArgs);\n\t\t},\n\t};\n}\n"]}

package/esm/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.9"
+      "packageVersion": "7.52.4"
     }
   ]
 }

package/oclif.manifest.json

@@ -4,6 +4,29 @@
       "aliases": [],
       "args": {},
       "flags": {
+        "verbose": {
+          "char": "v",
+          "description": "Enable verbose logging.",
+          "exclusive": [
+            "quiet"
+          ],
+          "helpGroup": "LOGGING",
+          "name": "verbose",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "quiet": {
+          "description": "Disable all logging.",
+          "exclusive": [
+            "verbose"
+          ],
+          "helpGroup": "LOGGING",
+          "name": "quiet",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
         "fix": {
           "aliases": [
             "resolve"
@@ -22,35 +45,6 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "policy": {
-          "char": "d",
-          "description": "Filter policies to apply by <regex>. Only policies with a name matching the regex will be applied.",
-          "name": "policy",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "excludePolicy": {
-          "char": "D",
-          "description": "Exclude policies by name. Can be specified multiple times to exclude multiple policies.",
-          "exclusive": [
-            "policy"
-          ],
-          "name": "excludePolicy",
-          "hasDynamicHelp": false,
-          "multiple": true,
-          "type": "option"
-        },
-        "path": {
-          "char": "p",
-          "description": "Filter file paths by <regex>.",
-          "name": "path",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "config": {
           "description": "The path to a configuration file.",
           "helpGroup": "CONFIGURATION",
@@ -67,7 +61,9 @@
       "pluginAlias": "repopo",
       "pluginName": "repopo",
       "pluginType": "core",
+      "strict": true,
       "summary": "Checks and applies policies to the files in the repository.",
+      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "esm",
@@ -79,34 +75,28 @@
       "aliases": [],
       "args": {},
       "flags": {
-        "policy": {
-          "char": "d",
-          "description": "Filter policies to apply by <regex>. Only policies with a name matching the regex will be applied.",
-          "name": "policy",
+        "verbose": {
+          "char": "v",
+          "description": "Enable verbose logging.",
+          "exclusive": [
+            "quiet"
+          ],
+          "helpGroup": "LOGGING",
+          "name": "verbose",
           "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+          "allowNo": false,
+          "type": "boolean"
         },
-        "excludePolicy": {
-          "char": "D",
-          "description": "Exclude policies by name. Can be specified multiple times to exclude multiple policies.",
+        "quiet": {
+          "description": "Disable all logging.",
           "exclusive": [
-            "policy"
+            "verbose"
           ],
-          "name": "excludePolicy",
-          "hasDynamicHelp": false,
-          "multiple": true,
-          "type": "option"
-        },
-        "path": {
-          "char": "p",
-          "description": "Filter file paths by <regex>.",
-          "name": "path",
+          "helpGroup": "LOGGING",
+          "name": "quiet",
           "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+          "allowNo": false,
+          "type": "boolean"
         },
         "config": {
           "description": "The path to a configuration file.",
@@ -124,7 +114,9 @@
       "pluginAlias": "repopo",
       "pluginName": "repopo",
       "pluginType": "core",
+      "strict": true,
       "summary": "Lists the policies configured to run.",
+      "enableJsonFlag": false,
       "isESM": true,
       "relativePath": [
         "esm",
@@ -133,5 +125,5 @@
       ]
     }
   },
-  "version": "0.3.2"
+  "version": "0.5.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repopo",
-  "version": "0.3.2",
+  "version": "0.5.0",
   "description": "Enforce policies on all or some of the files in a git repository.",
   "keywords": [
     "policy",
@@ -20,6 +20,14 @@
     ".": {
       "types": "./esm/index.d.ts",
       "import": "./esm/index.js"
+    },
+    "./api": {
+      "types": "./esm/api.d.ts",
+      "import": "./esm/api.js"
+    },
+    "./policies": {
+      "types": "./esm/policies.d.ts",
+      "import": "./esm/policies.js"
     }
   },
   "types": "esm/index.d.ts",
@@ -45,35 +53,45 @@
     "repositoryPrefix": "<%- repo %>/blob/main/packages/repopo/<%- commandPath %>"
   },
   "dependencies": {
-    "@fluidframework/build-tools": "^0.51.0",
-    "@oclif/core": "^4.0.19",
-    "@oclif/plugin-help": "^6.2.10",
-    "@rushstack/node-core-library": "^5.7.0",
-    "cosmiconfig": "^9.0.0",
+    "@fluid-tools/build-infrastructure": "^0.56.0",
+    "@oclif/core": "^4.2.10",
+    "@oclif/plugin-help": "^6.2.27",
+    "@rushstack/node-core-library": "^5.13.0",
+    "defu": "^6.1.4",
     "jsonfile": "^6.1.0",
-    "picocolors": "^1.1.0",
-    "sort-package-json": "2.10.0",
-    "@tylerbu/cli-api": "^0.6.1",
-    "sort-tsconfig": "^0.1.4"
+    "microdiff": "^1.5.0",
+    "pathe": "^2.0.3",
+    "picocolors": "^1.1.1",
+    "simple-git": "^3.27.0",
+    "@tylerbu/cli-api": "^0.7.1",
+    "@tylerbu/fundamentals": "^0.2.1"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.8.3",
-    "@microsoft/api-extractor": "^7.43.4",
-    "@oclif/plugin-command-snapshot": "^5.2.14",
-    "@oclif/test": "^4.0.9",
+    "@biomejs/biome": "1.9.4",
+    "@microsoft/api-extractor": "^7.52.4",
+    "@oclif/plugin-command-snapshot": "^5.2.38",
+    "@oclif/test": "^4.1.12",
     "@types/jsonfile": "^6.1.4",
     "@types/node": "^20.12.7",
     "@types/tmp": "^0.2.6",
-    "lefthook": "^1.6.11",
-    "oclif": "^4.14.26",
-    "rimraf": "^6.0.0",
-    "serve": "^14.2.3",
-    "start-server-and-test": "^2.0.3",
+    "generate-license-file": "^4.0.0",
+    "oclif": "^4.17.45",
+    "rimraf": "^6.0.1",
+    "serve": "^14.2.4",
+    "start-server-and-test": "^2.0.11",
     "tmp-promise": "^3.0.3",
     "ts-node": "^10.9.2",
-    "type-fest": "^4.18.2",
+    "type-fest": "^4.40.0",
     "typescript": "~5.5.4",
-    "vitest": "^2.0.0"
+    "vitest": "^3.1.1"
+  },
+  "peerDependencies": {
+    "sort-package-json": "*"
+  },
+  "peerDependenciesMeta": {
+    "sort-package-json": {
+      "optional": true
+    }
   },
   "engines": {
     "node": ">=18.0.0"
@@ -94,7 +112,9 @@
     "lint": "biome lint .",
     "lint:fix": "biome lint . --write",
     "manifest": "oclif manifest",
-    "readme": "oclif readme --no-aliases",
-    "sort-package-json": "sort-package-json"
+    "readme": "concurrently npm:readme:*",
+    "readme:docs": "oclif readme --no-aliases --readme-path=../repopo-docs/src/content/docs/cli-reference.md",
+    "readme:main": "oclif readme --no-aliases",
+    "release:license-file": "generate-license-file -c ../../.generatelicensefile.cjs"
   }
 }

package/esm/policies/PackageJsonSortedPolicy.d.ts

@@ -1,6 +0,0 @@
-import type { RepoPolicy } from "../policy.js";
-/**
- * A repo policy that checks if package.json files in the repo are sorted using sort-package-json.
- */
-export declare const PackageJsonSortedPolicy: RepoPolicy;
-//# sourceMappingURL=PackageJsonSortedPolicy.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"PackageJsonSortedPolicy.d.ts","sourceRoot":"","sources":["../../src/policies/PackageJsonSortedPolicy.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAkC,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,UAwCrC,CAAC"}