exitus-cli
v0.1.2
Published
A CLI tool for generating Angular components following the Exitus Component Pattern with SCSS variables and best practices.
Maintainers
Readme
exitus-cli
Exitus CLI is a command-line interface tool designed to streamline the creation of Angular components. It follows a structured approach to generate reusable, consistent components with predefined templates and best practices.
Table of Contents
Installation
To install Exitus CLI globally, run the following command:
npm install -g exitus-cliUsage
Once installed, you can use the CLI to generate new components. The basic syntax is:
exitus-cli new <component-name> [options]Commands
new
The new command is used to create a new Angular component. It accepts various options to customize the generation process.
Options
-o, --out <path>: Specify the output directory for the generated component.--page: Generate a component as a page.--standalone: Create a standalone component (default: true).--skip-test: Skip the generation of the test file.--with-service: Generate a companion service for the component.--dry-run: Preview the generated files without creating them.
Templates
Exitus CLI uses templates for generating component files. The following templates are available:
- TypeScript Component:
src/templates/component.ts.template - HTML Template:
src/templates/component.html.template - SCSS Styles:
src/templates/component.scss.template - Unit Test:
src/templates/component.spec.ts.template
Contributing
Contributions are welcome! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your branch and create a pull request.
License
This project is licensed under the MIT License. See the LICENSE file for details.
