@jpeakai/prose-gates 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Josh Peak
+
+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,62 @@
+# jpai-prose-gates
+
+Deterministic prose gates for markdown documentation.
+Extracted from the `gooddocs` agent skill so the same rules run in CI, not only when an agent is asked.
+Incubated in the [`jpai-library`](https://github.com/jpeakai/jpai-library) domain.
+
+## Usage
+
+It runs under Bun or Node 20 and later, from the npm registry.
+
+```sh
+bunx @jpeakai/prose-gates README.md docs/*.md     # report findings, exit 1 if any
+npx -y @jpeakai/prose-gates --fix README.md  # apply every fix proven safe, report the rest
+```
+
+Installed as a dev dependency, the command is `prose-gates`, and `--json` gives machine-readable output.
+
+`--max-words N` changes the sentence budget, which defaults to 25.
+Exit codes are 0 for clean, 1 for findings, and 2 for a usage error.
+
+## The rules
+
+Nine rules in three categories.
+[RULES.md](RULES.md) shows a failing example and the fix for each one.
+
+| Category | Rules | What it guards |
+|---|---|---|
+| Sentence | PG001, PG002 | How a sentence is laid out and how long it runs |
+| List | PG003, PG006, PG007, PG008, PG009 | A list hidden in running prose, promoted to a real markdown list |
+| Punctuation | PG004, PG005 | A glyph that reads as generated text |
+
+Every fix is verified before it is written.
+A fix that would change a word, url or code value is a bug and fails the run.
+A case the fixer cannot read unambiguously is refused, so the finding stays for a human.
+The reasoning behind each choice is recorded in [`adrs/`](adrs/index.md).
+
+Code blocks are exempt.
+Fences tagged `markdown` or `md` are the exception, since they hold templates whose body is audited recursively.
+
+## Consuming it
+
+Each meta repo declares this package and runs it through a `docs-ci` target.
+
+```sh
+bun add --dev @jpeakai/prose-gates
+```
+
+npm works the same way, with `npm install --save-dev @jpeakai/prose-gates`.
+The library exports `checkMarkdown` and `fixMarkdown`.
+Bun imports the TypeScript source, and Node imports the bundle in `dist/`.
+
+Generated markdown is gated too.
+A finding there is traced back to the source that rendered it, either the record or the template, and never fixed in the output.
+
+## Development
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, the make targets and how a change is accepted.
+Releases are covered in [docs/PUBLISHING.md](docs/PUBLISHING.md).
+
+## License
+
+MIT, see [LICENSE](LICENSE).