claude-code-starter 0.1.3 → 0.2.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 +70 -0
- package/package.json +7 -1
package/README.md
CHANGED
|
@@ -267,6 +267,70 @@ echo ".claude/" >> ~/.gitignore
|
|
|
267
267
|
git config --global core.excludesfile ~/.gitignore
|
|
268
268
|
```
|
|
269
269
|
|
|
270
|
+
## CI/CD
|
|
271
|
+
|
|
272
|
+
This project uses GitHub Actions for continuous integration and automated releases.
|
|
273
|
+
|
|
274
|
+
### PR Checks (`.github/workflows/pr-check.yml`)
|
|
275
|
+
|
|
276
|
+
Every pull request targeting `main` runs:
|
|
277
|
+
|
|
278
|
+
| Check | Description |
|
|
279
|
+
|-------|-------------|
|
|
280
|
+
| **Lint** | Biome lint and format validation |
|
|
281
|
+
| **Type Check** | TypeScript compilation check |
|
|
282
|
+
| **Unit Tests** | Full test suite with Bun |
|
|
283
|
+
| **Code Quality** | Checks for console.log, `any` types, skipped tests |
|
|
284
|
+
| **Build** | Verifies package builds successfully |
|
|
285
|
+
| **Package Size** | Reports bundle size (warns if > 500KB) |
|
|
286
|
+
|
|
287
|
+
### Automated Releases (`.github/workflows/release.yml`)
|
|
288
|
+
|
|
289
|
+
When code is merged to `main`, semantic-release automatically:
|
|
290
|
+
|
|
291
|
+
1. Analyzes commit messages (conventional commits)
|
|
292
|
+
2. Determines version bump (major/minor/patch)
|
|
293
|
+
3. Updates `package.json` version
|
|
294
|
+
4. Generates `CHANGELOG.md`
|
|
295
|
+
5. Creates GitHub release with notes
|
|
296
|
+
6. Publishes to npm registry
|
|
297
|
+
|
|
298
|
+
### Conventional Commits
|
|
299
|
+
|
|
300
|
+
Use these prefixes for automatic versioning:
|
|
301
|
+
|
|
302
|
+
| Prefix | Version Bump | Example |
|
|
303
|
+
|--------|--------------|---------|
|
|
304
|
+
| `feat:` | Minor | `feat: add dark mode support` |
|
|
305
|
+
| `fix:` | Patch | `fix: resolve memory leak` |
|
|
306
|
+
| `perf:` | Patch | `perf: optimize image loading` |
|
|
307
|
+
| `BREAKING CHANGE:` | Major | `feat!: redesign API` |
|
|
308
|
+
| `docs:`, `chore:`, `ci:` | No release | `docs: update README` |
|
|
309
|
+
|
|
310
|
+
### Required Secrets
|
|
311
|
+
|
|
312
|
+
Configure these in your GitHub repository settings:
|
|
313
|
+
|
|
314
|
+
| Secret | Description | Required For |
|
|
315
|
+
|--------|-------------|--------------|
|
|
316
|
+
| `NPM_TOKEN` | npm authentication token | Publishing to npm |
|
|
317
|
+
| `GITHUB_TOKEN` | Auto-provided by GitHub | Creating releases |
|
|
318
|
+
|
|
319
|
+
To create an npm token:
|
|
320
|
+
1. Go to [npmjs.com](https://npmjs.com) → Access Tokens
|
|
321
|
+
2. Generate a new "Automation" token
|
|
322
|
+
3. Add it as `NPM_TOKEN` in GitHub repo → Settings → Secrets
|
|
323
|
+
|
|
324
|
+
### Branch Protection (Recommended)
|
|
325
|
+
|
|
326
|
+
Configure these settings for the `main` branch:
|
|
327
|
+
|
|
328
|
+
- ✅ Require a pull request before merging
|
|
329
|
+
- ✅ Require status checks to pass before merging
|
|
330
|
+
- Required checks: `lint`, `typecheck`, `test`, `build`, `pr-check-complete`
|
|
331
|
+
- ✅ Require branches to be up to date before merging
|
|
332
|
+
- ✅ Do not allow bypassing the above settings
|
|
333
|
+
|
|
270
334
|
## Development
|
|
271
335
|
|
|
272
336
|
```bash
|
|
@@ -281,6 +345,12 @@ bun test
|
|
|
281
345
|
|
|
282
346
|
# Build
|
|
283
347
|
bun run build
|
|
348
|
+
|
|
349
|
+
# Lint
|
|
350
|
+
bun run lint
|
|
351
|
+
|
|
352
|
+
# Type check
|
|
353
|
+
bun run typecheck
|
|
284
354
|
```
|
|
285
355
|
|
|
286
356
|
## License
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "claude-code-starter",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "A lightweight starter kit for AI-assisted development with Claude Code",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"claude",
|
|
@@ -44,8 +44,14 @@
|
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@biomejs/biome": "^2.3.12",
|
|
47
|
+
"@commitlint/cli": "^19.6.1",
|
|
48
|
+
"@commitlint/config-conventional": "^19.6.0",
|
|
49
|
+
"@semantic-release/changelog": "^6.0.3",
|
|
50
|
+
"@semantic-release/git": "^10.0.1",
|
|
47
51
|
"@types/bun": "latest",
|
|
48
52
|
"@types/prompts": "^2.4.9",
|
|
53
|
+
"conventional-changelog-conventionalcommits": "^8.0.0",
|
|
54
|
+
"semantic-release": "^24.2.0",
|
|
49
55
|
"tsup": "^8.3.5",
|
|
50
56
|
"typescript": "^5.7.2"
|
|
51
57
|
},
|