chant dev onboard
Synopsis
Section titled “Synopsis”chant dev onboard <name> [--verbose]Description
Section titled “Description”chant dev onboard patches the monorepo infrastructure to include a new lexicon in CI, Docker smoke tests, and the npm publish workflow. Run this after scaffolding a lexicon with chant init lexicon <name> and building out its implementation.
The command modifies 6 files:
| File | Change |
|---|---|
package.json (root) | Adds @intentius/chant-lexicon-<name>: "workspace:*" to dependencies |
tsconfig.json (root) | Adds paths entries for @intentius/chant-lexicon-<name> and @intentius/chant-lexicon-<name>/*. The repo-wide typecheck uses moduleResolution: node, which ignores package exports maps, so without these the lexicon’s example fails to resolve |
.github/workflows/chant.yml | Adds prepack lines to check/test jobs + a validate step |
.github/workflows/publish.yml | Adds prepack line to test job (publishing needs no per-lexicon step — scripts/publish-packages.sh enumerates the workspace) |
test/Dockerfile.smoke | Adds <name> to the for lex in ... lexicon list |
test/Dockerfile.smoke-npm | Adds <name> to both for lex in ... lexicon lists |
The command is idempotent. Running it again on an already-onboarded lexicon changes nothing and reports each file as already covered.
Options
Section titled “Options”| Flag | Description |
|---|---|
--verbose | Show detailed output |
Example
Section titled “Example”# Scaffold the lexiconchant init lexicon terraform
# ... implement generate, serializer, rules, etc. ...
# Wire into CIchant dev onboard terraformRemaining manual steps
Section titled “Remaining manual steps”After running dev onboard, you still need to:
- Create an example workspace under
lexicons/<name>/examples/ - Add smoke tests to
test/integration.sh - Run
npm installto update workspace links - Run
just release-lexicon <name> patchfor the first release
See CI & Distribution for details.
See also
Section titled “See also”chant init lexicon— scaffold a new lexiconchant dev generate— run the generation pipelinechant dev publish— build the distributable bundle- CI & Distribution guide