Skip to content

bed-and-breakfast/template-tools

Repository files navigation

NPM Version CI Release Code Climate Code Coverage Known Vulnerabilities Semantic Release: Conventional Commits Commitizen friendly

Bed & Breakfast Template Tools

Tools to aid in the management of repositories based on @bed-and-breakfast/template-*.

Installation

After creating a new @bed-and-breakfast/template-*, it can be installed with the following command:

npm i -D @bed-and-breakfast/template-tools

Tools

Template tools are available in the form of the following CLI commands

template-init

After a repository has been created from the @bed-and-breakfast/templates-open-source template it needs to be initialized. Run the following command to do this and follow the instructions on the screen.

npx template-init

Note The default behavior is to automatically commit and push the changes to git, this can be prevented.

template-add-remote

Adds a read-only remote to the @bed-and-breakfast/templates-open-source template from which we can pull the latest changes.

npx template-add-remote

template-pull

Bed & Breakfast repository templates will be updated over time. Start by setting up a remote with the template-add-remote command. You can then use the following command to pull these changes into an existing repository:

npx template-pull

Note Be careful resolving conflicts when pulling from a template. Files like package.json, README.md, CHANGELOG.md etc. will have changes you don't want to accept.