qodfy 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,104 @@
+# Qodfy
+
+AI built it fast. Qodfy checks if it's ready.
+
+Qodfy is an open-source launch-readiness scanner for AI-built apps. The first product is a local CLI focused on Next.js projects built with TypeScript, Vercel AI SDK, Cursor, Claude Code, v0, Lovable, Bolt, Replit, and similar AI coding workflows.
+
+## Quick Start
+
+Run Qodfy in any local project:
+
+```bash
+npx qodfy scan
+```
+
+Scan a specific folder:
+
+```bash
+npx qodfy scan --path apps/web
+```
+
+## What Qodfy Checks Today
+
+Qodfy v0.1 scans locally and looks for common launch-readiness risks:
+
+- Next.js project detection
+- missing `.env.example`
+- API routes in `app/api` and `pages/api`
+- API routes that may be missing auth/session checks
+- AI-related files using keywords like `openai`, `@ai-sdk`, `anthropic`, `gemini`, `generateText`, `streamText`, and `useChat`
+- AI routes/files that may be missing rate limiting
+- large generated files
+- a simple launch readiness score from `0` to `100`
+
+Qodfy does not send your code to any external server.
+
+## Example Output
+
+```txt
+Qodfy is scanning your project...
+
+Qodfy Report
+
+Launch Readiness: 72/100
+
+Stats
+Files scanned: 42
+API routes: 3
+AI-related files: 2
+Large files: 1
+
+Issues
+
+CRITICAL AI route may be missing rate limiting
+AI routes can create real API costs. Add rate limiting or usage limits before launch.
+File: app/api/chat/route.ts
+
+WARNING API route may be missing authentication
+This API route does not appear to contain an auth/session check.
+File: app/api/admin/route.ts
+
+Recommended next step:
+Fix critical issues first, then warnings, then cleanup items.
+```
+
+## Commands
+
+```bash
+qodfy scan
+qodfy scan --path <project-path>
+qodfy --help
+qodfy --version
+```
+
+## Scoring
+
+Qodfy starts at `100`.
+
+- Critical issue: `-20`
+- Warning: `-8`
+- Info: no major score penalty
+
+The score is intentionally simple in v0.1 and will become more precise as the rule set improves.
+
+## Roadmap
+
+Near-term priorities:
+
+- JSON and Markdown output
+- `.env.example` coverage for `process.env.*`
+- exposed secret detection
+- Stripe webhook signature checks
+- better auth and rate-limit heuristics
+- `--ci` and `--min-score`
+- GitHub Action
+
+## Repository
+
+GitHub: https://github.com/yassinifguisse1/qodfy
+
+Issues and feedback: https://github.com/yassinifguisse1/qodfy/issues
+
+## License
+
+MIT

package/dist/index.js

@@ -1,17 +1,65 @@
 #!/usr/bin/env node
 
 // src/index.ts
+import fs from "fs/promises";
+import path from "path";
 import { Command } from "commander";
 import pc from "picocolors";
 import { scanProject } from "@qodfy/core";
 var program = new Command();
-program.name("qodfy").description("Launch readiness scanner for AI-built apps.").version("0.1.0");
+program.name("qodfy").description("Launch readiness scanner for AI-built apps.").version("0.1.2");
 program.command("scan").description("Scan a project for launch readiness issues.").option("-p, --path <path>", "Project path to scan", process.cwd()).action(async (options) => {
-  console.log(pc.cyan("Qodfy is scanning your project...\n"));
-  const report = await scanProject(options.path);
-  printReport(report);
+  const pathResult = await resolveProjectPath(options.path);
+  if (!pathResult.ok) {
+    printScanError(pathResult.reason);
+    process.exitCode = 1;
+    return;
+  }
+  try {
+    console.log(pc.cyan("Qodfy is scanning your project...\n"));
+    const report = await scanProject(pathResult.projectPath);
+    printReport(report);
+  } catch (error) {
+    printScanError(getErrorMessage(error));
+    process.exitCode = 1;
+  }
 });
-program.parse();
+await program.parseAsync();
+async function resolveProjectPath(projectPath) {
+  const inputPath = projectPath.trim() || process.cwd();
+  const resolvedPath = path.resolve(inputPath);
+  try {
+    const stats = await fs.stat(resolvedPath);
+    if (!stats.isDirectory()) {
+      return {
+        ok: false,
+        reason: `The path "${inputPath}" is not a directory.`
+      };
+    }
+    return {
+      ok: true,
+      projectPath: resolvedPath
+    };
+  } catch (error) {
+    const code = getErrorCode(error);
+    if (code === "ENOENT") {
+      return {
+        ok: false,
+        reason: `The path "${inputPath}" does not exist.`
+      };
+    }
+    if (code === "ENOTDIR") {
+      return {
+        ok: false,
+        reason: `The path "${inputPath}" is not a directory.`
+      };
+    }
+    return {
+      ok: false,
+      reason: `Qodfy could not access the path "${inputPath}".`
+    };
+  }
+}
 function printReport(report) {
   console.log(pc.bold("Qodfy Report"));
   console.log("");
@@ -37,8 +85,32 @@ ${label} ${pc.bold(issue.title)}`);
     if (issue.file) {
       console.log(pc.dim(`File: ${issue.file}`));
     }
+    if (issue.suggestion) {
+      console.log(pc.dim(`Suggestion: ${issue.suggestion}`));
+    }
   }
   console.log("");
   console.log(pc.bold("Recommended next step:"));
   console.log("Fix critical issues first, then warnings, then cleanup items.");
 }
+function printScanError(reason) {
+  console.error(pc.red("Qodfy could not scan this project."));
+  console.error("");
+  console.error(pc.bold("Reason:"));
+  console.error(reason);
+  console.error("");
+  console.error(pc.bold("Try:"));
+  console.error("qodfy scan --path ./my-next-app");
+}
+function getErrorMessage(error) {
+  if (error instanceof Error && error.message) {
+    return error.message;
+  }
+  return "An unexpected error occurred while scanning the project.";
+}
+function getErrorCode(error) {
+  if (error && typeof error === "object" && "code" in error && typeof error.code === "string") {
+    return error.code;
+  }
+  return void 0;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qodfy",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Open-source launch readiness scanner for AI-built apps.",
   "keywords": [
     "qodfy",
@@ -38,7 +38,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "license": "MIT",
   "engines": {
@@ -50,7 +51,7 @@
   "dependencies": {
     "commander": "^14.0.3",
     "picocolors": "^1.1.1",
-    "@qodfy/core": "^0.1.0"
+    "@qodfy/core": "^0.1.2"
   },
   "devDependencies": {
     "@types/node": "^25.7.0",