platform/templates
Andrey Sobolev f69439eaef
Rework documents (#2347)
Signed-off-by: Andrey Sobolev <haiodo@gmail.com>
2022-11-02 14:50:14 +06:00
..
assets Rework documents (#2347) 2022-11-02 14:50:14 +06:00
default Migrate to hcengineering and publish to github packages (#2273) 2022-09-21 14:08:25 +06:00
model Rework documents (#2347) 2022-11-02 14:50:14 +06:00
platform Rework documents (#2347) 2022-11-02 14:50:14 +06:00
ui Rework documents (#2347) 2022-11-02 14:50:14 +06:00
webpack Migrate to hcengineering and publish to github packages (#2273) 2022-09-21 14:08:25 +06:00
apply.js Enable linting build phase (#966) 2022-02-10 10:04:18 +01:00
readme.md Enable linting build phase (#966) 2022-02-10 10:04:18 +01:00

Project templates

Folder contains a projeect templates and functionality to apply template values to all projects inside rush multi repo.

Any folder with package.json inside templates are template, so it is possible to apply it.

Templates will be matched using peerDependencies entries should be available inside dependencies of project template is matched against.

So ui template with peer dependency to svelte, will be matched to any UI plugin.

If no template is matched for project then default template will be used.

Explicit template selection

If package.json contains "template" field, template from templates with matched name will be selected.

Apply rules

  • If file in template folder is pressent and file in project folder is not, it will be copied.
    • If package.json contain '#replaces' section with filename, file will be overriten in any case.
    • If filename in template starts with ~ then file in project will be removed instead of add.
  • package.json
    • dependencies - will be updated to contain all values from template package.json dependencies with exact same versions.
    • devDependencies - will be updated to contain all values from template package.json dependencies with exact same versions.
    • scripts - will be updated to contain all values from template package.json dependencies with exact same versions.