mdsmith 1.0.2 → 1.1.1

package/README-MDSMITH.md

@@ -0,0 +1,31 @@
+
+# mdsmith
+
+CLI para gerar READMEs e arquivos Markdown
+
+## 🔖 Project Info
+- **Version:** 1.1.0
+- **Package Manager:** npm
+- **Type:** Node.js Project
+
+## 🚀 Dependencies
+No dependencies found.
+
+
+## 📁 Project Structure
+```
+ 📂 bin
+   📄 beta.js
+   📄 index.js
+ 📄 mdsmith.config.json
+ 📄 package-lock.json
+ 📄 package.json
+ 📄 README-MDSMITH.md
+
+```
+
+## 📜 Available Scripts
+No scripts available.
+
+
+Generated by **mdSmith**

package/bin/{fundamentos.js → beta.js}

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-// npx analyze --help           # ajuda
-// npx analyze --tree     # mostra estrutura
-// npx analyze --deps     # mostra dependências
-// npx analyze --readme   # gera README
+// npx mdsmith --help           # ajuda
+// npx mdsmith --tree     # mostra estrutura
+// npx mdsmith --deps     # mostra dependências
+// npx mdsmith --readme   # gera README
 
 const fs = require("fs");
 
@@ -63,7 +63,7 @@ function generateReadme(packageJson, tree){
 const content = `
 # ${packageJson.name || "Nome não informado."}
 
-${packageJson.description || "Projeto Node.js analisado automaticamente pelo Analyze."}
+${packageJson.description || "Projeto Node.js analisado automaticamente pelo mdSmith."}
 
 ## 🔖 Informações
 - **Versão:** ${packageJson.version || "Versão não informada."}
@@ -78,7 +78,7 @@ ${formatDependencies(packageJson.dependencies)}
 ${tree}
 \`\`\`
 
-📄 *README gerado automaticamente pelo **Analyze CLI***  
+📄 *README gerado automaticamente pelo **mdSmith***  
 `
     
     return content 
@@ -87,18 +87,18 @@ ${tree}
 
 if(args.length == 0){
     console.log(`
-    Bem vindo ao Analyze!
+    Bem vindo ao mdSmith!
     Analisador de projetos Node.js
 
-    Digite analyze --help se quiser ver os comandos disponíveis
+    Digite npx mdsmith --help se quiser ver os comandos disponíveis
     `);
     process.exit(0);
 } else if(args.includes("--help")){
     console.log(`
-    npx analyze --help      Mostra os comandos possíveis
-    npx analyze --tree      Mostra a estrutura do projeto
-    npx analyze --deps      Mostra as dependências
-    npx analyze --readme    Gera um README automaticamente
+    npx mdsmith --help      Mostra os comandos possíveis
+    npx mdsmith --tree      Mostra a estrutura do projeto
+    npx mdsmith --deps      Mostra as dependências
+    npx mdsmith --readme    Gera um README automaticamente
     `)  
 } else if (args.includes("--tree")){
     console.log("\n🌳 Estrutura do projeto:\n");
@@ -110,7 +110,8 @@ if(args.length == 0){
 } else if (args.includes("--readme")){
     const content = generateReadme(packageJson, scanDir(projectRoot, 0))
 
-    fs.writeFileSync("README-ANALYZE.md", content)
+    fs.writeFileSync("README-MDSMITH.md", content)
+    console.log("✅ README-MDSMITH.md gerado com sucesso!")
 } else {
-    console.log("❌ Comando não reconhecido. Use --help para ver as opções.")
+    console.log("❌ Comando não reconhecido. Use npx mdsmith --help para ver as opções.")
 }

package/bin/index.js

@@ -1,18 +1,30 @@
 #!/usr/bin/env node
 
-// npx mdsmith --help           # ajuda
-// npx mdsmith --tree     # mostra estrutura
-// npx mdsmith --deps     # mostra dependências
-// npx mdsmith --readme   # gera README
+// npx mdsmith --help     # show help
+// npx mdsmith --init     # create config file
+// npx mdsmith --tree     # show project structure
+// npx mdsmith --deps     # list dependencies
+// npx mdsmith --readme   # generate README
+
 
 const fs = require("fs");
 
 const path = require("path");
 
+const readline = require("readline");
+
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout
+});
+
 const projectRoot = process.cwd();
 
 if(!fs.existsSync(path.join(process.cwd(), "package.json"))){
-    console.log("Package.json não encontrado.\nVerifique se você está rodando o comando na raiz do projeto.")
+    console.log(`
+Error: package.json not found.
+Please run mdsmith from the project root.  
+    `)
     process.exit(1)
 }
 
@@ -20,11 +32,15 @@ const packageJson = JSON.parse(fs.readFileSync(path.join(projectRoot, "package.j
 
 const args = process.argv.slice(2)
 
-const IGNORE_DIRS = ["node_modules", ".git", ".vscode"]; 
+const defaultConfig = {
+  ignore: ["node_modules", ".git", ".vscode"],
+  depth: Infinity
+}
+
 
 function formatDependencies(deps) {
     if (!deps || Object.keys(deps).length === 0) {
-        return "Projeto sem dependências.";
+        return "No dependencies found.\n";
     }
 
     return Object.entries(deps)
@@ -32,8 +48,13 @@ function formatDependencies(deps) {
         .join("\n");
 }
 
-function scanDir(dirPath, padding) { 
-    const entries = fs.readdirSync(dirPath, { withFileTypes: true }); 
+function scanDir(dirPath, padding, config) { 
+    const entries = fs.readdirSync(dirPath, { withFileTypes: true })
+        .sort((a, b) => {
+            if (a.isDirectory() && !b.isDirectory()) return -1
+            if (!a.isDirectory() && b.isDirectory()) return 1
+            return a.name.localeCompare(b.name)
+        })
 
     let treeContent = ""
 
@@ -43,13 +64,17 @@ function scanDir(dirPath, padding) {
         const fullPath = path.join(dirPath, entry.name); 
         
         if (entry.isDirectory()) { 
-            if (IGNORE_DIRS.includes(entry.name)){
-                treeContent += `${" ".repeat(padding*2)} 📂 ${entry.name}\n`
+            if (config.ignore.includes(entry.name)){
+                continue
             } else {
                 treeContent += `${" ".repeat(padding*2)} 📂 ${entry.name}\n`
-                padding ++
-                treeContent += scanDir(fullPath, padding)
-                padding --
+                if (config.depth === null || padding < config.depth){
+                    padding ++
+                    treeContent += scanDir(fullPath, padding, config)
+                    padding --
+                } else {
+                    treeContent += `${" ".repeat((padding + 1) * 2)} ··· \n`
+                }
             }
         } else { 
             treeContent += `${" ".repeat(padding*2)} 📄 ${entry.name}\n`
@@ -59,59 +84,265 @@ function scanDir(dirPath, padding) {
     return treeContent
 }
 
-function generateReadme(packageJson, tree){
+function perguntar(pergunta) {
+  return new Promise(resolve => {
+    rl.question(pergunta, resolve);
+  });
+}
+
+async function buscarNome(nome){
+    if(!nome || nome == "" || nome == false){
+        
+        let respostaValida = false
+        let resposta = ""
+        while(!respostaValida){
+            resposta = await perguntar(`
+Project name not found in package.json.
+Would you like to provide one? (y/n):    
+            `)
+            resposta = resposta.trim().toLowerCase()
+
+            if(resposta == "y" || resposta == "n"){
+                respostaValida = true
+            }else {
+                console.log("Please type y or n.")
+            }
+        }
+
+
+        if(resposta == "n"){
+            console.log("\nProject name will be set as Unnamed Project.\n")
+            return "Unnamed Project"
+        }if(resposta == "y"){
+            let nome = await perguntar("Enter the project name: ")
+            console.log(`Project name set to "${nome}".`)
+            return nome
+        }else{
+            console.error("Failed to generate project name.")
+            process.exit(1)
+        }
+    }
+
+    return nome
+}
+
+async function buscarDescricao(descricao){
+    if(!descricao || descricao == "" || descricao == false){
+        
+        let respostaValida = false
+        let resposta = ""
+        while(!respostaValida){
+            resposta = await perguntar(`
+Project description not found.
+Would you like to provide one? (y/n):    
+            `)
+            resposta = resposta.trim().toLowerCase()
+
+            if(resposta == "y" || resposta == "n"){
+                respostaValida = true
+            }else {
+                console.log("Please type y or n.")
+            }
+        }
+
+
+        if(resposta == "n"){
+            console.log("\nDescription placeholder added.\n")
+            return "*Project description goes here*"
+        }if(resposta == "y"){
+            let descricao = await perguntar("Enter the project description: ")
+            console.log("\nDescription saved.\n")
+            return descricao
+        }else{
+            console.error("Failed to generate project description.")
+            process.exit(1)
+        }
+    }
+
+    return descricao
+}
+
+function detectarTipoProjeto(packageJson) {
+    const deps = {
+        ...packageJson.dependencies,
+        ...packageJson.devDependencies
+    }
+
+    if (deps.react) return "Frontend React"
+    if (deps.next) return "Next.js Application"
+    if (deps.express) return "API REST (Express)"
+    if (deps.typescript) return "Projeto TypeScript"
+
+    return "Node.js Project"
+}
+
+function formatScripts(scripts) {
+    if (!scripts || Object.keys(scripts).length === 0) {
+        return "No scripts available.\n";
+    }
+
+    return Object.entries(scripts)
+        .map(([name, script]) => `- ${name} -> ${script}`)
+        .join("\n");
+}
+
+
+async function generateReadme(packageJson, tree){
+
+    const nomeProjeto = await buscarNome(packageJson.name);
+    const descricaoProjeto = await buscarDescricao(packageJson.description);
+
 const content = `
-# ${packageJson.name || "Nome não informado."}
+# ${nomeProjeto}
 
-${packageJson.description || "Projeto Node.js analisado automaticamente pelo mdSmith."}
+${descricaoProjeto}
 
-## 🔖 Informações
-- **Versão:** ${packageJson.version || "Versão não informada."}
-- **Gerenciador:** npm
-- **Tipo:** Backend Node.js
+## 🔖 Project Info
+- **Version:** ${packageJson.version || "Not specified"}
+- **Package Manager:** npm
+- **Type:** ${detectarTipoProjeto(packageJson)}
 
-## 🚀 Dependências
+## 🚀 Dependencies
 ${formatDependencies(packageJson.dependencies)}
 
-## 📁 Estrutura do Projeto
+## 📁 Project Structure
 \`\`\`
 ${tree}
 \`\`\`
 
-📄 *README gerado automaticamente pelo **mdSmith***  
+## 📜 Available Scripts
+${formatScripts(packageJson.scripts)}
+
+Generated by **mdSmith**
 `
     
     return content 
 
 }
 
-if(args.length == 0){
-    console.log(`
-    Bem vindo ao mdSmith!
-    Analisador de projetos Node.js
+function loadConfig(projectRoot) {
+  const configPath = path.join(projectRoot, "mdsmith.config.json")
+
+  if (!fs.existsSync(configPath)) {
+    return defaultConfig
+  }
+
+  try {
+    const fileContent = fs.readFileSync(configPath, "utf-8")
+    const userConfig = JSON.parse(fileContent)
+
+    return {
+        ...defaultConfig,
+        ...userConfig,
+        ignore: [
+            ...defaultConfig.ignore,
+            ...(userConfig.ignore || [])
+        ]
+    }
+
+
+  } catch (error) {
+    console.log("Failed to read mdsmith.config.json. Using default configuration.")
+    return defaultConfig
+  }
+}
+
+async function main() {
+    const config = loadConfig(projectRoot)
+
+    if(args.length == 0){
+        console.log(`
+mdSmith
+Node.js project analyzer
+────────────────────────
+
+Run "mdsmith --help" to view available commands.
+        `);
+        process.exit(0);
+    }else if (args.includes("--init")) {
+
+        const configPath = path.join(projectRoot, "mdsmith.config.json")
+
+        if (fs.existsSync(configPath)) {
+            console.log("mdsmith.config.json already exists.")
+            process.exit(0)
+        }
+
+        fs.writeFileSync(
+            configPath,
+            JSON.stringify(defaultConfig, null, 2)
+        )
+
+        console.log("Configuration file created.")
+        process.exit(0)
+
+    } else if(args.includes("--help")){
+        console.log(`
+mdSmith — Available Commands
+────────────────────────
+
+    --help      Show help
+    --init      Create config file
+    --tree      Show project structure
+    --deps      List dependencies
+    --readme    Generate README
+        `)  
+        process.exit(0)
+    } else if (args.includes("--tree")){
+        console.log(`
+Project Structure
+────────────────────────
+        `);
+        console.log(scanDir(projectRoot, 0, config))
+        process.exit(0)
+    } else if (args.includes("--deps")){
+        console.log(`
+Dependencies
+────────────────────────   
+        `)
+        const deps = formatDependencies(packageJson.dependencies)
+        console.log(deps)
+        process.exit(0)
+    } else if (args.includes("--readme")){
+        const content = await generateReadme(packageJson, scanDir(projectRoot, 0, config))
+
+        console.log(`
+README Preview
+────────────────────────
+        `)
+
+        console.log(content)
+
+        let respostaValida = false
+        let confirm = ""
+
+        while (!respostaValida) {
+            confirm = await perguntar("\nGenerate README-MDSMITH.md? (y/n): ")
+            confirm = confirm.trim().toLowerCase()
+
+            if (confirm === "y" || confirm === "n") {
+                respostaValida = true
+            } else {
+                console.log("\nPlease type y or n.")
+            }
+        }
+
+        if (confirm === "y") {
+            fs.writeFileSync("README-MDSMITH.md", content)
+            console.log("\nREADME-MDSMITH.md created.\n")
+            process.exit(0)
+        } else {
+            console.log("\nOperation cancelled.\n")
+            process.exit(0)
+        }
+    } else {
+        console.log(`
+Unknown command.
+Run "mdsmith --help" for usage.    
+        `)
+        process.exit(0)
+    }
+}
+
+main()
 
-    Digite npx mdsmith --help se quiser ver os comandos disponíveis
-    `);
-    process.exit(0);
-} else if(args.includes("--help")){
-    console.log(`
-    npx mdsmith --help      Mostra os comandos possíveis
-    npx mdsmith --tree      Mostra a estrutura do projeto
-    npx mdsmith --deps      Mostra as dependências
-    npx mdsmith --readme    Gera um README automaticamente
-    `)  
-} else if (args.includes("--tree")){
-    console.log("\n🌳 Estrutura do projeto:\n");
-    console.log(scanDir(projectRoot, 0))
-} else if (args.includes("--deps")){
-    console.log(`O projeto ${packageJson.name} na versão ${packageJson.version}, tem as seguintes dependencias:`)
-    const deps = packageJson.dependencies || "Projeto sem depedencias"
-    console.log(deps)
-} else if (args.includes("--readme")){
-    const content = generateReadme(packageJson, scanDir(projectRoot, 0))
-
-    fs.writeFileSync("README-MDSMITH.md", content)
-    console.log("✅ README-MDSMITH.md gerado com sucesso!")
-} else {
-    console.log("❌ Comando não reconhecido. Use npx mdsmith --help para ver as opções.")
-}

package/mdsmith.config.json

@@ -0,0 +1,8 @@
+{
+  "ignore": [
+    "node_modules",
+    ".git",
+    ".vscode"
+  ],
+  "depth": 1
+}

package/package.json

@@ -1,6 +1,7 @@
 {
+  "$schema": "https://json.schemastore.org/package.json",
   "name": "mdsmith",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "CLI para gerar READMEs e arquivos Markdown",
   "bin": {
     "mdsmith": "./bin/index.js"