@meghjs/cli 0.0.0-stage → 0.5.0

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 (74) hide show
  1. package/LICENSE +21 -0
  2. package/dist/bin.d.ts +2 -0
  3. package/dist/bin.js +10 -0
  4. package/dist/commands/build.d.ts +11 -0
  5. package/dist/commands/build.js +65 -0
  6. package/dist/commands/doctor.d.ts +10 -0
  7. package/dist/commands/doctor.js +96 -0
  8. package/dist/commands/migrate.d.ts +32 -0
  9. package/dist/commands/migrate.js +177 -0
  10. package/dist/commands/new.d.ts +19 -0
  11. package/dist/commands/new.js +306 -0
  12. package/dist/commands/route-list.d.ts +19 -0
  13. package/dist/commands/route-list.js +160 -0
  14. package/dist/commands/serve.d.ts +17 -0
  15. package/dist/commands/serve.js +238 -0
  16. package/dist/commands/start.d.ts +10 -0
  17. package/dist/commands/start.js +43 -0
  18. package/dist/compiler.d.ts +24 -0
  19. package/dist/compiler.js +83 -0
  20. package/dist/errors.d.ts +8 -0
  21. package/dist/errors.js +16 -0
  22. package/dist/generators/make.d.ts +40 -0
  23. package/dist/generators/make.js +198 -0
  24. package/dist/index.d.ts +17 -0
  25. package/dist/index.js +42 -0
  26. package/dist/program.d.ts +22 -0
  27. package/dist/program.js +211 -0
  28. package/dist/utils/entry.d.ts +15 -0
  29. package/dist/utils/entry.js +55 -0
  30. package/dist/utils/env-types.d.ts +8 -0
  31. package/dist/utils/env-types.js +19 -0
  32. package/dist/utils/log.d.ts +25 -0
  33. package/dist/utils/log.js +39 -0
  34. package/dist/utils/names.d.ts +27 -0
  35. package/dist/utils/names.js +58 -0
  36. package/dist/utils/process.d.ts +18 -0
  37. package/dist/utils/process.js +84 -0
  38. package/dist/utils/project.d.ts +17 -0
  39. package/dist/utils/project.js +91 -0
  40. package/dist/utils/stubs.d.ts +15 -0
  41. package/dist/utils/stubs.js +52 -0
  42. package/dist/utils/tsconfig.d.ts +13 -0
  43. package/dist/utils/tsconfig.js +102 -0
  44. package/package.json +61 -4
  45. package/readme.md +155 -0
  46. package/stubs/config/config.stub +9 -0
  47. package/stubs/controllers/basic-controller.stub +9 -0
  48. package/stubs/controllers/resource-controller.stub +45 -0
  49. package/stubs/controllers/rest-controller.stub +29 -0
  50. package/stubs/dtos/dto.stub +11 -0
  51. package/stubs/middlewares/middleware.stub +9 -0
  52. package/stubs/migrations/alter-table.stub +9 -0
  53. package/stubs/migrations/create-table.stub +15 -0
  54. package/stubs/migrations/migration.stub +9 -0
  55. package/stubs/models/basic-model.stub +4 -0
  56. package/stubs/models/entity-model.stub +16 -0
  57. package/stubs/project/app-minimal.stub +7 -0
  58. package/stubs/project/app.stub +8 -0
  59. package/stubs/project/env.stub +3 -0
  60. package/stubs/project/gitignore.stub +5 -0
  61. package/stubs/project/home.controller.spec.stub +19 -0
  62. package/stubs/project/home.controller.stub +12 -0
  63. package/stubs/project/home.service.stub +8 -0
  64. package/stubs/project/openapi.config.stub +15 -0
  65. package/stubs/project/readme.stub +26 -0
  66. package/stubs/project/serve.stub +10 -0
  67. package/stubs/project/tsconfig.build.stub +4 -0
  68. package/stubs/project/tsconfig.stub +18 -0
  69. package/stubs/project/vitest-e2e.config.stub +10 -0
  70. package/stubs/project/vitest.config.stub +17 -0
  71. package/stubs/services/basic-service.stub +8 -0
  72. package/stubs/services/orm-rest-service.stub +61 -0
  73. package/stubs/services/rest-service.stub +34 -0
  74. package/README.md +0 -3
@@ -0,0 +1,238 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.serve = serve;
7
+ const child_process_1 = require("child_process");
8
+ const fs_1 = __importDefault(require("fs"));
9
+ const path_1 = __importDefault(require("path"));
10
+ const compiler_1 = require("../compiler");
11
+ const errors_1 = require("../errors");
12
+ const entry_1 = require("../utils/entry");
13
+ const log_1 = require("../utils/log");
14
+ const process_1 = require("../utils/process");
15
+ const project_1 = require("../utils/project");
16
+ const logServe = (0, log_1.tagged)("SERVE", log_1.c.cyan);
17
+ const logApp = (0, log_1.tagged)("MEGH", log_1.c.green);
18
+ const logWatch = (0, log_1.tagged)("WATCH", log_1.c.yellow);
19
+ const logErr = (category) => (0, log_1.tagged)(category, log_1.c.red);
20
+ /**
21
+ * Development server: transpiles `src/` with SWC into the output dir, copies
22
+ * assets, runs the entry file, and restarts it on changes to sources, assets
23
+ * or `.env*` files. Type errors are reported by a parallel `tsc --watch` and
24
+ * never block a reload; syntax errors do, and stop the running app so stale
25
+ * JS never keeps serving.
26
+ */
27
+ async function serve(opts = {}) {
28
+ const root = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
29
+ const layout = (0, entry_1.projectLayout)(root);
30
+ const pkg = (0, project_1.readPackageJson)(root);
31
+ if (!fs_1.default.existsSync(layout.srcDir))
32
+ throw new errors_1.CliError(`Source directory ${layout.srcDir} does not exist.`);
33
+ const compiler = new compiler_1.SwcCompiler(layout.srcDir, layout.outDir, layout.compilerOptions);
34
+ const candidates = (0, entry_1.entryCandidates)(layout, pkg, opts.entry);
35
+ const debounceMs = opts.debounce ?? 200;
36
+ const failures = new Map();
37
+ let app = null;
38
+ let stopping = false;
39
+ let typeChecker = null;
40
+ const watchers = [];
41
+ console.log(log_1.c.bold(log_1.c.cyan("Megh development server")));
42
+ logServe(`Project: ${root}`);
43
+ // ── Initial build ───────────────────────────────────────────────────────
44
+ const started = Date.now();
45
+ for (const [file, error] of compiler.compileAll())
46
+ failures.set(file, error);
47
+ (0, project_1.copyAssets)(layout.srcDir, layout.outDir);
48
+ logServe(`Compiled in ${Date.now() - started}ms`);
49
+ // ── App process ─────────────────────────────────────────────────────────
50
+ async function stopApp() {
51
+ if (!app)
52
+ return;
53
+ const child = app;
54
+ app = null;
55
+ stopping = true;
56
+ await (0, process_1.killTree)(child);
57
+ stopping = false;
58
+ }
59
+ function startApp() {
60
+ const entry = (0, entry_1.resolveEntry)(candidates, opts.entry);
61
+ if (!entry) {
62
+ logErr("MEGH")(`No entry file found. Tried:\n ${candidates.map((p) => path_1.default.relative(root, p)).join("\n ")}\n` +
63
+ `Set "megh": { "entry": "dist/serve.js" } or "main" in package.json, or pass --entry.`);
64
+ return;
65
+ }
66
+ logApp(`Starting ${path_1.default.relative(root, entry)}`);
67
+ const child = (0, child_process_1.spawn)(process.execPath, ["--enable-source-maps", entry], {
68
+ cwd: root,
69
+ stdio: "inherit",
70
+ env: { ...process.env, NODE_ENV: process.env.NODE_ENV ?? "development" },
71
+ ...process_1.treeSpawnOptions,
72
+ });
73
+ app = child;
74
+ child.on("exit", (code, signal) => {
75
+ if (app === child)
76
+ app = null;
77
+ if (stopping)
78
+ return;
79
+ if (code)
80
+ logErr("MEGH")(`Process exited with code ${code}. Waiting for changes...`);
81
+ else if (signal)
82
+ logApp(`Process terminated by ${signal}. Waiting for changes...`);
83
+ });
84
+ child.on("error", (err) => logErr("MEGH")(`Failed to start: ${err.message}`));
85
+ }
86
+ function reportFailures() {
87
+ for (const [file, error] of failures) {
88
+ logErr("COMPILE")(`${path_1.default.relative(root, file)}\n${error}`);
89
+ }
90
+ logErr("COMPILE")(`${failures.size} file(s) failed to compile. The app is stopped until they are fixed.`);
91
+ }
92
+ // Serialize restarts so overlapping events never race.
93
+ let chain = Promise.resolve();
94
+ const enqueue = (task) => {
95
+ chain = chain.then(task).catch((err) => logErr("SERVE")(String(err?.stack ?? err)));
96
+ return chain;
97
+ };
98
+ async function reload() {
99
+ await stopApp();
100
+ if (failures.size)
101
+ return reportFailures();
102
+ startApp();
103
+ }
104
+ // ── Change handling (debounced) ─────────────────────────────────────────
105
+ const pending = new Map();
106
+ let timer = null;
107
+ function onEvent(event, file) {
108
+ pending.set(file, event);
109
+ if (timer)
110
+ clearTimeout(timer);
111
+ timer = setTimeout(() => {
112
+ timer = null;
113
+ const batch = new Map(pending);
114
+ pending.clear();
115
+ enqueue(() => applyBatch(batch));
116
+ }, debounceMs);
117
+ }
118
+ const outPath = (file) => path_1.default.join(layout.outDir, path_1.default.relative(layout.srcDir, file));
119
+ const inSrc = (file) => {
120
+ const rel = path_1.default.relative(layout.srcDir, file);
121
+ return !!rel && !rel.startsWith("..") && !path_1.default.isAbsolute(rel);
122
+ };
123
+ /**
124
+ * Mirror one file event into the output dir. Returns true when the app
125
+ * should restart; test files, `.d.ts` and dotfiles are ignored.
126
+ */
127
+ function applyChange(event, file) {
128
+ if (path_1.default.dirname(file) === root && path_1.default.basename(file).startsWith(".env"))
129
+ return true;
130
+ if (!inSrc(file))
131
+ return false;
132
+ if (event === "unlinkDir") {
133
+ fs_1.default.rmSync(outPath(file), { recursive: true, force: true });
134
+ for (const f of failures.keys())
135
+ if (f.startsWith(file + path_1.default.sep))
136
+ failures.delete(f);
137
+ return true;
138
+ }
139
+ if (event === "addDir")
140
+ return false;
141
+ if ((0, compiler_1.isTsSource)(file)) {
142
+ if ((0, compiler_1.isTestFile)(file))
143
+ return false;
144
+ if (event === "unlink") {
145
+ fs_1.default.rmSync(compiler.outFileFor(file), { force: true });
146
+ failures.delete(file);
147
+ return true;
148
+ }
149
+ const result = compiler.compileFile(file);
150
+ if (result.ok)
151
+ failures.delete(file);
152
+ else
153
+ failures.set(file, result.error);
154
+ return true;
155
+ }
156
+ if (!(0, project_1.isAsset)(file))
157
+ return false;
158
+ if (event === "unlink") {
159
+ fs_1.default.rmSync(outPath(file), { force: true });
160
+ }
161
+ else {
162
+ fs_1.default.mkdirSync(path_1.default.dirname(outPath(file)), { recursive: true });
163
+ fs_1.default.copyFileSync(file, outPath(file));
164
+ }
165
+ return true;
166
+ }
167
+ async function applyBatch(batch) {
168
+ let relevant = false;
169
+ for (const [file, event] of batch) {
170
+ if (applyChange(event, file)) {
171
+ relevant = true;
172
+ logWatch(`${event} ${path_1.default.relative(root, file)}`);
173
+ }
174
+ }
175
+ if (relevant)
176
+ await reload();
177
+ }
178
+ // ── Watchers ────────────────────────────────────────────────────────────
179
+ const chokidar = require("chokidar");
180
+ const srcWatcher = chokidar.watch(layout.srcDir, {
181
+ ignoreInitial: true,
182
+ awaitWriteFinish: { stabilityThreshold: 100, pollInterval: 50 },
183
+ });
184
+ const envWatcher = chokidar.watch(root, {
185
+ ignoreInitial: true,
186
+ depth: 0,
187
+ ignored: (p) => p !== root && !path_1.default.basename(p).startsWith(".env"),
188
+ });
189
+ for (const w of [srcWatcher, envWatcher]) {
190
+ w.on("all", (event, file) => onEvent(event, file));
191
+ w.on("error", (err) => logErr("WATCH")(String(err?.message ?? err)));
192
+ watchers.push(w);
193
+ }
194
+ // ── Type checking ───────────────────────────────────────────────────────
195
+ if (opts.typeCheck !== false) {
196
+ const tsc = (0, process_1.findTsc)(root);
197
+ if (!tsc || !layout.tsconfig) {
198
+ logServe(log_1.c.yellow("Type checking disabled: TypeScript or tsconfig.json not found in the project."));
199
+ }
200
+ else {
201
+ typeChecker = (0, child_process_1.spawn)(process.execPath, [tsc, "--noEmit", "--watch", "--preserveWatchOutput", "--pretty", "-p", layout.tsconfig], { cwd: root, stdio: ["ignore", "pipe", "pipe"], ...process_1.treeSpawnOptions });
202
+ const forward = (data) => {
203
+ for (const line of data.toString().split(/\r?\n/)) {
204
+ // Skip tsc's per-cycle "Starting compilation" / "File change detected" chatter.
205
+ if (!line.trim() || /Starting (incremental )?compilation|File change detected/.test(line))
206
+ continue;
207
+ console.log(`${log_1.c.dim("[TSC]")} ${/Found 0 errors/.test(line) ? log_1.c.green(line) : line}`);
208
+ }
209
+ };
210
+ typeChecker.stdout?.on("data", forward);
211
+ typeChecker.stderr?.on("data", forward);
212
+ }
213
+ }
214
+ // ── Shutdown ────────────────────────────────────────────────────────────
215
+ let shuttingDown = false;
216
+ const shutdown = async (signal) => {
217
+ if (shuttingDown)
218
+ return;
219
+ shuttingDown = true;
220
+ logServe(`Received ${signal}, shutting down...`);
221
+ if (timer)
222
+ clearTimeout(timer);
223
+ await Promise.allSettled(watchers.map((w) => w.close()));
224
+ await Promise.allSettled([stopApp(), (0, process_1.killTree)(typeChecker, 1000)]);
225
+ process.exit(0);
226
+ };
227
+ process.on("SIGINT", () => void shutdown("SIGINT"));
228
+ process.on("SIGTERM", () => void shutdown("SIGTERM"));
229
+ if (process.platform === "win32")
230
+ process.on("SIGBREAK", () => void shutdown("SIGBREAK"));
231
+ if (failures.size)
232
+ reportFailures();
233
+ else
234
+ startApp();
235
+ logWatch("Watching for changes. Press Ctrl+C to stop.");
236
+ // Keep the promise pending for the lifetime of the server.
237
+ await new Promise(() => { });
238
+ }
@@ -0,0 +1,10 @@
1
+ export type StartOptions = {
2
+ cwd?: string;
3
+ entry?: string;
4
+ };
5
+ /**
6
+ * Run the compiled app from the output dir in production mode
7
+ * (`NODE_ENV=production` unless already set). Resolves to the app's exit code.
8
+ * SIGINT/SIGTERM are forwarded so the app can shut down gracefully.
9
+ */
10
+ export declare function start(opts?: StartOptions): Promise<number>;
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.start = start;
7
+ const child_process_1 = require("child_process");
8
+ const path_1 = __importDefault(require("path"));
9
+ const errors_1 = require("../errors");
10
+ const entry_1 = require("../utils/entry");
11
+ const log_1 = require("../utils/log");
12
+ const project_1 = require("../utils/project");
13
+ /**
14
+ * Run the compiled app from the output dir in production mode
15
+ * (`NODE_ENV=production` unless already set). Resolves to the app's exit code.
16
+ * SIGINT/SIGTERM are forwarded so the app can shut down gracefully.
17
+ */
18
+ async function start(opts = {}) {
19
+ const root = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
20
+ const layout = (0, entry_1.projectLayout)(root, true);
21
+ const candidates = (0, entry_1.entryCandidates)(layout, (0, project_1.readPackageJson)(root), opts.entry);
22
+ const entry = (0, entry_1.resolveEntry)(candidates, opts.entry);
23
+ if (!entry) {
24
+ throw new errors_1.CliError(`No compiled entry file found (tried ${candidates.map((p) => path_1.default.relative(root, p)).join(", ")}). ` +
25
+ "Run `megh build` first, or pass --entry.");
26
+ }
27
+ const env = { ...process.env, NODE_ENV: process.env.NODE_ENV ?? "production" };
28
+ log_1.log.info(`Starting ${path_1.default.relative(root, entry)} (NODE_ENV=${env.NODE_ENV})`);
29
+ return new Promise((resolve, reject) => {
30
+ const child = (0, child_process_1.spawn)(process.execPath, ["--enable-source-maps", entry], { cwd: root, env, stdio: "inherit" });
31
+ const forward = (signal) => () => child.kill(signal);
32
+ const onInt = forward("SIGINT");
33
+ const onTerm = forward("SIGTERM");
34
+ process.on("SIGINT", onInt);
35
+ process.on("SIGTERM", onTerm);
36
+ child.on("error", reject);
37
+ child.on("exit", (code, signal) => {
38
+ process.off("SIGINT", onInt);
39
+ process.off("SIGTERM", onTerm);
40
+ resolve(code ?? (signal === "SIGINT" || signal === "SIGTERM" ? 0 : 1));
41
+ });
42
+ });
43
+ }
@@ -0,0 +1,24 @@
1
+ export type CompileResult = {
2
+ ok: true;
3
+ } | {
4
+ ok: false;
5
+ error: string;
6
+ };
7
+ export declare function isTestFile(file: string): boolean;
8
+ export declare function isTsSource(file: string): boolean;
9
+ /**
10
+ * Fast per-file TypeScript -> CommonJS transpiler (SWC). It does not type-check;
11
+ * `serve` runs `tsc --noEmit` alongside it for that. tsconfig `paths` are
12
+ * rewritten to relative imports at compile time, so no runtime hook is needed.
13
+ */
14
+ export declare class SwcCompiler {
15
+ readonly srcDir: string;
16
+ readonly outDir: string;
17
+ private readonly options;
18
+ constructor(srcDir: string, outDir: string, compilerOptions?: Record<string, any>);
19
+ outFileFor(file: string): string;
20
+ compileFile(file: string): CompileResult;
21
+ /** All non-test `.ts` sources under `srcDir`. */
22
+ sources(): string[];
23
+ compileAll(): Map<string, string>;
24
+ }
@@ -0,0 +1,83 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.SwcCompiler = void 0;
7
+ exports.isTestFile = isTestFile;
8
+ exports.isTsSource = isTsSource;
9
+ const fs_1 = __importDefault(require("fs"));
10
+ const path_1 = __importDefault(require("path"));
11
+ function isTestFile(file) {
12
+ return /\.(test|spec)\.[cm]?[tj]s$/.test(path_1.default.basename(file));
13
+ }
14
+ function isTsSource(file) {
15
+ return /\.ts$/.test(file) && !/\.d\.ts$/.test(file);
16
+ }
17
+ /**
18
+ * Fast per-file TypeScript -> CommonJS transpiler (SWC). It does not type-check;
19
+ * `serve` runs `tsc --noEmit` alongside it for that. tsconfig `paths` are
20
+ * rewritten to relative imports at compile time, so no runtime hook is needed.
21
+ */
22
+ class SwcCompiler {
23
+ srcDir;
24
+ outDir;
25
+ options;
26
+ constructor(srcDir, outDir, compilerOptions = {}) {
27
+ this.srcDir = srcDir;
28
+ this.outDir = outDir;
29
+ const baseUrl = compilerOptions.baseUrl ?? compilerOptions.pathsBasePath;
30
+ const paths = compilerOptions.paths;
31
+ this.options = {
32
+ swcrc: false,
33
+ configFile: false,
34
+ sourceMaps: "inline",
35
+ module: { type: "commonjs" },
36
+ jsc: {
37
+ parser: { syntax: "typescript", decorators: true },
38
+ target: "es2022",
39
+ keepClassNames: true,
40
+ transform: { legacyDecorator: true, decoratorMetadata: true },
41
+ ...(paths && baseUrl ? { baseUrl, paths } : {}),
42
+ },
43
+ };
44
+ }
45
+ outFileFor(file) {
46
+ return path_1.default.join(this.outDir, path_1.default.relative(this.srcDir, file)).replace(/\.ts$/, ".js");
47
+ }
48
+ compileFile(file) {
49
+ try {
50
+ // Loaded lazily: the native binding is only needed by serve and route:list.
51
+ const { transformFileSync } = require("@swc/core");
52
+ const result = transformFileSync(file, { ...this.options, filename: file });
53
+ const out = this.outFileFor(file);
54
+ fs_1.default.mkdirSync(path_1.default.dirname(out), { recursive: true });
55
+ fs_1.default.writeFileSync(out, result.code, "utf8");
56
+ return { ok: true };
57
+ }
58
+ catch (err) {
59
+ // Never leave stale JS behind for a file that no longer compiles.
60
+ fs_1.default.rmSync(this.outFileFor(file), { force: true });
61
+ return { ok: false, error: err instanceof Error ? err.message : String(err) };
62
+ }
63
+ }
64
+ /** All non-test `.ts` sources under `srcDir`. */
65
+ sources() {
66
+ if (!fs_1.default.existsSync(this.srcDir))
67
+ return [];
68
+ return fs_1.default
69
+ .readdirSync(this.srcDir, { withFileTypes: true, recursive: true })
70
+ .filter((e) => e.isFile() && isTsSource(e.name) && !isTestFile(e.name))
71
+ .map((e) => path_1.default.join(e.parentPath ?? e.path, e.name));
72
+ }
73
+ compileAll() {
74
+ const failures = new Map();
75
+ for (const file of this.sources()) {
76
+ const r = this.compileFile(file);
77
+ if (!r.ok)
78
+ failures.set(file, r.error);
79
+ }
80
+ return failures;
81
+ }
82
+ }
83
+ exports.SwcCompiler = SwcCompiler;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * An expected failure: printed as a one-line message (no stack trace) and
3
+ * turned into a non-zero exit code by the bin entry.
4
+ */
5
+ export declare class CliError extends Error {
6
+ readonly exitCode: number;
7
+ constructor(message: string, exitCode?: number);
8
+ }
package/dist/errors.js ADDED
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CliError = void 0;
4
+ /**
5
+ * An expected failure: printed as a one-line message (no stack trace) and
6
+ * turned into a non-zero exit code by the bin entry.
7
+ */
8
+ class CliError extends Error {
9
+ exitCode;
10
+ constructor(message, exitCode = 1) {
11
+ super(message);
12
+ this.exitCode = exitCode;
13
+ this.name = "CliError";
14
+ }
15
+ }
16
+ exports.CliError = CliError;
@@ -0,0 +1,40 @@
1
+ export type MakeBaseOptions = {
2
+ /** Directory to start the project-root search from. Defaults to `process.cwd()`. */
3
+ cwd?: string;
4
+ force?: boolean;
5
+ /** Folder under `src/` to write to instead of the default one. */
6
+ root?: string;
7
+ };
8
+ export type MakeModelOptions = MakeBaseOptions & {
9
+ orm?: boolean;
10
+ };
11
+ export type MakeServiceOptions = MakeBaseOptions & {
12
+ resource?: boolean;
13
+ model?: string;
14
+ orm?: boolean;
15
+ };
16
+ export type MakeControllerOptions = MakeServiceOptions & {
17
+ basePath?: boolean;
18
+ };
19
+ export declare function makeModel(name: string, opts?: MakeModelOptions): string;
20
+ export declare function makeService(name: string, opts?: MakeServiceOptions): string;
21
+ export declare function makeController(name: string, opts?: MakeControllerOptions): string;
22
+ export declare function makeConfig(name: string, opts?: MakeBaseOptions): string;
23
+ export declare function makeMiddleware(name: string, opts?: MakeBaseOptions): string;
24
+ export declare function makeDto(name: string, opts?: MakeBaseOptions): string;
25
+ export type MakeMigrationOptions = Pick<MakeBaseOptions, "cwd" | "force"> & {
26
+ /** Create this table (overrides the name-based guess). */
27
+ create?: string;
28
+ /** Alter this table (overrides the name-based guess). */
29
+ table?: string;
30
+ /** Clock for the file name's timestamp (tests). */
31
+ now?: Date;
32
+ };
33
+ /** `YYYYMMDDHHmmss` in local time: migrations run in file-name order. */
34
+ export declare function migrationTimestamp(date?: Date): string;
35
+ /**
36
+ * Create `<migrations>/<timestamp>_<name>.ts`. `create_<table>_table` gives a
37
+ * create-table migration, `add_x_to_<table>_table` (also from/in, and
38
+ * remove/drop/alter/change/update) an alter-table one, anything else a blank one.
39
+ */
40
+ export declare function makeMigration(name: string, opts?: MakeMigrationOptions): string;
@@ -0,0 +1,198 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.makeModel = makeModel;
7
+ exports.makeService = makeService;
8
+ exports.makeController = makeController;
9
+ exports.makeConfig = makeConfig;
10
+ exports.makeMiddleware = makeMiddleware;
11
+ exports.makeDto = makeDto;
12
+ exports.migrationTimestamp = migrationTimestamp;
13
+ exports.makeMigration = makeMigration;
14
+ const fs_1 = __importDefault(require("fs"));
15
+ const path_1 = __importDefault(require("path"));
16
+ const errors_1 = require("../errors");
17
+ const log_1 = require("../utils/log");
18
+ const names_1 = require("../utils/names");
19
+ const project_1 = require("../utils/project");
20
+ const stubs_1 = require("../utils/stubs");
21
+ const migrate_1 = require("../commands/migrate");
22
+ const DEFAULT_DIRS = {
23
+ model: "models",
24
+ service: "services",
25
+ controller: "controllers",
26
+ config: "config",
27
+ middleware: "middlewares",
28
+ dto: "dtos",
29
+ };
30
+ function targetDir(projectRoot, kind, dirs, root) {
31
+ const folder = root ? root.split(/[\\/]+/).filter(Boolean) : [DEFAULT_DIRS[kind]];
32
+ if (folder.some((p) => p === ".."))
33
+ throw new errors_1.CliError(`Invalid --root "${root}".`);
34
+ return path_1.default.join(projectRoot, "src", ...folder, ...dirs);
35
+ }
36
+ /** A relative module specifier from `fromFile` to `toFile` (without extension), always using `/`. */
37
+ function importPath(fromFile, toFile) {
38
+ let rel = path_1.default.relative(path_1.default.dirname(fromFile), toFile).replace(/\.ts$/, "").split(path_1.default.sep).join("/");
39
+ if (!rel.startsWith("."))
40
+ rel = "./" + rel;
41
+ return rel;
42
+ }
43
+ function write(file, content, force, label, projectRoot) {
44
+ (0, project_1.writeFileSafe)(file, content, force);
45
+ log_1.log.success(`${label} created: ${path_1.default.relative(projectRoot, file).split(path_1.default.sep).join("/")}`);
46
+ return file;
47
+ }
48
+ /**
49
+ * Write a dependency of the requested file (the model behind a service, or the
50
+ * service behind a controller). An existing file is always kept and reused.
51
+ */
52
+ function ensureDependency(file, render, label, projectRoot) {
53
+ const rel = path_1.default.relative(projectRoot, file).split(path_1.default.sep).join("/");
54
+ if (fs_1.default.existsSync(file)) {
55
+ log_1.log.info(` ${label} exists, reusing: ${rel}`);
56
+ return;
57
+ }
58
+ write(file, render(), false, label, projectRoot);
59
+ }
60
+ function makeModel(name, opts = {}) {
61
+ const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
62
+ const n = (0, names_1.resolveName)(name, "Model");
63
+ const file = path_1.default.join(targetDir(projectRoot, "model", n.dirs, opts.root), `${n.fileBase}.model.ts`);
64
+ return write(file, renderModel(n.base, opts.orm), opts.force, "Model", projectRoot);
65
+ }
66
+ function renderModel(model, orm) {
67
+ return (0, stubs_1.renderStub)(orm ? "models/entity-model.stub" : "models/basic-model.stub", {
68
+ Model: model,
69
+ table: (0, names_1.snakeCase)(model),
70
+ });
71
+ }
72
+ /**
73
+ * Write a resource service for `model` at `serviceFile`, plus the model under
74
+ * `src/models` if it does not exist yet, so the generated code compiles.
75
+ */
76
+ function writeResourceService(projectRoot, serviceFile, serviceClass, model, orm, force, asDependency) {
77
+ const m = (0, names_1.resolveName)(model, "Model");
78
+ const modelFile = path_1.default.join(targetDir(projectRoot, "model", m.dirs), `${m.fileBase}.model.ts`);
79
+ const render = () => (0, stubs_1.renderStub)(orm ? "services/orm-rest-service.stub" : "services/rest-service.stub", {
80
+ ClassName: serviceClass,
81
+ Model: m.base,
82
+ modelVar: m.varName,
83
+ modelImport: importPath(serviceFile, modelFile),
84
+ });
85
+ if (asDependency)
86
+ ensureDependency(serviceFile, render, "Service", projectRoot);
87
+ else
88
+ write(serviceFile, render(), force, "Service", projectRoot);
89
+ ensureDependency(modelFile, () => renderModel(m.base, orm), "Model", projectRoot);
90
+ if (orm && !(0, project_1.installedVersion)("@meghjs/data", projectRoot)) {
91
+ log_1.log.warn("The generated service uses @meghjs/data. Install it: npm install @meghjs/data typeorm");
92
+ }
93
+ }
94
+ function makeService(name, opts = {}) {
95
+ const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
96
+ const n = (0, names_1.resolveName)(name, "Service");
97
+ const file = path_1.default.join(targetDir(projectRoot, "service", n.dirs, opts.root), `${n.fileBase}.service.ts`);
98
+ if (opts.resource && !opts.model) {
99
+ throw new errors_1.CliError("A resource service needs a model: pass -m <model> (or --model <model>).");
100
+ }
101
+ if (opts.model) {
102
+ writeResourceService(projectRoot, file, n.className, opts.model, opts.orm, opts.force, false);
103
+ return file;
104
+ }
105
+ return write(file, (0, stubs_1.renderStub)("services/basic-service.stub", { ClassName: n.className }), opts.force, "Service", projectRoot);
106
+ }
107
+ function makeController(name, opts = {}) {
108
+ const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
109
+ const n = (0, names_1.resolveName)(name, "Controller");
110
+ const file = path_1.default.join(targetDir(projectRoot, "controller", n.dirs, opts.root), `${n.fileBase}.controller.ts`);
111
+ if (fs_1.default.existsSync(file) && !opts.force) {
112
+ throw new errors_1.CliError(`${file} already exists. Use -f or --force to overwrite it.`);
113
+ }
114
+ const route = [...n.dirs, `${n.fileBase}s`].join("/");
115
+ let content;
116
+ if (opts.model) {
117
+ const m = (0, names_1.resolveName)(opts.model, "Model");
118
+ const serviceClass = `${m.base}Service`;
119
+ const serviceFile = path_1.default.join(targetDir(projectRoot, "service", []), `${m.fileBase}.service.ts`);
120
+ content = (0, stubs_1.renderStub)("controllers/resource-controller.stub", {
121
+ ClassName: n.className,
122
+ route,
123
+ Model: m.base,
124
+ modelVar: m.varName,
125
+ ServiceClass: serviceClass,
126
+ serviceVar: `${m.varName}Service`,
127
+ serviceImport: importPath(file, serviceFile),
128
+ });
129
+ // Dependencies first, so a failure leaves no controller pointing at missing files.
130
+ writeResourceService(projectRoot, serviceFile, serviceClass, opts.model, opts.orm, false, true);
131
+ }
132
+ else {
133
+ const stub = opts.resource ? "controllers/rest-controller.stub" : "controllers/basic-controller.stub";
134
+ content = (0, stubs_1.renderStub)(stub, { ClassName: n.className, route });
135
+ }
136
+ if (opts.basePath) {
137
+ content = content.replace(/@ApiController\s*\(([^)]*)\)/, "@ApiController");
138
+ }
139
+ write(file, content, opts.force, "Controller", projectRoot);
140
+ log_1.log.info(` Register it in your app: app.useControllers([..., ${n.className}])`);
141
+ return file;
142
+ }
143
+ function makeConfig(name, opts = {}) {
144
+ const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
145
+ const n = (0, names_1.resolveName)(name, "Config");
146
+ const file = path_1.default.join(targetDir(projectRoot, "config", n.dirs, opts.root), `${n.fileBase}.config.ts`);
147
+ return write(file, (0, stubs_1.renderStub)("config/config.stub", { ClassName: n.className }), opts.force, "Config", projectRoot);
148
+ }
149
+ function makeMiddleware(name, opts = {}) {
150
+ const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
151
+ const n = (0, names_1.resolveName)(name, "Middleware");
152
+ const file = path_1.default.join(targetDir(projectRoot, "middleware", n.dirs, opts.root), `${n.fileBase}.middleware.ts`);
153
+ return write(file, (0, stubs_1.renderStub)("middlewares/middleware.stub", { ClassName: n.className }), opts.force, "Middleware", projectRoot);
154
+ }
155
+ function makeDto(name, opts = {}) {
156
+ const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
157
+ const n = (0, names_1.resolveName)(name, "Dto");
158
+ const file = path_1.default.join(targetDir(projectRoot, "dto", n.dirs, opts.root), `${n.fileBase}.dto.ts`);
159
+ return write(file, (0, stubs_1.renderStub)("dtos/dto.stub", { ClassName: n.className }), opts.force, "DTO", projectRoot);
160
+ }
161
+ /** `YYYYMMDDHHmmss` in local time: migrations run in file-name order. */
162
+ function migrationTimestamp(date = new Date()) {
163
+ const p = (n) => String(n).padStart(2, "0");
164
+ return (`${date.getFullYear()}${p(date.getMonth() + 1)}${p(date.getDate())}` +
165
+ `${p(date.getHours())}${p(date.getMinutes())}${p(date.getSeconds())}`);
166
+ }
167
+ /** The `id` column for the project's database driver. */
168
+ function idColumn(pkg) {
169
+ const deps = { ...pkg?.dependencies, ...pkg?.devDependencies };
170
+ if (deps.pg || deps.postgres)
171
+ return `.addColumn("id", "serial", (col) => col.primaryKey())`;
172
+ if (deps.tedious)
173
+ return `.addColumn("id", "integer", (col) => col.identity().primaryKey())`;
174
+ return `.addColumn("id", "integer", (col) => col.primaryKey().autoIncrement())`;
175
+ }
176
+ /**
177
+ * Create `<migrations>/<timestamp>_<name>.ts`. `create_<table>_table` gives a
178
+ * create-table migration, `add_x_to_<table>_table` (also from/in, and
179
+ * remove/drop/alter/change/update) an alter-table one, anything else a blank one.
180
+ */
181
+ function makeMigration(name, opts = {}) {
182
+ const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
183
+ const snake = (0, names_1.snakeCase)(name);
184
+ if (!snake)
185
+ throw new errors_1.CliError(`Invalid migration name "${name}".`);
186
+ const pkg = JSON.parse(fs_1.default.readFileSync(path_1.default.join(projectRoot, "package.json"), "utf8"));
187
+ const { migrations } = (0, migrate_1.databasePaths)(projectRoot, pkg);
188
+ const createTable = opts.create ?? (opts.table ? undefined : snake.match(/^create_(\w+?)_table$/)?.[1]);
189
+ const alterTable = opts.table ??
190
+ (opts.create ? undefined : snake.match(/^(?:add|remove|drop|alter|change|update)_\w+_(?:to|from|in|on)_(\w+?)_table$/)?.[1]);
191
+ const content = createTable
192
+ ? (0, stubs_1.renderStub)("migrations/create-table.stub", { table: createTable, idColumn: idColumn(pkg) })
193
+ : alterTable
194
+ ? (0, stubs_1.renderStub)("migrations/alter-table.stub", { table: alterTable })
195
+ : (0, stubs_1.renderStub)("migrations/migration.stub");
196
+ const file = path_1.default.join(migrations, `${migrationTimestamp(opts.now)}_${snake}.ts`);
197
+ return write(file, content, opts.force, "Migration", projectRoot);
198
+ }