urtext 0.1.0 → 0.1.1
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 +14 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Urtext
|
|
2
2
|
|
|
3
3
|
[](https://github.com/noahogbi/urtext/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/urtext)
|
|
4
5
|
|
|
5
6
|
**A diff reviewer that shows its evidence.** Point `urtext` at a git range and it reports what
|
|
6
7
|
changed and why it matters — ranked, and with every claim labeled by the kind of evidence behind
|
|
@@ -60,16 +61,23 @@ the analyzers' findings and says in the report that the model was never asked.
|
|
|
60
61
|
|
|
61
62
|
## Install
|
|
62
63
|
|
|
63
|
-
Not on npm yet. Install straight from GitHub — the build runs automatically
|
|
64
|
-
on install — and `urtext` is on your PATH:
|
|
65
|
-
|
|
66
64
|
```bash
|
|
67
|
-
npm install -g
|
|
65
|
+
npm install -g urtext
|
|
68
66
|
urtext review # from any git repository
|
|
69
67
|
```
|
|
70
68
|
|
|
71
|
-
|
|
72
|
-
|
|
69
|
+
The published package ships its build, so nothing compiles on install and no
|
|
70
|
+
lifecycle script runs — which matters under npm v12, where dependency scripts
|
|
71
|
+
and git dependencies are both off by default.
|
|
72
|
+
|
|
73
|
+
**Installing from GitHub needs those defaults relaxed.** `npm install -g
|
|
74
|
+
github:noahogbi/urtext` is refused outright by npm v12 (`EALLOWGIT`), and even
|
|
75
|
+
allowed through it would fetch a tree with no `dist/`, whose build runs from a
|
|
76
|
+
`prepare` script that v12 also disables. Use the registry unless you have a
|
|
77
|
+
reason not to; from a local checkout, `npm install -g path/to/urtext` still
|
|
78
|
+
works.
|
|
79
|
+
|
|
80
|
+
The `npm run review` form above is the dev loop inside this repository; it runs
|
|
73
81
|
`src/` directly and needs no build.
|
|
74
82
|
|
|
75
83
|
PDF export embeds the bundled DejaVu fonts, which cover Latin, Cyrillic, and
|