Create, store, and use scaffolding templates from a single, easy to use CLI.
Code Forge is designed to allow you to easily create new scaffolded projects using your own templates. This project was conceived after the n-th time I installed an express app using their cli only to convert all the es5 code to es6.
It is also extremely useful for companies which have specific scaffolds for new projects, and it automates several minor project setup tasks.
``sh`
npm i -g code-forge
while maintaining the rest of the original project.json file.
4. Installs dependencies from the template, listed in the project.json file.Usage
`sh
forge (options)
`#### Commands
build
help
info
init
load-remote
ls
rm
set
$3
_Alias for init_$3
List the summary version of available commands:sh
forge help
`List specific help for a given command:
sh
forge help
`$3
List template details. For local templates this includes file count and total size for both the project files only and the entire project including the project's node_modules folder. _.gitignore affects the results_Templates from git repos do not include size information as none is available.
sh
forge info
`$3
Init retrieves the code within the template specified and installs it into the target directory if one is provided, or the current directory if none is provided. _For safety it will only do so if the target directory is empty._sh
forge init (target directory)Target the current directory
forge init company-express-template
-or-
forge init company-express-template .Target a sub-directory that may or may not already exist
forge init company-express-template super-project
`
$3
This command allows you to load an existing set of templates into your template database. This is useful for teams which desire to maintain a common list of templates.In the case of a template name conflict the command will prompt the user to pick the template source they wish to keep. It will ignore templates which are exact matches, and add any new templates to the local template database.
sh
forge load-remote
`$3
Lists the templates which have been installed to the local machine.sh
forge ls
`$3
Remove an existing template from the template database. _This will not remove local files or remote repos, just remove forge's reference to them._sh
forge rm
`$3
Set associates a path or git repo with a template name. Therefore if you set a template name of to a directoy of /code/scaffold-code, the user could subsequently install all the code within /code/scaffold-code with the init command.`sh
forge set forge set awesome-scaffold /code/scaffold-code
Now you can install the scaffold with
cd working-code/projects
forge init awesome-scaffold new-projectAll the code will be installed
the project.json will be configured
and npm init will be run
`Possible Features
* Add size information to template database so that it can be displayed with and info` even for repo templates (this would populate after the first time they were installed in the case of repos)