@brownnrl/geomlib 0.13.0 → 0.15.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 +22 -1
- package/dist/bundle.js +1 -1
- package/dist/bundle.js.map +1 -1
- package/package.json +10 -5
package/README.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# geomlib
|
|
2
2
|
|
|
3
|
+
[](https://github.com/brownnrl/euclid/actions/workflows/test.yml)
|
|
4
|
+
[](https://github.com/brownnrl/euclid/actions/workflows/github-code-scanning/codeql)
|
|
5
|
+
[](https://www.npmjs.com/package/@brownnrl/geomlib)
|
|
6
|
+
|
|
3
7
|
A TypeScript port of Dr. David E. Joyce's *Geometry Applet* (Clark
|
|
4
8
|
University, 1996, Java version 2.2). `geomlib` renders interactive
|
|
5
9
|
Euclidean geometry diagrams on an HTML5 `<canvas>`: drag a point, and
|
|
@@ -107,7 +111,7 @@ npm install # install dependencies (once)
|
|
|
107
111
|
npm run build # compile TypeScript (no emit; type-check only)
|
|
108
112
|
npm test # run the full Mocha suite (unit + snapshot)
|
|
109
113
|
npm run test:unit # unit tests only
|
|
110
|
-
npm run test:snapshot #
|
|
114
|
+
npm run test:snapshot # 705 rendered-pixel snapshot tests
|
|
111
115
|
npm run coverage # tests + c8 code coverage report
|
|
112
116
|
npm run bundle # webpack dev-mode bundle to dist/bundle.js
|
|
113
117
|
npm run bundle:prod # webpack production (minified) bundle
|
|
@@ -118,6 +122,23 @@ python3 -m http.server # serve view/test/* pages in a browser
|
|
|
118
122
|
so the tarball always contains a fresh production-built bundle. Run
|
|
119
123
|
`npm publish --dry-run` to preview what would ship without publishing.
|
|
120
124
|
|
|
125
|
+
## Reports
|
|
126
|
+
|
|
127
|
+
Regenerated and republished on each `npm publish`, so they track the
|
|
128
|
+
released version rather than whatever was last run by hand.
|
|
129
|
+
|
|
130
|
+
| Report | What it shows |
|
|
131
|
+
|---|---|
|
|
132
|
+
| [Code coverage](https://brownnrl.github.io/geomlib-reports/coverage/) | `c8` line/branch coverage of the TypeScript source. |
|
|
133
|
+
| [Snapshot regression](https://brownnrl.github.io/geomlib-reports/snapshots/report.html) | Every construction scene the library renders, with drag interactions. Click a thumbnail for a live, draggable slate. |
|
|
134
|
+
|
|
135
|
+
Both are generated locally (`npm run reports:build`) and pushed to
|
|
136
|
+
[brownnrl/geomlib-reports](https://github.com/brownnrl/geomlib-reports),
|
|
137
|
+
which GitHub Pages serves. They live in their own repository on purpose:
|
|
138
|
+
the snapshot report is ~42 MB of PNGs, several times the size of this
|
|
139
|
+
repository's entire history, and `git clone` fetches every branch by
|
|
140
|
+
default — keeping it out means a clone of `euclid` stays small.
|
|
141
|
+
|
|
121
142
|
## Origin
|
|
122
143
|
|
|
123
144
|
Built atop Dr. David E. Joyce's (Professor Emeritus, Clark
|