stackscan 0.1.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Benjamin Elliott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,222 @@
+# <img src="public/stackscan.svg#gh-light-mode-only" alt="StackScan" width="30" /> <img src="public/stackscan-white.svg#gh-dark-mode-only" alt="StackScan" width="30" /> StackScan
+
+![License](https://img.shields.io/badge/license-MIT-blue.svg)
+
+Automatically detect the tech stack of any project and generate structured output (JSON, Markdown, or badges).  
+Designed for portfolios, READMEs, dashboards, and CI automation.
+
+**StackScan** scans a repository (dependencies + file structure), normalizes detected technologies into categories, and maps them to logos with sensible fallbacks.
+
+---
+
+## Features
+
+- 🔍 Detect dependencies from `package.json`
+- 🖼 Built-in SVG logos with graceful fallbacks
+- 💾 Generate JSON, Markdown, and asset files
+- 🎨 Support for Brand, White, Black, or Custom color modes
+- 🤖 Automates Portfolio / Monorepo README updates
+
+---
+
+## Install
+
+### One-off (recommended)
+```bash
+npx stackscan@latest
+````
+
+### Global
+
+```bash
+npm install -g stackscan
+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.
+2.  **Run Scan**:
+
+```bash
+npx stackscan scan
+```
+
+### Add Command
+
+You can also add a project from anywhere on your disk using the CLI. You can point to a `package.json` file OR a project directory:
+
+```bash
+# Point to a file
+npx stackscan add ./path/to/package.json
+
+# Point to a folder (automatically finds 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:
+*   Scan all projects in `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.
+
+### Options
+
+```bash
+# Use white logos
+npx stackscan scan --color white
+
+# Use black logos
+npx stackscan scan --color black
+
+# Use brand colors (default)
+npx stackscan scan --color brand
+```
+
+---
+
+## Output
+
+For each project in `stackscan/`, a `stack.json` is generated in the same folder.
+
+Example `stack.json`:
+
+```json
+[
+  {
+    "name": "TypeScript",
+    "slug": "typescript",
+    "logo": "https://raw.githubusercontent.com/benjamindotdev/stackscan/main/public/assets/logos/language/typescript.svg",
+    "relativePath": "public/assets/logos/language/typescript.svg",
+    "color": "#3178C6"
+  },
+  {
+    "name": "Next.js",
+    "slug": "next",
+    "logo": "https://raw.githubusercontent.com/benjamindotdev/stackscan/main/public/assets/logos/frameworks/nextjs.svg",
+    "relativePath": "public/assets/logos/frameworks/nextjs.svg",
+    "color": "#000000"
+  }
+]
+```
+
+Anything without a known logo still renders cleanly using category defaults (e.g. a lock icon for auth).
+
+---
+
+
+## Logo resolution
+
+StackScan resolves logos in the following order:
+
+1. Built-in curated registry
+2. Known aliases (e.g. `next-auth` → **Auth.js**)
+3. External icon registries (when available)
+4. Category fallback icon (e.g. auth → lock)
+
+This guarantees usable output even when a logo is missing.
+
+---
+
+## GitHub Actions (optional)
+
+Use StackScan in CI to keep stack metadata up to date:
+
+```yaml
+name: stackscan
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  stackscan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npx stackscan scan
+```
+
+---
+
+## What StackSync does *not* do
+
+* ❌ It does not execute or analyze runtime code
+* ❌ It does not attempt to infer architectural quality
+* ❌ It does not require network access to be useful
+
+This keeps it fast, safe, and CI-friendly.
+
+---
+
+## Contributing
+
+Contributions are welcome — especially:
+
+* new detection rules
+* logo mappings and aliases
+* edge cases (monorepos, uncommon stacks)
+
+See `CONTRIBUTING.md` for development workflow and guidelines.
+
+---
+
+## License
+
+MIT
+
+```
+
+---
+
+### Final notes (important but quick)
+
+- This README is **npm-ready** and **user-focused**
+- Your internal branch/version automation should move to:
+  - `CONTRIBUTING.md` or `.github/`
+- The tone is correct for a free, public dev tool:  
+  *clear, confident, not over-marketed*
+
+You’re genuinely at the “ship it” point.  
+If you want, next I can:
+- tighten CLI flag descriptions to exactly match `commander`
+- write `CONTRIBUTING.md`
+- review your npm publish checklist line by line
+```
+
+
+<!-- STACKSYNC_START -->
+## My Projects
+
+### asozial
+<p>
+  <img src="public/assets/logos/auth/jsonwebtokens.svg" alt="JWT" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/frontend/nextdotjs.svg" alt="Auth.js" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/testing/jest.svg" alt="Jest" height="25" style="margin-right: 10px;" />
+</p>
+
+### portfolio
+<p>
+  <img src="public/assets/logos/frontend/react.svg" alt="React" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/frontend/react.svg" alt="ReactDOM" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/language/typescript.svg" alt="TypeScript" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/testing/playwright.svg" alt="Playwright" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/testing/testinglibrary.svg" alt="Testing Library" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/lint/husky.svg" alt="Husky" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/testing/jest.svg" alt="Jest" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/css/postcss.svg" alt="PostCSS" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/css/tailwindcss.svg" alt="TailwindCSS" height="25" style="margin-right: 10px;" />
+  <img src="public/assets/logos/build/vite.svg" alt="Vite" height="25" style="margin-right: 10px;" />
+</p>
+
+<!-- STACKSYNC_END -->

package/dist/add.d.mts

@@ -0,0 +1,3 @@
+declare function add(sourcePath: string): Promise<void>;
+
+export { add };

package/dist/add.d.ts

@@ -0,0 +1,3 @@
+declare function add(sourcePath: string): Promise<void>;
+
+export { add };

package/dist/add.js

@@ -0,0 +1,83 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/add.ts
+var add_exports = {};
+__export(add_exports, {
+  add: () => add
+});
+module.exports = __toCommonJS(add_exports);
+var import_fs_extra = __toESM(require("fs-extra"));
+var import_path = __toESM(require("path"));
+var import_chalk = __toESM(require("chalk"));
+var BASE_DIR = import_path.default.join(process.cwd(), "stackscan");
+async function add(sourcePath) {
+  let absoluteSourcePath = import_path.default.resolve(sourcePath);
+  if (!import_fs_extra.default.existsSync(absoluteSourcePath)) {
+    console.error(import_chalk.default.red(`\u274C Path not found: ${sourcePath}`));
+    process.exit(1);
+  }
+  if (import_fs_extra.default.statSync(absoluteSourcePath).isDirectory()) {
+    absoluteSourcePath = import_path.default.join(absoluteSourcePath, "package.json");
+    if (!import_fs_extra.default.existsSync(absoluteSourcePath)) {
+      console.error(import_chalk.default.red(`\u274C No package.json found in directory: ${sourcePath}`));
+      process.exit(1);
+    }
+  }
+  try {
+    const content = import_fs_extra.default.readFileSync(absoluteSourcePath, "utf-8");
+    const pkg = JSON.parse(content);
+    if (!pkg.name) {
+      console.error(import_chalk.default.red(`\u274C No "name" field found in ${sourcePath}`));
+      process.exit(1);
+    }
+    const baseFolderName = pkg.name.replace(/^@/, "").replace(/\//g, "-");
+    let folderName = baseFolderName;
+    let targetDir = import_path.default.join(BASE_DIR, folderName);
+    let counter = 1;
+    while (import_fs_extra.default.existsSync(targetDir)) {
+      folderName = `${baseFolderName}-${counter}`;
+      targetDir = import_path.default.join(BASE_DIR, folderName);
+      counter++;
+    }
+    const targetFile = import_path.default.join(targetDir, "package.json");
+    if (!import_fs_extra.default.existsSync(targetDir)) {
+      import_fs_extra.default.mkdirSync(targetDir, { recursive: true });
+    }
+    import_fs_extra.default.copyFileSync(absoluteSourcePath, targetFile);
+    console.log(import_chalk.default.green(`\u2705 Added project "${pkg.name}" to stackscan/${folderName}`));
+  } catch (error) {
+    console.error(import_chalk.default.red(`\u274C Error processing ${sourcePath}:`), error);
+    process.exit(1);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  add
+});

package/dist/add.mjs

@@ -0,0 +1,7 @@
+import {
+  add
+} from "./chunk-IFEEO473.mjs";
+import "./chunk-EOKQCSHI.mjs";
+export {
+  add
+};

package/dist/batch-import.d.mts

@@ -0,0 +1,6 @@
+interface BatchImportOptions {
+    color?: string;
+}
+declare function batchImport(options?: BatchImportOptions): Promise<void>;
+
+export { batchImport };

package/dist/batch-import.d.ts

@@ -0,0 +1,6 @@
+interface BatchImportOptions {
+    color?: string;
+}
+declare function batchImport(options?: BatchImportOptions): Promise<void>;
+
+export { batchImport };