Skip to content

Commit 209874d

Browse files
authored
ci: add pnpm-lock.yaml and fix formatting (#5)
1 parent e571a31 commit 209874d

3 files changed

Lines changed: 1446 additions & 22 deletions

File tree

CLAUDE.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
66

77
`scaffold` is a **GitHub template repository**, not an application. It ships the meta layer (lint, format, commit hooks, CI, CodeQL, Dependabot, release-please, issue/PR templates, standard meta docs) that every new kirchDev repo should start with. There is no application code — the project code can be anything (PHP, Go, Rust, Vue, shell). Only the meta layer lives here.
88

9-
Implication: when changing files, ask "does this default make sense for *every* future repo created from this template?" — not just for one project type.
9+
Implication: when changing files, ask "does this default make sense for _every_ future repo created from this template?" — not just for one project type.
1010

1111
## Commands
1212

13-
| Command | What it does |
14-
| :----------------- | :-------------------------------------------------------- |
15-
| `pnpm install` | Install deps and wire husky hooks via the `prepare` script |
16-
| `pnpm lint` | `oxlint . --deny-warnings` |
17-
| `pnpm format` | `oxfmt --check .` (note: `format` is the check, not fix) |
18-
| `pnpm check` | Runs `lint` + `format` — the CI gate |
19-
| `pnpm lint:fix` | Auto-fix lint |
20-
| `pnpm format:fix` | Auto-fix format |
21-
| `pnpm check:fix` | Auto-fix lint + format |
22-
| `pnpm taze` | Interactive dependency upgrade check |
23-
| `pnpm taze:w` | Write upgrade results |
13+
| Command | What it does |
14+
| :---------------- | :--------------------------------------------------------- |
15+
| `pnpm install` | Install deps and wire husky hooks via the `prepare` script |
16+
| `pnpm lint` | `oxlint . --deny-warnings` |
17+
| `pnpm format` | `oxfmt --check .` (note: `format` is the check, not fix) |
18+
| `pnpm check` | Runs `lint` + `format` — the CI gate |
19+
| `pnpm lint:fix` | Auto-fix lint |
20+
| `pnpm format:fix` | Auto-fix format |
21+
| `pnpm check:fix` | Auto-fix lint + format |
22+
| `pnpm taze` | Interactive dependency upgrade check |
23+
| `pnpm taze:w` | Write upgrade results |
2424

2525
There is no test suite — this is config-only. CI runs `pnpm lint` and `pnpm format` on PR.
2626

@@ -30,7 +30,7 @@ There is no test suite — this is config-only. CI runs `pnpm lint` and `pnpm fo
3030
- **oxc, not eslint/prettier.** Linting via `oxlint`, formatting via `oxfmt`. Configs live in `.oxlintrc.json` / `.oxfmtrc.json`. `oxlint` uses `unicorn` + `oxc` plugins; rules deliberately minimal.
3131
- **Husky hooks** (`.husky/pre-commit`, `.husky/commit-msg`) run `lint-staged` and `commitlint`. `lint-staged.config.js` excludes `README.md` (free-form prose) and `pnpm-lock.yaml`. `oxlint --fix --deny-warnings` then `oxfmt` on JS; `oxfmt` only on JSON/YAML/MD.
3232
- **Conventional Commits enforced** via `@commitlint/config-conventional`. Don't `--no-verify` unless explicitly asked.
33-
- **release-please is included** (unlike many templates that omit it). Files: `release-please-config.json`, `.release-please-manifest.json`, `.github/workflows/release-please.yml`. Config uses `release-type: simple` (language-agnostic), `include-v-in-tag: true`. Downstream repos start at `0.0.0` and reset via the steps in README → *Resetting release-please*.
33+
- **release-please is included** (unlike many templates that omit it). Files: `release-please-config.json`, `.release-please-manifest.json`, `.github/workflows/release-please.yml`. Config uses `release-type: simple` (language-agnostic), `include-v-in-tag: true`. Downstream repos start at `0.0.0` and reset via the steps in README → _Resetting release-please_.
3434
- **Workflows** use `actions/checkout@v6`, `actions/setup-node@v6`, `pnpm/action-setup@v6`, `github/codeql-action/{init,analyze}@v4`. Keep these pinned to major versions; Dependabot bumps them monthly.
3535
- **CodeQL** scans `actions` + `javascript-typescript` with `security-extended,security-and-quality` queries, gated by path filters so non-code changes don't trigger it.
3636
- **Dependabot** groups all minor/patch updates per ecosystem into a single PR (`npm-minor-patch`, `actions-minor-patch`). Majors come as separate PRs.

package.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44
"version": "0.0.0",
55
"description": "Language-agnostic baseline template for new kirchDev repositories.",
66
"keywords": [
7-
"template",
7+
"commitlint",
8+
"conventional-commits",
9+
"dependabot",
810
"github-template",
9-
"scaffold",
11+
"husky",
1012
"kirchdev",
11-
"pnpm",
12-
"oxlint",
13+
"nodejs",
1314
"oxfmt",
14-
"husky",
15-
"commitlint",
16-
"conventional-commits",
15+
"oxlint",
16+
"pnpm",
1717
"release-please",
18-
"dependabot",
19-
"nodejs"
18+
"scaffold",
19+
"template"
2020
],
2121
"homepage": "https://github.com/TitusKirch/scaffold#readme",
2222
"bugs": {

0 commit comments

Comments
 (0)