blytz 1.1.0 → 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';
 
@@ -80,45 +81,63 @@ function getLicenseName(licenseContent) {
     return firstLine || '';
 }
 
-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);
+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 (readmeExists && shouldInit && !shouldForce) {
-    console.error("README.md already exists. Try --force.");
-    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);
+    }
 
-if (!hasPackageJson && !hasRequirements) {
-    console.error("Error: No package.json or requirements.txt found in this directory.");
-    process.exit(1);
-}
+    if (readmeExists && shouldInit && !shouldForce) {
+        console.error("README.md already exists. Try --force.");
+        process.exit(1);
+    }
 
-console.log("Files found. Processing README...");
+    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 fileTree = buildFileTree(targetDir);
     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;
 
@@ -132,6 +151,8 @@ try {
             dependencies: collectDependencies(packageJson),
             scripts: collectScripts(packageJson),
             fileTree,
+            titleContent,
+            descriptionContent,
             licenseName,
             username: packageJson.author || process.env.USERNAME || 'Unknown Author',
             projectName: packageJson.name || projectName,
@@ -147,6 +168,8 @@ try {
             dependencies: collectPythonDependencies(requirementsContent),
             scripts: new Map(),
             fileTree,
+            titleContent,
+            descriptionContent,
             licenseName,
             username: process.env.USERNAME || 'Unknown Author',
             projectName,
@@ -156,15 +179,15 @@ try {
         projectType = 'python';
     }
 
-    // 3. Feed everything into your pure engine
     const updatedReadme = processReadme(readmeContent, projectType, context);
 
-    // 4. Overwrite the existing README.md with the new content
     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,6 +1,6 @@
 {
   "name": "blytz",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "bin": {
     "blytz": "./bin/cli.js"
   },

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,23 +1,24 @@
 import getProjectStructure from "./fileTree.js";
 
 export default function getDefaultContent(section, projectType, context = {}) {
-    const {
-        packages = [],
-        dependencies = [],
-        scripts = new Map(),
+    const {
+        packages = [],
+        dependencies = [],
+        scripts = new Map(),
         fileTree = null,
+        descriptionContent = "",
         licenseName = "",
         username = "Unknown",
-        projectName = "this project",
-        isMonorepo = false,
-    } = context ?? {};
+        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":
@@ -35,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.`;