blytz 1.0.0 → 1.0.2

package/README.md

@@ -1,60 +1,105 @@
-## Description
-
-diglet is a Node.js application. Add a brief description of its purpose and what problem it solves.
-
-## Installation
-
-Follow these steps to install the project:
-
-```bash
-npm install
-```
-
-## Usage
-
-You can run the following scripts:
-
-- `npm start`
-
-## Dependencies
-
-This project uses the following dependencies:
-
-- @octokit/app
-- @octokit/rest
-- dotenv
-- express
-
-## Folder Structure
-
-Project structure:
-
-```
-├── .env
-├── .gitignore
-├── bin
-│   └── cli.js
-├── LICENSE
-├── package-lock.json
-├── package.json
-├── README.md
-├── server
-│   ├── analytics.js
-│   ├── bot.js
-│   ├── github.js
-│   └── server.js
-└── src
-    ├── fileTree.js
-    ├── index.js
-    ├── processReadme.js
-    ├── projectReader.js
-    └── template.js
-```
-
-## License
-
-Add your license information here.
-
-## Built By
-
-Built with ❤️ by @Aryan Sharma
+# blytz
+
+`blytz` is a small Node.js CLI that creates and updates a project's `README.md` from local project metadata.
+
+## What it does
+
+- Updates an existing `README.md`
+- Creates a new `README.md` with `--init`
+- Replaces an existing `README.md` with `--force`
+- Reads `package.json` to build README sections automatically
+- Generates a basic folder tree for the project structure section
+
+## Install
+
+```bash
+npm install -g blytz
+```
+
+If you are developing locally from this repository, you can link it instead:
+
+```bash
+npm link
+```
+
+## Usage
+
+Run the CLI from the root of the project you want to document:
+
+```bash
+blytz
+```
+
+You can also use the available flags:
+
+```bash
+blytz --update
+blytz --init
+blytz --force
+blytz --help
+```
+
+## Commands
+
+### `blytz`
+
+Updates the existing `README.md` in the current directory.
+
+### `blytz --update`
+
+Same as `blytz`. Refreshes the current `README.md` using the project metadata it finds.
+
+### `blytz --init`
+
+Creates a new `README.md` only if one does not already exist.
+
+If a README already exists, the CLI stops and suggests using `--force`.
+
+### `blytz --force`
+
+Deletes the existing `README.md` and creates a fresh one.
+
+### `blytz --help`
+
+Prints the usage summary.
+
+## Output sections
+
+The generated README is built from these sections:
+
+- Description
+- Installation
+- Usage
+- Dependencies
+- Folder Structure
+- License
+- Built By
+
+## Project requirements
+
+For best results, include the following in your `package.json`:
+
+- `name`
+- `description`
+- `author`
+- `scripts`
+- `dependencies`
+
+The more metadata the CLI can read, the better the generated README will be.
+
+## Example
+
+```bash
+cd my-project
+blytz
+```
+
+## Notes
+
+- The CLI expects to run in a folder that contains `package.json`
+- The CLI reads the local `README.md` in the current directory
+- The folder tree excludes `node_modules` and `.git`
+
+## License
+
+MIT

package/bin/README-NPM.md

@@ -0,0 +1,105 @@
+# blytz
+
+`blytz` is a small Node.js CLI that creates and updates a project's `README.md` from local project metadata.
+
+## What it does
+
+- Updates an existing `README.md`
+- Creates a new `README.md` with `--init`
+- Replaces an existing `README.md` with `--force`
+- Reads `package.json` to build README sections automatically
+- Generates a basic folder tree for the project structure section
+
+## Install
+
+```bash
+npm install -g blytz
+```
+
+If you are developing locally from this repository, you can link it instead:
+
+```bash
+npm link
+```
+
+## Usage
+
+Run the CLI from the root of the project you want to document:
+
+```bash
+blytz
+```
+
+You can also use the available flags:
+
+```bash
+blytz --update
+blytz --init
+blytz --force
+blytz --help
+```
+
+## Commands
+
+### `blytz`
+
+Updates the existing `README.md` in the current directory.
+
+### `blytz --update`
+
+Same as `blytz`. Refreshes the current `README.md` using the project metadata it finds.
+
+### `blytz --init`
+
+Creates a new `README.md` only if one does not already exist.
+
+If a README already exists, the CLI stops and suggests using `--force`.
+
+### `blytz --force`
+
+Deletes the existing `README.md` and creates a fresh one.
+
+### `blytz --help`
+
+Prints the usage summary.
+
+## Output sections
+
+The generated README is built from these sections:
+
+- Description
+- Installation
+- Usage
+- Dependencies
+- Folder Structure
+- License
+- Built By
+
+## Project requirements
+
+For best results, include the following in your `package.json`:
+
+- `name`
+- `description`
+- `author`
+- `scripts`
+- `dependencies`
+
+The more metadata the CLI can read, the better the generated README will be.
+
+## Example
+
+```bash
+cd my-project
+blytz
+```
+
+## Notes
+
+- The CLI expects to run in a folder that contains `package.json`
+- The CLI reads the local `README.md` in the current directory
+- The folder tree excludes `node_modules` and `.git`
+
+## License
+
+MIT

package/bin/cli.js

@@ -13,12 +13,12 @@ const shouldUpdate = args.length === 0 || args.includes('--update');
 const hasAction = shouldUpdate || shouldInit || shouldForce;
 
 if (shouldShowHelp) {
-    console.log('Usage: fixme [--update|--init|--force]');
+    console.log('Usage: blytz [--update|--init|--force]');
     process.exit(0);
 }
 
 if (!hasAction) {
-    console.log('Usage: fixme [--update|--init|--force]');
+    console.log('Usage: blytz [--update|--init|--force]');
     process.exit(0);
 }
 

package/package.json

@@ -1,34 +1,46 @@
 {
   "name": "blytz",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "bin": {
     "blytz": "./bin/cli.js"
   },
+  "readme": "README-NPM.md",
+  "files": [
+    "bin/",
+    "src/",
+    "bin/README-NPM.md"
+  ],
   "description": "An automated CLI tool to fix and maintain project READMEs",
   "type": "module",
   "scripts": {
-    "start": "node src/index.js"
+    "start": "node src/index.js",
+    "prepublishOnly": "node scripts/sync-readme.js prepublish",
+    "postpublish": "node scripts/sync-readme.js postpublish"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AryanSharma48/readme-auto-fixer.git"
   },
   "keywords": [
+    "blytz",
     "cli",
     "readme",
+    "documentation",
     "automation",
     "github",
+    "npm",
     "bot",
     "readmefixer",
-    "readmeauto",
+    "readme-generator",
+    "devtools",
+    "markdown",
+    "workflow",
+    "productivity",
+    "automated-docs",
+    "repository-manager",
+    "scaffold",
     "readme-maintainer",
-    "readme-updater",
-    "readme-helper",
-    "readme-fixer",
-    "readme-bot",
-    "readme-automation",
-    "readme-enhancer",
-    "readme-improver"
+    "readme-updater"
   ],
   "author": "Aryan Sharma",
   "license": "MIT",

package/server/analytics.js

@@ -1,99 +0,0 @@
-import fs from "fs/promises";
-import path from "path";
-import { fileURLToPath } from "url";
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const DATA_FILE = path.join(__dirname, "../data/analytics.json");
-
-const DEFAULT_DATA = {
-    installs: [],
-    events: []
-};
-
-async function ensureDataDir() {
-    const dir = path.dirname(DATA_FILE);
-    try {
-        await fs.mkdir(dir, { recursive: true });
-    } catch (err) {
-        if (err.code !== "EEXIST") throw err;
-    }
-}
-
-async function readData() {
-    try {
-        const raw = await fs.readFile(DATA_FILE, "utf-8");
-        return JSON.parse(raw);
-    } catch (err) {
-        if (err.code === "ENOENT") {
-            return { ...DEFAULT_DATA };
-        }
-        if (err instanceof SyntaxError) {
-            console.error("Invalid JSON in analytics file, resetting...");
-            return { ...DEFAULT_DATA };
-        }
-        throw err;
-    }
-}
-
-async function writeData(data) {
-    await ensureDataDir();
-    await fs.writeFile(DATA_FILE, JSON.stringify(data, null, 2));
-}
-
-export async function trackInstall(installationId, accountLogin, accountType) {
-    const data = await readData();
-
-    const exists = data.installs.some(i => i.installationId === installationId);
-    if (!exists) {
-        data.installs.push({
-            installationId,
-            accountLogin,
-            accountType,
-            installedAt: new Date().toISOString()
-        });
-        await writeData(data);
-    }
-
-    return !exists;
-}
-
-export async function trackUninstall(installationId) {
-    const data = await readData();
-    const initialLength = data.installs.length;
-
-    data.installs = data.installs.filter(i => i.installationId !== installationId);
-
-    if (data.installs.length !== initialLength) {
-        await writeData(data);
-        return true;
-    }
-    return false;
-}
-
-export async function trackEvent(eventType, payload = {}) {
-    const data = await readData();
-
-    data.events.push({
-        type: eventType,
-        payload,
-        timestamp: new Date().toISOString()
-    });
-
-    await writeData(data);
-}
-
-export async function getStats() {
-    const data = await readData();
-
-    const eventCounts = data.events.reduce((acc, e) => {
-        acc[e.type] = (acc[e.type] || 0) + 1;
-        return acc;
-    }, {});
-
-    return {
-        totalInstalls: data.installs.length,
-        totalEvents: data.events.length,
-        eventsByType: eventCounts,
-        recentEvents: data.events.slice(-10).reverse()
-    };
-}

package/server/bot.js

@@ -1,210 +0,0 @@
-import { getOctokit } from "./github.js";
-import processReadme from "../src/processReadme.js";
-
-async function findAllPackageJsonPaths(octokit, owner, repo) {
-    try {
-        const { data: repoData } = await octokit.request("GET /repos/{owner}/{repo}", {
-            owner,
-            repo,
-        });
-        const defaultBranch = repoData.default_branch;
-
-        const { data: treeData } = await octokit.request("GET /repos/{owner}/{repo}/git/trees/{tree_sha}", {
-            owner,
-            repo,
-            tree_sha: defaultBranch,
-            recursive: "true",
-        });
-
-        const packageJsonPaths = treeData.tree
-            .filter(item =>
-                item.type === "blob" &&
-                item.path.endsWith("package.json") &&
-                !item.path.includes("node_modules/")
-            )
-            .map(item => item.path);
-
-        return { packageJsonPaths, treeData };
-    } catch (err) {
-        console.error("Error scanning repository tree:", err.message);
-        return { packageJsonPaths: [], treeData: null };
-    }
-}
-
-async function fetchPackageJson(octokit, owner, repo, path) {
-    try {
-        const { data } = await octokit.request("GET /repos/{owner}/{repo}/contents/{path}", {
-            owner,
-            repo,
-            path,
-        });
-        const content = JSON.parse(Buffer.from(data.content, "base64").toString());
-        return { path, content, error: null };
-    } catch (err) {
-        console.warn(`Failed to fetch/parse ${path}:`, err.message);
-        return { path, content: null, error: err.message };
-    }
-}
-
-async function fetchAllPackages(octokit, owner, repo) {
-    const { packageJsonPaths, treeData } = await findAllPackageJsonPaths(octokit, owner, repo);
-    const fileTree = treeData ? buildFileTree(treeData) : null;
-
-    if (packageJsonPaths.length === 0) {
-        return { packages: [], fileTree };
-    }
-
-    const results = await Promise.all(
-        packageJsonPaths.map(path => fetchPackageJson(octokit, owner, repo, path))
-    );
-
-    const packages = results.filter(pkg => pkg.content !== null);
-    return { packages, fileTree };
-}
-
-function aggregateDependencies(packages) {
-    const ignoreList = [
-        'eslint', 'prettier', 'husky', 'lint-staged', 'stylelint',
-        'typescript', 'vite', 'webpack', 'rollup', 'parcel', 'esbuild',
-        'babel', 'tsc', 'ts-node', 'tsx', 'nodemon', 'concurrently',
-        'jest', 'mocha', 'chai', 'vitest', 'cypress', 'playwright', 'supertest',
-        'postcss', 'autoprefixer', 'sass', 'less', 'dotenv', 'cross-env', 'rimraf',
-        'black', 'flake8', 'pylint', 'mypy', 'isort', 'autopep8', 'bandit',
-        'pytest', 'coverage', 'tox', 'mock', 'hypothesis', 'pytest-cov',
-        'setuptools', 'wheel', 'twine', 'build',
-        'python-dotenv', 'pip-tools', 'virtualenv', 'pre-commit'
-    ];
-
-    const depsSet = new Set();
-
-    for (const pkg of packages) {
-        const { content } = pkg;
-        if (content?.dependencies) {
-            Object.keys(content.dependencies).forEach(dep => {
-                if (dep.startsWith('@types/')) return;
-                if (dep.startsWith('@babel/')) return;
-                if (dep.startsWith('@vitejs/')) return;
-                if (dep.startsWith('types-')) return;
-                if (ignoreList.includes(dep)) return;
-                depsSet.add(dep);
-            });
-        }
-    }
-
-    return Array.from(depsSet).sort();
-}
-
-function buildFileTree(treeData, maxDepth = 4) {
-    const fileTree = {};
-
-    if (!treeData?.tree || !Array.isArray(treeData.tree)) {
-        return fileTree;
-    }
-
-    for (const item of treeData.tree) {
-        if (
-            item.path === "node_modules" ||
-            item.path.startsWith("node_modules/") ||
-            item.path === ".git" ||
-            item.path.startsWith(".git/")
-        ) {
-            continue;
-        }
-
-        const parts = item.path.split("/");
-        
-        if (parts.length > maxDepth) {
-            continue;
-        }
-
-        let current = fileTree;
-
-        for (let i = 0; i < parts.length; i++) {
-            const part = parts[i];
-            const isFile = i === parts.length - 1 && item.type === "blob";
-
-            if (isFile) {
-                current[part] = null;
-            } else {
-                if (!current[part]) {
-                    current[part] = {};
-                }
-                current = current[part];
-            }
-        }
-    }
-
-    return fileTree;
-}
-
-function aggregateScripts(packages) {
-    const scriptsMap = new Map();
-
-    for (const pkg of packages) {
-        const { path, content } = pkg;
-        const packageDir = path === "package.json" ? "(root)" : path.replace("/package.json", "");
-
-        if (content?.scripts) {
-            for (const [name, command] of Object.entries(content.scripts)) {
-                if (!scriptsMap.has(name)) {
-                    scriptsMap.set(name, []);
-                }
-                scriptsMap.get(name).push({ package: packageDir, command });
-            }
-        }
-    }
-
-    return scriptsMap;
-}
-
-export async function runBot(payload) {
-    try {
-        const installationId = payload.installation.id;
-        const owner = payload.repository.owner.login;
-        const repo = payload.repository.name;
-
-        const octokit = await getOctokit(installationId);
-
-        const { data } = await octokit.request("GET /repos/{owner}/{repo}/contents/{path}", {
-            owner,
-            repo,
-            path: "README.md",
-        });
-
-        const content = Buffer.from(data.content, "base64").toString();
-        const { packages, fileTree } = await fetchAllPackages(octokit, owner, repo);
-        const dependencies = aggregateDependencies(packages);
-        const scripts = aggregateScripts(packages);
-        const projectType = packages.length > 0 ? "node" : "unknown";
-
-        const context = {
-            packages,
-            dependencies,
-            scripts,
-            fileTree,
-            username: owner,
-            isMonorepo: packages.length > 1,
-        };
-
-        const newReadme = processReadme(content, projectType, context);
-
-        if (newReadme === content) {
-            console.log("No changes needed");
-            return;
-        }
-
-        await octokit.request("PUT /repos/{owner}/{repo}/contents/{path}", {
-            owner,
-            repo,
-            path: "README.md",
-            message: "Auto-update README",
-            content: Buffer.from(newReadme).toString("base64"),
-            sha: data.sha,
-        });
-
-        console.log("README updated successfully");
-
-    } catch (err) {
-        console.error("Bot error:", err.message);
-    }
-}

package/server/github.js

@@ -1,11 +0,0 @@
-import { App } from "@octokit/app";
-
-const app = new App({
-    appId: process.env.APP_ID,
-    privateKey: process.env.PRIVATE_KEY.replace(/\\n/g, '\n'),
-});
-
-export async function getOctokit(installationId) {
-    const octokit = await app.getInstallationOctokit(installationId);
-    return octokit;
-}

package/server/server.js

@@ -1,67 +0,0 @@
-import express from "express";
-import dotenv from "dotenv";
-import { runBot } from "./bot.js";
-import { trackInstall, trackUninstall, trackEvent, getStats } from "./analytics.js";
-
-dotenv.config();
-
-const app = express();
-app.use(express.json());
-
-app.get("/health", (req, res) => {
-    res.json({ status: "ok" });
-});
-
-app.get("/stats", async (req, res) => {
-    try {
-        const stats = await getStats();
-        res.json(stats);
-    } catch (err) {
-        console.error("Stats error:", err.message);
-        res.status(500).json({ error: "Failed to fetch stats" });
-    }
-});
-
-app.post("/webhook", async (req, res) => {
-    const event = req.headers["x-github-event"];
-
-    try {
-        if (event === "installation") {
-            const { action, installation } = req.body;
-
-            if (action === "created") {
-                await trackInstall(
-                    installation.id,
-                    installation.account.login,
-                    installation.account.type
-                );
-                await trackEvent("installation", { action, installationId: installation.id });
-            } else if (action === "deleted") {
-                await trackUninstall(installation.id);
-                await trackEvent("installation", { action, installationId: installation.id });
-            }
-        }
-
-        if (event === "push") {
-            console.log("Push event received");
-
-            const { repository, installation } = req.body;
-            await trackEvent("push", {
-                repo: repository.full_name,
-                installationId: installation.id
-            });
-
-            await runBot(req.body);
-        }
-    } catch (err) {
-        console.error("Webhook error:", err.message);
-    }
-
-    res.sendStatus(200);
-});
-
-const PORT = process.env.PORT || 3000;
-
-app.listen(PORT, () => {
-    console.log(`Server running on port ${PORT}`);
-});