@sektek/generator-base
v0.20.0
Published
Base Yeoman generator for scaffolding new SEKTEK projects (editorconfig, gitconfig, readme, devcontainer, workspace)
Readme
@sektek/generator-base
Base Yeoman generator for scaffolding new SEKTEK projects, driven by
@sektek/gen (or, in principle, still installable as a yo
generator).
BaseGenerator extends @sektek/generator's CoreGenerator and sets package = '@sektek/base'.
Sub-generators:
app— the entrypoint, composeseditorconfig,git,gitconfig,github,license, andreadmein sequence.editorconfig,gitconfig,readme— copy EJS templates for the corresponding project files.git— initializes a local git repository and creates an initial commit once every other composed generator has written its files. Default-on (gitInit: true); opt out via--no-git-init. Only ever auto-commits when it performed thegit inititself against an empty destination.github— creates a GitHub repository and pushes the scaffolded project to it; composesgititself, so it's self-sufficient run standalone. Opt-in (createRepo: falseby default) via--create-repo.license— writes aLICENSEfile namingauthoras the copyright holder whenlicenseis'MIT'; writes nothing for any other value (including the default,'UNLICENSED').devcontainer— writes.devcontainer/Dockerfileplus either a standalone or docker-compose-baseddevcontainer.json, depending on adefault/workspaceprofile option.workspace— composesdevcontainer,editorconfig,gitconfig, andreadmetogether and adds.vscode/settings.json/launch.json; the root-level variant ofappfor a workspace-style project rather than a single package.
Installation
npm install @sektek/generator-base