@jpeakai/prose-gates 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/README.md +9 -5
  2. package/dist/bin.js +398 -410
  3. package/dist/index.js +398 -410
  4. package/package.json +1 -1
  5. package/src/check.ts +2 -3
  6. package/src/fix/engine.ts +4 -4
  7. package/src/fix/promote.ts +14 -2
  8. package/src/interpunct.ts +48 -0
  9. package/src/model.ts +1 -13
  10. package/src/query.ts +131 -0
  11. package/src/rules/index.ts +8 -1
  12. package/src/rules/pg001-wrap.ts +71 -51
  13. package/src/rules/pg002-length.ts +19 -18
  14. package/src/rules/pg003-semicolon-list.ts +27 -35
  15. package/src/rules/pg004-em-dash.ts +118 -80
  16. package/src/rules/pg005-interpunct.ts +34 -25
  17. package/src/rules/pg006-interpunct-run.ts +33 -49
  18. package/src/rules/pg007-inline-enum.ts +66 -58
  19. package/src/rules/pg008-labelled-run.ts +50 -43
  20. package/src/rules/pg009-stacked-runs.ts +48 -47
  21. package/src/rules/types.ts +15 -12
  22. package/src/text.ts +50 -0
  23. package/src/fix/spans.ts +0 -75
  24. package/src/rules/interpunct.ts +0 -19
package/README.md CHANGED
@@ -1,12 +1,15 @@
1
1
  # jpai-prose-gates
2
2
 
3
- Deterministic prose gates for markdown documentation.
4
- Extracted from the `gooddocs` agent skill so the same rules run in CI, not only when an agent is asked.
5
- Incubated in the [`jpai-library`](https://github.com/jpeakai/jpai-library) domain.
3
+ Reading markdown should not be hard.
4
+ Keep AI accountable one anti-slop rule at a time.
6
5
 
7
- ## Usage
6
+ **[Rules](RULES.md)** | **[GitHub](https://github.com/jpeakai/jpai-prose-gates)** | **[npm](https://www.npmjs.com/package/@jpeakai/prose-gates)**
7
+
8
+ | Package Index | Published Version | Downloads | Node | CI | License |
9
+ |---|---|---|---|---|---|
10
+ | npm | [![npm](https://img.shields.io/npm/v/@jpeakai/prose-gates.svg)](https://www.npmjs.com/package/@jpeakai/prose-gates) | [![npm Downloads](https://img.shields.io/npm/dm/@jpeakai/prose-gates.svg)](https://www.npmjs.com/package/@jpeakai/prose-gates) | [![Node](https://img.shields.io/node/v/@jpeakai/prose-gates.svg)](package.json) | [![CI](https://github.com/jpeakai/jpai-prose-gates/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/jpeakai/jpai-prose-gates/actions/workflows/ci.yml) | [![License](https://img.shields.io/npm/l/@jpeakai/prose-gates.svg)](LICENSE) |
8
11
 
9
- It runs under Bun or Node 20 and later, from the npm registry.
12
+ ## Usage
10
13
 
11
14
  ```sh
12
15
  bunx @jpeakai/prose-gates README.md docs/*.md # report findings, exit 1 if any
@@ -22,6 +25,7 @@ Exit codes are 0 for clean, 1 for findings, and 2 for a usage error.
22
25
 
23
26
  Nine rules in three categories.
24
27
  [RULES.md](RULES.md) shows a failing example and the fix for each one.
28
+ [docs/DATA_MODEL.md](docs/DATA_MODEL.md) diagrams how a rule is checked, fixed and verified.
25
29
 
26
30
  | Category | Rules | What it guards |
27
31
  |---|---|---|