@express-tool/cli 1.0.1 → 1.0.3
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/dist/bin.js +29 -32
- package/dist/commands/generate.generator.d.ts.map +1 -1
- package/dist/commands/init.generator.d.ts.map +1 -1
- package/dist/index.js +29 -32
- package/package.json +13 -13
package/dist/bin.js
CHANGED
|
@@ -1,18 +1,22 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{createRequire as e}from"module";e(import.meta.url);import{Command as t}from"commander";import s from"picocolors";import{authPlugin as
|
|
2
|
+
import{createRequire as e}from"module";e(import.meta.url);import{Command as t}from"commander";import s from"picocolors";import{authPlugin as n}from"@express-tool/plugin-auth";import{ciPlugin as a}from"@express-tool/plugin-ci";import{commonPlugin as o}from"@express-tool/plugin-common";import{databasePlugin as r}from"@express-tool/plugin-database";import{dockerPlugin as i}from"@express-tool/plugin-docker";import{middlewarePlugin as p}from"@express-tool/plugin-middleware";import{qualityPlugin as l}from"@express-tool/plugin-quality";import{swaggerPlugin as c}from"@express-tool/plugin-swagger";import{testingPlugin as m}from"@express-tool/plugin-testing";import{viewsPlugin as g}from"@express-tool/plugin-views";import d from"fs-extra";import u from"prompts";import{z as y}from"zod";import{controllerJs as f,controllerTs as w,routesJs as v,routesTs as h,testJs as j,testTs as x}from"@express-tool/plugin-resource";import S from"envinfo";import{createRequire as $}from"node:module";let b=$(import.meta.url);var k={656(e,$,k){k.d($,{x:()=>G});var C=JSON.parse('{"UU":"@express-tool/cli","rE":"1.0.3"}');let E=e=>console.log(s.blue("ℹ"),e),D=e=>console.log(s.green("✔"),e),P=e=>console.log(s.yellow("⚠"),e),R=e=>console.log(s.red("✖"),e),T=b("path");var N=k.n(T);async function M(e,t,s,n,a,o){E(`Applying plugin: ${e.name}`);let r=await e.apply(t,o);if(r.dependencies&&(n.dependencies={...n.dependencies,...r.dependencies}),r.devDependencies&&(n.devDependencies={...n.devDependencies,...r.devDependencies}),r.files)for(let e of r.files){let t=N().join(s,"src",e.path);d.ensureDirSync(N().dirname(t)),d.writeFileSync(t,e.content),E(` Created ${e.path}`)}if(r.env)for(let[e,t]of Object.entries(r.env))a.push(`${e}=${t}`);if(r.scripts&&(n.scripts={...n.scripts,...r.scripts}),r.commands)for(let e of r.commands){E(` Running command: ${e}`);try{k(317).execSync(e,{cwd:s,stdio:"inherit"})}catch(t){P(` Command failed: ${e}`)}}return r}async function L(e){let t=N().resolve(process.cwd(),e.projectName);d.existsSync(t)&&(R(`Directory ${e.projectName} already exists.`),process.exit(1)),E(`Creating project in ${t}...`),d.mkdirSync(t);let s=[],u={name:e.projectName,version:"0.0.0",private:!0,type:"module",scripts:{dev:"ts"===e.language?"tsx watch src/index.ts":"nodemon src/index.js",build:"ts"===e.language?"tsup src/index.ts --format esm --platform node --target es2022 --clean":void 0,start:"ts"===e.language?"node dist/index.js":"node src/index.js",..."ts"===e.language?{typecheck:"tsc --noEmit",test:"vitest"}:{}},dependencies:{express:"^4.21.0"},devDependencies:{..."ts"===e.language?{"@types/node":"^20.12.0","@types/express":"^4.17.21",tsup:"^8.1.0",tsx:"^4.19.2",typescript:"^5.7.0"}:{}},engines:{node:">=20.0.0"}};if("rest-swagger"===e.apiType&&(Object.assign(u.dependencies,{"swagger-ui-express":"^5.0.0",zod:"^3.23.8","@asteasolutions/zod-to-openapi":"^7.3.0"}),"ts"===e.language&&Object.assign(u.devDependencies,{"@types/swagger-ui-express":"^4.1.6"})),"jwt"===e.auth&&(Object.assign(u.dependencies,{jsonwebtoken:"^9.0.2"}),"ts"===e.language&&Object.assign(u.devDependencies,{"@types/jsonwebtoken":"^9.0.6"})),"none"!==e.templateEngine){let t="ejs"===e.templateEngine?"^3.1.10":"^3.0.3";if(Object.assign(u.dependencies,{[e.templateEngine]:t}),"ts"===e.language){let t="ejs"===e.templateEngine?"^3.1.5":"^2.0.10";Object.assign(u.devDependencies,{[`@types/${e.templateEngine}`]:t})}}d.writeJsonSync(N().join(t,"package.json"),u,{spaces:2});let y=N().join(t,"src");d.mkdirSync(y),e.language;let f={projectRoot:t,projectName:e.projectName,isTs:"ts"===e.language,language:e.language};await M(o,f,t,u,s),e.validation&&await M(p,f,t,u,s),"rest-swagger"===e.apiType&&await M(c,f,t,u,s),"none"!==e.database&&await M(r,f,t,u,s,{database:e.database}),"jwt"===e.auth&&await M(n,f,t,u,s),"none"!==e.templateEngine&&await M(g,f,t,u,s,{templateEngine:e.templateEngine});let w=s.join("\n")+"\n";d.writeFileSync(N().join(t,".env"),w),d.writeFileSync(N().join(t,".env.example"),w);let v=`import 'dotenv/config';
|
|
3
3
|
import express${"ts"===e.language?", { Request, Response }":""} from 'express';
|
|
4
4
|
import cors from 'cors';
|
|
5
5
|
import helmet from 'helmet';
|
|
6
6
|
import path from 'path';
|
|
7
|
+
import { fileURLToPath } from 'url';
|
|
7
8
|
import pinoHttp from 'pino-http';
|
|
8
9
|
import { rateLimit } from 'express-rate-limit';
|
|
9
10
|
import { logger } from './utils/logger';
|
|
10
11
|
import { errorHandler } from './middleware/errorHandler';
|
|
11
12
|
${"mongodb"===e.database?"import { connectDB } from './lib/db';":""}
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
13
|
+
|
|
14
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
15
|
+
const __dirname = path.dirname(__filename);
|
|
16
|
+
|
|
17
|
+
${"jwt"===e.auth?"import { authRouter } from './routes/auth';\nimport { authenticateToken } from './middleware/auth';":""}
|
|
18
|
+
${"rest-swagger"===e.apiType?"import { swaggerRouter } from './docs/index';":""}
|
|
19
|
+
|
|
16
20
|
const app = express();
|
|
17
21
|
const port = process.env.PORT || 3000;
|
|
18
22
|
|
|
@@ -38,7 +42,7 @@ app.set('view engine', '${e.templateEngine}');
|
|
|
38
42
|
app.use(express.static(path.join(__dirname, 'public')));
|
|
39
43
|
`:""}
|
|
40
44
|
|
|
41
|
-
|
|
45
|
+
`;"rest-swagger"===e.apiType&&(v+=`app.use('/docs', swaggerRouter);
|
|
42
46
|
`),"jwt"===e.auth&&(v+=`app.use('/auth', authRouter);
|
|
43
47
|
`),v+=`app.get('/', (req${"ts"===e.language?": Request":""}, res${"ts"===e.language?": Response":""}) => {
|
|
44
48
|
${"none"!==e.templateEngine?`res.render('index', { title: 'Express App', message: 'Hello from ${e.templateEngine.toUpperCase()}!' });`:"res.json({ status: 'ok', timestamp: new Date().toISOString() });"}
|
|
@@ -56,38 +60,31 @@ app.use(errorHandler);
|
|
|
56
60
|
|
|
57
61
|
// Export app for testing
|
|
58
62
|
export { app };
|
|
59
|
-
`;let h=`
|
|
60
|
-
const server = app.listen(port, () => {
|
|
61
|
-
logger.info(\`Server running on http://localhost:\${port}\`);
|
|
62
|
-
});
|
|
63
63
|
|
|
64
|
-
//
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
logger.info('HTTP server closed');
|
|
69
|
-
process.exit(0);
|
|
64
|
+
// Start server
|
|
65
|
+
if (process.env.NODE_ENV !== 'test') {
|
|
66
|
+
const server = app.listen(port, () => {
|
|
67
|
+
logger.info(\`Server running on http://localhost:\${port}\`);
|
|
70
68
|
});
|
|
71
|
-
};
|
|
72
69
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
70
|
+
// Graceful Shutdown
|
|
71
|
+
const shutdown = () => {
|
|
72
|
+
logger.info('SIGTERM signal received: closing HTTP server');
|
|
73
|
+
server.close(() => {
|
|
74
|
+
logger.info('HTTP server closed');
|
|
75
|
+
process.exit(0);
|
|
76
|
+
});
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
process.on('SIGTERM', shutdown);
|
|
80
|
+
process.on('SIGINT', shutdown);
|
|
84
81
|
}
|
|
85
|
-
`;let
|
|
82
|
+
`;let h="ts"===e.language?"index.ts":"index.js";d.writeFileSync(N().join(y,h),v),await M(m,f,t,u,s),e.linting&&await M(l,f,t,u,s),await M(i,f,t,u,s,{packageManager:e.packageManager,database:e.database}),await M(a,f,t,u,s,{packageManager:e.packageManager}),"ts"===e.language&&d.writeJsonSync(N().join(t,"tsconfig.json"),{compilerOptions:{target:"ES2022",lib:["ES2022"],module:"ESNext",moduleResolution:"bundler",rootDir:"./src",outDir:"./dist",strict:!0,esModuleInterop:!0,skipLibCheck:!0,declaration:!0,sourceMap:!0,noEmit:!0},include:["src/**/*"]},{spaces:2});let j=`node_modules
|
|
86
83
|
dist
|
|
87
84
|
.env
|
|
88
85
|
.DS_Store
|
|
89
|
-
`;
|
|
86
|
+
`;d.writeFileSync(N().join(t,".gitignore"),j),d.writeJsonSync(N().join(t,"package.json"),u,{spaces:2}),E("Installing dependencies...");try{let s=(e.packageManager,"install");k(317).execSync(`${e.packageManager} ${s}`,{cwd:t,stdio:"inherit"})}catch(e){P("Failed to install dependencies. Please run install manually.")}D(`Project ${e.projectName} created successfully!`),console.log(`
|
|
90
87
|
Next steps:`),console.log(` cd ${e.projectName}`),console.log(` ${e.packageManager} run dev`),"prisma-postgres"===e.database&&console.log(` ${e.packageManager} run db:init (To setup Prisma Postgres Managed DB)`),console.log(`
|
|
91
88
|
Happy Coding! 🚀
|
|
92
|
-
`)}let O=y.object({projectName:y.string().min(1).regex(/^[a-z0-9-]+$/,"Project name must be kebab-case (lowercase letters, numbers, and hyphens)"),language:y.enum(["ts","js"]),architecture:y.enum(["feature","mvc"]),apiType:y.enum(["rest","rest-swagger"]),database:y.enum(["postgresql","prisma-postgres","mysql","mongodb","none"]),auth:y.enum(["jwt","none"]),templateEngine:y.enum(["ejs","pug","none"]),packageManager:y.enum(["npm","pnpm","yarn","bun"]),linting:y.boolean(),validation:y.boolean()});async function I(){return await
|
|
93
|
-
Don't forget to register the route in src/index.${o}:`),E(`import { ${e.toLowerCase()}Router } from './routes/${e.toLowerCase()}.routes';`),E(`app.use('/${e.toLowerCase()}s', ${e.toLowerCase()}Router);`)}let
|
|
89
|
+
`)}let O=y.object({projectName:y.string().min(1).regex(/^[a-z0-9-]+$/,"Project name must be kebab-case (lowercase letters, numbers, and hyphens)"),language:y.enum(["ts","js"]),architecture:y.enum(["feature","mvc"]),apiType:y.enum(["rest","rest-swagger"]),database:y.enum(["postgresql","prisma-postgres","mysql","mongodb","none"]),auth:y.enum(["jwt","none"]),templateEngine:y.enum(["ejs","pug","none"]),packageManager:y.enum(["npm","pnpm","yarn","bun"]),linting:y.boolean(),validation:y.boolean()});async function I(){return await u([{type:"text",name:"projectName",message:"What is your project name?",initial:"my-express-app",validate:e=>{let t=O.shape.projectName.safeParse(e);return!!t.success||t.error.issues[0].message}},{type:"select",name:"language",message:"Select language",choices:[{title:"TypeScript (Recommended)",value:"ts"},{title:"JavaScript",value:"js"}],initial:0},{type:"select",name:"packageManager",message:"Select package manager",choices:[{title:"pnpm (Recommended)",value:"pnpm"},{title:"npm",value:"npm"},{title:"Yarn",value:"yarn"},{title:"Bun",value:"bun"}],initial:0},{type:"select",name:"architecture",message:"Select architecture",choices:[{title:"Feature-based (Recommended)",value:"feature",description:"Modules grouped by feature (e.g., users, posts)"},{title:"MVC",value:"mvc",description:"Classic Model-View-Controller structure"}],initial:0},{type:"select",name:"apiType",message:"Select API type",choices:[{title:"REST API + Swagger",value:"rest-swagger"},{title:"REST API (Basic)",value:"rest"}],initial:0},{type:"select",name:"database",message:"Select database",choices:[{title:"PostgreSQL (Prisma)",value:"postgresql"},{title:"PostgreSQL (Prisma Postgres Managed)",value:"prisma-postgres"},{title:"MySQL (Prisma)",value:"mysql"},{title:"MongoDB (Mongoose)",value:"mongodb"},{title:"None",value:"none"}],initial:0},{type:"select",name:"auth",message:"Select authentication",choices:[{title:"JWT (JSON Web Token)",value:"jwt"},{title:"None",value:"none"}],initial:0},{type:"select",name:"templateEngine",message:"Select template engine",choices:[{title:"EJS (Embedded JavaScript)",value:"ejs"},{title:"Pug (Jade)",value:"pug"},{title:"None (API only)",value:"none"}],initial:0},{type:"confirm",name:"linting",message:"Do you want to include code quality tools (Linting & Formatting)?",initial:!0},{type:"confirm",name:"validation",message:"Do you want to include runtime validation (Zod)?",initial:!0}],{onCancel:()=>{R("Operation cancelled"),process.exit(1)}})}let _=new t("init").description("Initialize a new Express.js project").action(async()=>{let e=await I();await L(e)});async function q(e){let t=process.cwd(),s=N().join(t,"package.json");d.existsSync(s)||(R("No package.json found. Are you in the root of the project?"),process.exit(1));let n=d.readJsonSync(s),a=d.existsSync(N().join(t,"tsconfig.json"))||n.devDependencies&&n.devDependencies.typescript||n.dependencies&&n.dependencies.typescript,o=a?"ts":"js",r=N().join(t,"src"),i=N().join(r,"controllers"),p=N().join(r,"routes"),l=N().join(t,"test");d.ensureDirSync(i),d.ensureDirSync(p),d.ensureDirSync(l);let c=e.charAt(0).toUpperCase()+e.slice(1),m=N().join(i,`${e.toLowerCase()}.controller.${o}`);d.existsSync(m)?P(`Controller ${m} already exists. Skipping.`):(d.writeFileSync(m,a?w(c):f(c)),E(`Created controller: src/controllers/${e.toLowerCase()}.controller.${o}`));let g=N().join(p,`${e.toLowerCase()}.routes.${o}`);d.existsSync(g)?P(`Route ${g} already exists. Skipping.`):(d.writeFileSync(g,a?h(c):v(c)),E(`Created route: src/routes/${e.toLowerCase()}.routes.${o}`));let u=N().join(l,`${e.toLowerCase()}.test.${o}`);d.existsSync(u)?P(`Test ${u} already exists. Skipping.`):(d.writeFileSync(u,a?x(c):j(c)),E(`Created test: test/${e.toLowerCase()}.test.${o}`)),D(`Feature ${e} generated successfully!`),E(`
|
|
90
|
+
Don't forget to register the route in src/index.${o}:`),E(`import { ${e.toLowerCase()}Router } from './routes/${e.toLowerCase()}.routes';`),E(`app.use('/${e.toLowerCase()}s', ${e.toLowerCase()}Router);`)}let F=new t().name("generate").alias("g").description("Generate a new feature (controller, routes, test)").argument("<name>","Name of the feature (e.g. users, blogs)").action(async e=>{await q(e)}),J=new t().name("info").description("Print debugging information about your environment").action(async()=>{console.log(" System:"),await S.run({System:["OS","CPU","Memory","Shell"],Binaries:["Node","Yarn","npm","pnpm"],Utilities:["Git"],IDEs:["VSCode"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:["typescript","express","express-tool"]},{console:!0,showNotFound:!0})}),H=b("https");var U=k.n(H);let A=new t().name("upgrade").description("Check for updates").action(async()=>{E("Checking for updates...");let e=C.rE,t=C.UU;try{var s;let n=await (s=t,new Promise(e=>{U().get(`https://registry.npmjs.org/${s}/latest`,t=>{let s="";t.on("data",e=>s+=e),t.on("end",()=>{try{let t=JSON.parse(s);e(t.version)}catch{e(null)}})}).on("error",()=>e(null))}));if(!n)return void P("Could not fetch latest version info.");n!==e?(E(`New version available: ${n} (current: ${e})`),E(`Run 'npm install -g ${t}' to update.`)):D("You are using the latest version.")}catch(e){R("Failed to check for updates.")}}),{rE:B}=C,G=new t;G.name("express-tool").description("Production-grade CLI for Express.js applications").version(B),G.hook("preAction",()=>{E("Welcome to express-tool CLI")}),G.addCommand(_),G.addCommand(F),G.addCommand(J),G.addCommand(A)},317(e){e.exports=b("child_process")}},C={};function E(e){var t=C[e];if(void 0!==t)return t.exports;var s=C[e]={exports:{}};return k[e](s,s.exports,E),s.exports}E.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return E.d(t,{a:t}),t},E.d=(e,t)=>{for(var s in t)E.o(t,s)&&!E.o(e,s)&&Object.defineProperty(e,s,{enumerable:!0,get:t[s]})},E.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),E(656).x.parse(process.argv);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.generator.d.ts","sourceRoot":"","sources":["../../src/commands/generate.generator.ts"],"names":[],"mappings":"AAgBA,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"generate.generator.d.ts","sourceRoot":"","sources":["../../src/commands/generate.generator.ts"],"names":[],"mappings":"AAgBA,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,MAAM,iBAiElD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.generator.d.ts","sourceRoot":"","sources":["../../src/commands/init.generator.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,wBAAsB,eAAe,CAAC,OAAO,EAAE,WAAW,
|
|
1
|
+
{"version":3,"file":"init.generator.d.ts","sourceRoot":"","sources":["../../src/commands/init.generator.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,wBAAsB,eAAe,CAAC,OAAO,EAAE,WAAW,iBAgUzD"}
|
package/dist/index.js
CHANGED
|
@@ -1,17 +1,21 @@
|
|
|
1
|
-
import{createRequire as e}from"node:module";let t=e(import.meta.url);import{Command as s}from"commander";import
|
|
1
|
+
import{createRequire as e}from"node:module";let t=e(import.meta.url);import{Command as s}from"commander";import n from"picocolors";import{authPlugin as a}from"@express-tool/plugin-auth";import{ciPlugin as o}from"@express-tool/plugin-ci";import{commonPlugin as r}from"@express-tool/plugin-common";import{databasePlugin as i}from"@express-tool/plugin-database";import{dockerPlugin as p}from"@express-tool/plugin-docker";import{middlewarePlugin as l}from"@express-tool/plugin-middleware";import{qualityPlugin as c}from"@express-tool/plugin-quality";import{swaggerPlugin as g}from"@express-tool/plugin-swagger";import{testingPlugin as m}from"@express-tool/plugin-testing";import{viewsPlugin as d}from"@express-tool/plugin-views";import u from"fs-extra";import y from"prompts";import{z as f}from"zod";import{controllerJs as w,controllerTs as v,routesJs as h,routesTs as j,testJs as x,testTs as S}from"@express-tool/plugin-resource";import $ from"envinfo";var b={317(e){e.exports=t("child_process")}},k={};function C(e){var t=k[e];if(void 0!==t)return t.exports;var s=k[e]={exports:{}};return b[e](s,s.exports,C),s.exports}C.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return C.d(t,{a:t}),t},C.d=(e,t)=>{for(var s in t)C.o(t,s)&&!C.o(e,s)&&Object.defineProperty(e,s,{enumerable:!0,get:t[s]})},C.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t);var E={};(()=>{C.d(E,{x:()=>B});var e=JSON.parse('{"UU":"@express-tool/cli","rE":"1.0.3"}');let b=e=>console.log(n.blue("ℹ"),e),k=e=>console.log(n.green("✔"),e),D=e=>console.log(n.yellow("⚠"),e),P=e=>console.log(n.red("✖"),e),R=t("path");var T=C.n(R);async function N(e,t,s,n,a,o){b(`Applying plugin: ${e.name}`);let r=await e.apply(t,o);if(r.dependencies&&(n.dependencies={...n.dependencies,...r.dependencies}),r.devDependencies&&(n.devDependencies={...n.devDependencies,...r.devDependencies}),r.files)for(let e of r.files){let t=T().join(s,"src",e.path);u.ensureDirSync(T().dirname(t)),u.writeFileSync(t,e.content),b(` Created ${e.path}`)}if(r.env)for(let[e,t]of Object.entries(r.env))a.push(`${e}=${t}`);if(r.scripts&&(n.scripts={...n.scripts,...r.scripts}),r.commands)for(let e of r.commands){b(` Running command: ${e}`);try{C(317).execSync(e,{cwd:s,stdio:"inherit"})}catch(t){D(` Command failed: ${e}`)}}return r}async function M(e){let t=T().resolve(process.cwd(),e.projectName);u.existsSync(t)&&(P(`Directory ${e.projectName} already exists.`),process.exit(1)),b(`Creating project in ${t}...`),u.mkdirSync(t);let s=[],n={name:e.projectName,version:"0.0.0",private:!0,type:"module",scripts:{dev:"ts"===e.language?"tsx watch src/index.ts":"nodemon src/index.js",build:"ts"===e.language?"tsup src/index.ts --format esm --platform node --target es2022 --clean":void 0,start:"ts"===e.language?"node dist/index.js":"node src/index.js",..."ts"===e.language?{typecheck:"tsc --noEmit",test:"vitest"}:{}},dependencies:{express:"^4.21.0"},devDependencies:{..."ts"===e.language?{"@types/node":"^20.12.0","@types/express":"^4.17.21",tsup:"^8.1.0",tsx:"^4.19.2",typescript:"^5.7.0"}:{}},engines:{node:">=20.0.0"}};if("rest-swagger"===e.apiType&&(Object.assign(n.dependencies,{"swagger-ui-express":"^5.0.0",zod:"^3.23.8","@asteasolutions/zod-to-openapi":"^7.3.0"}),"ts"===e.language&&Object.assign(n.devDependencies,{"@types/swagger-ui-express":"^4.1.6"})),"jwt"===e.auth&&(Object.assign(n.dependencies,{jsonwebtoken:"^9.0.2"}),"ts"===e.language&&Object.assign(n.devDependencies,{"@types/jsonwebtoken":"^9.0.6"})),"none"!==e.templateEngine){let t="ejs"===e.templateEngine?"^3.1.10":"^3.0.3";if(Object.assign(n.dependencies,{[e.templateEngine]:t}),"ts"===e.language){let t="ejs"===e.templateEngine?"^3.1.5":"^2.0.10";Object.assign(n.devDependencies,{[`@types/${e.templateEngine}`]:t})}}u.writeJsonSync(T().join(t,"package.json"),n,{spaces:2});let y=T().join(t,"src");u.mkdirSync(y),e.language;let f={projectRoot:t,projectName:e.projectName,isTs:"ts"===e.language,language:e.language};await N(r,f,t,n,s),e.validation&&await N(l,f,t,n,s),"rest-swagger"===e.apiType&&await N(g,f,t,n,s),"none"!==e.database&&await N(i,f,t,n,s,{database:e.database}),"jwt"===e.auth&&await N(a,f,t,n,s),"none"!==e.templateEngine&&await N(d,f,t,n,s,{templateEngine:e.templateEngine});let w=s.join("\n")+"\n";u.writeFileSync(T().join(t,".env"),w),u.writeFileSync(T().join(t,".env.example"),w);let v=`import 'dotenv/config';
|
|
2
2
|
import express${"ts"===e.language?", { Request, Response }":""} from 'express';
|
|
3
3
|
import cors from 'cors';
|
|
4
4
|
import helmet from 'helmet';
|
|
5
5
|
import path from 'path';
|
|
6
|
+
import { fileURLToPath } from 'url';
|
|
6
7
|
import pinoHttp from 'pino-http';
|
|
7
8
|
import { rateLimit } from 'express-rate-limit';
|
|
8
9
|
import { logger } from './utils/logger';
|
|
9
10
|
import { errorHandler } from './middleware/errorHandler';
|
|
10
11
|
${"mongodb"===e.database?"import { connectDB } from './lib/db';":""}
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
|
|
13
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
14
|
+
const __dirname = path.dirname(__filename);
|
|
15
|
+
|
|
16
|
+
${"jwt"===e.auth?"import { authRouter } from './routes/auth';\nimport { authenticateToken } from './middleware/auth';":""}
|
|
17
|
+
${"rest-swagger"===e.apiType?"import { swaggerRouter } from './docs/index';":""}
|
|
18
|
+
|
|
15
19
|
const app = express();
|
|
16
20
|
const port = process.env.PORT || 3000;
|
|
17
21
|
|
|
@@ -37,7 +41,7 @@ app.set('view engine', '${e.templateEngine}');
|
|
|
37
41
|
app.use(express.static(path.join(__dirname, 'public')));
|
|
38
42
|
`:""}
|
|
39
43
|
|
|
40
|
-
|
|
44
|
+
`;"rest-swagger"===e.apiType&&(v+=`app.use('/docs', swaggerRouter);
|
|
41
45
|
`),"jwt"===e.auth&&(v+=`app.use('/auth', authRouter);
|
|
42
46
|
`),v+=`app.get('/', (req${"ts"===e.language?": Request":""}, res${"ts"===e.language?": Response":""}) => {
|
|
43
47
|
${"none"!==e.templateEngine?`res.render('index', { title: 'Express App', message: 'Hello from ${e.templateEngine.toUpperCase()}!' });`:"res.json({ status: 'ok', timestamp: new Date().toISOString() });"}
|
|
@@ -55,38 +59,31 @@ app.use(errorHandler);
|
|
|
55
59
|
|
|
56
60
|
// Export app for testing
|
|
57
61
|
export { app };
|
|
58
|
-
`;let h=`
|
|
59
|
-
const server = app.listen(port, () => {
|
|
60
|
-
logger.info(\`Server running on http://localhost:\${port}\`);
|
|
61
|
-
});
|
|
62
62
|
|
|
63
|
-
//
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
logger.info('HTTP server closed');
|
|
68
|
-
process.exit(0);
|
|
63
|
+
// Start server
|
|
64
|
+
if (process.env.NODE_ENV !== 'test') {
|
|
65
|
+
const server = app.listen(port, () => {
|
|
66
|
+
logger.info(\`Server running on http://localhost:\${port}\`);
|
|
69
67
|
});
|
|
70
|
-
};
|
|
71
68
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
69
|
+
// Graceful Shutdown
|
|
70
|
+
const shutdown = () => {
|
|
71
|
+
logger.info('SIGTERM signal received: closing HTTP server');
|
|
72
|
+
server.close(() => {
|
|
73
|
+
logger.info('HTTP server closed');
|
|
74
|
+
process.exit(0);
|
|
75
|
+
});
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
process.on('SIGTERM', shutdown);
|
|
79
|
+
process.on('SIGINT', shutdown);
|
|
83
80
|
}
|
|
84
|
-
`;let
|
|
81
|
+
`;let h="ts"===e.language?"index.ts":"index.js";u.writeFileSync(T().join(y,h),v),await N(m,f,t,n,s),e.linting&&await N(c,f,t,n,s),await N(p,f,t,n,s,{packageManager:e.packageManager,database:e.database}),await N(o,f,t,n,s,{packageManager:e.packageManager}),"ts"===e.language&&u.writeJsonSync(T().join(t,"tsconfig.json"),{compilerOptions:{target:"ES2022",lib:["ES2022"],module:"ESNext",moduleResolution:"bundler",rootDir:"./src",outDir:"./dist",strict:!0,esModuleInterop:!0,skipLibCheck:!0,declaration:!0,sourceMap:!0,noEmit:!0},include:["src/**/*"]},{spaces:2});let j=`node_modules
|
|
85
82
|
dist
|
|
86
83
|
.env
|
|
87
84
|
.DS_Store
|
|
88
|
-
`;
|
|
85
|
+
`;u.writeFileSync(T().join(t,".gitignore"),j),u.writeJsonSync(T().join(t,"package.json"),n,{spaces:2}),b("Installing dependencies...");try{let s=(e.packageManager,"install");C(317).execSync(`${e.packageManager} ${s}`,{cwd:t,stdio:"inherit"})}catch(e){D("Failed to install dependencies. Please run install manually.")}k(`Project ${e.projectName} created successfully!`),console.log(`
|
|
89
86
|
Next steps:`),console.log(` cd ${e.projectName}`),console.log(` ${e.packageManager} run dev`),"prisma-postgres"===e.database&&console.log(` ${e.packageManager} run db:init (To setup Prisma Postgres Managed DB)`),console.log(`
|
|
90
87
|
Happy Coding! 🚀
|
|
91
|
-
`)}let L=f.object({projectName:f.string().min(1).regex(/^[a-z0-9-]+$/,"Project name must be kebab-case (lowercase letters, numbers, and hyphens)"),language:f.enum(["ts","js"]),architecture:f.enum(["feature","mvc"]),apiType:f.enum(["rest","rest-swagger"]),database:f.enum(["postgresql","prisma-postgres","mysql","mongodb","none"]),auth:f.enum(["jwt","none"]),templateEngine:f.enum(["ejs","pug","none"]),packageManager:f.enum(["npm","pnpm","yarn","bun"]),linting:f.boolean(),validation:f.boolean()});async function
|
|
92
|
-
Don't forget to register the route in src/index.${o}:`),b(`import { ${e.toLowerCase()}Router } from './routes/${e.toLowerCase()}.routes';`),b(`app.use('/${e.toLowerCase()}s', ${e.toLowerCase()}Router);`)}let q=new s().name("generate").alias("g").description("Generate a new feature (controller, routes, test)").argument("<name>","Name of the feature (e.g. users, blogs)").action(async e=>{await
|
|
88
|
+
`)}let L=f.object({projectName:f.string().min(1).regex(/^[a-z0-9-]+$/,"Project name must be kebab-case (lowercase letters, numbers, and hyphens)"),language:f.enum(["ts","js"]),architecture:f.enum(["feature","mvc"]),apiType:f.enum(["rest","rest-swagger"]),database:f.enum(["postgresql","prisma-postgres","mysql","mongodb","none"]),auth:f.enum(["jwt","none"]),templateEngine:f.enum(["ejs","pug","none"]),packageManager:f.enum(["npm","pnpm","yarn","bun"]),linting:f.boolean(),validation:f.boolean()});async function _(){return await y([{type:"text",name:"projectName",message:"What is your project name?",initial:"my-express-app",validate:e=>{let t=L.shape.projectName.safeParse(e);return!!t.success||t.error.issues[0].message}},{type:"select",name:"language",message:"Select language",choices:[{title:"TypeScript (Recommended)",value:"ts"},{title:"JavaScript",value:"js"}],initial:0},{type:"select",name:"packageManager",message:"Select package manager",choices:[{title:"pnpm (Recommended)",value:"pnpm"},{title:"npm",value:"npm"},{title:"Yarn",value:"yarn"},{title:"Bun",value:"bun"}],initial:0},{type:"select",name:"architecture",message:"Select architecture",choices:[{title:"Feature-based (Recommended)",value:"feature",description:"Modules grouped by feature (e.g., users, posts)"},{title:"MVC",value:"mvc",description:"Classic Model-View-Controller structure"}],initial:0},{type:"select",name:"apiType",message:"Select API type",choices:[{title:"REST API + Swagger",value:"rest-swagger"},{title:"REST API (Basic)",value:"rest"}],initial:0},{type:"select",name:"database",message:"Select database",choices:[{title:"PostgreSQL (Prisma)",value:"postgresql"},{title:"PostgreSQL (Prisma Postgres Managed)",value:"prisma-postgres"},{title:"MySQL (Prisma)",value:"mysql"},{title:"MongoDB (Mongoose)",value:"mongodb"},{title:"None",value:"none"}],initial:0},{type:"select",name:"auth",message:"Select authentication",choices:[{title:"JWT (JSON Web Token)",value:"jwt"},{title:"None",value:"none"}],initial:0},{type:"select",name:"templateEngine",message:"Select template engine",choices:[{title:"EJS (Embedded JavaScript)",value:"ejs"},{title:"Pug (Jade)",value:"pug"},{title:"None (API only)",value:"none"}],initial:0},{type:"confirm",name:"linting",message:"Do you want to include code quality tools (Linting & Formatting)?",initial:!0},{type:"confirm",name:"validation",message:"Do you want to include runtime validation (Zod)?",initial:!0}],{onCancel:()=>{P("Operation cancelled"),process.exit(1)}})}let O=new s("init").description("Initialize a new Express.js project").action(async()=>{let e=await _();await M(e)});async function I(e){let t=process.cwd(),s=T().join(t,"package.json");u.existsSync(s)||(P("No package.json found. Are you in the root of the project?"),process.exit(1));let n=u.readJsonSync(s),a=u.existsSync(T().join(t,"tsconfig.json"))||n.devDependencies&&n.devDependencies.typescript||n.dependencies&&n.dependencies.typescript,o=a?"ts":"js",r=T().join(t,"src"),i=T().join(r,"controllers"),p=T().join(r,"routes"),l=T().join(t,"test");u.ensureDirSync(i),u.ensureDirSync(p),u.ensureDirSync(l);let c=e.charAt(0).toUpperCase()+e.slice(1),g=T().join(i,`${e.toLowerCase()}.controller.${o}`);u.existsSync(g)?D(`Controller ${g} already exists. Skipping.`):(u.writeFileSync(g,a?v(c):w(c)),b(`Created controller: src/controllers/${e.toLowerCase()}.controller.${o}`));let m=T().join(p,`${e.toLowerCase()}.routes.${o}`);u.existsSync(m)?D(`Route ${m} already exists. Skipping.`):(u.writeFileSync(m,a?j(c):h(c)),b(`Created route: src/routes/${e.toLowerCase()}.routes.${o}`));let d=T().join(l,`${e.toLowerCase()}.test.${o}`);u.existsSync(d)?D(`Test ${d} already exists. Skipping.`):(u.writeFileSync(d,a?S(c):x(c)),b(`Created test: test/${e.toLowerCase()}.test.${o}`)),k(`Feature ${e} generated successfully!`),b(`
|
|
89
|
+
Don't forget to register the route in src/index.${o}:`),b(`import { ${e.toLowerCase()}Router } from './routes/${e.toLowerCase()}.routes';`),b(`app.use('/${e.toLowerCase()}s', ${e.toLowerCase()}Router);`)}let q=new s().name("generate").alias("g").description("Generate a new feature (controller, routes, test)").argument("<name>","Name of the feature (e.g. users, blogs)").action(async e=>{await I(e)}),F=new s().name("info").description("Print debugging information about your environment").action(async()=>{console.log(" System:"),await $.run({System:["OS","CPU","Memory","Shell"],Binaries:["Node","Yarn","npm","pnpm"],Utilities:["Git"],IDEs:["VSCode"],Browsers:["Chrome","Edge","Firefox","Safari"],npmPackages:["typescript","express","express-tool"]},{console:!0,showNotFound:!0})}),J=t("https");var H=C.n(J);let U=new s().name("upgrade").description("Check for updates").action(async()=>{b("Checking for updates...");let t=e.rE,s=e.UU;try{var n;let e=await (n=s,new Promise(e=>{H().get(`https://registry.npmjs.org/${n}/latest`,t=>{let s="";t.on("data",e=>s+=e),t.on("end",()=>{try{let t=JSON.parse(s);e(t.version)}catch{e(null)}})}).on("error",()=>e(null))}));if(!e)return void D("Could not fetch latest version info.");e!==t?(b(`New version available: ${e} (current: ${t})`),b(`Run 'npm install -g ${s}' to update.`)):k("You are using the latest version.")}catch(e){P("Failed to check for updates.")}}),{rE:A}=e,B=new s;B.name("express-tool").description("Production-grade CLI for Express.js applications").version(A),B.hook("preAction",()=>{b("Welcome to express-tool CLI")}),B.addCommand(O),B.addCommand(q),B.addCommand(F),B.addCommand(U)})();var D=E.x;export{D as cli};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@express-tool/cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Production-grade CLI for Express.js applications",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"express",
|
|
@@ -41,18 +41,18 @@
|
|
|
41
41
|
"picocolors": "^1.1.1",
|
|
42
42
|
"prompts": "^2.4.2",
|
|
43
43
|
"zod": "^4.3.6",
|
|
44
|
-
"@express-tool/
|
|
45
|
-
"@express-tool/
|
|
46
|
-
"@express-tool/plugin-
|
|
47
|
-
"@express-tool/plugin-
|
|
48
|
-
"@express-tool/plugin-
|
|
49
|
-
"@express-tool/plugin-middleware": "1.0.
|
|
50
|
-
"@express-tool/plugin-
|
|
51
|
-
"@express-tool/plugin-
|
|
52
|
-
"@express-tool/plugin-
|
|
53
|
-
"@express-tool/plugin-resource": "1.0.
|
|
54
|
-
"@express-tool/plugin-
|
|
55
|
-
"@express-tool/plugin-
|
|
44
|
+
"@express-tool/plugin-auth": "1.0.2",
|
|
45
|
+
"@express-tool/core": "1.0.2",
|
|
46
|
+
"@express-tool/plugin-common": "1.0.3",
|
|
47
|
+
"@express-tool/plugin-database": "1.0.2",
|
|
48
|
+
"@express-tool/plugin-swagger": "1.0.2",
|
|
49
|
+
"@express-tool/plugin-middleware": "1.0.2",
|
|
50
|
+
"@express-tool/plugin-views": "1.0.2",
|
|
51
|
+
"@express-tool/plugin-docker": "1.0.2",
|
|
52
|
+
"@express-tool/plugin-testing": "1.0.2",
|
|
53
|
+
"@express-tool/plugin-resource": "1.0.2",
|
|
54
|
+
"@express-tool/plugin-quality": "1.0.2",
|
|
55
|
+
"@express-tool/plugin-ci": "1.0.2"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
58
58
|
"@rsbuild/core": "^1.7.3",
|