create-banana 2.4.1 → 2.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +27 -61
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-banana",
3
- "version": "2.4.1",
3
+ "version": "2.4.2",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/TMname1/create-banana.git"
package/readme.md CHANGED
@@ -6,7 +6,33 @@ To create a new project, run:
6
6
  pnpm create banana
7
7
  ```
8
8
 
9
- Follow the interactive prompts to key in your project name and select features
9
+ ## CLI usage
10
+
11
+ ```bash
12
+ Usage: index [options] <projectName>
13
+
14
+ Create a new project with features you select.
15
+
16
+ Arguments:
17
+ projectName Name of the project to create
18
+
19
+ Options:
20
+ --p3a, --usePinia pinia state management (default: false)
21
+ -v, --useVueRouter vue-router for routing (default: false)
22
+ --t9s, --useTailwindcss tailwindcss for styling (default: false)
23
+ --p23e, --usePiniaPluginPersistedstate pinia plugin persistedstate (default: false)
24
+ --h7e, --useHTML5Mode HTML5 mode for routing (default: false)
25
+ --h6e, --useHashMode hash mode for routing (default: false)
26
+ --t8t, --useTypescript typescript support (default: false)
27
+ -e, --useEslint eslint support (default: false)
28
+ --p6r, --usePrettier prettier support (default: false)
29
+ --h3y, --useHusky husky support (default: false)
30
+ -l, --useLintStaged lint-staged support (default: false)
31
+ -c, --useCommitizen commitizen support (default: false)
32
+ --p23s, --usePrettierPluginTailwindcss prettier plugin tailwindcss support (default: false)
33
+ -h, --help display help for command
34
+ ```
35
+
10
36
 
11
37
  # Currently implemented functions
12
38
 
@@ -26,63 +52,3 @@ Follow the interactive prompts to key in your project name and select features
26
52
  - [husky](https://typicode.github.io/husky/)
27
53
  - [lint-staged](https://github.com/lint-staged/lint-staged)
28
54
  - [commitizen](https://github.com/commitizen/cz-cli)
29
-
30
- # Project structure
31
-
32
- ```text
33
- create-tm
34
- ├─ script
35
- │ └─ build.js
36
- ├─ src
37
- │ ├─ app
38
- │ │ ├─ CLI
39
- │ │ │ ├─ depSelect.ts
40
- │ │ │ ├─ devDepSelect.ts
41
- │ │ │ ├─ input.ts
42
- │ │ │ ├─ main.ts
43
- │ │ │ └─ output.ts
44
- │ │ ├─ core
45
- │ │ │ ├─ depManger.ts
46
- │ │ │ ├─ devDepManger.ts
47
- │ │ │ ├─ execute.ts
48
- │ │ │ ├─ featsManger.ts
49
- │ │ │ └─ generator.ts
50
- │ │ └─ features
51
- │ │ ├─ dep
52
- │ │ │ ├─ base.ts
53
- │ │ │ ├─ pinia.ts
54
- │ │ │ ├─ tailwindcss.ts
55
- │ │ │ └─ vueRouter.ts
56
- │ │ └─ devDep
57
- │ │ ├─ commitizen.ts
58
- │ │ ├─ eslint.ts
59
- │ │ ├─ husky.ts
60
- │ │ ├─ lintStaged.ts
61
- │ │ └─ prettier.ts
62
- │ ├─ bin
63
- │ │ └─ index.ts
64
- │ └─ utils
65
- │ ├─ figletPrint.ts
66
- │ ├─ pathExists.ts
67
- │ ├─ prompt.ts
68
- │ ├─ rainbow.ts
69
- │ └─ URL.ts
70
- ├─ template
71
- │ ├─ dep
72
- │ │ ├─ base
73
- │ │ ├─ pinia
74
- │ │ ├─ tailwindcss
75
- │ │ └─ vue-router
76
- │ └─ devDep
77
- │ ├─ commitizen
78
- │ ├─ eslint
79
- │ ├─ husky
80
- │ ├─ lintStaged
81
- │ └─ prettier
82
- ├─ eslint.config.js
83
- ├─ LICENSE
84
- ├─ package.json
85
- ├─ pnpm-lock.yaml
86
- ├─ readme.md
87
- └─ tsconfig.json
88
- ```