create-vf-app

create-vf-app

create-vf-app is a command-line tool to scaffold Vectorform starter repositories.

Overview

This command-line tool helps you initialize new projects using Vectorform starter repositories. It offers the flexibility to pick any repository as a template, create a new repository with clean git history, and optionally add a .prettierrc file from a remote source.

Features

• Clones the chosen template repository.
• Removes the existing git history and initializes a new one.
• Prompts for adding a .prettierrc file from a remote source.
• Handles existing .prettierrc or .prettierrc.json files in the project.

Installation

To install this package globally, run:

npm install -g create-vf-app

Usage

To use this command-line tool, run:

create-vf-app <template> <name>

Where:

• <template> is the repository you want to use as a template.
• <name> is the name of your new repository.

For example:

create-vf-app https://github.com/vectorform/starter my-new-project

Adding a .prettierrc File

During the project initialization process, you will be prompted whether you want to add a .prettierrc file from a remote source. If you select yes, the tool will automatically fetch and add the .prettierrc file to your project. If a .prettierrc or .prettierrc.json file already exists in the project, you will be prompted whether to override it.

Dependencies

• Commander: For creating command-line interfaces.
• Inquirer: For creating interactive command-line prompts.
• Prettier: For code formatting.
• ShellJS: For executing shell commands.

License

This project is licensed under the ISC license.