Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.37 KB

README.md

File metadata and controls

50 lines (35 loc) · 1.37 KB
Raw

create-eruption 🌋

The official template to create a Eruption project.

Usage

To initialize a new project, run the following command (with you prefered package manager)):

npm init eruption@latest
yarn create eruption@latest
pnpm create eruption@latest

Contributing to this CLI

The CLI uses Clack to generate the prompt. The main file is located in lib/eruption-cli.mjs. To run the CLI locally, run the following command on the root of the repository:

To test the CLI, you first need to run in dev mode:

pnpm run dev

This command will run the CLI in watch mode, so you can make changes and see them reflected in the CLI, while using in watch mode, you can test using:

node ./lib/eruption-cli.mjs

What is in this repository?

  • PNPM as workspace manager and package manager.
  • TSUP as a TypeScript universal package.
  • Vitest as a test runner.
  • Size Limit as a size limit plugin.
  • Prettier as a code formatter.
  • ESLint as a code linter.

Folder structure

  • docs - An empty folder to store documentation.
  • lib - The CLI source.

License

MIT @ EruptionJS and its contributors.