@dansyuqri/spark-joy 0.1.1 → 0.1.3
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 +6 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,6 +9,11 @@
|
|
|
9
9
|
|
|
10
10
|
<p align="center"><em>Make PRs spark joy again.</em></p>
|
|
11
11
|
|
|
12
|
+
<p align="center">
|
|
13
|
+
<a href="https://www.npmjs.com/package/@dansyuqri/spark-joy"><img src="https://img.shields.io/npm/v/@dansyuqri/spark-joy?style=flat-square&label=npm" alt="npm version"></a>
|
|
14
|
+
<img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="MIT license">
|
|
15
|
+
</p>
|
|
16
|
+
|
|
12
17
|
AI-assisted pull requests are often thousands of lines long, too big to review properly in one go. spark-joy has Claude break a big PR or MR into small, ordered chunks, then opens a local app where you review them one batch at a time. You tick chunks off, leave notes, and finish with a summary of everything the PR changes.
|
|
13
18
|
|
|
14
19
|
It works from plain git, so it works the same for GitHub, GitLab or anything else. Nothing is posted anywhere; your notes export as markdown you can paste into the PR.
|
|
@@ -34,7 +39,7 @@ spark-joy serve → review app choose an order, review chunk by chunk, e
|
|
|
34
39
|
|
|
35
40
|
## Install
|
|
36
41
|
|
|
37
|
-
Requires Node 22 or newer and git.
|
|
42
|
+
Requires Node 22 or newer and git. Published on npm as [`@dansyuqri/spark-joy`](https://www.npmjs.com/package/@dansyuqri/spark-joy).
|
|
38
43
|
|
|
39
44
|
```sh
|
|
40
45
|
npm install -g @dansyuqri/spark-joy
|
|
@@ -92,11 +97,3 @@ Layout:
|
|
|
92
97
|
- `src/`: the React review app.
|
|
93
98
|
- `skill/`: the Claude Code skill.
|
|
94
99
|
- `test/`: Vitest, with a fixture git repo.
|
|
95
|
-
|
|
96
|
-
## Releasing
|
|
97
|
-
|
|
98
|
-
Releases publish to npm from GitHub Actions with [trusted publishing](https://docs.npmjs.com/trusted-publishers), so no npm token is stored anywhere.
|
|
99
|
-
|
|
100
|
-
1. **First release only, by hand.** npm needs the package to exist before a trusted publisher can be added: `npm login`, then `npm publish`.
|
|
101
|
-
2. **Once, on npmjs.com:** open the package's Settings → Trusted publishing → GitHub Actions. Enter owner `Dansyuqri`, repository `spark-joy` and workflow `release.yml` (case-sensitive); leave the environment blank.
|
|
102
|
-
3. **Every release after that:** `npm version patch` (or `minor`/`major`), then `git push --follow-tags`. The `v*` tag runs `.github/workflows/release.yml`, which tests and publishes with provenance.
|