Repository navigation
feat(templates): list the DMS Connect Demo project template - #14
Merged
Merged
Conversation
This was referenced Nov 4, 2026
5 tasks done
Upd4ting
added a commit
that referenced
this pull request
Nov 10, 2026
## Summary A registry contributor who reads the README should learn about every template field the CLI reads. #14 set `"install": false` on the DMS Starter and DMS Connect Demo templates, but the optional-field list in "Project template metadata" named only `description`, `packageManager` and `nextSteps`. This adds `install` to that list. The wording is the TSDoc of `Template.install` in the CLI: `false` copies the template and installs nothing on the host, for a template that installs its own dependencies (for example in its container). Absent or `true` installs the dependencies on the host. ## Related issue ANT-1817 (internal task). Follow-up to #14. ## Verification The CLI code that reads the field, at `AntelopeJS/antelopejs@d6cbc9f`: `src/cli/catalog-manifest.ts` lines 24-30 declare and document it: ```ts /** * `false` when the template installs its own dependencies, for example * inside its container. The CLI then copies the template and installs * nothing on the host, so the package manager does not have to be * installed. Absent or `true` installs the dependencies on the host. */ install?: boolean; ``` Lines 200 and 209 validate and pass it through: ```ts this.optionalBoolean(`${at}.install`, template.install); ... install: template.install, ``` `src/cli/commands/module/init-action.ts` lines 226-228 decide host installation from it: ```ts function installsOnHost(template?: Template): boolean { return template?.install !== false; } ``` Repo check: the `Documentation` workflow's action (`AntelopeJS/tooling-configs/actions/docs@310e3d8`) run locally on this branch: ``` $ node actions/docs/check.mjs --files README.md --typescript-project "" Docs: 1 files, 3 local links, 0 compatibility tables, 0 checked examples, 0 API pages; 0 failures. ``` ## Checklist - [x] The pull request title follows Conventional Commits. - [x] I added or updated tests when behavior changed. (No behavior change.) - [x] I updated documentation when users or contributors are affected. - [x] I documented breaking changes and migration steps. (None.) - [x] I did not include credentials or unrelated changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
A newcomer with nothing installed should create a project with one copy-paste
npx @antelopejs/corecommand and a short template slug. Thedms-connect-demotemplate was not available: the registry did not list it. The README also still used a globalajs, display names, and an outdated first-run step.What changed
manifest.jsonlists the DMS Connect Demo project template. It setspackageManagertopnpm, so the template keeps its pinnedpnpm@10.2.0and lockfile. Its next step isdocker compose up, then the onboarding address in thedmslog.npx @antelopejs/core project init my-app --template <slug>fordms-starter,dms-connect-demo,dms-demo,dms-adonis, anddms-module-typescript. It describes the first run as opening the onboarding address that the backend console prints.nextStepsof DMS Starter, DMS Demo and DMS Adonis now point to the onboarding address in the backend log (thedmslog for DMS Starter, thepnpm devlog for the others), soproject initstops telling the user to just open the dashboard."install": false. Both runpnpm install --frozen-lockfileinside the container (docker/start.sh) and shipantelope.config.ts, soproject initcopies the template and skips the host install. This needs the core release with feat(cli): skip the host install for templates that install themselves antelopejs#381. Older cores ignore the field and keep installing on the host.Scope
Blast Radius
The new entry only adds a choice to
project init. The README slug commands work only with the@antelopejs/corerelease that ships template slugs, so merge this after that release. The display name works today:--template "DMS Connect Demo".Verification
npx -y @antelopejs/core project init demo --template "DMS Connect Demo" --yesfound 8 templates, created the project, installed dependencies, and printed the new next step. The lockfile matched the template andpackageManagerstayedpnpm@10.2.0.docker compose upin that project logged[DMS] No owner exists yet. To create it, open http://localhost:3001/onboarding?token=...andLocal: http://localhost:3001/. The dashboard answered 302 on/and 200 on/onboarding.