create-openibm 0.1.0 → 0.1.2

package/dist/templates/base.js

@@ -12,10 +12,6 @@ function schemaIbmi(a) {
         `    transport = env("IBMI_TRANSPORT")`,
         `    system    = env("IBMI_SYSTEM")`,
         `}`,
-        ``,
-        `generator client {`,
-        `    output = "./src/generated/ibmi"`,
-        `}`,
     ];
     if (a.features.includes('program')) {
         blocks.push(``, `// RPG/COBOL program — JS name maps to actual IBM i program via @map`, `program SimpleCalc @map("SIMPLECALC") {`, `    library = "MYLIB"`, `    input   PackedDecimal(15, 0) @in`, `    output  PackedDecimal(16, 0) @out`, `}`);
@@ -48,9 +44,6 @@ function gitignore() {
         '.env',
         '*.tsbuildinfo',
         '',
-        '# Generated IBM i client — re-create with: npm run generate',
-        'src/generated/',
-        '',
         '# OS',
         '.DS_Store',
         'Thumbs.db',

package/dist/templates/basic.d.ts

@@ -7,5 +7,11 @@ export declare function clientConfigBlock(a: Answers): string;
  * pulling @openibm/* from the globally linked monorepo packages.
  */
 export declare function linkDevScriptMjs(): string;
+/**
+ * Stub for src/generated/ibmi/index.ts — created by `npm run generate`.
+ * Allows the server to boot without a real IBM i connection.
+ * Replace by running: npm run generate
+ */
+export declare function generatedStub(): string;
 /** Zod-based IBM i data-type validators — shared by basic + express templates */
 export declare function ibmiValidatorsTs(): string;

package/dist/templates/basic.js

@@ -51,6 +51,10 @@ function tsconfig() {
             esModuleInterop: true,
             skipLibCheck: true,
             forceConsistentCasingInFileNames: true,
+            baseUrl: '.',
+            paths: {
+                'openibm': ['./node_modules/openibm/index.ts'],
+            },
         },
         include: ['src'],
         exclude: ['node_modules', 'dist'],
@@ -61,7 +65,7 @@ function indexTs(a) {
     const hasProgram = a.features.includes('program');
     const hasTable = a.features.includes('table');
     const imports = [
-        `import { createClient } from './generated/ibmi/index.js';`,
+        `import { createClient } from 'openibm';`,
         ...(a.transport === 'odbc' ? [`import 'odbc';`] : []),
     ];
     const clientConfig = clientConfigBlock(a);
@@ -235,6 +239,45 @@ export function linkDevScriptMjs() {
         ``,
     ].join('\n');
 }
+/**
+ * Stub for src/generated/ibmi/index.ts — created by `npm run generate`.
+ * Allows the server to boot without a real IBM i connection.
+ * Replace by running: npm run generate
+ */
+export function generatedStub() {
+    return [
+        `// AUTO-GENERATED STUB — run \`npm run generate\` to replace with the real IBM i client.`,
+        `/* eslint-disable */`,
+        ``,
+        `export function createClient(_config: any): {`,
+        `    connect(): Promise<void>;`,
+        `    disconnect(): Promise<void>;`,
+        `    isConnected(): boolean;`,
+        `    query: Record<string, any>;`,
+        `    program: Record<string, any>;`,
+        `} {`,
+        `    const warn = () =>`,
+        `        console.warn('\\x1b[33m[openibm]\\x1b[0m Stub client — run \`npm run generate\` to connect to IBM i');`,
+        ``,
+        `    const tableProxy: any = new Proxy({}, {`,
+        `        get: (_t, method) => {`,
+        `            if (method === 'findMany')  return async () => { warn(); return []; };`,
+        `            if (method === 'findFirst') return async () => { warn(); return null; };`,
+        `            return async () => { warn(); return null; };`,
+        `        },`,
+        `    });`,
+        ``,
+        `    return {`,
+        `        connect:     async () => { warn(); },`,
+        `        disconnect:  async () => {},`,
+        `        isConnected: () => false,`,
+        `        query:   new Proxy({}, { get: () => tableProxy }),`,
+        `        program: new Proxy({}, { get: () => async (..._a: any[]) => { warn(); return {}; } }),`,
+        `    };`,
+        `}`,
+        ``,
+    ].join('\n');
+}
 /** Zod-based IBM i data-type validators — shared by basic + express templates */
 export function ibmiValidatorsTs() {
     return [

package/dist/templates/express.js

@@ -2,14 +2,32 @@ import { clientConfigBlock, ibmiValidatorsTs, linkDevScriptMjs } from './basic.j
 export function expressFiles(a) {
     const hasProgram = a.features.includes('program');
     const hasTable = a.features.includes('table');
-    return {
+    const files = {
         'package.json': packageJson(a),
         'tsconfig.json': tsconfig(),
-        'src/index.ts': indexTs(a, hasProgram, hasTable),
+        'nodemon.json': nodemonJson(),
+        'src/index.ts': indexTs(),
+        'src/app.ts': appTs(hasProgram, hasTable),
+        'src/client.ts': clientTs(a),
+        'src/docs.ts': docsTs(a, hasProgram, hasTable),
+        'src/routes/index.ts': routesIndex(hasProgram, hasTable),
+        'src/routes/health.routes.ts': healthRoutes(),
+        'src/controllers/health.controller.ts': healthController(),
         'src/ibmi-validators.ts': ibmiValidatorsTs(),
         'scripts/link-dev.mjs': linkDevScriptMjs(),
+        '.vscode/settings.json': vscodeSettings(),
+        '.vscode/extensions.json': vscodeExtensions(),
         'README.md': readme(a, hasProgram, hasTable),
     };
+    if (hasTable) {
+        files['src/routes/customers.routes.ts'] = customersRoutes();
+        files['src/controllers/customers.controller.ts'] = customersController();
+    }
+    if (hasProgram) {
+        files['src/routes/calculate.routes.ts'] = calculateRoutes();
+        files['src/controllers/calculate.controller.ts'] = calculateController();
+    }
+    return files;
 }
 // ── package.json ──────────────────────────────────────────────────────────────
 function packageJson(a) {
@@ -21,13 +39,14 @@ function packageJson(a) {
         scripts: {
             generate: 'openibm generate',
             build: 'tsc --project tsconfig.json',
-            dev: 'node --env-file=.env --import tsx/esm src/index.ts',
+            dev: 'nodemon',
             start: 'node dist/index.js',
             'link:dev': 'node scripts/link-dev.mjs',
         },
         dependencies: {
             '@openibm/driver': '^0.1.0',
             '@openibm/types': '^0.1.0',
+            '@scalar/express-api-reference': '^0.4.0',
             express: '^4.21.0',
             morgan: '^1.10.0',
             'swagger-ui-express': '^5.0.0',
@@ -41,6 +60,7 @@ function packageJson(a) {
             '@types/morgan': '^1.9.0',
             '@types/swagger-ui-express': '^4.1.0',
             '@types/node': '^22.0.0',
+            nodemon: '^3.1.0',
             tsx: '^4.0.0',
             typescript: '^5.7.0',
         },
@@ -60,14 +80,80 @@ function tsconfig() {
             esModuleInterop: true,
             skipLibCheck: true,
             forceConsistentCasingInFileNames: true,
+            baseUrl: '.',
+            paths: {
+                'openibm': ['./node_modules/openibm/index.ts'],
+            },
         },
         include: ['src'],
         exclude: ['node_modules', 'dist'],
     }, null, 4) + '\n';
 }
+// ── nodemon.json ──────────────────────────────────────────────────────────────
+function nodemonJson() {
+    return JSON.stringify({
+        watch: ['src'],
+        ext: 'ts,json',
+        exec: 'node --env-file=.env --import tsx/esm src/index.ts',
+    }, null, 4) + '\n';
+}
 // ── src/index.ts ──────────────────────────────────────────────────────────────
-function indexTs(a, hasProgram, hasTable) {
-    // ── Swagger paths (built conditionally) ──────────────────────────────────
+function indexTs() {
+    return [
+        `import { client } from './client.js';`,
+        `import app from './app.js';`,
+        ``,
+        `const PORT = Number(process.env.PORT ?? 3000);`,
+        ``,
+        `app.listen(PORT, async () => {`,
+        `    await client.connect();`,
+        `    console.log(\`Server:  http://localhost:\${PORT}\`);`,
+        `    console.log(\`Swagger: http://localhost:\${PORT}/api-docs\`);`,
+        `    console.log(\`Scalar:  http://localhost:\${PORT}/scalar\`);`,
+        `});`,
+        ``,
+    ].join('\n');
+}
+// ── src/app.ts ────────────────────────────────────────────────────────────────
+function appTs(hasProgram, hasTable) {
+    return [
+        `import express from 'express';`,
+        `import morgan from 'morgan';`,
+        `import { setupDocs } from './docs.js';`,
+        `import router from './routes/index.js';`,
+        ``,
+        `const app = express();`,
+        ``,
+        `// ── Middleware ────────────────────────────────────────────────────────────────`,
+        ``,
+        `app.use(express.json());`,
+        `app.use(morgan('dev'));`,
+        ``,
+        `// ── API docs ──────────────────────────────────────────────────────────────────`,
+        ``,
+        `setupDocs(app);`,
+        ``,
+        `// ── Routes ───────────────────────────────────────────────────────────────────`,
+        ``,
+        `app.use('/', router);`,
+        ``,
+        `export default app;`,
+        ``,
+    ].join('\n');
+}
+// ── src/client.ts ─────────────────────────────────────────────────────────────
+function clientTs(a) {
+    return [
+        `import { createClient } from 'openibm';`,
+        ``,
+        clientConfigBlock(a),
+        ``,
+        `export { client };`,
+        ``,
+    ].join('\n');
+}
+// ── src/docs.ts ───────────────────────────────────────────────────────────────
+function docsTs(a, hasProgram, hasTable) {
     const swaggerPaths = [
         `        '/health': {`,
         `            get: {`,
@@ -85,73 +171,259 @@ function indexTs(a, hasProgram, hasTable) {
     if (hasProgram) {
         swaggerPaths.push(`        '/calculate': {`, `            post: {`, `                tags: ['Programs'],`, `                summary: 'Call SimpleCalc IBM i program',`, `                requestBody: {`, `                    required: true,`, `                    content: {`, `                        'application/json': {`, `                            schema: {`, `                                type: 'object',`, `                                required: ['input'],`, `                                properties: { input: { type: 'integer', example: 5, description: 'IBM i INTEGER' } },`, `                            },`, `                        },`, `                    },`, `                },`, `                responses: {`, `                    '200': { description: 'Calculation result', content: { 'application/json': { schema: { example: { input: 5, output: 500 } } } } },`, `                    '400': { description: 'Validation error' },`, `                },`, `            },`, `        },`);
     }
-    // ── Routes ───────────────────────────────────────────────────────────────
-    const routes = [
-        `// ── Health ───────────────────────────────────────────────────────────────────`,
+    return [
+        `import type { Express } from 'express';`,
+        `import swaggerUi from 'swagger-ui-express';`,
+        `import { apiReference } from '@scalar/express-api-reference';`,
         ``,
-        `app.get('/health', (_req, res) => {`,
-        `    res.json({ status: 'ok', connected: client.isConnected() });`,
-        `});`,
+        `export const apiSpec = {`,
+        `    openapi: '3.0.0',`,
+        `    info: { title: '${a.projectName}', version: '1.0.0', description: 'IBM i REST API' },`,
+        `    paths: {`,
+        ...swaggerPaths,
+        `    },`,
+        `};`,
+        ``,
+        `export function setupDocs(app: Express): void {`,
+        `    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(apiSpec as any));`,
+        `    app.use(`,
+        `        '/scalar',`,
+        `        apiReference({ spec: { content: apiSpec } }) as any,`,
+        `    );`,
+        `}`,
+        ``,
+    ].join('\n');
+}
+// ── src/routes/index.ts ───────────────────────────────────────────────────────
+function routesIndex(hasProgram, hasTable) {
+    const imports = [
+        `import { Router } from 'express';`,
+        `import healthRouter from './health.routes.js';`,
     ];
-    if (hasTable) {
-        routes.push(``, `// ── Customers ────────────────────────────────────────────────────────────────`, ``, `app.get('/customers', async (req, res) => {`, `    const state = typeof req.query.state === 'string' ? req.query.state : 'TX';`, `    const rows  = await client.query.Customer.findMany({`, `        where:   { state },`, `        orderBy: { customerId: 'asc' },`, `        take:    20,`, `    });`, `    res.json(rows);`, `});`, ``, `app.get('/customers/:id', async (req, res) => {`, `    const row = await client.query.Customer.findFirst({`, `        where: { customerId: Number(req.params.id) },`, `    });`, `    if (!row) { res.status(404).json({ error: 'Not found' }); return; }`, `    res.json(row);`, `});`);
-    }
-    if (hasProgram) {
-        routes.push(``, `// ── SimpleCalc ───────────────────────────────────────────────────────────────`, ``, `const calculateSchema = z.object({ input: ibmiInt });`, ``, `app.post('/calculate', async (req, res) => {`, `    const parsed = calculateSchema.safeParse(req.body);`, `    if (!parsed.success) {`, `        res.status(400).json({ errors: parsed.error.flatten() });`, `        return;`, `    }`, `    const result = await client.program.SimpleCalc({ input: parsed.data.input });`, `    res.json({ input: parsed.data.input, output: result.output });`, `});`);
-    }
-    const zodImports = hasProgram
-        ? [`import { z } from 'zod';`, `import { ibmiInt } from './ibmi-validators.js';`]
-        : [];
+    if (hasTable)
+        imports.push(`import customersRouter from './customers.routes.js';`);
+    if (hasProgram)
+        imports.push(`import calculateRouter from './calculate.routes.js';`);
+    const mounts = [
+        `router.use('/health', healthRouter);`,
+    ];
+    if (hasTable)
+        mounts.push(`router.use('/customers', customersRouter);`);
+    if (hasProgram)
+        mounts.push(`router.use('/calculate', calculateRouter);`);
     return [
-        `import express from 'express';`,
-        `import morgan from 'morgan';`,
-        `import swaggerUi from 'swagger-ui-express';`,
-        `import { createClient } from './generated/ibmi/index.js';`,
-        ...zodImports,
+        ...imports,
         ``,
-        `const app  = express();`,
-        `const PORT = Number(process.env.PORT ?? 3000);`,
+        `const router = Router();`,
         ``,
-        `// ── Middleware ────────────────────────────────────────────────────────────────`,
+        ...mounts,
         ``,
-        `app.use(express.json());`,
-        `app.use(morgan('dev'));`,
+        `export default router;`,
         ``,
-        `// ── IBM i client ──────────────────────────────────────────────────────────────`,
+    ].join('\n');
+}
+// ── src/routes/health.routes.ts ───────────────────────────────────────────────
+function healthRoutes() {
+    return [
+        `import { Router } from 'express';`,
+        `import { getHealth } from '../controllers/health.controller.js';`,
         ``,
-        clientConfigBlock(a),
+        `const router = Router();`,
         ``,
-        `// ── OpenAPI / Swagger ─────────────────────────────────────────────────────────`,
+        `router.get('/', getHealth);`,
         ``,
-        `const apiSpec = {`,
-        `    openapi: '3.0.0',`,
-        `    info: { title: '${a.projectName}', version: '1.0.0', description: 'IBM i REST API' },`,
-        `    paths: {`,
-        ...swaggerPaths,
-        `    },`,
-        `};`,
+        `export default router;`,
         ``,
-        `app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(apiSpec as any));`,
+    ].join('\n');
+}
+// ── src/controllers/health.controller.ts ─────────────────────────────────────
+function healthController() {
+    return [
+        `import type { Request, Response } from 'express';`,
+        `import { client } from '../client.js';`,
         ``,
-        `// ── Routes ───────────────────────────────────────────────────────────────────`,
+        `export function getHealth(_req: Request, res: Response): void {`,
+        `    res.json({ status: 'ok', connected: client.isConnected() });`,
+        `}`,
+        ``,
+    ].join('\n');
+}
+// ── src/routes/customers.routes.ts ───────────────────────────────────────────
+function customersRoutes() {
+    return [
+        `import { Router } from 'express';`,
+        `import { listCustomers, getCustomer } from '../controllers/customers.controller.js';`,
         ``,
-        ...routes,
+        `const router = Router();`,
         ``,
-        `// ── Start ────────────────────────────────────────────────────────────────────`,
+        `router.get('/',    listCustomers);`,
+        `router.get('/:id', getCustomer);`,
         ``,
-        `app.listen(PORT, async () => {`,
-        `    await client.connect();`,
-        `    console.log(\`Server:  http://localhost:\${PORT}\`);`,
-        `    console.log(\`Swagger: http://localhost:\${PORT}/api-docs\`);`,
-        `});`,
+        `export default router;`,
+        ``,
+    ].join('\n');
+}
+// ── src/controllers/customers.controller.ts ──────────────────────────────────
+function customersController() {
+    return [
+        `import type { Request, Response } from 'express';`,
+        `import { client } from '../client.js';`,
+        ``,
+        `export async function listCustomers(req: Request, res: Response): Promise<void> {`,
+        `    const state = typeof req.query.state === 'string' ? req.query.state : 'TX';`,
+        `    const rows  = await client.query.Customer.findMany({`,
+        `        where:   { state },`,
+        `        orderBy: { customerId: 'asc' },`,
+        `        take:    20,`,
+        `    });`,
+        `    res.json(rows);`,
+        `}`,
+        ``,
+        `export async function getCustomer(req: Request, res: Response): Promise<void> {`,
+        `    const row = await client.query.Customer.findFirst({`,
+        `        where: { customerId: Number(req.params.id) },`,
+        `    });`,
+        `    if (!row) { res.status(404).json({ error: 'Not found' }); return; }`,
+        `    res.json(row);`,
+        `}`,
+        ``,
+    ].join('\n');
+}
+// ── src/routes/calculate.routes.ts ───────────────────────────────────────────
+function calculateRoutes() {
+    return [
+        `import { Router } from 'express';`,
+        `import { calculate } from '../controllers/calculate.controller.js';`,
+        ``,
+        `const router = Router();`,
+        ``,
+        `router.post('/', calculate);`,
+        ``,
+        `export default router;`,
+        ``,
+    ].join('\n');
+}
+// ── src/controllers/calculate.controller.ts ──────────────────────────────────
+function calculateController() {
+    return [
+        `import type { Request, Response } from 'express';`,
+        `import { z } from 'zod';`,
+        `import { ibmiInt } from '../ibmi-validators.js';`,
+        `import { client } from '../client.js';`,
+        ``,
+        `const calculateSchema = z.object({ input: ibmiInt });`,
+        ``,
+        `export async function calculate(req: Request, res: Response): Promise<void> {`,
+        `    const parsed = calculateSchema.safeParse(req.body);`,
+        `    if (!parsed.success) {`,
+        `        res.status(400).json({ errors: parsed.error.flatten() });`,
+        `        return;`,
+        `    }`,
+        `    const result = await client.program.SimpleCalc({ input: parsed.data.input });`,
+        `    res.json({ input: parsed.data.input, output: result.output });`,
+        `}`,
         ``,
     ].join('\n');
 }
+// ── .vscode/settings.json ─────────────────────────────────────────────────────
+function vscodeSettings() {
+    return JSON.stringify({
+        'editor.formatOnSave': true,
+        'editor.defaultFormatter': 'esbenp.prettier-vscode',
+        'editor.codeActionsOnSave': {
+            'source.fixAll.eslint': 'explicit',
+            'source.organizeImports': 'never',
+            'source.removeUnusedImports': 'explicit',
+        },
+        'editor.tabSize': 2,
+        'editor.insertSpaces': true,
+        'editor.rulers': [80, 120],
+        'editor.wordWrap': 'on',
+        'editor.bracketPairColorization.enabled': true,
+        'editor.guides.bracketPairs': true,
+        'editor.inlineSuggest.enabled': true,
+        'js/ts.tsdk': 'node_modules/typescript/lib',
+        'js/ts.enablePromptUseWorkspaceTsdk': true,
+        'js/ts.preferences.importModuleSpecifier': 'non-relative',
+        'js/ts.updateImportsOnFileMove.enabled': 'always',
+        'js/ts.suggest.autoImports': true,
+        'js/ts.preferences.quoteStyle': 'single',
+        'files.autoSave': 'onFocusChange',
+        'files.trimTrailingWhitespace': true,
+        'files.insertFinalNewline': true,
+        'files.eol': '\n',
+        'files.exclude': {
+            '**/.git': true,
+            '**/.DS_Store': true,
+            '**/dist': true,
+            '**/coverage': true,
+        },
+        'search.exclude': {
+            '**/node_modules': true,
+            '**/dist': true,
+            '**/coverage': true,
+            'package-lock.json': true,
+            'pnpm-lock.yaml': true,
+        },
+        'prettier.singleQuote': true,
+        'prettier.trailingComma': 'all',
+        'prettier.tabWidth': 2,
+        'prettier.semi': true,
+        'prettier.arrowParens': 'always',
+        'prettier.endOfLine': 'lf',
+        'git.autofetch': true,
+        'git.confirmSync': false,
+        'git.enableSmartCommit': true,
+        'explorer.confirmDelete': false,
+        'explorer.confirmDragAndDrop': false,
+        'explorer.fileNesting.enabled': true,
+        'explorer.fileNesting.patterns': {
+            '*.ts': '${capture}.js, ${capture}.d.ts, ${capture}.spec.ts, ${capture}.test.ts',
+            'package.json': 'package-lock.json, pnpm-lock.yaml, yarn.lock, .npmrc, .nvmrc, .node-version',
+            'tsconfig.json': 'tsconfig.*.json',
+            '.env': '.env.*',
+            '.gitignore': '.gitattributes',
+            'README.md': 'CHANGELOG.md, LICENSE',
+        },
+        '[typescript]': { 'editor.defaultFormatter': 'esbenp.prettier-vscode' },
+        '[javascript]': { 'editor.defaultFormatter': 'esbenp.prettier-vscode' },
+        '[json]': { 'editor.defaultFormatter': 'esbenp.prettier-vscode' },
+        '[ibmi]': { 'editor.defaultFormatter': 'openibm.vscode' },
+        'rest-client.environmentVariables': {
+            '$shared': { baseUrl: 'http://localhost:3000' },
+            'local': { baseUrl: 'http://localhost:3000' },
+        },
+        'todo-tree.general.tags': ['TODO', 'FIXME', 'NOTE', 'BUG'],
+        'todo-tree.highlights.defaultHighlight': {
+            icon: 'alert', type: 'text', foreground: '#fff', iconColour: '#ffcc00',
+        },
+        'todo-tree.highlights.customHighlight': {
+            'TODO': { icon: 'check', iconColour: '#3498db' },
+            'FIXME': { icon: 'flame', iconColour: '#e74c3c' },
+            'NOTE': { icon: 'note', iconColour: '#2ecc71' },
+            'BUG': { icon: 'bug', iconColour: '#e74c3c' },
+        },
+    }, null, 2) + '\n';
+}
+// ── .vscode/extensions.json ───────────────────────────────────────────────────
+function vscodeExtensions() {
+    return JSON.stringify({
+        recommendations: [
+            'openibm.vscode',
+            'esbenp.prettier-vscode',
+            'dbaeumer.vscode-eslint',
+            'christian-kohler.path-intellisense',
+            'humao.rest-client',
+            'gruntfuggly.todo-tree',
+        ],
+    }, null, 2) + '\n';
+}
 // ── README.md ─────────────────────────────────────────────────────────────────
-function readme(a, hasTable, hasProgram) {
+function readme(a, hasProgram, hasTable) {
     const endpoints = [
         `| \`GET  /health\`        | Connection status |`,
         `| \`GET  /api-docs\`      | Swagger UI |`,
+        `| \`GET  /scalar\`        | Scalar API reference |`,
         ...(hasTable ? [`| \`GET  /customers\`    | Query DB2 table (filtered by state) |`] : []),
         ...(hasTable ? [`| \`GET  /customers/:id\`| Find customer by ID |`] : []),
         ...(hasProgram ? [`| \`POST /calculate\`    | Call IBM i program (\`{ input: number }\`) |`] : []),
@@ -161,6 +433,19 @@ function readme(a, hasTable, hasProgram) {
         ``,
         `IBM i Express application generated by [create-openibm](https://www.npmjs.com/package/create-openibm).`,
         ``,
+        `## Project structure`,
+        ``,
+        `\`\`\``,
+        `src/`,
+        `├── index.ts              # Entry point — listen & connect`,
+        `├── app.ts                # Express setup, middleware, routes`,
+        `├── client.ts             # IBM i client singleton`,
+        `├── docs.ts               # OpenAPI spec + Swagger & Scalar setup`,
+        `├── ibmi-validators.ts    # Zod schemas for IBM i types`,
+        `├── controllers/          # Request handlers`,
+        `└── routes/               # Express routers`,
+        `\`\`\``,
+        ``,
         `## Setup`,
         ``,
         `\`\`\`bash`,
@@ -172,7 +457,7 @@ function readme(a, hasTable, hasProgram) {
         `## Development`,
         ``,
         `\`\`\`bash`,
-        `npm run dev`,
+        `npm run dev   # starts with nodemon — restarts on file save`,
         `\`\`\``,
         ``,
         `## Endpoints`,