@color-sunset/veye 0.1.0
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.
- package/README.md +52 -0
- package/dist/cli.js +11754 -0
- package/package.json +42 -0
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# veye
|
|
2
|
+
|
|
3
|
+
> Doc-freshness engine — measure, surface, and gate on documentation staleness.
|
|
4
|
+
|
|
5
|
+
Veye scans your codebase, computes freshness scores for every doc page, and gates
|
|
6
|
+
pull requests on documentation drift so docs never go silently stale.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
# global install
|
|
12
|
+
npm i -g veye
|
|
13
|
+
|
|
14
|
+
# one-off (no install)
|
|
15
|
+
npx veye <command>
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
A standalone binary (no Node/Bun required) is also available on the
|
|
19
|
+
[GitHub Releases](https://github.com/veye/veye/releases) page, and via Homebrew:
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
brew install veye/tap/veye
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Commands
|
|
26
|
+
|
|
27
|
+
| Command | Description |
|
|
28
|
+
| --------- | ----------------------------------------------------------------- |
|
|
29
|
+
| `scan` | Scan the repo for modules and spec systems |
|
|
30
|
+
| `compute` | Compute freshness scores, write `.veye/freshness.json` |
|
|
31
|
+
| `generate`| Read `wiki/` + JSON, write `wiki.dist/` with freshness blocks |
|
|
32
|
+
| `gate` | Check PR freshness against thresholds (for CI) |
|
|
33
|
+
| `lint` | Health check — orphans, broken refs, missing frontmatter |
|
|
34
|
+
| `init` | Write config, GitHub Actions, run initial `compute` |
|
|
35
|
+
|
|
36
|
+
## Quick start
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
veye init
|
|
40
|
+
veye scan
|
|
41
|
+
veye compute
|
|
42
|
+
veye gate --base-sha origin/main --head-sha HEAD
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Documentation
|
|
46
|
+
|
|
47
|
+
Full docs, configuration reference, and CI recipes live in the
|
|
48
|
+
[main repository](https://github.com/veye/veye).
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
MIT
|