@natjswenson/devlog 0.1.3 → 0.1.4
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 +20 -1
- package/SKILL.md +7 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
# devlog
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@natjswenson/devlog)
|
|
4
|
+
[](./LICENSE)
|
|
5
|
+
|
|
3
6
|
A Claude Code skill that turns your daily git commits into a published dev log — and a React example for displaying it on your site.
|
|
4
7
|
|
|
5
8
|
> **Build in public, automatically.** Make commits like you always do. Run `/devlog`. Today's work shows up on your site as a narrative entry, not raw commit messages.
|
|
6
9
|
|
|
7
10
|
## Live example
|
|
8
11
|
|
|
9
|
-
The skill is in production at [natejswenson.io/devlog](https://natejswenson.io/devlog), publishing entries to [github.com/natejswenson/daily-dev-log](https://github.com/natejswenson/daily-dev-log).
|
|
12
|
+
The skill is in production at [natejswenson.io/devlog](https://natejswenson.io/devlog), publishing entries to [github.com/natejswenson/daily-dev-log](https://github.com/natejswenson/daily-dev-log). What you see on that page is exactly what `npx @natjswenson/devlog preview` renders for you locally.
|
|
10
13
|
|
|
11
14
|
## How it works
|
|
12
15
|
|
|
@@ -159,6 +162,22 @@ See [`config.example.json`](./config.example.json) for a complete template.
|
|
|
159
162
|
- **Tweak the UI:** override the `--devlog-*` CSS variables in `examples/react/DevLogPage.css` to match your theme. Or build your own UI against the data contract above.
|
|
160
163
|
- **Add more projects:** edit `~/.claude/skills/devlog/config.json` directly.
|
|
161
164
|
|
|
165
|
+
## Troubleshooting
|
|
166
|
+
|
|
167
|
+
**`sh: devlog: command not found` when running `npx`:** you're probably inside a checkout of this repo. The local `package.json` collides with the published name. Run `npx` from anywhere else (e.g. `cd ~ && npx @natjswenson/devlog ...`).
|
|
168
|
+
|
|
169
|
+
**Init prompt shows `78` after the placeholder text:** that's an artifact of capturing terminal output (cursor save/restore escapes); in a real terminal you won't see it.
|
|
170
|
+
|
|
171
|
+
**Preview is blank / no tabs / no entries:** check the browser console. If you see *"does not provide an export named …"* errors related to `react-dom/client`, `style-to-js`, or `react-markdown`, you're on a pre-0.1.3 release — upgrade with `npm cache clean --force && rm -rf ~/.npm/_npx && npx --yes @natjswenson/devlog@latest preview`.
|
|
172
|
+
|
|
173
|
+
**`npm publish` (if you fork/republish your own copy) fails with 403:** npm requires 2FA or a granular access token with bypass-2FA enabled for write operations. Easiest path: enable 2FA, install an authenticator app, and pass `--otp=<code>` to `npm publish`.
|
|
174
|
+
|
|
175
|
+
**Init can't find `gh`:** install via [cli.github.com](https://cli.github.com/) and run `gh auth login`.
|
|
176
|
+
|
|
177
|
+
## Versioning
|
|
178
|
+
|
|
179
|
+
Stable: see [npm](https://www.npmjs.com/package/@natjswenson/devlog). The package follows semver — bug fixes in patch releases (0.1.x), behavior changes in minor (0.x.0).
|
|
180
|
+
|
|
162
181
|
## License
|
|
163
182
|
|
|
164
183
|
MIT
|
package/SKILL.md
CHANGED
|
@@ -14,16 +14,18 @@ Usage: `/devlog` (all configured projects) or `/devlog <project-key>` (single pr
|
|
|
14
14
|
|
|
15
15
|
This skill is configuration-driven. All user-specific values (target repo, git author, project list) live in `~/.claude/skills/devlog/config.json`.
|
|
16
16
|
|
|
17
|
-
Schema:
|
|
17
|
+
Schema (required fields plus optional ones):
|
|
18
18
|
|
|
19
19
|
```json
|
|
20
20
|
{
|
|
21
21
|
"targetRepo": "<owner>/<repo>",
|
|
22
|
+
"branch": "main",
|
|
22
23
|
"gitAuthor": "Your Name",
|
|
23
24
|
"githubUser": "<your-github-username>",
|
|
24
25
|
"projects": [
|
|
25
26
|
{
|
|
26
27
|
"key": "project-key",
|
|
28
|
+
"label": "Display Name",
|
|
27
29
|
"path": "/absolute/path/to/project",
|
|
28
30
|
"remote": "<owner>/<repo>"
|
|
29
31
|
}
|
|
@@ -31,6 +33,8 @@ Schema:
|
|
|
31
33
|
}
|
|
32
34
|
```
|
|
33
35
|
|
|
36
|
+
Optional fields: `branch` (defaults to `main`), `projects[].label` (defaults to `key`).
|
|
37
|
+
|
|
34
38
|
## Step 0: Load and validate config
|
|
35
39
|
|
|
36
40
|
```bash
|
|
@@ -144,7 +148,7 @@ git add .
|
|
|
144
148
|
|
|
145
149
|
# Single commit covering all projects
|
|
146
150
|
git commit -m "devlog: add entries for YYYY-MM-DD"
|
|
147
|
-
git push origin main
|
|
151
|
+
git push origin <config.branch || 'main'>
|
|
148
152
|
|
|
149
153
|
# Cleanup
|
|
150
154
|
rm -rf "$TMPDIR"
|
|
@@ -160,7 +164,7 @@ Dev log entries published for <Month Day, Year>
|
|
|
160
164
|
Project: <project.key>
|
|
161
165
|
Commits summarized: <count>
|
|
162
166
|
Public commits linked: <count>
|
|
163
|
-
URL: https://github.com/<config.targetRepo>/blob
|
|
167
|
+
URL: https://github.com/<config.targetRepo>/blob/<config.branch || 'main'>/<project.key>/YYYY-MM-DD.md
|
|
164
168
|
```
|
|
165
169
|
|
|
166
170
|
## Edge Cases
|
package/package.json
CHANGED