From c383ae70fa401c1a55bb36701a320767240b4f09 Mon Sep 17 00:00:00 2001 From: Ayo Date: Wed, 25 Oct 2023 22:40:29 +0200 Subject: [PATCH] chore: update commands list for the CLI --- README.md | 5 ++++- package-lock.json | 2 +- packages/cli/README.md | 6 ++++-- packages/cli/commands/build.mjs | 2 +- packages/cli/package.json | 2 +- templates/basic/README.md | 5 +++-- 6 files changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 926394d..749b768 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,10 @@ Then, you can run the following **McFly CLI** commands: | Command | Action | | --- | --- | | `mcfly new` | Creates a new McFly project. | -| `mcfly generate` | Generates building blocks for a McFly app. | +| `mcfly dev` | Runs the developent server. | +| `mcfly build` | Builds the McFly project for production. | +| `mcfly prepare` | Prepares the McFly workspace. | +| `mcfly generate` | Generates building blocks for a McFly app. (In-progress) | diff --git a/package-lock.json b/package-lock.json index 5ad3660..2080a28 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3123,7 +3123,7 @@ }, "packages/cli": { "name": "@mcflyjs/cli", - "version": "0.0.3", + "version": "0.0.4", "license": "MIT", "dependencies": { "citty": "^0.1.4", diff --git a/packages/cli/README.md b/packages/cli/README.md index df4ba42..90cf835 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -16,9 +16,11 @@ You can run the following **McFly CLI** commands: | Command | Action | | --- | --- | -| `mcfly prepare` | Prepares the McFly workspace. | | `mcfly new` | Creates a new McFly project. | -| `mcfly generate` | Generates building blocks for a McFly app. | +| `mcfly dev` | Runs the developent server. | +| `mcfly build` | Builds the McFly project for production. | +| `mcfly prepare` | Prepares the McFly workspace. | +| `mcfly generate` | Generates building blocks for a McFly app. (In-progress) | --- *Just keep building*
diff --git a/packages/cli/commands/build.mjs b/packages/cli/commands/build.mjs index b4aff3e..66bf312 100644 --- a/packages/cli/commands/build.mjs +++ b/packages/cli/commands/build.mjs @@ -8,7 +8,7 @@ import { execSync as exec } from "child_process"; export default defineCommand({ meta: { name: "prepare", - description: "Generates the build files for the McFly app.", + description: "Builds the McFly project for production.", }, args: { ...commonArgs, diff --git a/packages/cli/package.json b/packages/cli/package.json index a3a868a..684af86 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@mcflyjs/cli", - "version": "0.0.3", + "version": "0.0.4", "description": "McFly CLI tools", "main": "index.js", "bin": { diff --git a/templates/basic/README.md b/templates/basic/README.md index ee22334..d1872a5 100644 --- a/templates/basic/README.md +++ b/templates/basic/README.md @@ -55,11 +55,12 @@ The following commands are available to you on this project. Add more, or modify | Command | Action | | --- | --- | -| npm start | Start the dev server | -| npm run prepare | Prepare the app | +| npm start | Start the development server | +| npm run prepare | Prepare the workspace | | npm run build | Locally generate the app's build files to `./output` | | npm run preview | Preview the built app locally | + ## More info This framework is a result of [an exploration](https://social.ayco.io/@ayo/111195315785886977) for using [**Nitro**](https://nitro.unjs.io) and vanilla JS custom elements using a minimal [**Web Component Base**](https://ayco.io/n/web-component-base) class.