arcane-cli 1.12.0 → 1.12.1
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
CHANGED
|
@@ -345,11 +345,12 @@ Arcane is built *with Arcane*. From this repo's first commit forward, developmen
|
|
|
345
345
|
PRs welcome. See **[CONTRIBUTING.md](./CONTRIBUTING.md)** for dev setup and conventions, and **[SECURITY.md](./SECURITY.md)** to report a vulnerability. By contributing you agree your contributions are licensed under MIT.
|
|
346
346
|
|
|
347
347
|
```bash
|
|
348
|
-
npm ci
|
|
349
|
-
npm test
|
|
350
|
-
npm run build
|
|
351
|
-
npm run lint
|
|
352
|
-
npm run typecheck
|
|
348
|
+
npm ci # install dependencies
|
|
349
|
+
npm test # run the test suite
|
|
350
|
+
npm run build # produces dist/index.js + dist/assets/
|
|
351
|
+
npm run lint # lint
|
|
352
|
+
npm run typecheck # type-check src/
|
|
353
|
+
npm run typecheck:all # type-check src/, scripts/, test/ and the root configs
|
|
353
354
|
```
|
|
354
355
|
|
|
355
356
|
**Claude Code preview config:** [.claude/launch.json](./.claude/launch.json) registers dev-server launch configs (`arcane-website`, `arcane-ui`) for Claude Code's in-editor preview tooling. It assumes both repos are cloned as sibling directories next to this one (`../arcane-website`, `../arcane-ui`).
|
|
@@ -15,7 +15,7 @@ How to structure commits, branches, and pull requests for this repository.
|
|
|
15
15
|
|
|
16
16
|
- This repo uses Conventional Commits format for all commit messages — industry standard, tool-portable, human-readable.
|
|
17
17
|
- Trunk-based development with short-lived feature branches keeps history clean and reduces merge conflicts.
|
|
18
|
-
- No custom git hooks — conventions work on any machine without setup, no fragile tooling dependencies. **Enforcement: explicitly advisory prose (ARC-023) — inaccurate as currently written: this repository's own `.husky/pre-commit` (
|
|
18
|
+
- No custom git hooks — conventions work on any machine without setup, no fragile tooling dependencies. **Enforcement: explicitly advisory prose (ARC-023) — inaccurate as currently written: this repository's own `.husky/pre-commit` (the staged org-token scan, `lint`, `typecheck`, `typecheck:all` and `doctor:leaks`) and `.husky/pre-push` (`npm test`, plus a PR-state check) are custom git hooks that exist today. Neither validates commit message format or branch naming, so the Conventional Commits and branch-naming conventions this document describes remain hook-independent — but the bullet's literal claim of no custom git hooks in this repository does not hold.**
|
|
19
19
|
- Use `spell-commit-work` prompt during sessions to automate commit message generation in the correct format.
|
|
20
20
|
|
|
21
21
|
---
|
|
@@ -817,7 +817,7 @@ If committing manually, use this mental checklist:
|
|
|
817
817
|
|
|
818
818
|
### Validating Format
|
|
819
819
|
|
|
820
|
-
Quick regex to check format (optional — not enforced by hooks): **Enforcement: explicitly advisory prose (ARC-023) — confirmed: no `commitlint` (or equivalent) dependency exists in `package.json`, and no `.husky/commit-msg` hook exists; `.husky/pre-commit` runs
|
|
820
|
+
Quick regex to check format (optional — not enforced by hooks): **Enforcement: explicitly advisory prose (ARC-023) — confirmed: no `commitlint` (or equivalent) dependency exists in `package.json`, and no `.husky/commit-msg` hook exists; `.husky/pre-commit` runs the staged org-token scan, `lint`, `typecheck`, `typecheck:all` and `doctor:leaks`, and `.husky/pre-push` runs only `npm test` plus a PR-state check — neither validates commit message format.**
|
|
821
821
|
|
|
822
822
|
```bash
|
|
823
823
|
# Valid: type(scope): description
|
|
@@ -101,7 +101,7 @@ Every PR must include:
|
|
|
101
101
|
|
|
102
102
|
### Unit Tests (Required)
|
|
103
103
|
|
|
104
|
-
**Enforcement: executable check (ARC-023) — ci.yml's build-test job's Test step runs `npm test` (`vitest run`), which fails the job on any failing unit test; `.husky/pre-commit` runs
|
|
104
|
+
**Enforcement: executable check (ARC-023) — ci.yml's build-test job's Test step runs `npm test` (`vitest run`), which fails the job on any failing unit test; `.husky/pre-commit` runs the staged org-token scan, `lint`, `typecheck`, `typecheck:all` and `doctor:leaks`, not tests, so the "every commit" portion of this rule is not locally enforced.**
|
|
105
105
|
|
|
106
106
|
- Test individual functions/methods in isolation
|
|
107
107
|
- Mock external dependencies (DB, API, hardware)
|