@forinda/kickjs-cli 0.3.0 → 0.3.1
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 +58 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# @forinda/kickjs-cli
|
|
2
|
+
|
|
3
|
+
CLI for KickJS — project scaffolding, DDD module generation, dev/build/start commands.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add -D @forinda/kickjs-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Commands
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
kick new <name> # Scaffold a new KickJS project
|
|
15
|
+
kick dev # Start dev server with Vite HMR
|
|
16
|
+
kick build # Production build via Vite
|
|
17
|
+
kick start # Run production build
|
|
18
|
+
kick info # Print system and framework info
|
|
19
|
+
|
|
20
|
+
kick g module <name> # Generate full DDD module
|
|
21
|
+
kick g controller <name> # Generate controller
|
|
22
|
+
kick g service <name> # Generate service
|
|
23
|
+
kick g middleware <name> # Generate middleware
|
|
24
|
+
kick g guard <name> # Generate auth guard
|
|
25
|
+
kick g adapter <name> # Generate lifecycle adapter
|
|
26
|
+
kick g dto <name> # Generate DTO with Zod schema
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Generator Flags
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
kick g module users --no-entity # Skip entity/value objects
|
|
33
|
+
kick g module users --minimal # Only index.ts + controller
|
|
34
|
+
kick g module users --dry-run # Preview without writing
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Custom Commands
|
|
38
|
+
|
|
39
|
+
Extend the CLI via `kick.config.ts`:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { defineConfig } from '@forinda/kickjs-cli'
|
|
43
|
+
|
|
44
|
+
export default defineConfig({
|
|
45
|
+
commands: [
|
|
46
|
+
{ name: 'db:migrate', description: 'Run migrations', steps: 'npx drizzle-kit migrate' },
|
|
47
|
+
{ name: 'db:seed', description: 'Seed database', steps: 'npx tsx src/db/seed.ts' },
|
|
48
|
+
],
|
|
49
|
+
})
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Documentation
|
|
53
|
+
|
|
54
|
+
[Full documentation](https://github.com/forinda/kick-js)
|
|
55
|
+
|
|
56
|
+
## License
|
|
57
|
+
|
|
58
|
+
MIT
|