Skip to content

Commit e544232

Browse files
committed
chore: project improvements
Signed-off-by: Raí Siqueira <rai93siqueira@gmail.com>
1 parent e805108 commit e544232

File tree

4 files changed

+30
-13
lines changed

4 files changed

+30
-13
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ jobs:
2828
- name: Lint
2929
run: npm run lint
3030

31-
- name: Test
32-
run: npm run test
33-
3431
- name: Build
3532
run: npm run build
33+
34+
- name: Test
35+
run: npm run test

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,33 @@
11
# create-eruption 🌋
22

3-
> The official template to create a new Eruption project.
3+
> The official template to create a Eruption project.
44
55
## Usage
66

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

99
```bash
1010
npm init eruption@latest
1111
```
1212

13+
```bash
14+
yarn create eruption@latest
15+
```
16+
17+
```bash
18+
pnpm create eruption@latest
19+
```
20+
1321
### Contributing to this CLI
1422

23+
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:
24+
25+
```bash
26+
pnpm run dev
27+
```
28+
29+
This command will run the CLI in watch mode, so you can make changes and see them reflected in the CLI.
30+
1531
### What is in this repository?
1632

1733
- [PNPM](https://pnpm.io/workspaces) as workspace manager and package manager.
@@ -20,13 +36,12 @@ npm init eruption@latest
2036
- [Size Limit](https://github.com/ai/size-limit) as a size limit plugin.
2137
- [Prettier](https://prettier.io/) as a code formatter.
2238
- [ESLint](https://eslint.org/) as a code linter.
23-
- [Turbo](https://turbo.build) as cacheable build tool.
2439

2540
### Folder structure
2641

27-
- docs - An empty folder to store documentation.
28-
- lib - The CLI source.
42+
- [docs](./docs/) - An empty folder to store documentation.
43+
- [lib](./lib/) - The CLI source.
2944

3045
## License
3146

32-
MIT @ Raí Siqueira
47+
MIT @ EruptionJS and its contributors.

lib/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@
44
55
## Usage
66

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

99
```bash
1010
npm init eruption@latest
1111
```
1212

13-
Or, if you prefer to use `yarn`:
14-
1513
```bash
1614
yarn create eruption@latest
1715
```
1816

17+
```bash
18+
pnpm create eruption@latest
19+
```
20+
1921
The CLI will ask you a few questions (_in interactive_ mode) and then create a new project for you, but you can also pass a few flags to skip the interactive mode.
2022

2123
## Available Kits

lib/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-eruption",
3-
"version": "0.1.1",
3+
"version": "0.1.2",
44
"description": "The Eruption CLI 🌋",
55
"license": "MIT",
66
"author": "Raí Siqueira <me@raisiqueira.io>",

0 commit comments

Comments
 (0)