mdsmith 1.0.2 → 1.1.0

package/README-MDSMITH.md

@@ -0,0 +1,30 @@
+
+# mdsmith
+
+CLI para gerar READMEs e arquivos Markdown
+
+## 🔖 Informações
+- **Versão:** 1.0.2
+- **Gerenciador:** npm
+- **Tipo:** Projeto Node.js
+
+## 🚀 Dependências
+Projeto sem dependências.
+
+## 📁 Estrutura do Projeto
+```
+ 📂 bin
+   📄 beta.js
+   📄 index.js
+ 📂 node_modules
+ 📄 package-lock.json
+ 📄 package.json
+ 📄 README-MDSMITH.md
+
+```
+
+## 📜 Scripts disponíveis
+Projeto sem scripts.
+
+
+📄 *README gerado automaticamente pelo **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

@@ -9,6 +9,13 @@ 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"))){
@@ -59,16 +66,117 @@ 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("Não achamos o nome do projeto nos arquivos do Package.json, gostaria de informar pelo terminal? (y/n): ")
+            resposta = resposta.toLowerCase()
+
+            if(resposta == "y" || resposta == "n"){
+                respostaValida = true
+            }else {
+                console.log("Digite Y ou N caso queira prosseguir.")
+            }
+        }
+
+
+        if(resposta == "n"){
+            console.log("Escolha feita. O título do Readme ficará como NOME DO PROJETO NÃO INFORMADO.")
+            return "Nome do projeto não informado"
+        }if(resposta == "y"){
+            let nome = await perguntar("Informe o nome desejado para colocarmos no nome do projeto: ")
+            console.log("Obrigado por informar o nome!")
+            return nome
+        }else{
+            console.error("Erro ao gerar o nome do readme.")
+            process.exit(1)
+        }
+    }
+
+    return nome
+}
+
+async function buscarDescricao(descricao){
+    if(!descricao || descricao == "" || descricao == false){
+        
+        let respostaValida = false
+        let resposta = ""
+        while(!respostaValida){
+            resposta = await perguntar("Não achamos a descrição do projeto nos arquivos do Package.json, gostaria de informar pelo terminal? (y/n): ")
+            resposta = resposta.toLowerCase()
+
+            if(resposta == "y" || resposta == "n"){
+                respostaValida = true
+            }else {
+                console.log("Digite Y ou N caso queira prosseguir.")
+            }
+        }
+
+
+        if(resposta == "n"){
+            console.log("\nEscolha feita. O campo da descrição ficará presente para preenchimento posterior.\n")
+            return "*Digite aqui a descrição do projeto*"
+        }if(resposta == "y"){
+            let descricao = await perguntar("Conte-me sobre seu projeto: ")
+            console.log("\nObrigado por informar os dados do seu projeto!\n")
+            return descricao
+        }else{
+            console.error("Erro ao gerar o a descrição do readme.")
+            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 "Projeto Node.js"
+}
+
+function formatScripts(scripts) {
+    if (!scripts || Object.keys(scripts).length === 0) {
+        return "Projeto sem scripts.";
+    }
+
+    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
+- **Tipo:** ${detectarTipoProjeto(packageJson)}
 
 ## 🚀 Dependências
 ${formatDependencies(packageJson.dependencies)}
@@ -78,6 +186,10 @@ ${formatDependencies(packageJson.dependencies)}
 ${tree}
 \`\`\`
 
+## 📜 Scripts disponíveis
+${formatScripts(packageJson.scripts)}
+
+
 📄 *README gerado automaticamente pelo **mdSmith***  
 `
     
@@ -85,33 +197,38 @@ ${tree}
 
 }
 
-if(args.length == 0){
-    console.log(`
-    Bem vindo ao mdSmith!
-    Analisador de projetos Node.js
-
-    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.")
-}
+async function main() {
+    if(args.length == 0){
+        console.log(`
+        Bem vindo ao mdSmith!
+        Analisador de projetos Node.js
+
+        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 = await generateReadme(packageJson, scanDir(projectRoot, 0))
+
+        fs.writeFileSync("README-MDSMITH.md", content)
+        console.log("✅ README-MDSMITH.md gerado com sucesso!")
+        process.exit(0);
+    } else {
+        console.log("❌ Comando não reconhecido. Use npx mdsmith --help para ver as opções.")
+    }
+}
+
+main()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdsmith",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "CLI para gerar READMEs e arquivos Markdown",
   "bin": {
     "mdsmith": "./bin/index.js"