repopo 0.2.2

package/CHANGELOG.md

@@ -0,0 +1,89 @@
+# repopo
+
+## 0.2.2
+
+### Patch Changes
+
+- Publish repopo package _[`#125`](https://github.com/tylerbutler/tools-monorepo/pull/125) [`12b3a58`](https://github.com/tylerbutler/tools-monorepo/commit/12b3a58e8946b0988009331bf1830e1fa1cc6567) [@tylerbutler](https://github.com/tylerbutler)_
+
+## 0.2.1
+
+### Patch Changes
+
+<details><summary>Updated 1 dependency</summary>
+
+<small>
+
+[`61fade5`](https://github.com/tylerbutler/tools-monorepo/commit/61fade577c27a6ad55c79d997eb42ecc0ca9abe9)
+
+</small>
+
+- `sort-tsconfig@0.1.1`
+
+</details>
+
+## 0.2.0
+
+### Minor Changes
+
+- PackageJsonSortedPolicy keeps package.json files sorted _[`#114`](https://github.com/tylerbutler/tools-monorepo/pull/114) [`0664ac5`](https://github.com/tylerbutler/tools-monorepo/commit/0664ac5731c5dd23bc1c21070fe880335f46489b) [@tylerbutler](https://github.com/tylerbutler)_
+
+  The new `PackageJsonSortedPolicy` policy enforces that package.json files are always sorted according to sort-package-json.
+
+### Patch Changes
+
+<details><summary>Updated 2 dependencies</summary>
+
+<small>
+
+[`cbdec3f`](https://github.com/tylerbutler/tools-monorepo/commit/cbdec3f7b3daa4ec642b44a5de046fff8420f15a) [`d55c982`](https://github.com/tylerbutler/tools-monorepo/commit/d55c982f960b56a79f0e0d35dd9102a25882032f) [`ddcbd48`](https://github.com/tylerbutler/tools-monorepo/commit/ddcbd48a161d8be666ff537316fa018d8c0b7ad8)
+
+</small>
+
+- `@tylerbu/cli-api@0.4.0`
+- `sort-tsconfig@0.1.0`
+
+</details>
+
+## 0.1.1
+
+### Patch Changes
+
+- Fix homepage URL _[`#99`](https://github.com/tylerbutler/tools-monorepo/pull/99) [`0654323`](https://github.com/tylerbutler/tools-monorepo/commit/06543231947fa5267863e5467d5837a51cf3d44b) [@tylerbutler](https://github.com/tylerbutler)_
+
+<details><summary>Updated 1 dependency</summary>
+
+<small>
+
+[`0654323`](https://github.com/tylerbutler/tools-monorepo/commit/06543231947fa5267863e5467d5837a51cf3d44b)
+
+</small>
+
+- `@tylerbu/cli-api@0.3.1`
+
+</details>
+
+## 0.1.0
+
+### Minor Changes
+
+- Introducing repopo, a tool to make sure the files in a git repository adhere to configurable policies _[`#16`](https://github.com/tylerbutler/tools-monorepo/pull/16) [`030fd98`](https://github.com/tylerbutler/tools-monorepo/commit/030fd980ee45471074a8f41aab46d1a5b025b2f6) [@tylerbutler](https://github.com/tylerbutler)_
+
+  You can use repopo to make sure all source files have a common header, check that all packages have a particular field
+  in package.json, etc. You can extend repopo with your own policies or policies from the ecosystem.
+
+  For more information, see the [repopo readme](https://github.com/tylerbutler/tools-monorepo/blob/main/packages/repopo/README.md).
+
+### Patch Changes
+
+<details><summary>Updated 1 dependency</summary>
+
+<small>
+
+[`f54b0e7`](https://github.com/tylerbutler/tools-monorepo/commit/f54b0e71dd1d54c5e3730b7a1f1ab1a53b9b7943)
+
+</small>
+
+- `@tylerbu/cli-api@0.3.0`
+
+</details>

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Tyler Butler <tyler@tylerbutler.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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,103 @@
+# repopo - police the files in your git repo with extensible policies
+
+repopo is a tool to apply policies to the files in your git repo. You can think of it as a sort of lint tool for any
+file in your git repo, with a straightforward way to write your own policies.
+
+<!-- toc -->
+* [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)
+<!-- 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
+TypeScript configuration file is recommended.
+
+The policy config must export a default object of the type `PolicyConfig`.
+
+## Excluding files from policy check
+
+By default, all files in the repo are checked. You can exclude files completely from the policy check by configuring the
+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.
+
+## 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.
+
+# Included policies
+
+repopo includes the following policies. All of the included policies are enabled by default.
+
+## NoJsFileExtensions
+
+The NoJsFileExtensions policy checks for JavaScript source files that just use the .js file extension. Such files may be
+interpreted by Node.js 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.
+
+## PackageJsonProperties
+
+The PackageJsonProperties policy is used to enforce fields in package.json files across the repo.
+
+### Configuration
+
+The `verbatim` setting requires that all the configured fields in package.json match the values in the configuration.
+
+```ts
+import type { PolicyConfig } from "@tylerbu/repopo";
+const config: PolicyConfig = {
+	policySettings: {
+		PackageJsonProperties: {
+      // This setting will force all package.json files to contain these fields with the exact configured values.
+			verbatim: {
+				license: "MIT",
+				author: "Tyler Butler <tyler@tylerbutler.com>",
+				bugs: "https://github.com/tylerbutler/tools-monorepo/issues",
+			}
+		}
+	}
+};
+```
+
+## PackageJsonRepoDirectoryProperty
+
+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
+
+<!-- commands -->
+* [`repopo check`](#repopo-check)
+
+## `repopo check`
+
+Checks and applies policies to the files in the repository.
+
+```
+USAGE
+  $ repopo check [-v | --quiet] [-f] [-D <value>... | -d <value>] [-p <value>] [--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.
+
+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)_
+<!-- commandsstop -->

package/THIRD-PARTY-LICENSES.txt

@@ -0,0 +1,198 @@
+This file was generated with the generate-license-file npm package!
+https://www.npmjs.com/package/generate-license-file
+
+The following npm package may be included in this product:
+
+ - fs-extra@11.2.0
+
+This package contains the following license and notice below:
+
+(The MIT License)
+
+Copyright (c) 2011-2017 JP Richardson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
+(the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
+ merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+-----------
+
+The following npm package may be included in this product:
+
+ - @fluidframework/build-tools@0.41.0
+
+This package contains the following license and notice below:
+
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-----------
+
+The following npm packages may be included in this product:
+
+ - @oclif/core@4.0.12
+ - @oclif/plugin-help@6.2.6
+
+These packages each contain the following license and notice below:
+
+MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-----------
+
+The following npm package may be included in this product:
+
+ - sort-tsconfig@0.0.1
+
+This package contains the following license and notice below:
+
+MIT License
+
+Copyright (c) 2023 Tyler Butler <tyler@tylerbutler.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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-----------
+
+The following npm package may be included in this product:
+
+ - chalk@5.3.0
+
+This package contains the following license and notice below:
+
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.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 in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+-----------
+
+The following npm package may be included in this product:
+
+ - @tylerbu/cli-api@0.2.0
+
+This package contains the following license and notice below:
+
+MIT License
+
+Copyright (c) Tyler Butler <tyler@tylerbutler.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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-----------
+
+The following npm package may be included in this product:
+
+ - cosmiconfig@9.0.0
+
+This package contains the following license and notice below:
+
+The MIT License (MIT)
+
+Copyright (c) 2015 David Clark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-----------
+
+This file was generated with the generate-license-file npm package!
+https://www.npmjs.com/package/generate-license-file

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
+
+import { execute } from "@oclif/core";
+
+await execute({ development: true, dir: import.meta.url });

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from "@oclif/core";
+
+await execute({ dir: import.meta.url });

package/esm/commands/check.d.ts

@@ -0,0 +1,46 @@
+import { GitCommand } from "@tylerbu/cli-api";
+import { type PolicyConfig } from "../config.js";
+/**
+ * This tool enforces policies across the code base via a series of handler functions. The handler functions are
+ * associated with a regular expression, and all files matching that expression are passed to the handler function.
+ *
+ * By default, the list of files to check comes from `git ls-files. You can also pipe in file names from stdin. For
+ * example:
+ *
+ * `git ls-files -co --exclude-standard --full-name | repopo check --stdin --verbose`
+ */
+export declare class CheckPolicy extends GitCommand<typeof CheckPolicy & {
+    args: typeof GitCommand.args;
+    flags: typeof GitCommand.flags;
+}, PolicyConfig> {
+    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 fix: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        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 stdin: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    private processed;
+    private count;
+    private commandContext;
+    get defaultConfig(): import("type-fest").SetOptional<Required<PolicyConfig>, "policies" | "policySettings">;
+    protected loadConfig(): Promise<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.
+     */
+    private routeToHandlers;
+    private logStats;
+    /**
+     * 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.
+     */
+    private checkOrExcludeFile;
+}
+//# sourceMappingURL=check.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAA2B,MAAM,kBAAkB,CAAC;AAGvE,OAAO,EAAuB,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAoDtE;;;;;;;;GAQG;AACH,qBAAa,WAAY,SAAQ,UAAU,CAC1C,OAAO,WAAW,GAAG;IACpB,IAAI,EAAE,OAAO,UAAU,CAAC,IAAI,CAAC;IAC7B,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CAC/B,EACD,YAAY,CACZ;IACA,gBAAyB,OAAO,iEAC+B;IAE/D,gBAAyB,KAAK;gCA7De,wBAAwB,wCAGrD,wBAAwB;;;;;;MAwF7B;IAEX,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,KAAK,CAAK;IAElB,OAAO,CAAC,cAAc,CAAwC;IAE9D,IAAoB,aAAa,2FAEhC;cAEwB,UAAU,IAAI,OAAO,CAAC,YAAY,CAAC;IAuBtC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA6DrB,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;YAmE5B,aAAa;IAc3B;;;;OAIG;YACW,eAAe;IAwG7B,OAAO,CAAC,QAAQ;IAchB;;;OAGG;YACW,kBAAkB;CA0BhC"}