[Upd4ting]

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:

  /**
   * `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:

    this.optionalBoolean(`${at}.install`, template.install);
    ...
      install: template.install,

src/cli/commands/module/init-action.ts lines 226-228 decide host installation from it:

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

• The pull request title follows Conventional Commits.
• I added or updated tests when behavior changed. (No behavior change.)
• I updated documentation when users or contributors are affected.
• I documented breaking changes and migration steps. (None.)
• I did not include credentials or unrelated changes.