@emeryld/manager 0.3.3 → 0.4.1

package/dist/create-package/variants/contract.js

@@ -1,5 +1,16 @@
-import { baseTsConfig, writeFileIfMissing, } from '../shared.js';
-const CONTRACT_TS = `import { defineSocketEvents, finalize, resource } from '@emeryld/rrroutes-contract'
+import { BASE_LINT_DEV_DEPENDENCIES, basePackageFiles, basePackageJson, buildReadme, baseScripts, baseTsConfig, writeFileIfMissing, } from '../shared.js';
+const CONTRACT_SCRIPTS = [
+    'dev',
+    'build',
+    'typecheck',
+    'lint',
+    'lint:fix',
+    'format',
+    'format:check',
+    'clean',
+    'test',
+];
+export const CONTRACT_TS = `import { defineSocketEvents, finalize, resource } from '@emeryld/rrroutes-contract'
 import { z } from 'zod'
 
 const routes = resource('/api')
@@ -70,51 +81,65 @@ export const socketEvents = sockets.events
 export type AppRegistry = typeof registry
 `;
 function contractPackageJson(name) {
-    return `${JSON.stringify({
+    return basePackageJson({
         name,
-        version: '0.1.0',
         private: false,
-        type: 'module',
-        main: 'dist/index.js',
-        types: 'dist/index.d.ts',
         exports: {
             '.': {
                 types: './dist/index.d.ts',
                 import: './dist/index.js',
             },
         },
-        files: ['dist'],
-        scripts: {
-            build: 'tsc -p tsconfig.json',
-            typecheck: 'tsc -p tsconfig.json --noEmit',
-        },
+        scripts: baseScripts('tsx watch src/index.ts'),
         dependencies: {
             '@emeryld/rrroutes-contract': '^2.5.2',
             zod: '^4.2.1',
         },
         devDependencies: {
-            typescript: '^5.9.3',
+            ...BASE_LINT_DEV_DEPENDENCIES,
         },
-    }, null, 2)}\n`;
+    });
 }
 function contractFiles(pkgName) {
     return {
         'package.json': contractPackageJson(pkgName),
         'tsconfig.json': baseTsConfig(),
+        ...basePackageFiles(),
         'src/index.ts': CONTRACT_TS,
-        'README.md': `# ${pkgName}
-
-Contract package scaffolded by manager-cli.
-- edit src/index.ts to add routes and socket events
-- build with \`npm run build\`
-- import the registry in your server/client packages
-`,
+        'README.md': buildReadme({
+            name: pkgName,
+            description: 'Contract package scaffolded by manager-cli.',
+            scripts: CONTRACT_SCRIPTS,
+            sections: [
+                {
+                    title: 'Getting Started',
+                    lines: [
+                        '- Install deps: `npm install` (or `pnpm install`)',
+                        '- Start dev mode: `npm run dev`',
+                        '- Build output: `npm run build`',
+                    ],
+                },
+                {
+                    title: 'Usage',
+                    lines: [
+                        '- Edit `src/index.ts` to add routes and socket events.',
+                        '- Import and share the generated registry in server/client packages.',
+                    ],
+                },
+            ],
+        }),
     };
 }
 export const contractVariant = {
     id: 'rrr-contract',
     label: 'rrr contract',
     defaultDir: 'packages/rrr-contract',
+    summary: 'Shared RRRoutes registry + sockets to be consumed by server/client packages.',
+    keyFiles: ['src/index.ts', 'README.md'],
+    scripts: CONTRACT_SCRIPTS,
+    notes: [
+        'Edit src/index.ts to define routes and socket events; exports registry/socket config.',
+    ],
     async scaffold(ctx) {
         const files = contractFiles(ctx.pkgName);
         for (const [relative, contents] of Object.entries(files)) {

package/dist/create-package/variants/docker.js

@@ -1,38 +1,49 @@
-import { baseTsConfig, writeFileIfMissing, } from '../shared.js';
+import { BASE_LINT_DEV_DEPENDENCIES, basePackageFiles, basePackageJson, buildReadme, baseScripts, baseTsConfig, writeFileIfMissing, } from '../shared.js';
+const DOCKER_SCRIPTS = [
+    'dev',
+    'build',
+    'typecheck',
+    'lint',
+    'lint:fix',
+    'format',
+    'format:check',
+    'clean',
+    'test',
+    'start',
+    'docker:build',
+    'docker:up',
+    'docker:dev',
+    'docker:logs',
+    'docker:stop',
+    'docker:clean',
+    'docker:reset',
+];
 function dockerPackageJson(name) {
-    return `${JSON.stringify({
+    return basePackageJson({
         name,
-        version: '0.1.0',
-        private: true,
-        type: 'module',
-        main: 'dist/index.js',
-        types: 'dist/index.d.ts',
-        files: ['dist'],
-        scripts: {
-            dev: 'tsx watch src/index.ts',
-            build: 'tsc -p tsconfig.json',
-            typecheck: 'tsc -p tsconfig.json --noEmit',
+        scripts: baseScripts('tsx watch src/index.ts', {
             start: 'node dist/index.js',
             'docker:cli': 'tsx scripts/docker.ts',
             'docker:build': 'npm run docker:cli -- build',
             'docker:up': 'npm run docker:cli -- up',
+            'docker:dev': 'npm run docker:cli -- dev',
             'docker:logs': 'npm run docker:cli -- logs',
             'docker:stop': 'npm run docker:cli -- stop',
             'docker:clean': 'npm run docker:cli -- clean',
-        },
+            'docker:reset': 'npm run docker:cli -- reset',
+        }),
         dependencies: {
             cors: '^2.8.5',
             express: '^5.1.0',
         },
         devDependencies: {
+            ...BASE_LINT_DEV_DEPENDENCIES,
             '@types/cors': '^2.8.5',
             '@types/express': '^5.0.6',
             '@types/node': '^24.10.2',
             'docker-cli-js': '^3.0.9',
-            tsx: '^4.19.0',
-            typescript: '^5.9.3',
         },
-    }, null, 2)}\n`;
+    });
 }
 function dockerIndexTs() {
     return `import express from 'express'
@@ -91,14 +102,40 @@ function dockerFiles(pkgName) {
         'src/index.ts': dockerIndexTs(),
         'scripts/docker.ts': dockerCliScript(pkgName),
         '.dockerignore': DOCKER_DOCKERIGNORE,
+        ...basePackageFiles(),
         Dockerfile: dockerDockerfile(),
-        'README.md': `# ${pkgName}
-
-Dockerized service scaffolded by manager-cli.
-- develop locally with \`npm run dev\`
-- build with \`npm run build\` and start with \`npm start\`
-- docker helper: \`npm run docker:up\` (build + run), \`npm run docker:logs\`, \`npm run docker:stop\`
-`,
+        'README.md': buildReadme({
+            name: pkgName,
+            description: 'Dockerized service scaffolded by manager-cli.',
+            scripts: DOCKER_SCRIPTS,
+            sections: [
+                {
+                    title: 'Getting Started',
+                    lines: [
+                        '- Install deps: `npm install` (or `pnpm install`)',
+                        '- Local dev: `npm run dev`',
+                        '- Build output: `npm run build`',
+                        '- Start built app: `npm start`',
+                    ],
+                },
+                {
+                    title: 'Docker Helpers',
+                    lines: [
+                        '- Build image: `npm run docker:build`',
+                        '- Build + run detached: `npm run docker:up`',
+                        '- Build + run + tail logs: `npm run docker:dev`',
+                        '- Tail logs: `npm run docker:logs`',
+                        '- Stop container: `npm run docker:stop`',
+                        '- Clean container: `npm run docker:clean`',
+                        '- Reset container/image: `npm run docker:reset`',
+                    ],
+                },
+                {
+                    title: 'Environment',
+                    lines: ['- `PORT` sets the exposed port (default 3000).'],
+                },
+            ],
+        }),
     };
 }
 function dockerCliScript(pkgName) {
@@ -126,32 +163,50 @@ async function main() {
     await docker.command(\`build -t \${image} .\`)
     return docker.command(\`run -d --rm -p \${port}:\${port} --name \${container} \${image}\`)
   }
+  if (command === 'dev') {
+    await docker.command(\`build -t \${image} .\`)
+    await docker.command(\`run -d --rm -p \${port}:\${port} --name \${container} \${image}\`)
+    return docker.command(\`logs -f \${container}\`)
+  }
   if (command === 'run') {
     return docker.command(\`run -d --rm -p \${port}:\${port} --name \${container} \${image}\`)
   }
   if (command === 'logs') return docker.command(\`logs -f \${container}\`)
   if (command === 'stop') return docker.command(\`stop \${container}\`)
   if (command === 'clean') {
-    try {
-      await docker.command(\`rm -f \${container}\`)
-    } catch (error) {
-      console.warn(String(error))
-    }
+    await safe(() => docker.command(\`stop \${container}\`))
+    await safe(() => docker.command(\`rm -f \${container}\`))
+    return
+  }
+  if (command === 'reset') {
+    await safe(() => docker.command(\`stop \${container}\`))
+    await safe(() => docker.command(\`rm -f \${container}\`))
+    await safe(() => docker.command(\`rmi -f \${image}\`))
     return
   }
   return printHelp()
 }
 
+async function safe(run: () => Promise<unknown>) {
+  try {
+    await run()
+  } catch (error) {
+    console.warn(String(error))
+  }
+}
+
 function printHelp() {
   console.log(
     [
       'Docker helper commands:',
       '  build   -> docker build -t ${pkgName}:latest .',
       '  up      -> build then run in detached mode',
+      '  dev     -> build, run, and tail logs',
       '  run     -> run existing image detached',
       '  logs    -> docker logs -f <container>',
       '  stop    -> docker stop <container>',
-      '  clean   -> docker rm -f <container>',
+      '  clean   -> docker stop/rm <container>',
+      '  reset   -> clean container and remove image',
     ].join('\\n'),
   )
 }
@@ -166,6 +221,18 @@ export const dockerVariant = {
     id: 'rrr-docker',
     label: 'dockerized service',
     defaultDir: 'packages/rrr-docker',
+    summary: 'Express service plus Dockerfile and a helper CLI for local runs.',
+    keyFiles: [
+        'src/index.ts',
+        'scripts/docker.ts',
+        'Dockerfile',
+        'README.md',
+    ],
+    scripts: DOCKER_SCRIPTS,
+    notes: [
+        'Use docker:dev or docker:up to build and run the container quickly.',
+        'scripts/docker.ts wraps common docker commands with consistent naming.',
+    ],
     async scaffold(ctx) {
         const files = dockerFiles(ctx.pkgName);
         for (const [relative, contents] of Object.entries(files)) {

package/dist/create-package/variants/empty.js

@@ -1,39 +1,59 @@
-import { baseTsConfig, writeFileIfMissing, } from '../shared.js';
+import { BASE_LINT_DEV_DEPENDENCIES, basePackageFiles, basePackageJson, buildReadme, baseScripts, baseTsConfig, writeFileIfMissing, } from '../shared.js';
+const EMPTY_SCRIPTS = [
+    'dev',
+    'build',
+    'typecheck',
+    'lint',
+    'lint:fix',
+    'format',
+    'format:check',
+    'clean',
+    'test',
+];
 function emptyPackageJson(name) {
-    return `${JSON.stringify({
+    return basePackageJson({
         name,
-        version: '0.1.0',
-        private: true,
-        type: 'module',
-        main: 'dist/index.js',
-        types: 'dist/index.d.ts',
-        files: ['dist'],
-        scripts: {
-            build: 'tsc -p tsconfig.json',
-            typecheck: 'tsc -p tsconfig.json --noEmit',
-        },
+        scripts: baseScripts('tsx watch src/index.ts'),
         devDependencies: {
-            typescript: '^5.9.3',
+            ...BASE_LINT_DEV_DEPENDENCIES,
         },
-    }, null, 2)}\n`;
+    });
 }
 function emptyFiles(pkgName) {
     return {
         'package.json': emptyPackageJson(pkgName),
         'tsconfig.json': baseTsConfig({ types: ['node'] }),
+        ...basePackageFiles(),
         'src/index.ts': "export const hello = 'world'\n",
-        'README.md': `# ${pkgName}
-
-Empty package scaffolded by manager-cli.
-- edit src/index.ts to start coding
-- build with \`npm run build\`
-`,
+        'README.md': buildReadme({
+            name: pkgName,
+            description: 'Empty package scaffolded by manager-cli.',
+            scripts: EMPTY_SCRIPTS,
+            sections: [
+                {
+                    title: 'Getting Started',
+                    lines: [
+                        '- Install deps: `npm install` (or `pnpm install`)',
+                        '- Start dev mode: `npm run dev`',
+                        '- Build output: `npm run build`',
+                    ],
+                },
+                {
+                    title: 'Notes',
+                    lines: ['- Edit `src/index.ts` to start coding.'],
+                },
+            ],
+        }),
     };
 }
 export const emptyVariant = {
     id: 'rrr-empty',
     label: 'empty package',
     defaultDir: 'packages/rrr-empty',
+    summary: 'Minimal TypeScript package with lint/format/test scaffolding.',
+    keyFiles: ['src/index.ts', 'README.md'],
+    scripts: EMPTY_SCRIPTS,
+    notes: ['Start coding in src/index.ts; everything else is wired up.'],
     async scaffold(ctx) {
         const files = emptyFiles(ctx.pkgName);
         for (const [relative, contents] of Object.entries(files)) {