@karmaniverous/smoz 0.1.6 → 0.1.8

package/README.md

@@ -12,9 +12,7 @@
 
 </div>
 
-SMOZ is a small, pragmatic toolkit for authoring AWS Lambda handlers with
-[Middy] and [Zod], then aggregating Serverless functions and hand‑crafted
-OpenAPI 3.1 paths from a single, schema‑first application definition.
+SMOZ is a small, pragmatic toolkit for authoring AWS Lambda handlers with [Middy] and [Zod], then aggregating Serverless functions and hand‑crafted OpenAPI 3.1 paths from a single, schema‑first application definition.
 
 - Keep prod code testable and framework‑agnostic
 - HTTP middleware with validation, shaping, errors, CORS, negotiation, and HEAD
@@ -41,14 +39,7 @@ OpenAPI 3.1 paths from a single, schema‑first application definition.
 ## Install
 
 ```bash
-npm i @karmaniverous/smoz zod zod-openapi @middy/core \
-  @middy/http-header-normalizer \
-  @middy/http-event-normalizer \
-  @middy/http-json-body-parser \
-  @middy/http-content-negotiation \
-  @middy/http-error-handler \
-  @middy/http-cors \
-  @middy/http-response-serializer
+npm i @karmaniverous/smoz zod zod-openapi
 ```
 
 ## Dev tooling (recommended):

package/dist/cli/index.cjs

@@ -796,8 +796,7 @@ const launchInline = async (root, opts) => {
  * Scaffolds a new project from packaged templates.
  * - Copies ./templates/project/ into the target root (shared boilerplate)
  * - Copies ./templates/<template>/ into the target root (default: minimal)
- * - Seeds app/generated/register.*.ts (empty modules) if missing
- * - Idempotent: copy-if-absent; if a file exists, writes <name>.example alongside
+ * - Seeds app/generated/register.*.ts (empty modules) if missing * - Idempotent: copy-if-absent; if a file exists, writes <name>.example alongside
  * - Additive merge of template manifest (deps/devDeps/scripts) into package.json
  * - Optional dependency installation via --install[=<pm>]
  */
@@ -971,6 +970,33 @@ const runInit = async (root, template = 'minimal', opts) => {
     }
     // 2) Copy selected template
     await copyDirIdempotent(srcBase, root, created, skipped, examples);
+    // 2.5) Convert template 'gitignore' into real '.gitignore'
+    // NPM often excludes '.gitignore' from published packages; shipping 'gitignore'
+    // and converting here ensures downstream projects get a proper .gitignore.
+    try {
+        const giSrc = path.join(root, 'gitignore');
+        const giDot = path.join(root, '.gitignore');
+        if (fs.existsSync(giSrc)) {
+            if (!fs.existsSync(giDot)) {
+                await fs.promises.rename(giSrc, giDot);
+                created.push(path.posix.normalize(giDot));
+            }
+            else {
+                // Both exist: preserve the template as an example (if not already present),
+                // then remove the extra 'gitignore' to avoid clutter.
+                const example = path.join(root, 'gitignore.example');
+                if (!fs.existsSync(example)) {
+                    const data = await fs.promises.readFile(giSrc, 'utf8');
+                    await fs.promises.writeFile(example, data, 'utf8');
+                    examples.push(path.posix.normalize(example));
+                }
+                await fs.promises.rm(giSrc, { force: true });
+            }
+        }
+    }
+    catch {
+        // best-effort; ignore conversion errors
+    }
     // Seed app/generated/register.*.ts (empty modules) if missing
     const genDir = path.resolve(root, 'app', 'generated');
     const seeds = [

package/package.json

@@ -185,5 +185,5 @@
     "templates:lint": "eslint --fix -c templates/.check/eslint.templates.config.ts \"templates/**/*.{ts,tsx,js,jsx}\" && eslint --fix --no-ignore templates/.check/eslint.templates.config.ts"
   },
   "type": "module",
-  "version": "0.1.6"
+  "version": "0.1.8"
 }

package/templates/.manifests/package.full.json

@@ -1,21 +1,22 @@
 {
   "dependencies": {
-    "zod": "^4.1.5",
-    "@middy/core": "^6.4.4"
+    "@middy/core": "^6.4.4",
+    "zod": "^4.1.5"
   },
   "devDependencies": {
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.41.0",
     "eslint": "^9.34.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "vitest": "^3.2.4",
-    "typedoc": "^0.28.11"
+    "jiti": "^2.5.1",
+    "typedoc": "^0.28.11",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.41.0",
+    "vitest": "^3.2.4"
   },
   "scripts": {
-    "typecheck": "tsc -p tsconfig.json --noEmit",
     "lint": "eslint .",
-    "lint:fix": "eslint --fix ."
+    "lint:fix": "eslint --fix .",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
   }
 }

package/templates/.manifests/package.minimal.json

@@ -1,19 +1,22 @@
 {
   "dependencies": {
-    "zod": "^4.1.5",
-    "@middy/core": "^6.4.4"
+    "@middy/core": "^6.4.4",
+    "zod": "^4.1.5"
   },
   "devDependencies": {
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.41.0",
     "eslint": "^9.34.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.4",
-    "eslint-plugin-simple-import-sort": "^12.1.1"
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "jiti": "^2.5.1",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.41.0",
+    "vitest": "^3.2.4"
   },
   "scripts": {
-    "typecheck": "tsc -p tsconfig.json --noEmit",
     "lint": "eslint .",
-    "lint:fix": "eslint --fix ."
+    "lint:fix": "eslint --fix .",
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
   }
 }

package/templates/.manifests/package.project.json

@@ -1,23 +1,24 @@
 {
   "dependencies": {
-    "zod": "^4.1.5",
-    "@middy/core": "^6.4.4"
+    "@middy/core": "^6.4.4",
+    "zod": "^4.1.5"
   },
   "devDependencies": {
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.41.0",
     "eslint": "^9.34.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "vitest": "^3.2.4",
-    "typedoc": "^0.28.11"
+    "jiti": "^2.5.1",
+    "typedoc": "^0.28.11",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.41.0",
+    "vitest": "^3.2.4"
   },
   "scripts": {
-    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "docs": "typedoc",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "vitest run",
-    "docs": "typedoc"
+    "typecheck": "tsc -p tsconfig.json --noEmit"
   }
 }

package/templates/project/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "redhat.vscode-yaml",
+    "vitest.explorer"
+  ]
+}

package/templates/project/.vscode/settings.json

@@ -0,0 +1,23 @@
+{
+  "[markdown]": {
+    "editor.wordWrap": "bounded"
+  },
+  "diffEditor.ignoreTrimWhitespace": false,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnPaste": true,
+  "editor.formatOnSave": true,
+  "eslint.useFlatConfig": true,
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
+  "git.autofetch": true,
+  "git.enableSmartCommit": true,
+  "javascript.preferences.importModuleSpecifierEnding": "minimal",
+  "javascript.updateImportsOnFileMove.enabled": "always",
+  "prettier.prettierPath": "./node_modules/prettier",
+  "prettier.singleQuote": true,
+  "yaml.format.singleQuote": true
+}

package/templates/project/README.md

@@ -23,34 +23,27 @@ This template provides a minimal, convention‑friendly baseline for new SMOZ ap
 
 1. Install dependencies
    - Run: `npm install`
-
 2. Type checking
    - Run: `npm run typecheck`
-
 3. Linting
    - Run: `npm run lint` (or `npm run lint:fix` to auto‑fix)
-
 4. Tests (baseline suite OK)
    - Run: `npm run test`
-
 5. Docs (TypeDoc baseline loads)
    - Run: `npm run docs`
-
 6. Generate OpenAPI (if your app config and endpoints are present)
    - Run: `npm run openapi`
 
 ## SMOZ CLI — register
 
-The CLI scans `app/functions/**` for `lambda.ts`, `openapi.ts`, and optional `serverless.ts`
-and generates side‑effect registration files under `app/generated/`.
+The CLI scans `app/functions/**` for `lambda.ts`, `openapi.ts`, and optional `serverless.ts` and generates side‑effect registration files under `app/generated/`.
 
 - Build CLI (if packaged locally): `npm run cli:build`
 - Register: `npx smoz register`
   - Idempotent: rewrites files only when content changes
   - Formats output with Prettier when available
 
-Tip: Commit `app/generated/register.*.ts` so typecheck is stable without running the CLI.
-Teams often keep `app/generated/openapi.json` untracked in VCS (optional).
+Tip: Commit `app/generated/register.*.ts` so typecheck is stable without running the CLI. Teams often keep `app/generated/openapi.json` untracked in VCS (optional).
 
 ## Notes
 
@@ -70,9 +63,7 @@ Teams often keep `app/generated/openapi.json` untracked in VCS (optional).
 
 ## Path hygiene (cross‑platform)
 
-Windows uses backslashes in paths, which can leak into string comparisons and
-generated artifacts. Normalize separators consistently using the helper exported
-by the toolkit:
+Windows uses backslashes in paths, which can leak into string comparisons and generated artifacts. Normalize separators consistently using the helper exported by the toolkit:
 
 ```ts
 import { toPosixPath } from '@karmaniverous/smoz';
@@ -82,4 +73,4 @@ import { fileURLToPath } from 'node:url';
 export const APP_ROOT_ABS = toPosixPath(
   fileURLToPath(new URL('..', import.meta.url)),
 );
-```
+```

package/templates/project/gitignore

@@ -0,0 +1,42 @@
+# Dependencies
+node_modules/
+
+# Build outputs and caches
+dist/
+.tsbuild/
+**/.tsbuild/
+*.tsbuildinfo
+**/.rollup.cache/
+
+# Serverless packaging
+.serverless/
+
+# Test coverage
+coverage/
+
+# Generated artifacts
+# Teams often keep registers tracked for typecheck stability,
+# but the OpenAPI JSON is usually untracked.
+app/generated/openapi.json
+
+# Environment files (local only; do not commit secrets)
+.env
+.env.local
+.env.*.local
+
+# Logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# OS / editor files
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+
+# Misc
+*.swp
+*.swo

package/templates/project/test/smoke.test.ts

@@ -0,0 +1,7 @@
+import { describe, expect, it } from 'vitest';
+
+describe('template smoke', () => {
+  it('runs vitest', () => {
+    expect(1 + 1).toBe(2);
+  });
+});

package/templates/project/tsdoc.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "noStandardTags": false,
+  "tagDefinitions": [
+    { "tagName": "@author", "syntaxKind": "block" },
+    { "tagName": "@module", "syntaxKind": "block" },
+    { "tagName": "@type", "syntaxKind": "block" },
+    { "tagName": "@typedef", "syntaxKind": "block" },
+    { "tagName": "@callback", "syntaxKind": "block" },
+    { "tagName": "@prop", "syntaxKind": "block", "allowMultiple": true },
+    { "tagName": "@property", "syntaxKind": "block", "allowMultiple": true },
+    { "tagName": "@group", "syntaxKind": "block", "allowMultiple": true },
+    { "tagName": "@groupDescription", "syntaxKind": "block", "allowMultiple": true },
+    { "tagName": "@category", "syntaxKind": "block", "allowMultiple": true },
+    { "tagName": "@categoryDescription", "syntaxKind": "block", "allowMultiple": true },
+    { "tagName": "@hidden", "syntaxKind": "modifier" },
+    { "tagName": "@ignore", "syntaxKind": "modifier" },
+    { "tagName": "@class", "syntaxKind": "modifier" },
+    { "tagName": "@document", "syntaxKind": "block" },
+    { "tagName": "@default", "syntaxKind": "block" },
+    { "tagName": "@extends", "syntaxKind": "block" },
+    { "tagName": "@augments", "syntaxKind": "block" },
+    { "tagName": "@return", "syntaxKind": "block" },
+    { "tagName": "@yields", "syntaxKind": "block" },
+    { "tagName": "@enum", "syntaxKind": "modifier" },
+    { "tagName": "@event", "syntaxKind": "modifier" },
+    { "tagName": "@template", "syntaxKind": "block", "allowMultiple": true },
+    { "tagName": "@linkcode", "syntaxKind": "inline", "allowMultiple": true },
+    { "tagName": "@linkplain", "syntaxKind": "inline", "allowMultiple": true },
+    { "tagName": "@private", "syntaxKind": "modifier" },
+    { "tagName": "@protected", "syntaxKind": "modifier" },
+    { "tagName": "@satisfies", "syntaxKind": "block" },
+    { "tagName": "@since", "syntaxKind": "block" },
+    { "tagName": "@license", "syntaxKind": "block" },
+    { "tagName": "@import", "syntaxKind": "block" },
+    { "tagName": "@overload", "syntaxKind": "modifier" },
+    { "tagName": "@namespace", "syntaxKind": "modifier" },
+    { "tagName": "@interface", "syntaxKind": "modifier" },
+    { "tagName": "@showCategories", "syntaxKind": "modifier" },
+    { "tagName": "@hideCategories", "syntaxKind": "modifier" },
+    { "tagName": "@showGroups", "syntaxKind": "modifier" },
+    { "tagName": "@hideGroups", "syntaxKind": "modifier" },
+    { "tagName": "@hideconstructor", "syntaxKind": "modifier" },
+    { "tagName": "@jsx", "syntaxKind": "block" }
+  ]
+}