@lukoweb/create-apitogo 0.1.95 → 0.1.97
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.
- package/README.md +16 -14
- package/dist/index.js +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,30 +14,32 @@ pnpm create @lukoweb/apitogo
|
|
|
14
14
|
bunx @lukoweb/create-apitogo
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
You will be asked for the project name, TypeScript, and ESLint.
|
|
18
|
-
|
|
17
|
+
You will be asked for the project name, TypeScript, and ESLint. After scaffold it auto-wires a
|
|
18
|
+
nearby `openapi.yaml` (parent/siblings/site) and markdown under `docs/`, `doc/`, `documents/`, or
|
|
19
|
+
`documentation/`. Example files are not prompted; they stay off unless you pass
|
|
20
|
+
`--include-examples`.
|
|
19
21
|
|
|
20
22
|
### Non-interactive
|
|
21
23
|
|
|
22
24
|
```bash
|
|
23
|
-
npx @lukoweb/create-apitogo@latest
|
|
25
|
+
npx @lukoweb/create-apitogo@latest dev-portal --typescript --eslint
|
|
24
26
|
```
|
|
25
27
|
|
|
26
|
-
| Flag
|
|
27
|
-
|
|
|
28
|
-
| `--typescript` / `--ts`
|
|
29
|
-
| `--javascript` / `--js`
|
|
30
|
-
| `--eslint`
|
|
31
|
-
| `--no-eslint`
|
|
32
|
-
| `--include-examples`
|
|
33
|
-
| `--skip-install`
|
|
34
|
-
| `--use-npm` / `--use-pnpm` / `--use-yarn` / `--use-bun` | Force a package manager
|
|
28
|
+
| Flag | Effect |
|
|
29
|
+
| ------------------------------------------------------- | ----------------------------------------------------------- |
|
|
30
|
+
| `--typescript` / `--ts` | TypeScript project (default if you skip prompts in CI) |
|
|
31
|
+
| `--javascript` / `--js` | JavaScript project |
|
|
32
|
+
| `--eslint` | Add ESLint config |
|
|
33
|
+
| `--no-eslint` | Skip ESLint config |
|
|
34
|
+
| `--include-examples` | Add starter docs and a sample OpenAPI spec (off by default) |
|
|
35
|
+
| `--skip-install` | Do not run the package manager after scaffolding |
|
|
36
|
+
| `--use-npm` / `--use-pnpm` / `--use-yarn` / `--use-bun` | Force a package manager |
|
|
35
37
|
|
|
36
38
|
`--with-examples` is an alias for `--include-examples`.
|
|
37
39
|
|
|
38
40
|
```bash
|
|
39
|
-
npx @lukoweb/create-apitogo@latest
|
|
40
|
-
npx @lukoweb/create-apitogo@latest
|
|
41
|
+
npx @lukoweb/create-apitogo@latest dev-portal --javascript --no-eslint
|
|
42
|
+
npx @lukoweb/create-apitogo@latest dev-portal --typescript --eslint --include-examples
|
|
41
43
|
```
|
|
42
44
|
|
|
43
45
|
See `npx @lukoweb/create-apitogo --help` for the full list (`--example`, `--skip-install`, …).
|