UNPKG

modkit

Version:

CLI tool to generate boilerplate module files structure

134 lines (90 loc) â€ĸ 2.56 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# 🧩 modkit **modkit** is a lightweight CLI tool that helps developers quickly scaffold consistent and boilerplate-ready module structures for TypeScript-based Node.js applications. Whether you're working on a monorepo or organizing your backend using clean architecture, `modkit` helps you save time by auto-generating files like `controller`, `service`, `model`, `route`, and more — all in one command. --- ## 🚀 Features - ⚡ Super-fast module scaffolding - 🧱 Consistent naming convention (`feature.type.ts`) - 🔁 Supports deeply nested paths (e.g. `src/modules/auth/user`) - ✅ Zero configuration required - 🆓 Open-source & free forever --- ## đŸ“Ļ Installation ### Using **npm**: ```bash npm install -g modkit ``` ### Or using **Yarn**: ```bash yarn global add modkit ``` > ℹī¸ If using Yarn, ensure `yarn global bin` is added to your PATH. You can check with: > > ```bash > yarn global bin > ``` --- ## ⚙ī¸ Usage ```bash modkit <target-path> ``` ### Example: ```bash modkit src/modules/user ``` ### Output: ``` src/modules/user/ ├── user.controller.ts ├── user.interface.ts ├── user.model.ts ├── user.route.ts ├── user.service.ts └── user.validation.ts ``` Each file includes a basic default comment: ```ts // user.service.ts ``` --- ## 📁 Generated File Types | File | Purpose | | ----------------- | --------------------------------- | | `*.controller.ts` | Route handler or controller logic | | `*.interface.ts` | Interfaces & TypeScript types | | `*.model.ts` | DB models or schema definition | | `*.route.ts` | Express or route config | | `*.service.ts` | Core business logic | | `*.validation.ts` | Input validation logic | --- ## 🛠 Development Setup To work on `modkit` locally: ```bash git clone https://github.com/webashraf/modkit cd modkit yarn install # or: npm install ``` ### Run CLI in dev: ```bash yarn start src/modules/example ``` ### Build: ```bash yarn build ``` ### Link CLI for local testing: ```bash yarn link modkit src/modules/test ``` --- ## 🤝 Contributing We welcome contributions and suggestions! - 🐛 Report issues - 🌟 Star the repository - ✨ Submit pull requests --- ## 📄 License This project is licensed under the **ISC License**. --- > Made with ❤ī¸ by Ali Ashraf