/tap

🔖 ― Generate projects in a... tap

Primary LanguageTypeScriptOtherNOASSERTION

🔖 tap

Generate projects in a... tap

📋 Usage

First of all, install it:

$ npm i -g tap

Then, you can use it like so:

$ tap
$ tap [command] [...args]

Here are some examples:

$ tap
$ tap help
$ tap help install
$ tap install https://github.com/demiboy/gba # Installs a template
$ tap update # Updates all templates
$ tap update gba # Updates a specific template

🔧 Creating a template

All you need to do is create a .taprc.js file in your project root, then use defineConfig to define your configuration.
All the values returned by the prompt, can be used in Mustache's templates, which should be postfixed with .template

For example:

.taprc.js

/**
 * Do note that, as the question is an array of inquirer questions
 * you can use all of prompts' features and power, eg: validation etc
 */
module.exports = {
	questions: [
		{
			name: 'description',
			message: "What's the description of your project?",
			initial: 'No description provided.',
		},
		{
			name: 'author',
			message: "What's the author of your project?",
			initial: 'No author provided.',
		},
		{
			name: 'repository',
			message: "What's the repository of your project?",
			initial: 'No repository provided.',
		},
	],
};

README.md.template

# 🔖 {{name}}

{{description}}

As internally tap uses Mustache, much like Prompts, you can use all of it's features and power as well!

package.json.template

{
	"name": "{{name}}",
	"description": "{{description}}",
	"author": "{{author}}",
	"repository": "{{repository}}"
}