@zgeoff/checks 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Geoff Whatley
+
+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

@@ -1,3 +1,67 @@
-# Temporary Holding Version
+# @zgeoff/checks
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`zgeoff-check` runs the checks that every zgeoff repo shares, so a repo runs them with one package
+script instead of a lint script of its own. Each check is a module with a name, a file glob, and a
+function that returns findings. The runner prints each finding as `path:line: <check>: <message>`
+and exits 1 when it prints any. With no arguments it checks every file that git tracks, and with a
+list of files it checks only those. It runs from any folder in the repo: it reads the config at the
+repo root, prints each path from the root, and reads a file argument from the folder it runs in. It
+skips a listed file that does not exist, such as one the branch deletes, so a misspelled path checks
+nothing.
+
+## Install
+
+```sh
+bun add -d @zgeoff/checks
+```
+
+Add the script that the pre-push baseline and the standard list of the shared pull-request checks
+call. Both skip the check with a notice while a repo lacks the script, so adding it turns the check
+on. A repo that sets its own list in the `BUN_CHECK_SCRIPTS` variable adds `check` to that list as
+well:
+
+```json
+{
+  "scripts": {
+    "check": "zgeoff-check"
+  }
+}
+```
+
+The package runs on Bun.
+
+## Checks
+
+| Check   | Files     | It runs                        | It needs on the PATH  |
+| ------- | --------- | ------------------------------ | --------------------- |
+| `shell` | `**/*.sh` | `shellcheck -x` and `shfmt -d` | `shellcheck`, `shfmt` |
+
+The `shell` check runs `shfmt` with no style flags, so `shfmt` reads its style from the repo's
+`.editorconfig`. The `shfmt` finding sits at the first line of each block that `shfmt` would change.
+`shellcheck` follows each `source` line into the file it names, and looks for that file beside the
+script and then from the repo root. A sourced file is followed even when the run does not list it.
+The shared pull-request checks install `shfmt` when their list runs `check`, and the runner image
+already has `shellcheck`.
+
+## Exit codes
+
+- `0`: no check found a problem.
+- `1`: a check found at least one problem.
+- `2`: the run could not finish, so the runner prints the reason and no findings, even when some
+  checks found problems before it stopped. That happens when the config file breaks a rule, a check
+  needs a program that the PATH lacks, git or a check's program fails, a listed file cannot be read
+  for a reason other than being absent, or the command line holds an unknown option or `--help` with
+  files.
+
+## Turning a check off
+
+A repo turns a check off in `zgeoff-check.json` at its root, and each entry gives the reason:
+
+```json
+{
+  "off": [{ "check": "shell", "reason": "the scripts are vendored from another project" }]
+}
+```
+
+The runner rejects an entry with no reason, with a blank reason, or with a check name it does not
+know, and it exits 2 without running any check. A check is either on or off for the whole repo.