ayo/mcfly
ayo/mcfly
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update commands list for the CLI

Browse source
This commit is contained in:
Ayo 2023-10-25 22:40:29 +02:00
parent 877a45a44f
commit c383ae70fa
6 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -57,7 +57,10 @@ Then, you can run the following **McFly CLI** commands:
| Command | Action | | Command | Action |
| --- | --- | | --- | --- |
| `mcfly new` | Creates a new McFly project. | | `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) |

2
package-lock.json generated
View file

@ -3123,7 +3123,7 @@
}, },
"packages/cli": { "packages/cli": {
"name": "@mcflyjs/cli", "name": "@mcflyjs/cli",
"version": "0.0.3", "version": "0.0.4",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"citty": "^0.1.4", "citty": "^0.1.4",

6
packages/cli/README.md
View file

@ -16,9 +16,11 @@ You can run the following **McFly CLI** commands:
| Command | Action | | Command | Action |
| --- | --- | | --- | --- |
| `mcfly prepare` | Prepares the McFly workspace. |
| `mcfly new` | Creates a new McFly project. | | `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*<br /> *Just keep building*<br />

2
packages/cli/commands/build.mjs
View file

@ -8,7 +8,7 @@ import { execSync as exec } from "child_process";
export default defineCommand({ export default defineCommand({
meta: { meta: {
name: "prepare", name: "prepare",
description: "Generates the build files for the McFly app.", description: "Builds the McFly project for production.",
}, },
args: { args: {
...commonArgs, ...commonArgs,

2
packages/cli/package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "@mcflyjs/cli", "name": "@mcflyjs/cli",
"version": "0.0.3", "version": "0.0.4",
"description": "McFly CLI tools", "description": "McFly CLI tools",
"main": "index.js", "main": "index.js",
"bin": { "bin": {

5
templates/basic/README.md
View file

@ -55,11 +55,12 @@ The following commands are available to you on this project. Add more, or modify
| Command | Action | | Command | Action |
| --- | --- | | --- | --- |
| npm start | Start the dev server | | npm start | Start the development server |
| npm run prepare | Prepare the app | | npm run prepare | Prepare the workspace |
| npm run build | Locally generate the app's build files to `./output` | | npm run build | Locally generate the app's build files to `./output` |
| npm run preview | Preview the built app locally | | npm run preview | Preview the built app locally |
## More info ## 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. 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.