@zgeoff/chex 0.0.6 → 0.0.7
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
CHANGED
|
@@ -41,14 +41,14 @@ program. `chex <check> <args...>` hands the arguments to that one check.
|
|
|
41
41
|
|
|
42
42
|
The docs checks read the repo's READMEs, its `docs/` tree and its skills:
|
|
43
43
|
|
|
44
|
-
| Check | Fails on
|
|
45
|
-
| --------- |
|
|
46
|
-
| `prose` | banned words, process residue and over-long paragraphs
|
|
47
|
-
| `length` | a README over its line limit, and warns on a doc over its cap
|
|
48
|
-
| `links` | a relative link or anchor that does not resolve
|
|
49
|
-
| `readmes` | a README of none of the [five kinds](
|
|
50
|
-
| `vision` | a missing `docs/vision.md`, or one past 60 lines
|
|
51
|
-
| `skill` | a skill's frontmatter, its word limit, and a link with a line anchor
|
|
44
|
+
| Check | Fails on | Arguments |
|
|
45
|
+
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
46
|
+
| `prose` | banned words, process residue and over-long paragraphs | the paths |
|
|
47
|
+
| `length` | a README over its line limit, and warns on a doc over its cap | none |
|
|
48
|
+
| `links` | a relative link or anchor that does not resolve | the paths |
|
|
49
|
+
| `readmes` | a README of none of the [five kinds](https://github.com/zgeoff/skills/blob/main/skills/docs-writing/references/readmes.md#the-five-kinds) | none |
|
|
50
|
+
| `vision` | a missing `docs/vision.md`, or one past 60 lines | none |
|
|
51
|
+
| `skill` | a skill's frontmatter, its word limit, and a link with a line anchor | the skill dirs |
|
|
52
52
|
|
|
53
53
|
The repo checks read the branch, the pushed commits and the repo's config:
|
|
54
54
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zgeoff/chex",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"description": "Run each shared docs and repo check as one subcommand, with the lefthook pre-push baseline that calls them",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"checks",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"typecheck": "tsrs"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@zgeoff/std": "0.3.
|
|
33
|
+
"@zgeoff/std": "0.3.2",
|
|
34
34
|
"ts-pattern": "5.9.2"
|
|
35
35
|
},
|
|
36
36
|
"devDependencies": {
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { existsSync, readFileSync } from 'node:fs';
|
|
2
2
|
import { join } from 'node:path';
|
|
3
|
+
import { writeStdout } from '@zgeoff/std';
|
|
3
4
|
import { runProgram } from '../run-program.ts';
|
|
4
5
|
import type { DependencyGateSources } from './read-dependency-gate-findings.ts';
|
|
5
6
|
import { readDependencyGateFindings } from './read-dependency-gate-findings.ts';
|
|
@@ -40,9 +41,7 @@ export function runDependencyGatesCommand(): number {
|
|
|
40
41
|
|
|
41
42
|
return existsSync(fullPath) ? readFileSync(fullPath, 'utf8') : null;
|
|
42
43
|
},
|
|
43
|
-
writeOutput:
|
|
44
|
-
process.stdout.write(text);
|
|
45
|
-
},
|
|
44
|
+
writeOutput: writeStdout,
|
|
46
45
|
writeError: (text) => {
|
|
47
46
|
process.stderr.write(text);
|
|
48
47
|
},
|