@meghjs/cli 0.0.0-stage → 0.5.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/LICENSE +21 -0
- package/dist/bin.d.ts +2 -0
- package/dist/bin.js +10 -0
- package/dist/commands/build.d.ts +11 -0
- package/dist/commands/build.js +65 -0
- package/dist/commands/doctor.d.ts +10 -0
- package/dist/commands/doctor.js +96 -0
- package/dist/commands/migrate.d.ts +41 -0
- package/dist/commands/migrate.js +193 -0
- package/dist/commands/new.d.ts +24 -0
- package/dist/commands/new.js +377 -0
- package/dist/commands/route-list.d.ts +19 -0
- package/dist/commands/route-list.js +160 -0
- package/dist/commands/serve.d.ts +17 -0
- package/dist/commands/serve.js +238 -0
- package/dist/commands/start.d.ts +10 -0
- package/dist/commands/start.js +43 -0
- package/dist/compiler.d.ts +24 -0
- package/dist/compiler.js +83 -0
- package/dist/errors.d.ts +8 -0
- package/dist/errors.js +16 -0
- package/dist/generators/make.d.ts +60 -0
- package/dist/generators/make.js +325 -0
- package/dist/generators/migration-schema.d.ts +29 -0
- package/dist/generators/migration-schema.js +398 -0
- package/dist/generators/orm-model.d.ts +23 -0
- package/dist/generators/orm-model.js +158 -0
- package/dist/generators/resource.d.ts +32 -0
- package/dist/generators/resource.js +277 -0
- package/dist/index.d.ts +17 -0
- package/dist/index.js +42 -0
- package/dist/program.d.ts +22 -0
- package/dist/program.js +224 -0
- package/dist/utils/entry.d.ts +15 -0
- package/dist/utils/entry.js +55 -0
- package/dist/utils/env-types.d.ts +8 -0
- package/dist/utils/env-types.js +19 -0
- package/dist/utils/log.d.ts +25 -0
- package/dist/utils/log.js +39 -0
- package/dist/utils/names.d.ts +27 -0
- package/dist/utils/names.js +58 -0
- package/dist/utils/process.d.ts +18 -0
- package/dist/utils/process.js +84 -0
- package/dist/utils/project.d.ts +17 -0
- package/dist/utils/project.js +91 -0
- package/dist/utils/stubs.d.ts +15 -0
- package/dist/utils/stubs.js +52 -0
- package/dist/utils/tsconfig.d.ts +13 -0
- package/dist/utils/tsconfig.js +102 -0
- package/package.json +61 -4
- package/readme.md +155 -0
- package/stubs/config/config.stub +9 -0
- package/stubs/controllers/basic-controller.stub +9 -0
- package/stubs/controllers/model-controller.stub +34 -0
- package/stubs/controllers/resource-controller.stub +45 -0
- package/stubs/controllers/rest-controller.stub +29 -0
- package/stubs/dtos/dto.stub +11 -0
- package/stubs/dtos/resource-dto.stub +28 -0
- package/stubs/middlewares/middleware.stub +9 -0
- package/stubs/migrations/alter-table.stub +15 -0
- package/stubs/migrations/create-table.stub +15 -0
- package/stubs/migrations/migration.stub +11 -0
- package/stubs/models/entity-model.stub +16 -0
- package/stubs/models/orm-model-blank.stub +10 -0
- package/stubs/models/orm-model.stub +7 -0
- package/stubs/project/app-minimal.stub +7 -0
- package/stubs/project/app.stub +8 -0
- package/stubs/project/env.stub +3 -0
- package/stubs/project/gitignore.stub +5 -0
- package/stubs/project/home.controller.spec.stub +19 -0
- package/stubs/project/home.controller.stub +12 -0
- package/stubs/project/home.service.stub +8 -0
- package/stubs/project/openapi.config.stub +15 -0
- package/stubs/project/readme.stub +26 -0
- package/stubs/project/serve.stub +10 -0
- package/stubs/project/tsconfig.build.stub +4 -0
- package/stubs/project/tsconfig.stub +18 -0
- package/stubs/project/vitest-e2e.config.stub +10 -0
- package/stubs/project/vitest.config.stub +17 -0
- package/stubs/services/basic-service.stub +8 -0
- package/stubs/services/model-service.stub +42 -0
- package/stubs/services/orm-rest-service.stub +61 -0
- package/README.md +0 -3
|
@@ -0,0 +1,325 @@
|
|
|
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.makeResource = makeResource;
|
|
10
|
+
exports.makeConfig = makeConfig;
|
|
11
|
+
exports.makeMiddleware = makeMiddleware;
|
|
12
|
+
exports.makeDto = makeDto;
|
|
13
|
+
exports.migrationTimestamp = migrationTimestamp;
|
|
14
|
+
exports.makeMigration = makeMigration;
|
|
15
|
+
const fs_1 = __importDefault(require("fs"));
|
|
16
|
+
const path_1 = __importDefault(require("path"));
|
|
17
|
+
const errors_1 = require("../errors");
|
|
18
|
+
const log_1 = require("../utils/log");
|
|
19
|
+
const names_1 = require("../utils/names");
|
|
20
|
+
const project_1 = require("../utils/project");
|
|
21
|
+
const stubs_1 = require("../utils/stubs");
|
|
22
|
+
const migrate_1 = require("../commands/migrate");
|
|
23
|
+
const migration_schema_1 = require("./migration-schema");
|
|
24
|
+
const orm_model_1 = require("./orm-model");
|
|
25
|
+
const resource_1 = require("./resource");
|
|
26
|
+
const DEFAULT_DIRS = {
|
|
27
|
+
model: "models",
|
|
28
|
+
service: "services",
|
|
29
|
+
controller: "controllers",
|
|
30
|
+
config: "config",
|
|
31
|
+
middleware: "middlewares",
|
|
32
|
+
dto: "dtos",
|
|
33
|
+
};
|
|
34
|
+
function targetDir(projectRoot, kind, dirs, root) {
|
|
35
|
+
const folder = root ? root.split(/[\\/]+/).filter(Boolean) : [DEFAULT_DIRS[kind]];
|
|
36
|
+
if (folder.some((p) => p === ".."))
|
|
37
|
+
throw new errors_1.CliError(`Invalid --root "${root}".`);
|
|
38
|
+
return path_1.default.join(projectRoot, "src", ...folder, ...dirs);
|
|
39
|
+
}
|
|
40
|
+
/** A relative module specifier from `fromFile` to `toFile` (without extension), always using `/`. */
|
|
41
|
+
function importPath(fromFile, toFile) {
|
|
42
|
+
let rel = path_1.default.relative(path_1.default.dirname(fromFile), toFile).replace(/\.ts$/, "").split(path_1.default.sep).join("/");
|
|
43
|
+
if (!rel.startsWith("."))
|
|
44
|
+
rel = "./" + rel;
|
|
45
|
+
return rel;
|
|
46
|
+
}
|
|
47
|
+
function write(file, content, force, label, projectRoot) {
|
|
48
|
+
(0, project_1.writeFileSafe)(file, content, force);
|
|
49
|
+
log_1.log.success(`${label} created: ${path_1.default.relative(projectRoot, file).split(path_1.default.sep).join("/")}`);
|
|
50
|
+
return file;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Write a dependency of the requested file (the model behind a service, or the
|
|
54
|
+
* service behind a controller). An existing file is always kept and reused.
|
|
55
|
+
*/
|
|
56
|
+
function ensureDependency(file, render, label, projectRoot) {
|
|
57
|
+
const rel = path_1.default.relative(projectRoot, file).split(path_1.default.sep).join("/");
|
|
58
|
+
if (fs_1.default.existsSync(file)) {
|
|
59
|
+
log_1.log.info(` ${label} exists, reusing: ${rel}`);
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
write(file, render(), false, label, projectRoot);
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Create a Megh ORM model (or, with `orm`, a TypeORM entity). The model's
|
|
66
|
+
* columns come from the migration that creates its table, if there is one;
|
|
67
|
+
* otherwise it gets placeholder columns.
|
|
68
|
+
*/
|
|
69
|
+
function makeModel(name, opts = {}) {
|
|
70
|
+
const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
|
|
71
|
+
const n = (0, names_1.resolveName)(name, "Model");
|
|
72
|
+
const file = path_1.default.join(targetDir(projectRoot, "model", n.dirs, opts.root), `${n.fileBase}.model.ts`);
|
|
73
|
+
if (opts.orm)
|
|
74
|
+
return write(file, renderEntityModel(n.base), opts.force, "Model", projectRoot);
|
|
75
|
+
const { migrations } = (0, migrate_1.databasePaths)(projectRoot);
|
|
76
|
+
const rel = (p) => path_1.default.relative(projectRoot, p).split(path_1.default.sep).join("/");
|
|
77
|
+
const snake = (0, names_1.snakeCase)(n.base);
|
|
78
|
+
const candidates = opts.table ? [opts.table] : [(0, orm_model_1.pluralize)(snake), snake];
|
|
79
|
+
const schema = (0, migration_schema_1.readMigrationSchema)(migrations);
|
|
80
|
+
const table = candidates.map((t) => schema.get(t)).find((t) => t !== undefined);
|
|
81
|
+
if (table) {
|
|
82
|
+
write(file, (0, orm_model_1.renderOrmModel)(n.base, table), opts.force, "Model", projectRoot);
|
|
83
|
+
log_1.log.info(` ${table.columns.length} columns of "${table.name}" read from ${rel(migrations)}`);
|
|
84
|
+
}
|
|
85
|
+
else {
|
|
86
|
+
write(file, (0, orm_model_1.renderBlankOrmModel)(n.base, candidates[0]), opts.force, "Model", projectRoot);
|
|
87
|
+
log_1.log.info(` No migration creates "${candidates[0]}", so the columns are placeholders. ` +
|
|
88
|
+
`Create one with: megh make:migration create_${candidates[0]}_table`);
|
|
89
|
+
}
|
|
90
|
+
return file;
|
|
91
|
+
}
|
|
92
|
+
function renderEntityModel(model) {
|
|
93
|
+
return (0, stubs_1.renderStub)("models/entity-model.stub", { Model: model, table: (0, names_1.snakeCase)(model) });
|
|
94
|
+
}
|
|
95
|
+
/** The URL segment for a resource: `admin/BlogPost` → `admin/blog-posts`. */
|
|
96
|
+
function resourceRoute(dirs, base) {
|
|
97
|
+
// Singularize first so already-plural names (`Users`) become `/users`, not `/userses`.
|
|
98
|
+
return [...dirs, (0, orm_model_1.pluralRoute)((0, names_1.snakeCase)(base)).replace(/_/g, "-")].join("/");
|
|
99
|
+
}
|
|
100
|
+
const relPath = (projectRoot, file) => path_1.default.relative(projectRoot, file).split(path_1.default.sep).join("/");
|
|
101
|
+
/**
|
|
102
|
+
* Find the model for a resource: an existing model file is read as is;
|
|
103
|
+
* otherwise a Megh ORM model is built from the migration that creates its
|
|
104
|
+
* table. With `orm`, a missing model becomes a TypeORM placeholder entity.
|
|
105
|
+
* Throws when there is neither a model nor a migration.
|
|
106
|
+
*/
|
|
107
|
+
function resolveResourceModel(projectRoot, model, opts = {}) {
|
|
108
|
+
const name = (0, names_1.resolveName)(model, "Model");
|
|
109
|
+
const file = path_1.default.join(targetDir(projectRoot, "model", name.dirs), `${name.fileBase}.model.ts`);
|
|
110
|
+
const exists = fs_1.default.existsSync(file);
|
|
111
|
+
if (opts.orm && !exists)
|
|
112
|
+
return { name, file, create: renderEntityModel(name.base), typeorm: true };
|
|
113
|
+
const snake = (0, names_1.snakeCase)(name.base);
|
|
114
|
+
const tables = (0, migration_schema_1.readMigrationSchema)((0, migrate_1.databasePaths)(projectRoot).migrations);
|
|
115
|
+
const lookup = (candidates) => candidates.map((t) => (t ? tables.get(t) : undefined)).find((t) => t !== undefined);
|
|
116
|
+
if (exists) {
|
|
117
|
+
const source = fs_1.default.readFileSync(file, "utf8");
|
|
118
|
+
const declared = (0, resource_1.readModelSchema)(source).table;
|
|
119
|
+
const schema = (0, resource_1.readModelSchema)(source, lookup([opts.table, declared, (0, orm_model_1.pluralize)(snake), snake]));
|
|
120
|
+
return { name, file, schema, typeorm: opts.orm === true || schema.kind === "typeorm" };
|
|
121
|
+
}
|
|
122
|
+
const candidates = opts.table ? [opts.table] : [(0, orm_model_1.pluralize)(snake), snake];
|
|
123
|
+
const table = lookup(candidates);
|
|
124
|
+
if (!table) {
|
|
125
|
+
throw new errors_1.CliError(`There is no ${name.base} model (${relPath(projectRoot, file)}) and no migration creates the ` +
|
|
126
|
+
`"${candidates[0]}" table, so its columns are unknown. Create the table first:\n` +
|
|
127
|
+
` megh make:migration create_${candidates[0]}_table\n` +
|
|
128
|
+
`or a model to fill in by hand: megh make:model ${name.base}`);
|
|
129
|
+
}
|
|
130
|
+
const create = (0, orm_model_1.renderOrmModel)(name.base, table);
|
|
131
|
+
return { name, file, create, schema: (0, resource_1.readModelSchema)(create, table), typeorm: false };
|
|
132
|
+
}
|
|
133
|
+
function renderResourceService(model, serviceFile, serviceClass) {
|
|
134
|
+
const vars = {
|
|
135
|
+
ClassName: serviceClass,
|
|
136
|
+
Model: model.name.base,
|
|
137
|
+
modelVar: model.name.varName,
|
|
138
|
+
modelImport: importPath(serviceFile, model.file),
|
|
139
|
+
};
|
|
140
|
+
if (model.typeorm)
|
|
141
|
+
return (0, stubs_1.renderStub)("services/orm-rest-service.stub", vars);
|
|
142
|
+
return (0, stubs_1.renderStub)("services/model-service.stub", {
|
|
143
|
+
...vars,
|
|
144
|
+
primaryKey: model.schema.primaryKey,
|
|
145
|
+
primaryKeyType: model.schema.primaryKeyType,
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
function renderResourceController(model, controllerFile, className, route, serviceFile, dtoFile) {
|
|
149
|
+
const m = model.name;
|
|
150
|
+
const vars = {
|
|
151
|
+
ClassName: className,
|
|
152
|
+
route,
|
|
153
|
+
Model: m.base,
|
|
154
|
+
modelVar: m.varName,
|
|
155
|
+
ServiceClass: `${m.base}Service`,
|
|
156
|
+
serviceVar: `${m.varName}Service`,
|
|
157
|
+
serviceImport: importPath(controllerFile, serviceFile),
|
|
158
|
+
};
|
|
159
|
+
if (model.typeorm)
|
|
160
|
+
return (0, stubs_1.renderStub)("controllers/resource-controller.stub", vars);
|
|
161
|
+
const numeric = model.schema.primaryKeyType === "number";
|
|
162
|
+
return (0, stubs_1.renderStub)("controllers/model-controller.stub", {
|
|
163
|
+
...vars,
|
|
164
|
+
Plural: (0, names_1.pascalCase)((0, orm_model_1.pluralize)((0, names_1.snakeCase)(m.base))),
|
|
165
|
+
dtoImport: importPath(controllerFile, dtoFile),
|
|
166
|
+
primaryKeyType: numeric ? "number" : "string",
|
|
167
|
+
idArg: numeric ? "Number(id)" : "id",
|
|
168
|
+
});
|
|
169
|
+
}
|
|
170
|
+
function renderDtoFor(model) {
|
|
171
|
+
const plural = (0, names_1.pascalCase)((0, orm_model_1.pluralize)((0, names_1.snakeCase)(model.name.base)));
|
|
172
|
+
return (0, resource_1.renderResourceDto)(model.name.base, plural, resourceRoute(model.name.dirs, model.name.base), model.schema);
|
|
173
|
+
}
|
|
174
|
+
function warnMissing(projectRoot, model) {
|
|
175
|
+
if (model.typeorm && !(0, project_1.installedVersion)("@meghjs/data", projectRoot)) {
|
|
176
|
+
log_1.log.warn("The generated service uses @meghjs/data. Install it: npm install @meghjs/data typeorm");
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
function writeModelIfNew(projectRoot, model) {
|
|
180
|
+
if (model.create === undefined) {
|
|
181
|
+
log_1.log.info(` Model exists, reusing: ${relPath(projectRoot, model.file)}`);
|
|
182
|
+
return;
|
|
183
|
+
}
|
|
184
|
+
write(model.file, model.create, false, "Model", projectRoot);
|
|
185
|
+
const source = model.create.match(/table is created in (\S+?)\)/)?.[1];
|
|
186
|
+
if (source)
|
|
187
|
+
log_1.log.info(` Columns read from ${source}`);
|
|
188
|
+
}
|
|
189
|
+
function makeService(name, opts = {}) {
|
|
190
|
+
const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
|
|
191
|
+
const n = (0, names_1.resolveName)(name, "Service");
|
|
192
|
+
const file = path_1.default.join(targetDir(projectRoot, "service", n.dirs, opts.root), `${n.fileBase}.service.ts`);
|
|
193
|
+
if (opts.resource && !opts.model) {
|
|
194
|
+
throw new errors_1.CliError("A resource service needs a model: pass -m <model> (or --model <model>).");
|
|
195
|
+
}
|
|
196
|
+
if (opts.model) {
|
|
197
|
+
const model = resolveResourceModel(projectRoot, opts.model, { orm: opts.orm });
|
|
198
|
+
write(file, renderResourceService(model, file, n.className), opts.force, "Service", projectRoot);
|
|
199
|
+
writeModelIfNew(projectRoot, model);
|
|
200
|
+
warnMissing(projectRoot, model);
|
|
201
|
+
return file;
|
|
202
|
+
}
|
|
203
|
+
return write(file, (0, stubs_1.renderStub)("services/basic-service.stub", { ClassName: n.className }), opts.force, "Service", projectRoot);
|
|
204
|
+
}
|
|
205
|
+
function makeController(name, opts = {}) {
|
|
206
|
+
const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
|
|
207
|
+
const n = (0, names_1.resolveName)(name, "Controller");
|
|
208
|
+
const file = path_1.default.join(targetDir(projectRoot, "controller", n.dirs, opts.root), `${n.fileBase}.controller.ts`);
|
|
209
|
+
if (fs_1.default.existsSync(file) && !opts.force) {
|
|
210
|
+
throw new errors_1.CliError(`${file} already exists. Use -f or --force to overwrite it.`);
|
|
211
|
+
}
|
|
212
|
+
const route = resourceRoute(n.dirs, n.base);
|
|
213
|
+
let content;
|
|
214
|
+
if (opts.model) {
|
|
215
|
+
const model = resolveResourceModel(projectRoot, opts.model, { orm: opts.orm });
|
|
216
|
+
const m = model.name;
|
|
217
|
+
const serviceFile = path_1.default.join(targetDir(projectRoot, "service", m.dirs), `${m.fileBase}.service.ts`);
|
|
218
|
+
const dtoFile = path_1.default.join(targetDir(projectRoot, "dto", m.dirs), `${m.fileBase}.dto.ts`);
|
|
219
|
+
content = renderResourceController(model, file, n.className, route, serviceFile, dtoFile);
|
|
220
|
+
// Dependencies first, so a failure leaves no controller pointing at missing files.
|
|
221
|
+
if (!model.typeorm)
|
|
222
|
+
ensureDependency(dtoFile, () => renderDtoFor(model), "DTO", projectRoot);
|
|
223
|
+
ensureDependency(serviceFile, () => renderResourceService(model, serviceFile, `${m.base}Service`), "Service", projectRoot);
|
|
224
|
+
writeModelIfNew(projectRoot, model);
|
|
225
|
+
warnMissing(projectRoot, model);
|
|
226
|
+
}
|
|
227
|
+
else {
|
|
228
|
+
const stub = opts.resource ? "controllers/rest-controller.stub" : "controllers/basic-controller.stub";
|
|
229
|
+
content = (0, stubs_1.renderStub)(stub, { ClassName: n.className, route });
|
|
230
|
+
}
|
|
231
|
+
if (opts.basePath) {
|
|
232
|
+
content = content.replace(/@ApiController\s*\(([^)]*)\)/, "@ApiController");
|
|
233
|
+
}
|
|
234
|
+
write(file, content, opts.force, "Controller", projectRoot);
|
|
235
|
+
log_1.log.info(` Register it in your app: app.useControllers([..., ${n.className}])`);
|
|
236
|
+
return file;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* `make:resource user`: a REST resource for a model. The model is reused when
|
|
240
|
+
* it exists, otherwise generated from the migration that creates its table;
|
|
241
|
+
* then its DTOs, a service with the CRUD operations, and a controller exposing
|
|
242
|
+
* them are written. Nothing is written if any of those files already exists
|
|
243
|
+
* (unless `force`), or if the model's columns cannot be found.
|
|
244
|
+
*/
|
|
245
|
+
function makeResource(name, opts = {}) {
|
|
246
|
+
const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
|
|
247
|
+
const model = resolveResourceModel(projectRoot, name, { table: opts.table });
|
|
248
|
+
const m = model.name;
|
|
249
|
+
const files = {
|
|
250
|
+
service: path_1.default.join(targetDir(projectRoot, "service", m.dirs), `${m.fileBase}.service.ts`),
|
|
251
|
+
controller: path_1.default.join(targetDir(projectRoot, "controller", m.dirs), `${m.fileBase}.controller.ts`),
|
|
252
|
+
dto: path_1.default.join(targetDir(projectRoot, "dto", m.dirs), `${m.fileBase}.dto.ts`),
|
|
253
|
+
};
|
|
254
|
+
if (!opts.force) {
|
|
255
|
+
const taken = Object.values(files).filter((f) => fs_1.default.existsSync(f) && !(model.typeorm && f === files.dto));
|
|
256
|
+
if (taken.length > 0) {
|
|
257
|
+
throw new errors_1.CliError(`Already exists: ${taken.map((f) => relPath(projectRoot, f)).join(", ")}. Use -f or --force to overwrite.`);
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
const controllerClass = `${m.base}Controller`;
|
|
261
|
+
const route = resourceRoute(m.dirs, m.base);
|
|
262
|
+
const written = [];
|
|
263
|
+
writeModelIfNew(projectRoot, model);
|
|
264
|
+
if (model.create !== undefined)
|
|
265
|
+
written.push(model.file);
|
|
266
|
+
if (model.typeorm) {
|
|
267
|
+
log_1.log.info(" The model is a TypeORM entity: generating a repository service and an untyped controller (no DTOs).");
|
|
268
|
+
}
|
|
269
|
+
else {
|
|
270
|
+
written.push(write(files.dto, renderDtoFor(model), opts.force, "DTO", projectRoot));
|
|
271
|
+
}
|
|
272
|
+
written.push(write(files.service, renderResourceService(model, files.service, `${m.base}Service`), opts.force, "Service", projectRoot));
|
|
273
|
+
written.push(write(files.controller, renderResourceController(model, files.controller, controllerClass, route, files.service, files.dto), opts.force, "Controller", projectRoot));
|
|
274
|
+
warnMissing(projectRoot, model);
|
|
275
|
+
log_1.log.info(` Routes: GET|POST /${route}, GET|PUT|DELETE /${route}/:id`);
|
|
276
|
+
log_1.log.info(` Register it in your app: app.useControllers([..., ${controllerClass}])`);
|
|
277
|
+
return written;
|
|
278
|
+
}
|
|
279
|
+
function makeConfig(name, opts = {}) {
|
|
280
|
+
const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
|
|
281
|
+
const n = (0, names_1.resolveName)(name, "Config");
|
|
282
|
+
const file = path_1.default.join(targetDir(projectRoot, "config", n.dirs, opts.root), `${n.fileBase}.config.ts`);
|
|
283
|
+
return write(file, (0, stubs_1.renderStub)("config/config.stub", { ClassName: n.className }), opts.force, "Config", projectRoot);
|
|
284
|
+
}
|
|
285
|
+
function makeMiddleware(name, opts = {}) {
|
|
286
|
+
const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
|
|
287
|
+
const n = (0, names_1.resolveName)(name, "Middleware");
|
|
288
|
+
const file = path_1.default.join(targetDir(projectRoot, "middleware", n.dirs, opts.root), `${n.fileBase}.middleware.ts`);
|
|
289
|
+
return write(file, (0, stubs_1.renderStub)("middlewares/middleware.stub", { ClassName: n.className }), opts.force, "Middleware", projectRoot);
|
|
290
|
+
}
|
|
291
|
+
function makeDto(name, opts = {}) {
|
|
292
|
+
const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
|
|
293
|
+
const n = (0, names_1.resolveName)(name, "Dto");
|
|
294
|
+
const file = path_1.default.join(targetDir(projectRoot, "dto", n.dirs, opts.root), `${n.fileBase}.dto.ts`);
|
|
295
|
+
return write(file, (0, stubs_1.renderStub)("dtos/dto.stub", { ClassName: n.className }), opts.force, "DTO", projectRoot);
|
|
296
|
+
}
|
|
297
|
+
/** `YYYYMMDDHHmmss` in local time: migrations run in file-name order. */
|
|
298
|
+
function migrationTimestamp(date = new Date()) {
|
|
299
|
+
const p = (n) => String(n).padStart(2, "0");
|
|
300
|
+
return (`${date.getFullYear()}${p(date.getMonth() + 1)}${p(date.getDate())}` +
|
|
301
|
+
`${p(date.getHours())}${p(date.getMinutes())}${p(date.getSeconds())}`);
|
|
302
|
+
}
|
|
303
|
+
/**
|
|
304
|
+
* Create `<migrations>/<timestamp>_<name>.ts`. `create_<table>_table` gives a
|
|
305
|
+
* create-table migration, `add_x_to_<table>_table` (also from/in, and
|
|
306
|
+
* remove/drop/alter/change/update) an alter-table one, anything else a blank one.
|
|
307
|
+
*/
|
|
308
|
+
function makeMigration(name, opts = {}) {
|
|
309
|
+
const projectRoot = (0, project_1.requireProjectRoot)(opts.cwd ?? process.cwd());
|
|
310
|
+
const snake = (0, names_1.snakeCase)(name);
|
|
311
|
+
if (!snake)
|
|
312
|
+
throw new errors_1.CliError(`Invalid migration name "${name}".`);
|
|
313
|
+
const pkg = JSON.parse(fs_1.default.readFileSync(path_1.default.join(projectRoot, "package.json"), "utf8"));
|
|
314
|
+
const { migrations } = (0, migrate_1.databasePaths)(projectRoot, pkg);
|
|
315
|
+
const createTable = opts.create ?? (opts.table ? undefined : snake.match(/^create_(\w+?)_table$/)?.[1]);
|
|
316
|
+
const alterTable = opts.table ??
|
|
317
|
+
(opts.create ? undefined : snake.match(/^(?:add|remove|drop|alter|change|update)_\w+_(?:to|from|in|on)_(\w+?)_table$/)?.[1]);
|
|
318
|
+
const content = createTable
|
|
319
|
+
? (0, stubs_1.renderStub)("migrations/create-table.stub", { table: createTable })
|
|
320
|
+
: alterTable
|
|
321
|
+
? (0, stubs_1.renderStub)("migrations/alter-table.stub", { table: alterTable })
|
|
322
|
+
: (0, stubs_1.renderStub)("migrations/migration.stub");
|
|
323
|
+
const file = path_1.default.join(migrations, `${migrationTimestamp(opts.now)}_${snake}.ts`);
|
|
324
|
+
return write(file, content, opts.force, "Migration", projectRoot);
|
|
325
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reads table schemas out of migration files, without running them: the
|
|
3
|
+
* `up()` code of every migration is scanned, in file order, and its schema
|
|
4
|
+
* changes are replayed. Used by `make:model` to declare a model's columns.
|
|
5
|
+
*
|
|
6
|
+
* It understands Megh's schema builder (`defineMigration`, with
|
|
7
|
+
* `schema.create` / `schema.table` / `schema.drop`), and Kysely's
|
|
8
|
+
* `createTable` / `alterTable` / `dropTable` chains in older migrations.
|
|
9
|
+
* Anything it cannot read (raw SQL, computed names) is skipped.
|
|
10
|
+
*/
|
|
11
|
+
export interface MigrationColumn {
|
|
12
|
+
name: string;
|
|
13
|
+
/** Data type as written, lower-cased, e.g. `"varchar(255)"`; `""` when not a literal. */
|
|
14
|
+
type: string;
|
|
15
|
+
notNull: boolean;
|
|
16
|
+
primaryKey: boolean;
|
|
17
|
+
/** The database fills it in: auto-increment, identity, serial or a default. */
|
|
18
|
+
generated: boolean;
|
|
19
|
+
/** Auto-increment / identity / serial (as opposed to a default value). */
|
|
20
|
+
autoIncrement: boolean;
|
|
21
|
+
}
|
|
22
|
+
export interface MigrationTable {
|
|
23
|
+
name: string;
|
|
24
|
+
columns: MigrationColumn[];
|
|
25
|
+
/** Migration that created the table (file name). */
|
|
26
|
+
createdIn: string;
|
|
27
|
+
}
|
|
28
|
+
/** Every table the migrations in `folder` leave behind, keyed by name. */
|
|
29
|
+
export declare function readMigrationSchema(folder: string): Map<string, MigrationTable>;
|