https://github.com/eruptionjs/create-eruption
The Eruption CLI 🌋
https://github.com/eruptionjs/create-eruption
Last synced: about 1 year ago
JSON representation
The Eruption CLI 🌋
- Host: GitHub
- URL: https://github.com/eruptionjs/create-eruption
- Owner: eruptionjs
- License: mit
- Created: 2023-02-14T23:35:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T23:53:31.000Z (about 2 years ago)
- Last Synced: 2024-10-31T18:33:54.701Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/create-eruption
- Size: 194 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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)):
```bash
npm init eruption@latest
```
```bash
yarn create eruption@latest
```
```bash
pnpm create eruption@latest
```
### Contributing to this CLI
The CLI uses [Clack](https://github.com/natemoo-re/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:
```bash
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:
```bash
node ./lib/eruption-cli.mjs
```
### What is in this repository?
- [PNPM](https://pnpm.io/workspaces) as workspace manager and package manager.
- [TSUP](https://tsup.egoist.dev/) as a TypeScript universal package.
- [Vitest](https://vitest.dev/) as a test runner.
- [Size Limit](https://github.com/ai/size-limit) as a size limit plugin.
- [Prettier](https://prettier.io/) as a code formatter.
- [ESLint](https://eslint.org/) as a code linter.
### Folder structure
- [docs](./docs/) - An empty folder to store documentation.
- [lib](./lib/) - The CLI source.
## License
MIT @ EruptionJS and its contributors.