You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**quality-ratchet** is a zero-dependency CLI that installs a smart quality gate with a *ratchet mechanism* into any JavaScript or TypeScript project. It detects your stack automatically, presents the viable options, and generates the necessary files: a standalone gate script, a CI workflow, and npm scripts — all tailored to your project.
7
+
**boatman** is a zero-dependency CLI that installs a smart quality gate with a *ratchet mechanism* into any JavaScript or TypeScript project. It detects your stack automatically, presents the viable options, and generates the necessary files: a standalone gate script, a CI workflow, and npm scripts — all tailored to your project.
6
8
7
9
---
8
10
@@ -22,25 +24,25 @@ The key insight: **you can never silently regress**. Every merge either holds th
22
24
## Quick Start
23
25
24
26
```bash
25
-
npx quality-ratchet init
27
+
npx boatman init
26
28
```
27
29
28
30
Or target a specific directory:
29
31
30
32
```bash
31
-
npx quality-ratchet init --path ./my-project
33
+
npx boatman init --path ./my-project
32
34
```
33
35
34
36
Accept all defaults without interactive prompts:
35
37
36
38
```bash
37
-
npx quality-ratchet --yes
39
+
npx boatman --yes
38
40
```
39
41
40
42
Preview what would be generated without writing any files:
41
43
42
44
```bash
43
-
npx quality-ratchet --dry-run
45
+
npx boatman --dry-run
44
46
```
45
47
46
48
---
@@ -75,7 +77,7 @@ npx quality-ratchet --dry-run
75
77
76
78
## Generated Files
77
79
78
-
After running `quality-ratchet init`, the following files are created or updated in your project:
80
+
After running `boatman init`, the following files are created or updated in your project:
@@ -231,7 +233,7 @@ When running on GitHub Actions with the `pr-comment` check enabled, the gate pos
231
233
> Run `npm run quality:baseline` to update the baseline with these improvements.
232
234
233
235
---
234
-
*Generated by [quality-ratchet](https://github.com/rafaelvieiras/quality-ratchet)*
236
+
*Generated by [boatman](https://github.com/rafaelvieiras/boatman)*
235
237
```
236
238
237
239
When a regression is detected:
@@ -250,19 +252,19 @@ When a regression is detected:
250
252
251
253
## Zero Dependencies
252
254
253
-
`quality-ratchet` uses only Node.js built-ins (`fs`, `path`, `readline`, `child_process`). The **generated** gate script is also standalone — it does not import anything from `quality-ratchet` at runtime.
255
+
`boatman` uses only Node.js built-ins (`fs`, `path`, `readline`, `child_process`). The **generated** gate script is also standalone — it does not import anything from `boatman` at runtime.
254
256
255
257
---
256
258
257
259
## Contributing
258
260
259
261
1. Fork the repository
260
262
2. Create your feature branch: `git checkout -b feat/my-feature`
261
-
3. Make your changes and ensure the CLI still works: `node bin/quality-ratchet.mjs --dry-run`
263
+
3. Make your changes and ensure the CLI still works: `node bin/boatman.mjs --dry-run`
262
264
4. Commit your changes: `git commit -m "feat: add my feature"`
263
265
5. Open a pull request
264
266
265
-
Bug reports and feature requests are welcome via [GitHub Issues](https://github.com/rafaelvieiras/quality-ratchet/issues).
267
+
Bug reports and feature requests are welcome via [GitHub Issues](https://github.com/rafaelvieiras/boatman/issues).
0 commit comments