@turri-dev/cli 0.2.2 → 0.2.3-next.5009c4c
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 +2 -0
- package/docs/development.md +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -203,6 +203,8 @@ Start at the [documentation index](docs/README.md), or go straight to a page:
|
|
|
203
203
|
| [The \*\*\*plain parser](docs/parser.md) | the TypeScript port, `turri parse`, fidelity to the reference parser |
|
|
204
204
|
| [Theming](docs/theming.md) | the two brand themes |
|
|
205
205
|
| [Development](docs/development.md) | tests, layout, known edges |
|
|
206
|
+
| [Contributing](CONTRIBUTING.md) | reporting a bug, making a change, the conventions a pull request follows |
|
|
207
|
+
| [Security](SECURITY.md) | reporting a vulnerability, privately |
|
|
206
208
|
|
|
207
209
|
## License
|
|
208
210
|
|
package/docs/development.md
CHANGED
|
@@ -7,6 +7,8 @@ npm test # the whole suite, about a minute
|
|
|
7
7
|
|
|
8
8
|
The suite runs the projects' testing scripts on this machine, as turri does. The fixture scripts stage each run in a folder of their own, as test files running side by side would otherwise share one.
|
|
9
9
|
|
|
10
|
+
`.github/workflows/test.yml` runs both on GitHub for every pull request and every push to `main`, and `.github/workflows/commits.yml` checks that each of a pull request's commits is a Conventional Commit, with no fixup and no merge commit - a pull request is rebased onto `main`, each commit as it is. A pull request from a fork runs them once the maintainer has approved its run - see [contributing](../CONTRIBUTING.md).
|
|
11
|
+
|
|
10
12
|
## Mutation testing
|
|
11
13
|
|
|
12
14
|
`npm run mutation` runs [Stryker](https://stryker-mutator.io) over the core of regeneration - the parts in `stryker.config.mjs` - one part at a time, each part's report in `reports/mutation/<part>/`. A part with a report is skipped, so a run that is stopped goes on from the part it was in; `npm run mutation -- <part>` runs one again, and `npm run mutation -- --summary` sums up the reports there are. It takes hours: each part runs the suite once to find which tests reach which mutant (`vitest.stryker.config.ts`, the suite without the files that run real commands behind the sandbox), then each mutant against those tests. `scripts/mutation.mjs` sets two things in Stryker's vitest runner the suite needs - forked workers, and a test-name filter that matches vitest 5's names - again after every `npm install`.
|