sentinelayer-cli 0.1.2 → 0.3.0

package/src/scaffold/generator.js

@@ -0,0 +1,67 @@
+/**
+ * Scaffold generator — writes template files into a project directory.
+ * Skips files that already exist unless force is true.
+ */
+import fs from "node:fs";
+import fsp from "node:fs/promises";
+import path from "node:path";
+
+async function ensureDir(dirPath) {
+  await fsp.mkdir(dirPath, { recursive: true });
+}
+
+export async function generateScaffold({ projectDir, templateFiles, packageJsonTemplate, readmeContent, force }) {
+  const written = [];
+  const skipped = [];
+
+  // Write template files (src/, tests/, .gitignore, etc.)
+  for (const [relativePath, content] of Object.entries(templateFiles)) {
+    const fullPath = path.join(projectDir, relativePath);
+    if (!force && fs.existsSync(fullPath)) {
+      skipped.push({ path: relativePath, reason: "already exists" });
+      continue;
+    }
+    await ensureDir(path.dirname(fullPath));
+    await fsp.writeFile(fullPath, content, "utf-8");
+    written.push(relativePath);
+  }
+
+  // Merge or create package.json
+  const pkgPath = path.join(projectDir, "package.json");
+  if (fs.existsSync(pkgPath)) {
+    const existing = JSON.parse(await fsp.readFile(pkgPath, "utf-8"));
+    // Merge dependencies and scripts without overwriting existing keys
+    if (packageJsonTemplate.dependencies) {
+      existing.dependencies = { ...packageJsonTemplate.dependencies, ...(existing.dependencies || {}) };
+    }
+    if (packageJsonTemplate.devDependencies) {
+      existing.devDependencies = { ...packageJsonTemplate.devDependencies, ...(existing.devDependencies || {}) };
+    }
+    if (packageJsonTemplate.scripts) {
+      existing.scripts = { ...packageJsonTemplate.scripts, ...(existing.scripts || {}) };
+    }
+    if (!existing.type) {
+      existing.type = packageJsonTemplate.type || "module";
+    }
+    await fsp.writeFile(pkgPath, JSON.stringify(existing, null, 2) + "\n", "utf-8");
+    written.push("package.json (merged)");
+  } else {
+    await ensureDir(path.dirname(pkgPath));
+    await fsp.writeFile(pkgPath, JSON.stringify(packageJsonTemplate, null, 2) + "\n", "utf-8");
+    written.push("package.json");
+  }
+
+  // Write README.md
+  if (readmeContent) {
+    const readmePath = path.join(projectDir, "README.md");
+    if (!force && fs.existsSync(readmePath)) {
+      skipped.push({ path: "README.md", reason: "already exists" });
+    } else {
+      await ensureDir(path.dirname(readmePath));
+      await fsp.writeFile(readmePath, readmeContent, "utf-8");
+      written.push("README.md");
+    }
+  }
+
+  return { written, skipped };
+}

package/src/scaffold/templates.js

@@ -0,0 +1,150 @@
+/**
+ * Project code scaffold templates.
+ *
+ * Each template returns a map of { relativePath: fileContent } that the
+ * generator writes into the target project directory, skipping files
+ * that already exist unless --force is set.
+ */
+
+export function getExpressTemplate({ projectName, description }) {
+  const safeName = String(projectName || "my-app").replace(/[^a-zA-Z0-9_-]/g, "-").toLowerCase();
+  const safeDesc = String(description || `${safeName} API`);
+
+  return {
+    "src/index.js": `import express from "express";
+import dotenv from "dotenv";
+import { healthRouter } from "./routes/health.js";
+
+dotenv.config();
+
+const app = express();
+app.use(express.json());
+
+app.use("/api/health", healthRouter);
+
+const PORT = process.env.PORT || 3000;
+app.listen(PORT, () => {
+  console.log(\`${safeName} listening on port \${PORT}\`);
+});
+
+export default app;
+`,
+
+    "src/routes/health.js": `import { Router } from "express";
+
+export const healthRouter = Router();
+
+healthRouter.get("/", (_req, res) => {
+  res.json({ status: "ok", timestamp: new Date().toISOString() });
+});
+`,
+
+    "tests/health.test.js": `import assert from "node:assert/strict";
+import { test } from "node:test";
+
+test("health endpoint returns ok status", async () => {
+  // Dynamically import to avoid port binding during test
+  const { default: app } = await import("../src/index.js");
+  // Verify app is an express instance
+  assert.ok(app, "Express app should be exported");
+  assert.equal(typeof app.listen, "function", "App should have listen method");
+});
+`,
+
+    ".gitignore": `node_modules/
+.env
+dist/
+coverage/
+.sentinelayer/
+*.log
+`,
+
+    ".env.example": `PORT=3000
+# Add your environment variables here
+`,
+  };
+}
+
+export function getPackageJsonTemplate({ projectName, description }) {
+  const safeName = String(projectName || "my-app").replace(/[^a-zA-Z0-9_-]/g, "-").toLowerCase();
+  return {
+    name: safeName,
+    version: "0.1.0",
+    description: String(description || `${safeName} API`),
+    type: "module",
+    main: "src/index.js",
+    scripts: {
+      start: "node src/index.js",
+      dev: "node --watch src/index.js",
+      test: "node --test tests/**/*.test.js",
+    },
+    dependencies: {
+      express: "^5.1.0",
+      dotenv: "^16.4.7",
+      jsonwebtoken: "^9.0.2",
+      bcrypt: "^5.1.1",
+    },
+    devDependencies: {},
+    engines: {
+      node: ">=18.17.0",
+    },
+  };
+}
+
+export function buildReadmeContent({ projectName, description, techStack }) {
+  const name = String(projectName || "my-app");
+  const desc = String(description || `${name} project`);
+  const stack = String(techStack || "Node.js + Express");
+
+  return `# ${name}
+
+${desc}
+
+## Tech Stack
+
+${stack}
+
+## Getting Started
+
+\`\`\`bash
+npm install
+cp .env.example .env
+npm run dev
+\`\`\`
+
+## Testing
+
+\`\`\`bash
+npm test
+\`\`\`
+
+## Project Structure
+
+\`\`\`
+${name}/
+├── src/
+│   ├── index.js          # Application entry point
+│   └── routes/            # API route handlers
+├── tests/                 # Test files
+├── docs/                  # SentinelLayer spec & build guide
+├── prompts/               # Agent execution prompts
+├── .github/workflows/     # CI/CD (Omar Gate)
+└── tasks/                 # Build checklist
+\`\`\`
+
+## Security
+
+This project uses [SentinelLayer](https://sentinelayer.com) Omar Gate for automated security review on every PR.
+
+---
+Generated with [create-sentinelayer](https://www.npmjs.com/package/sentinelayer-cli)
+`;
+}
+
+export const TEMPLATE_REGISTRY = {
+  "rest-api-express": {
+    name: "REST API (Express.js)",
+    getFiles: getExpressTemplate,
+    getPackageJson: getPackageJsonTemplate,
+  },
+};