blytz 1.0.4 → 1.1.1

package/bin/cli.js

@@ -2,6 +2,7 @@
 
 import fs from 'fs';
 import path from 'path';
+import readline from 'readline/promises';
 
 import processReadme from '../src/processReadme.js';
 
@@ -49,6 +50,18 @@ function collectDependencies(packageJson) {
     return Object.keys(packageJson.dependencies || {}).sort();
 }
 
+function collectPythonDependencies(requirementsContent) {
+    return requirementsContent
+        .split(/\r?\n/)
+        .map(line => line.trim())
+        .filter(line => line && !line.startsWith('#'))
+        .filter(line => !line.startsWith('-'))
+        .map(line => line.split(';')[0].trim())
+        .map(line => line.split(/[=<>!~]/)[0].trim())
+        .filter(Boolean)
+        .sort((left, right) => left.localeCompare(right));
+}
+
 function collectScripts(packageJson) {
     const scripts = new Map();
 
@@ -59,64 +72,122 @@ function collectScripts(packageJson) {
     return scripts;
 }
 
-console.log("Scanning for project files...");
+function getLicenseName(licenseContent) {
+    const firstLine = licenseContent
+        .split(/\r?\n/)
+        .map(line => line.trim())
+        .find(Boolean);
 
-const targetDir = process.cwd();
-const readmePath = path.join(targetDir, 'README.md');
-const packageJsonPath = path.join(targetDir, 'package.json');
-const readmeExists = fs.existsSync(readmePath);
-
-if (!readmeExists && !shouldInit && !shouldForce) {
-    console.error("Error: No README.md found in this directory. Try --init.");
-    process.exit(1);
+    return firstLine || '';
 }
 
-if (readmeExists && shouldInit && !shouldForce) {
-    console.error("README.md already exists. Try --force.");
-    process.exit(1);
+async function promptForTitleAndDescription() {
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+
+    try {
+        const titleContent = (await rl.question('Add title: ')).trim();
+        const descriptionContent = (await rl.question('Add description: ')).trim();
+        return { titleContent, descriptionContent };
+    } finally {
+        rl.close();
+    }
 }
 
-if (!fs.existsSync(packageJsonPath)) {
-    console.error("Error: No package.json found in this directory.");
-    process.exit(1);
-}
+async function main() {
+    console.log("Scanning for project files...");
+
+    const targetDir = process.cwd();
+    const readmePath = path.join(targetDir, 'README.md');
+    const packageJsonPath = path.join(targetDir, 'package.json');
+    const requirementsPath = path.join(targetDir, 'requirements.txt');
+    const licensePath = path.join(targetDir, 'LICENSE');
+    const readmeExists = fs.existsSync(readmePath);
+    const hasPackageJson = fs.existsSync(packageJsonPath);
+    const hasRequirements = fs.existsSync(requirementsPath);
+    const hasLicense = fs.existsSync(licensePath);
+
+    if (!readmeExists && !shouldInit && !shouldForce) {
+        console.error("Error: No README.md found in this directory. Try --init.");
+        process.exit(1);
+    }
 
-console.log("Files found. Processing README...");
+    if (readmeExists && shouldInit && !shouldForce) {
+        console.error("README.md already exists. Try --force.");
+        process.exit(1);
+    }
+
+    if (!hasPackageJson && !hasRequirements) {
+        console.error("Error: No package.json or requirements.txt found in this directory.");
+        process.exit(1);
+    }
+
+    console.log("Files found. Processing README...");
 
-try {
     if (shouldForce && readmeExists) {
         fs.unlinkSync(readmePath);
     }
 
-    // 1. Read the raw text of both files
     const readmeContent = fs.existsSync(readmePath) ? fs.readFileSync(readmePath, 'utf-8') : '';
-    const packageJsonData = fs.readFileSync(packageJsonPath, 'utf-8');
-
-    // 2. Parse package.json to build the context object your engine expects
-    const packageJson = JSON.parse(packageJsonData);
     const fileTree = buildFileTree(targetDir);
-    const context = {
-        packageJson,
-        packages: [{ path: 'package.json', content: packageJson }],
-        dependencies: collectDependencies(packageJson),
-        scripts: collectScripts(packageJson),
-        fileTree,
-        username: packageJson.author || 'Unknown Author',
-        projectName: packageJson.name || 'this project',
-        hasPackageJson: true,
-        isMonorepo: false
-    };
-
-    // 3. Feed everything into your pure engine
-    // Hardcoding 'node' as projectType for now since we rely on package.json
-    const updatedReadme = processReadme(readmeContent, 'node', context);
-
-    // 4. Overwrite the existing README.md with the new content
+    const projectName = path.basename(targetDir);
+    const licenseName = hasLicense ? getLicenseName(fs.readFileSync(licensePath, 'utf-8')) : '';
+    const shouldPromptMetadata = !shouldUpdate;
+    const { titleContent, descriptionContent } = shouldPromptMetadata
+        ? await promptForTitleAndDescription()
+        : { titleContent: '', descriptionContent: '' };
+    let context;
+    let projectType;
+
+    if (hasPackageJson) {
+        const packageJsonData = fs.readFileSync(packageJsonPath, 'utf-8');
+        const packageJson = JSON.parse(packageJsonData);
+
+        context = {
+            packageJson,
+            packages: [{ path: 'package.json', content: packageJson }],
+            dependencies: collectDependencies(packageJson),
+            scripts: collectScripts(packageJson),
+            fileTree,
+            titleContent,
+            descriptionContent,
+            licenseName,
+            username: packageJson.author || process.env.USERNAME || 'Unknown Author',
+            projectName: packageJson.name || projectName,
+            hasPackageJson: true,
+            isMonorepo: false
+        };
+        projectType = 'node';
+    } else {
+        const requirementsContent = fs.readFileSync(requirementsPath, 'utf-8');
+
+        context = {
+            packages: [{ path: 'requirements.txt', content: requirementsContent }],
+            dependencies: collectPythonDependencies(requirementsContent),
+            scripts: new Map(),
+            fileTree,
+            titleContent,
+            descriptionContent,
+            licenseName,
+            username: process.env.USERNAME || 'Unknown Author',
+            projectName,
+            hasPackageJson: false,
+            isMonorepo: false
+        };
+        projectType = 'python';
+    }
+
+    const updatedReadme = processReadme(readmeContent, projectType, context);
+
     fs.writeFileSync(readmePath, updatedReadme, 'utf-8');
 
     console.log("Success! README.md has been auto-fixed.");
+}
 
-} catch (error) {
-    console.error("An error occurred during processing:", error.message);
-    process.exit(1);
-}
+(main()
+    .catch(error => {
+        console.error("An error occurred during processing:", error.message);
+        process.exit(1);
+    }));

package/package.json

@@ -1,49 +1,49 @@
-{
-  "name": "blytz",
-  "version": "1.0.4",
-  "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",
-    "prepublishOnly": "node scripts/sync-readme.js prepublish",
-    "postpublish": "node scripts/sync-readme.js postpublish"
-  },
-  "keywords": [
-    "blytz",
-    "cli",
-    "readme",
-    "documentation",
-    "automation",
-    "github",
-    "npm",
-    "bot",
-    "readmefixer",
-    "readme-generator",
-    "devtools",
-    "markdown",
-    "workflow",
-    "productivity",
-    "automated-docs",
-    "repository-manager",
-    "scaffold",
-    "readme-maintainer",
-    "readme-updater"
-  ],
-  "author": "Aryan Sharma",
-  "license": "MIT",
-  "dependencies": {
-    "@octokit/app": "^16.1.2",
-    "@octokit/rest": "^22.0.1",
-    "dotenv": "^17.4.0",
-    "express": "^5.2.1"
-  }
-}
+{
+  "name": "blytz",
+  "version": "1.1.1",
+  "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",
+    "prepublishOnly": "node scripts/sync-readme.js prepublish",
+    "postpublish": "node scripts/sync-readme.js postpublish"
+  },
+  "keywords": [
+    "blytz",
+    "cli",
+    "readme",
+    "documentation",
+    "automation",
+    "github",
+    "npm",
+    "bot",
+    "readmefixer",
+    "readme-generator",
+    "devtools",
+    "markdown",
+    "workflow",
+    "productivity",
+    "automated-docs",
+    "repository-manager",
+    "scaffold",
+    "readme-maintainer",
+    "readme-updater"
+  ],
+  "author": "Aryan Sharma",
+  "license": "MIT",
+  "dependencies": {
+    "@octokit/app": "^16.1.2",
+    "@octokit/rest": "^22.0.1",
+    "dotenv": "^17.4.0",
+    "express": "^5.2.1"
+  }
+}

package/src/processReadme.js

@@ -2,16 +2,18 @@ import getDefaultContent from "./template.js";
 
 
 //Core engine: processes README content and returns updated version
-export default function processReadme(content, projectType, context = {}) {
-
-    const normalizedContent = (content || "").replace(/^##(?=\S)/gm, "## ");
+export default function processReadme(content, projectType, context = {}) {
+    const { titleContent = "" } = context ?? {};
+
+    const normalizedContent = (content || "").replace(/^##(?=\S)/gm, "## ");
 
     // Split into sections
     const sections = normalizedContent.split("## ");
     const sectionMap = {};
 
     // Extract intro (title + description)
-    const intro = sections[0].trim();
+    const intro = sections[0].trim();
+    const finalIntro = titleContent ? `# ${titleContent}` : intro;
 
     // Parse sections
     sections.slice(1).forEach(section => {
@@ -65,7 +67,7 @@ export default function processReadme(content, projectType, context = {}) {
             .join(" ");
 
     // Rebuild README
-    let newReadme = intro ? intro + "\n\n" : "";
+    let newReadme = finalIntro ? finalIntro + "\n\n" : "";
 
     // Ordered sections
     requiredSections.forEach(section => {
@@ -80,4 +82,4 @@ export default function processReadme(content, projectType, context = {}) {
     });
 
     return newReadme.trim();
-}
+}

package/src/template.js

@@ -1,22 +1,24 @@
 import getProjectStructure from "./fileTree.js";
 
 export default function getDefaultContent(section, projectType, context = {}) {
-    const {
-        packages = [],
-        dependencies = [],
-        scripts = new Map(),
-        fileTree = null,
-        username = "Unknown",
-        projectName = "this project",
-        isMonorepo = false,
-    } = context ?? {};
+    const {
+        packages = [],
+        dependencies = [],
+        scripts = new Map(),
+        fileTree = null,
+        descriptionContent = "",
+        licenseName = "",
+        username = "Unknown",
+        projectName = "this project",
+        isMonorepo = false,
+    } = context ?? {};
 
     const safeProjectType = projectType || "unknown";
     const safeSection = (section || "").toLowerCase().trim();
 
-    switch (safeSection) {
-        case "description":
-            return getDescriptionContent(safeProjectType, projectName, isMonorepo);
+    switch (safeSection) {
+        case "description":
+            return getDescriptionContent(safeProjectType, projectName, isMonorepo, descriptionContent);
         case "installation":
             return getInstallationContent(safeProjectType, packages, isMonorepo);
         case "usage":
@@ -25,8 +27,8 @@ export default function getDefaultContent(section, projectType, context = {}) {
             return getDependenciesContent(dependencies, packages);
         case "folder structure":
             return getFolderStructureContent(fileTree);
-        case "license":
-            return "Add your license information here.";
+        case "license":
+            return getLicenseContent(licenseName);
         case "built by":
             return `Built with ❤️ by @${(username || "Unknown").trim()}`;
         default:
@@ -34,8 +36,12 @@ export default function getDefaultContent(section, projectType, context = {}) {
     }
 }
 
-function getDescriptionContent(projectType, projectName, isMonorepo) {
-    const name = projectName || "this project";
+function getDescriptionContent(projectType, projectName, isMonorepo, descriptionContent) {
+    if (descriptionContent) {
+        return descriptionContent;
+    }
+
+    const name = projectName || "this project";
     if (projectType === "node") {
         if (isMonorepo) {
             return `${name} is a Node.js monorepo containing multiple packages. Add a brief description of its purpose and what problem it solves.`;
@@ -93,21 +99,28 @@ function getUsageContent(projectType, scripts, isMonorepo) {
     return "Add usage instructions here.";
 }
 
-function getDependenciesContent(dependencies, packages) {
-    if (dependencies && dependencies.length > 0) {
-        const isMonorepo = packages && packages.length > 1;
-        const header = isMonorepo
-            ? `This project uses the following dependencies (across ${packages.length} packages):\n\n`
+function getDependenciesContent(dependencies, packages) {
+    if (dependencies && dependencies.length > 0) {
+        const isMonorepo = packages && packages.length > 1;
+        const header = isMonorepo
+            ? `This project uses the following dependencies (across ${packages.length} packages):\n\n`
             : "This project uses the following dependencies:\n\n";
 
         return header + dependencies.map(d => `- ${d}`).join("\n");
-    }
-    return "No dependencies found.";
-}
-
-function getFolderStructureContent(fileTree) {
+    }
+    return "No dependencies found.";
+}
+
+function getLicenseContent(licenseName) {
+    if (licenseName) {
+        return `This project is licensed under the ${licenseName}. See the LICENSE file for details.`;
+    }
+    return "Add your license information here.";
+}
+
+function getFolderStructureContent(fileTree) {
     if (!fileTree || typeof fileTree !== "object" || Object.keys(fileTree).length === 0) {
         return "Project structure:\n\n```\n(No file tree provided)\n```";
     }
     return "Project structure:\n\n" + getProjectStructure(fileTree);
-}
+}