repopo 0.2.2

package/esm/policies/PackageJsonRepoDirectoryProperty.js

@@ -0,0 +1,48 @@
+import assert from "node:assert/strict";
+import path from "node:path";
+import { updatePackageJsonFile } from "@fluidframework/build-tools";
+import { readJson } from "fs-extra/esm";
+/**
+ * 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 const PackageJsonRepoDirectoryProperty = {
+    name: "PackageJsonRepoDirectoryProperty",
+    match: /(^|\/)package\.json/i,
+    handler: async ({ file, root, resolve }) => {
+        const failResult = {
+            name: PackageJsonRepoDirectoryProperty.name,
+            file,
+            autoFixable: true,
+        };
+        const fixResult = {
+            ...failResult,
+            resolved: false,
+        };
+        const pkg = (await readJson(file));
+        const pkgDir = path.dirname(file);
+        const relativePkgDir = path.relative(root, pkgDir);
+        if (typeof pkg.repository === "object") {
+            if (pkg.repository.directory !== relativePkgDir) {
+                if (resolve) {
+                    try {
+                        updatePackageJsonFile(file, (json) => {
+                            assert(typeof json.repository === "object");
+                            json.repository.directory = relativePkgDir;
+                        });
+                        fixResult.resolved = true;
+                    }
+                    catch (error) {
+                        fixResult.resolved = false;
+                        fixResult.errorMessage = `${error.message}\n${error.stack}`;
+                    }
+                    return fixResult;
+                }
+                failResult.errorMessage = `repository.directory value is wrong. Expected '${relativePkgDir}', got '${pkg.repository.directory}'`;
+                return failResult;
+            }
+        }
+        return true;
+    },
+};
+//# sourceMappingURL=PackageJsonRepoDirectoryProperty.js.map

package/esm/policies/PackageJsonRepoDirectoryProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageJsonRepoDirectoryProperty.js","sourceRoot":"","sources":["../../src/policies/PackageJsonRepoDirectoryProperty.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAIxC;;;GAGG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAe;IAC3D,IAAI,EAAE,kCAAkC;IACxC,KAAK,EAAE,sBAAsB;IAC7B,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;QAC1C,MAAM,UAAU,GAAkB;YACjC,IAAI,EAAE,gCAAgC,CAAC,IAAI;YAC3C,IAAI;YACJ,WAAW,EAAE,IAAI;SACjB,CAAC;QAEF,MAAM,SAAS,GAAoB;YAClC,GAAG,UAAU;YACb,QAAQ,EAAE,KAAK;SACf,CAAC;QAEF,MAAM,GAAG,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAgB,CAAC;QAClD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;YACxC,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,KAAK,cAAc,EAAE,CAAC;gBACjD,IAAI,OAAO,EAAE,CAAC;oBACb,IAAI,CAAC;wBACJ,qBAAqB,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;4BACpC,MAAM,CAAC,OAAO,IAAI,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC;4BAC5C,IAAI,CAAC,UAAU,CAAC,SAAS,GAAG,cAAc,CAAC;wBAC5C,CAAC,CAAC,CAAC;wBACH,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;oBAC3B,CAAC;oBAAC,OAAO,KAAc,EAAE,CAAC;wBACzB,SAAS,CAAC,QAAQ,GAAG,KAAK,CAAC;wBAC3B,SAAS,CAAC,YAAY,GAAG,GAAI,KAAe,CAAC,OAAO,KAClD,KAAe,CAAC,KAClB,EAAE,CAAC;oBACJ,CAAC;oBACD,OAAO,SAAS,CAAC;gBAClB,CAAC;gBACD,UAAU,CAAC,YAAY,GAAG,kDAAkD,cAAc,WAAW,GAAG,CAAC,UAAU,CAAC,SAAS,GAAG,CAAC;gBACjI,OAAO,UAAU,CAAC;YACnB,CAAC;QACF,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;CACD,CAAC","sourcesContent":["import assert from \"node:assert/strict\";\nimport path from \"node:path\";\nimport { updatePackageJsonFile } from \"@fluidframework/build-tools\";\nimport { readJson } from \"fs-extra/esm\";\nimport type { PackageJson } from \"type-fest\";\nimport type { PolicyFailure, PolicyFixResult, RepoPolicy } from \"../policy.js\";\n\n/**\n * A RepoPolicy that checks that the repository.directory property in package.json is set correctly. If the repository\n * field is a string instead of an object the package will be ignored.\n */\nexport const PackageJsonRepoDirectoryProperty: RepoPolicy = {\n\tname: \"PackageJsonRepoDirectoryProperty\",\n\tmatch: /(^|\\/)package\\.json/i,\n\thandler: async ({ file, root, resolve }) => {\n\t\tconst failResult: PolicyFailure = {\n\t\t\tname: PackageJsonRepoDirectoryProperty.name,\n\t\t\tfile,\n\t\t\tautoFixable: true,\n\t\t};\n\n\t\tconst fixResult: PolicyFixResult = {\n\t\t\t...failResult,\n\t\t\tresolved: false,\n\t\t};\n\n\t\tconst pkg = (await readJson(file)) as PackageJson;\n\t\tconst pkgDir = path.dirname(file);\n\t\tconst relativePkgDir = path.relative(root, pkgDir);\n\n\t\tif (typeof pkg.repository === \"object\") {\n\t\t\tif (pkg.repository.directory !== relativePkgDir) {\n\t\t\t\tif (resolve) {\n\t\t\t\t\ttry {\n\t\t\t\t\t\tupdatePackageJsonFile(file, (json) => {\n\t\t\t\t\t\t\tassert(typeof json.repository === \"object\");\n\t\t\t\t\t\t\tjson.repository.directory = relativePkgDir;\n\t\t\t\t\t\t});\n\t\t\t\t\t\tfixResult.resolved = true;\n\t\t\t\t\t} catch (error: unknown) {\n\t\t\t\t\t\tfixResult.resolved = false;\n\t\t\t\t\t\tfixResult.errorMessage = `${(error as Error).message}\\n${\n\t\t\t\t\t\t\t(error as Error).stack\n\t\t\t\t\t\t}`;\n\t\t\t\t\t}\n\t\t\t\t\treturn fixResult;\n\t\t\t\t}\n\t\t\t\tfailResult.errorMessage = `repository.directory value is wrong. Expected '${relativePkgDir}', got '${pkg.repository.directory}'`;\n\t\t\t\treturn failResult;\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t},\n};\n"]}

package/esm/policies/PackageJsonSortedPolicy.d.ts

@@ -0,0 +1,6 @@
+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

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

package/esm/policies/PackageJsonSortedPolicy.js

@@ -0,0 +1,48 @@
+import { updatePackageJsonFile } from "@tylerbu/cli-api";
+import { readJson } from "fs-extra/esm";
+import { sortPackageJson } from "sort-package-json";
+/**
+ * A repo policy that checks if package.json files in the repo are sorted using sort-package-json.
+ */
+export const PackageJsonSortedPolicy = {
+    name: "PackageJsonSortedPolicy",
+    match: /(^|\/)package\.json/i,
+    handler: async ({ file, resolve }) => {
+        const json = await readJson(file);
+        const sortedJson = sortPackageJson(json);
+        const isSorted = JSON.stringify(sortedJson) === JSON.stringify(json);
+        if (isSorted) {
+            return true;
+        }
+        if (resolve) {
+            try {
+                await updatePackageJsonFile(file, (json) => json, { sort: true });
+                const result = {
+                    name: PackageJsonSortedPolicy.name,
+                    file,
+                    resolved: true,
+                };
+                return result;
+            }
+            catch (error) {
+                const result = {
+                    name: PackageJsonSortedPolicy.name,
+                    file,
+                    resolved: false,
+                    autoFixable: true,
+                    errorMessage: error.message,
+                };
+                return result;
+            }
+        }
+        else {
+            const result = {
+                name: PackageJsonSortedPolicy.name,
+                file,
+                autoFixable: true,
+            };
+            return result;
+        }
+    },
+};
+//# sourceMappingURL=PackageJsonSortedPolicy.js.map

package/esm/policies/PackageJsonSortedPolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageJsonSortedPolicy.js","sourceRoot":"","sources":["../../src/policies/PackageJsonSortedPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIpD;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAe;IAClD,IAAI,EAAE,yBAAyB;IAC/B,KAAK,EAAE,sBAAsB;IAC7B,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;QACpC,MAAM,IAAI,GAAgB,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAErE,IAAI,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,CAAC;QACb,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACb,IAAI,CAAC;gBACJ,MAAM,qBAAqB,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;gBAClE,MAAM,MAAM,GAAoB;oBAC/B,IAAI,EAAE,uBAAuB,CAAC,IAAI;oBAClC,IAAI;oBACJ,QAAQ,EAAE,IAAI;iBACd,CAAC;gBACF,OAAO,MAAM,CAAC;YACf,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACzB,MAAM,MAAM,GAAoB;oBAC/B,IAAI,EAAE,uBAAuB,CAAC,IAAI;oBAClC,IAAI;oBACJ,QAAQ,EAAE,KAAK;oBACf,WAAW,EAAE,IAAI;oBACjB,YAAY,EAAG,KAAe,CAAC,OAAO;iBACtC,CAAC;gBACF,OAAO,MAAM,CAAC;YACf,CAAC;QACF,CAAC;aAAM,CAAC;YACP,MAAM,MAAM,GAAkB;gBAC7B,IAAI,EAAE,uBAAuB,CAAC,IAAI;gBAClC,IAAI;gBACJ,WAAW,EAAE,IAAI;aACjB,CAAC;YACF,OAAO,MAAM,CAAC;QACf,CAAC;IACF,CAAC;CACD,CAAC","sourcesContent":["import { updatePackageJsonFile } from \"@tylerbu/cli-api\";\nimport { readJson } from \"fs-extra/esm\";\nimport { sortPackageJson } from \"sort-package-json\";\nimport type { PackageJson } from \"type-fest\";\nimport type { PolicyFailure, PolicyFixResult, RepoPolicy } from \"../policy.js\";\n\n/**\n * A repo policy that checks if package.json files in the repo are sorted using sort-package-json.\n */\nexport const PackageJsonSortedPolicy: RepoPolicy = {\n\tname: \"PackageJsonSortedPolicy\",\n\tmatch: /(^|\\/)package\\.json/i,\n\thandler: async ({ file, resolve }) => {\n\t\tconst json: PackageJson = await readJson(file);\n\t\tconst sortedJson = sortPackageJson(json);\n\t\tconst isSorted = JSON.stringify(sortedJson) === JSON.stringify(json);\n\n\t\tif (isSorted) {\n\t\t\treturn true;\n\t\t}\n\n\t\tif (resolve) {\n\t\t\ttry {\n\t\t\t\tawait updatePackageJsonFile(file, (json) => json, { sort: true });\n\t\t\t\tconst result: PolicyFixResult = {\n\t\t\t\t\tname: PackageJsonSortedPolicy.name,\n\t\t\t\t\tfile,\n\t\t\t\t\tresolved: true,\n\t\t\t\t};\n\t\t\t\treturn result;\n\t\t\t} catch (error: unknown) {\n\t\t\t\tconst result: PolicyFixResult = {\n\t\t\t\t\tname: PackageJsonSortedPolicy.name,\n\t\t\t\t\tfile,\n\t\t\t\t\tresolved: false,\n\t\t\t\t\tautoFixable: true,\n\t\t\t\t\terrorMessage: (error as Error).message,\n\t\t\t\t};\n\t\t\t\treturn result;\n\t\t\t}\n\t\t} else {\n\t\t\tconst result: PolicyFailure = {\n\t\t\t\tname: PackageJsonSortedPolicy.name,\n\t\t\t\tfile,\n\t\t\t\tautoFixable: true,\n\t\t\t};\n\t\t\treturn result;\n\t\t}\n\t},\n};\n"]}

package/esm/policies/SortTsconfigs.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 SortTsconfigs: RepoPolicy;
+//# sourceMappingURL=SortTsconfigs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SortTsconfigs.d.ts","sourceRoot":"","sources":["../../src/policies/SortTsconfigs.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAkC,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,EAAE,UA2B3B,CAAC"}

package/esm/policies/SortTsconfigs.js

@@ -0,0 +1,33 @@
+import { isSorted, sortTsconfigFile } from "sort-tsconfig";
+/**
+ * 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 SortTsconfigs = {
+    name: "SortTsconfigs",
+    match: /(^|\/)[^/]+tsconfig\..*\.json$/i,
+    // biome-ignore lint/suspicious/useAwait: <explanation>
+    handler: async ({ file, config, resolve }) => {
+        if (config === undefined) {
+            return true;
+        }
+        const failResult = {
+            name: SortTsconfigs.name,
+            file,
+            autoFixable: true,
+        };
+        if (resolve) {
+            sortTsconfigFile(file, true);
+            const fixResult = {
+                ...failResult,
+                resolved: true,
+            };
+            return fixResult;
+        }
+        return isSorted(file) === true ? true : failResult;
+    },
+};
+//# sourceMappingURL=SortTsconfigs.js.map

package/esm/policies/SortTsconfigs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SortTsconfigs.js","sourceRoot":"","sources":["../../src/policies/SortTsconfigs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAG3D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAe;IACxC,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,iCAAiC;IACxC,uDAAuD;IACvD,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,aAAa,CAAC,IAAI;YACxB,IAAI;YACJ,WAAW,EAAE,IAAI;SACjB,CAAC;QAEF,IAAI,OAAO,EAAE,CAAC;YACb,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC7B,MAAM,SAAS,GAAoB;gBAClC,GAAG,UAAU;gBACb,QAAQ,EAAE,IAAI;aACd,CAAC;YAEF,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;IACpD,CAAC;CACD,CAAC","sourcesContent":["import { isSorted, sortTsconfigFile } from \"sort-tsconfig\";\nimport type { PolicyFailure, PolicyFixResult, 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 SortTsconfigs: RepoPolicy = {\n\tname: \"SortTsconfigs\",\n\tmatch: /(^|\\/)[^/]+tsconfig\\..*\\.json$/i,\n\t// biome-ignore lint/suspicious/useAwait: <explanation>\n\thandler: async ({ file, config, resolve }) => {\n\t\tif (config === undefined) {\n\t\t\treturn true;\n\t\t}\n\n\t\tconst failResult: PolicyFailure = {\n\t\t\tname: SortTsconfigs.name,\n\t\t\tfile,\n\t\t\tautoFixable: true,\n\t\t};\n\n\t\tif (resolve) {\n\t\t\tsortTsconfigFile(file, true);\n\t\t\tconst fixResult: PolicyFixResult = {\n\t\t\t\t...failResult,\n\t\t\t\tresolved: true,\n\t\t\t};\n\n\t\t\treturn fixResult;\n\t\t}\n\n\t\treturn isSorted(file) === true ? true : failResult;\n\t},\n};\n"]}

package/esm/policy.d.ts

@@ -0,0 +1,104 @@
+/**
+ * A type representing a policy name.
+ *
+ * @alpha
+ */
+export type PolicyName = string;
+/**
+ * @alpha
+ */
+export interface PolicyFunctionArguments<C = unknown | undefined> {
+    file: string;
+    root: string;
+    resolve: boolean;
+    config?: C;
+}
+/**
+ * A policy handler is a function that is called to check policy against a file.
+ *
+ * @alpha
+ */
+export type PolicyHandler<C = unknown | undefined> = (args: PolicyFunctionArguments<C>) => Promise<true | PolicyFailure | PolicyFixResult>;
+/**
+ * A standalone function that can be called to resolve a policy failure.
+ *
+ * @alpha
+ */
+export type PolicyStandaloneResolver<C = unknown | undefined> = (args: Omit<PolicyFunctionArguments<C>, "resolve">) => PolicyFixResult;
+/**
+ * A RepoPolicy checks and applies policies to files in the repository.
+ *
+ * Each policy has a name and a match regex for matching which files it should apply to. Every file in th repo is
+ * enumerated and if it matches the regex for a policy, that policy is applied.
+ *
+ * Each policy includes a handler function that checks a file against the policy and can optionally resolve any problems
+ * (automated resolutions depend on the policy implementation).
+ *
+ * @typeParam C - type of configuration object used by the policy
+ *
+ * @alpha
+ */
+export interface RepoPolicy<C = any | undefined> {
+    /**
+     * The name of the policy; displayed in UI and used in settings.
+     */
+    name: PolicyName;
+    /**
+     * A more detailed description of the policy and its intended function.
+     */
+    description?: string;
+    /**
+     * A regular expression that is used to match files in the repo.
+     */
+    match: RegExp;
+    /**
+     * A handler function that checks if a file is compliant with the policy.
+     *
+     * @param file - Repo-relative path to the file to check.
+     * @param root - Absolute path to the root of the repo.
+     * @param resolve - If true, automated policy fixes will be applied. Not all policies support automated fixes.
+     * @returns True if the file passed the policy; otherwise a PolicyFailure object will be returned.
+     */
+    handler: PolicyHandler<C>;
+    /**
+     * A resolver function that can be used to automatically address the policy violation.
+     *
+     * @param file - Repo-relative path to the file to check.
+     * @param root - Absolute path to the root of the repo.
+     * @returns true if the file passed the policy; otherwise a PolicyFailure object will be returned.
+     */
+    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 failure.
+ *
+ * @alpha
+ */
+export interface PolicyFailure {
+    name: PolicyName;
+    file: string;
+    autoFixable?: boolean | undefined;
+    errorMessage?: string | undefined;
+}
+/**
+ * @alpha
+ */
+export interface PolicyFixResult extends PolicyFailure {
+    resolved: boolean;
+}
+export declare function isPolicyFixResult(toCheck: any): toCheck is PolicyFixResult;
+/**
+ * Default policies included with repopo.
+ *
+ * @alpha
+ */
+export declare const DefaultPolicies: RepoPolicy[];
+//# sourceMappingURL=policy.d.ts.map

package/esm/policy.d.ts.map

@@ -0,0 +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,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD,QAAQ,EAAE,OAAO,CAAC;CAClB;AAGD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,IAAI,eAAe,CAK1E;AAiBD;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,UAAU,EAMvC,CAAC"}

package/esm/policy.js

@@ -0,0 +1,53 @@
+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
+    }
+}
+// biome-ignore lint/suspicious/noExplicitAny: type guard
+export function isPolicyFixResult(toCheck) {
+    if (typeof toCheck !== "object") {
+        return false;
+    }
+    return "resolved" in toCheck;
+}
+// export const commonMatchPatterns = {
+// 	"package.json": /(^|\/)package\.json/i,
+// } as const;
+// export function createPackageJsonPolicy(
+// 	props: Omit<RepoPolicy, "match">,
+// ): RepoPolicy {
+// 	const newPolicy: RepoPolicy = {
+// 		...props,
+// 		match: commonMatchPatterns["package.json"],
+// 	};
+// 	return newPolicy;
+// }
+/**
+ * Default policies included with repopo.
+ *
+ * @alpha
+ */
+export const DefaultPolicies = [
+    NoJsFileExtensions,
+    PackageJsonRepoDirectoryProperty,
+    PackageJsonProperties,
+    PackageJsonSortedPolicy,
+    SortTsconfigs,
+];
+//# sourceMappingURL=policy.js.map

package/esm/policy.js.map

@@ -0,0 +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;AAqBD,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,uCAAuC;AACvC,2CAA2C;AAC3C,cAAc;AAEd,2CAA2C;AAC3C,qCAAqC;AACrC,kBAAkB;AAClB,mCAAmC;AACnC,cAAc;AACd,gDAAgD;AAChD,MAAM;AAEN,qBAAqB;AACrB,IAAI;AAEJ;;;;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\tname: PolicyName;\n\tfile: string;\n\tautoFixable?: boolean | undefined;\n\terrorMessage?: string | undefined;\n}\n\n/**\n * @alpha\n */\nexport interface PolicyFixResult extends PolicyFailure {\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// export const commonMatchPatterns = {\n// \t\"package.json\": /(^|\\/)package\\.json/i,\n// } as const;\n\n// export function createPackageJsonPolicy(\n// \tprops: Omit<RepoPolicy, \"match\">,\n// ): RepoPolicy {\n// \tconst newPolicy: RepoPolicy = {\n// \t\t...props,\n// \t\tmatch: commonMatchPatterns[\"package.json\"],\n// \t};\n\n// \treturn newPolicy;\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"]}

package/esm/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.47.9"
+    }
+  ]
+}

package/oclif.manifest.json

@@ -0,0 +1,104 @@
+{
+  "commands": {
+    "check": {
+      "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"
+          ],
+          "char": "f",
+          "description": "Fix errors if possible.",
+          "name": "fix",
+          "required": false,
+          "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"
+        },
+        "stdin": {
+          "description": "Read list of files from stdin.",
+          "name": "stdin",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "config": {
+          "description": "The path to a configuration file.",
+          "helpGroup": "CONFIGURATION",
+          "hidden": true,
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "check",
+      "pluginAlias": "repopo",
+      "pluginName": "repopo",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Checks and applies policies to the files in the repository.",
+      "isESM": true,
+      "relativePath": [
+        "esm",
+        "commands",
+        "check.js"
+      ]
+    }
+  },
+  "version": "0.2.2"
+}

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "repopo",
+  "version": "0.2.2",
+  "description": "Enforce policies on all or some of the files in a git repository.",
+  "keywords": [
+    "policy",
+    "ci"
+  ],
+  "homepage": "https://github.com/tylerbutler/tools-monorepo/tree/main/packages/repopo#repopo---police-the-files-in-your-git-repo-with-extensible-policies",
+  "bugs": "https://github.com/tylerbutler/tools-monorepo/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tylerbutler/tools-monorepo.git",
+    "directory": "packages/repopo"
+  },
+  "license": "MIT",
+  "author": "Tyler Butler <tyler@tylerbutler.com>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./esm/index.d.ts",
+      "import": "./esm/index.js"
+    }
+  },
+  "types": "esm/index.d.ts",
+  "bin": {
+    "repopo": "./bin/run.js"
+  },
+  "files": [
+    "/CHANGELOG.md",
+    "/bin",
+    "/oclif.manifest.json",
+    "/esm",
+    "/THIRD-PARTY-LICENSES.txt"
+  ],
+  "oclif": {
+    "bin": "repopo",
+    "commands": {
+      "strategy": "pattern",
+      "target": "./esm/commands"
+    },
+    "devPlugins": [],
+    "dirname": "repopo",
+    "plugins": [],
+    "repositoryPrefix": "<%- repo %>/blob/main/packages/repopo/<%- commandPath %>"
+  },
+  "dependencies": {
+    "@fluidframework/build-tools": "^0.44.0",
+    "@oclif/core": "^4.0.19",
+    "@oclif/plugin-help": "^6.2.10",
+    "@rushstack/node-core-library": "^5.7.0",
+    "chalk": "^5.3.0",
+    "cosmiconfig": "^9.0.0",
+    "fs-extra": "^11.2.0",
+    "sort-package-json": "2.10.0",
+    "@tylerbu/cli-api": "^0.4.0",
+    "sort-tsconfig": "^0.1.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",
+    "@types/fs-extra": "^11.0.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",
+    "tmp-promise": "^3.0.3",
+    "ts-node": "^10.9.2",
+    "type-fest": "^4.18.2",
+    "typescript": "~5.5.4",
+    "vitest": "^2.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "api": "api-extractor run --local",
+    "api:markdown": "api-documenter markdown -i _temp/api-extractor -o _temp/docs",
+    "build": "fluid-build . --task build",
+    "check": "concurrently npm:check:format",
+    "check:format": "biome check . --linter-enabled=false",
+    "check:snapshot": "./bin/dev.js snapshot:compare --filepath test/commands/__snapshots__/commands.json",
+    "clean": "concurrently npm:clean:build npm:clean:manifest",
+    "clean:build": "rimraf esm *.tsbuildinfo *.done.build.log",
+    "clean:manifest": "rimraf oclif.manifest.json",
+    "compile": "tsc --project ./tsconfig.json",
+    "format": "biome check . --linter-enabled=false --write",
+    "full": "fluid-build . --task full",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint . --write",
+    "manifest": "oclif manifest",
+    "readme": "oclif readme --no-aliases",
+    "sort-package-json": "sort-package-json"
+  }
+}