stackscan 0.1.22 → 0.1.24

package/README.md

@@ -38,10 +38,8 @@ stackscan
 ## Usage
 
 1.  **Prepare Input**: 
-    *   Place your project folders inside `stackscan/`.
-    *   **OR** simply drop your `package.json` files directly into `stackscan/`. 
-        *   If you have multiple, you can name them `package (1).json`, `package (2).json`, etc.
-        *   StackScan will automatically create folders based on the project name defined in each file.
+    *   Place a folder for each desired project inside `public/stackscan/`.
+    *   Each folder should contain a `package.json` file.
 2.  **Run Scan**:
 
 ```bash
@@ -60,10 +58,10 @@ npx stackscan add ./path/to/package.json
 npx stackscan add ../my-project
 ```
 
-This will copy the `package.json` into a new folder inside `stackscan/` (e.g., `stackscan/my-project/`), handling name collisions automatically.
+This will copy the `package.json` into a new folder inside `public/stackscan/` (e.g., `public/stackscan/my-project/`), handling name collisions automatically.
 
 This will:
-*   Scan all projects in `stackscan/`.
+*   Scan all projects in `public/stackscan/`.
 *   Generate `stack.json` and `stack.md` inside each project folder.
 *   Copy logo assets to `public/assets/logos/`.
 *   Update your root `README.md` with a "My Projects" section.
@@ -85,7 +83,7 @@ npx stackscan scan --color brand
 
 ## Output
 
-For each project in `stackscan/`, a `stack.json` is generated in the same folder.
+For each project in `public/stackscan/`, a `stack.json` is generated in the same folder.
 
 Example `stack.json`:
 
@@ -149,7 +147,7 @@ jobs:
 
 ---
 
-## What StackSync does *not* do
+## What StackScan does *not* do
 
 * ❌ It does not execute or analyze runtime code
 * ❌ It does not attempt to infer architectural quality

package/dist/chunk-24PM76MV.mjs

@@ -0,0 +1,235 @@
+import {
+  techMap
+} from "./chunk-HKCVFKM4.mjs";
+import {
+  copyAssets,
+  generateMarkdown
+} from "./chunk-UJM3S22V.mjs";
+import {
+  simple_icons_hex_default
+} from "./chunk-EH2SEQZP.mjs";
+
+// src/scan.ts
+import fs from "fs";
+import path from "path";
+var BASE_DIR = path.join(process.cwd(), "public", "stackscan");
+var SKIPPED_TECHS = [
+  "react-dom"
+];
+var CATEGORY_PRIORITY = [
+  "language",
+  "framework",
+  "mobile",
+  "frontend",
+  "backend",
+  "runtime",
+  "database",
+  "orm",
+  "auth",
+  "api",
+  "state",
+  "css",
+  "cloud",
+  "hosting",
+  "devops",
+  "container",
+  "ci",
+  "testing",
+  "build",
+  "lint",
+  "format",
+  "automation",
+  "package",
+  "ai",
+  "network",
+  "utility",
+  "cms",
+  "ssg",
+  "payment"
+];
+var getCategoryPriority = (cat) => {
+  const idx = CATEGORY_PRIORITY.indexOf(cat ? cat.toLowerCase() : "");
+  return idx === -1 ? 999 : idx;
+};
+async function analyzeProject(projectPath, options) {
+  const packageJsonPath = path.join(projectPath, "package.json");
+  if (!fs.existsSync(packageJsonPath)) {
+    throw new Error(`No package.json found at ${packageJsonPath}`);
+  }
+  const content = fs.readFileSync(packageJsonPath, "utf-8");
+  const pkg = JSON.parse(content);
+  const allDeps = { ...pkg.dependencies, ...pkg.devDependencies };
+  const detectedTechs = [];
+  Object.keys(allDeps).forEach((dep) => {
+    if (SKIPPED_TECHS.includes(dep)) return;
+    if (techMap[dep]) {
+      const tech = techMap[dep];
+      let color = null;
+      if (options.color === "white") color = "#FFFFFF";
+      else if (options.color === "black") color = "#000000";
+      else if (options.color && options.color.startsWith("#")) color = options.color;
+      else {
+        const depSlug = dep.toLowerCase();
+        const nameSlug = tech.name.toLowerCase();
+        const nameSlugNoSpaces = tech.name.toLowerCase().replace(/\s+/g, "");
+        const hex = simple_icons_hex_default[depSlug] || simple_icons_hex_default[nameSlug] || simple_icons_hex_default[nameSlugNoSpaces];
+        if (hex) color = `#${hex}`;
+      }
+      detectedTechs.push({
+        name: tech.name,
+        slug: dep,
+        logo: tech.logo,
+        type: tech.type,
+        color
+      });
+    }
+  });
+  const uniqueSlugs = Array.from(new Set(detectedTechs.map((t) => t.slug)));
+  let uniqueTechs = uniqueSlugs.map((slug) => detectedTechs.find((t) => t.slug === slug));
+  const seenLogos = /* @__PURE__ */ new Set();
+  uniqueTechs = uniqueTechs.filter((t) => {
+    if (seenLogos.has(t.logo)) {
+      return false;
+    }
+    seenLogos.add(t.logo);
+    return true;
+  });
+  uniqueTechs.sort((a, b) => {
+    const pA = getCategoryPriority(a.type);
+    const pB = getCategoryPriority(b.type);
+    if (pA !== pB) return pA - pB;
+    return a.name.localeCompare(b.name);
+  });
+  const assetsDir = path.join(process.cwd(), "public", "assets", "logos");
+  if (options.copyAssets !== false) {
+    await copyAssets(uniqueTechs, assetsDir, { colorMode: options.color });
+  }
+  return uniqueTechs.map((t) => ({
+    ...t,
+    logo: `https://raw.githubusercontent.com/benjamindotdev/stackscan/main/public/assets/logos/${t.logo}`,
+    relativePath: `./public/assets/logos/${t.logo}`
+  }));
+}
+async function scan(targetPath, optionsOrUndefined) {
+  let options = {};
+  let pathArg = void 0;
+  if (typeof targetPath === "string") {
+    pathArg = targetPath;
+    options = optionsOrUndefined || {};
+  } else if (typeof targetPath === "object") {
+    options = targetPath;
+  }
+  if (options.readme === void 0) options.readme = true;
+  console.log("\u{1F680} Starting Scan...");
+  if (options.color) {
+    console.log(`\u{1F3A8} Color mode: ${options.color}`);
+  }
+  if (pathArg) {
+    const absPath = path.resolve(pathArg);
+    console.log(`Scanning single project at: ${absPath}`);
+    try {
+      const techsWithUrls = await analyzeProject(absPath, options);
+      if (options.out) {
+        const outPath = path.resolve(options.out);
+        fs.writeFileSync(outPath, JSON.stringify(techsWithUrls, null, 2));
+        console.log(`\u2705 Generated stack output to: ${options.out}`);
+      } else {
+        const outPath = path.join(absPath, "stack.json");
+        fs.writeFileSync(outPath, JSON.stringify(techsWithUrls, null, 2));
+        console.log(`\u2705 Generated stack.json at: ${outPath}`);
+      }
+    } catch (err) {
+      console.error(`\u274C Error scanning project:`, err.message);
+      process.exit(1);
+    }
+    return;
+  }
+  if (!fs.existsSync(BASE_DIR)) {
+    console.log(`Creating stackscan directory at: ${BASE_DIR}`);
+    fs.mkdirSync(BASE_DIR, { recursive: true });
+    console.log('Please place your project folders inside "public/stackscan/" and run this command again.');
+    process.exit(0);
+  }
+  const entries = fs.readdirSync(BASE_DIR, { withFileTypes: true });
+  const projectDirs = entries.filter((dirent) => dirent.isDirectory() && dirent.name !== "input" && dirent.name !== "output");
+  if (projectDirs.length === 0) {
+    console.log('\u26A0\uFE0F  No project directories found in "public/stackscan/".');
+    return;
+  }
+  console.log(`Found ${projectDirs.length} projects to process.
+`);
+  const allProjects = [];
+  for (const dir of projectDirs) {
+    const projectPath = path.join(BASE_DIR, dir.name);
+    if (fs.existsSync(path.join(projectPath, "package.json"))) {
+      try {
+        const techsWithUrls = await analyzeProject(projectPath, options);
+        fs.writeFileSync(
+          path.join(projectPath, "stack.json"),
+          JSON.stringify(techsWithUrls, null, 2)
+        );
+        const mdContent = generateMarkdown(techsWithUrls);
+        fs.writeFileSync(path.join(projectPath, "stack.md"), mdContent);
+        allProjects.push({
+          name: dir.name,
+          techs: techsWithUrls
+        });
+        console.log(`\u2705 ${dir.name.padEnd(20)} -> stack.json (${techsWithUrls.length} techs)`);
+      } catch (err) {
+        console.error(`\u274C Error processing ${dir.name}:`, err.message);
+      }
+    } else {
+      console.warn(`\u26A0\uFE0F  Skipping "${dir.name}": No package.json found.`);
+    }
+  }
+  if (options.readme && allProjects.length > 0) {
+    updateRootReadme(allProjects);
+  } else if (!options.readme) {
+    console.log("Skipping README update (--no-readme passed).");
+  }
+  console.log("\n\u2728 Sync complete.");
+}
+function updateRootReadme(projects) {
+  const readmePath = path.join(process.cwd(), "README.md");
+  if (!fs.existsSync(readmePath)) {
+    console.log("\u26A0\uFE0F  No root README.md found to update.");
+    return;
+  }
+  let readmeContent = fs.readFileSync(readmePath, "utf-8");
+  const startMarker = "<!-- STACKSCAN_START -->";
+  const endMarker = "<!-- STACKSCAN_END -->";
+  let newSection = `${startMarker}
+## My Projects
+
+`;
+  for (const p of projects) {
+    newSection += `### ${p.name}
+`;
+    newSection += `<p>
+`;
+    for (const t of p.techs) {
+      const src = t.relativePath || t.logo;
+      newSection += `  <img src="${src}" alt="${t.name}" height="25" style="margin-right: 10px;" />
+`;
+    }
+    newSection += `</p>
+
+`;
+  }
+  newSection += `${endMarker}`;
+  if (readmeContent.includes(startMarker) && readmeContent.includes(endMarker)) {
+    const regex = new RegExp(`${startMarker}[\\s\\S]*?${endMarker}`);
+    readmeContent = readmeContent.replace(regex, newSection);
+    console.log(`\u{1F4DD} Updated root README.md with ${projects.length} projects.`);
+  } else {
+    readmeContent += `
+
+${newSection}`;
+    console.log(`\u{1F4DD} Appended projects to root README.md.`);
+  }
+  fs.writeFileSync(readmePath, readmeContent);
+}
+
+export {
+  scan
+};