mdsmith 1.1.2 → 1.2.1

package/README-MDSMITH.md

@@ -1,30 +1,66 @@
 
-# Docuapi
+# mdsmith
 
 CLI para gerar READMEs e arquivos Markdown
 
-## 🔖 Project Info
-- **Version:** 1.1.1
-- **Package Manager:** npm
-- **Type:** Node.js Project
+## 🔖 Informações do Projeto
+- **Versão:** 1.2.0
+- **Gerenciador de Pacotes:** npm
+- **Tipo:** Node.js Project
 
-## 🚀 Dependencies
-No dependencies found.
+## 🛠 Tecnologias
 
 
-## 📁 Project Structure
+## 📁 Estrutura do Projeto
 ```
  📂 bin
    📄 beta.js
    📄 index.js
+   📄 versão2.js
+ 📂 src
+   📂 analysis
+     📄 index.js
+   📂 config
+     📄 index.js
+   📂 detectors
+     📄 index.js
+   📂 formatters
+     📄 index.js
+   📂 generators
+     📄 index.js
+   📂 interactive
+     📄 index.js
+   📂 readme
+     📄 index.js
+   📂 scanner
+     📄 index.js
  📄 mdsmith.config.json
+ 📄 package-lock.json
  📄 package.json
  📄 README-MDSMITH.md
 
 ```
 
-## 📜 Available Scripts
-No scripts available.
+## 🚀 Primeiros Passos
 
 
-Generated by **mdSmith**
+```bash
+npm install
+```
+
+
+
+## 🔑 Variáveis de Ambiente
+Crie um arquivo `.env` na raiz do projeto com as seguintes variáveis:
+
+
+## 🗄 Configuração do Banco de Dados
+Execute as migrations do Prisma:
+
+
+
+
+
+---
+
+Gerado por **mdSmith**

package/bin/index.js

@@ -5,18 +5,24 @@
 // npx mdsmith --tree     # show project structure
 // npx mdsmith --deps     # list dependencies
 // npx mdsmith --readme   # generate README
+// npx mdsmith --analyze  # project analyze
+
 
 
 const fs = require("fs");
 
 const path = require("path");
 
-const readline = require("readline");
+const core = require("../src/generators")
+const detectors = require("../src/detectors")
+const scanner = require("../src/scanner")
+const readme = require("../src/readme")
+const configModule = require("../src/config")
+const analysisModule = require("../src/analysis")
+const formatters = require("../src/formatters")
+
 
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout
-});
+const prompts = require('prompts');
 
 const projectRoot = process.cwd();
 
@@ -28,229 +34,21 @@ Please run mdsmith from the project root.
     process.exit(1)
 }
 
-const packageJson = JSON.parse(fs.readFileSync(path.join(projectRoot, "package.json"), "utf-8"));
-
-const args = process.argv.slice(2)
-
-const defaultConfig = {
-  ignore: ["node_modules", ".git", ".vscode"],
-  depth: Infinity
-}
-
-
-function formatDependencies(deps) {
-    if (!deps || Object.keys(deps).length === 0) {
-        return "No dependencies found.\n";
-    }
-
-    return Object.entries(deps)
-        .map(([name, version]) => `- ${name} ${version}`)
-        .join("\n");
-}
-
-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 = ""
-
-    
-    for (const entry of entries) { 
-        
-        const fullPath = path.join(dirPath, entry.name); 
-        
-        if (entry.isDirectory()) { 
-            if (config.ignore.includes(entry.name)){
-                continue
-            } else {
-                treeContent += `${" ".repeat(padding*2)} 📂 ${entry.name}\n`
-                if (config.depth === null || padding < config.depth){
-                    padding ++
-                    treeContent += scanDir(fullPath, padding, config)
-                    padding --
-                } else {
-                    treeContent += `${" ".repeat((padding + 1) * 2)} ··· \n`
-                }
-            }
-        } else { 
-            if (config.ignore.includes(entry.name)){
-                continue
-            } else{
-                treeContent += `${" ".repeat(padding*2)} 📄 ${entry.name}\n`
-            }
-        } 
-    } 
-
-    return treeContent
-}
-
-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";
-    }
+let packageJson
 
-    return Object.entries(scripts)
-        .map(([name, script]) => `- ${name} -> ${script}`)
-        .join("\n");
+try {
+  packageJson = JSON.parse(
+    fs.readFileSync(path.join(projectRoot, "package.json"), "utf-8")
+  )
+} catch {
+  console.log("Invalid package.json file.")
+  process.exit(1)
 }
 
-
-async function generateReadme(packageJson, tree){
-
-    const nomeProjeto = await buscarNome(packageJson.name);
-    const descricaoProjeto = await buscarDescricao(packageJson.description);
-
-const content = `
-# ${nomeProjeto}
-
-${descricaoProjeto}
-
-## 🔖 Project Info
-- **Version:** ${packageJson.version || "Not specified"}
-- **Package Manager:** npm
-- **Type:** ${detectarTipoProjeto(packageJson)}
-
-## 🚀 Dependencies
-${formatDependencies(packageJson.dependencies)}
-
-## 📁 Project Structure
-\`\`\`
-${tree}
-\`\`\`
-
-## 📜 Available Scripts
-${formatScripts(packageJson.scripts)}
-
-Generated by **mdSmith**
-`
-    
-    return content 
-
-}
-
-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
-  }
-}
+const args = process.argv.slice(2)
 
 async function main() {
-    const config = loadConfig(projectRoot)
+    const config = configModule.loadConfig(projectRoot)
 
     if(args.length == 0){
         console.log(`
@@ -272,7 +70,7 @@ Run "mdsmith --help" to view available commands.
 
         fs.writeFileSync(
             configPath,
-            JSON.stringify(defaultConfig, null, 2)
+            JSON.stringify(configModule.defaultConfig, null, 2)
         )
 
         console.log("Configuration file created.")
@@ -288,6 +86,7 @@ mdSmith — Available Commands
     --tree      Show project structure
     --deps      List dependencies
     --readme    Generate README
+    --analyze   Project analysis
         `)  
         process.exit(0)
     } else if (args.includes("--tree")){
@@ -295,18 +94,47 @@ mdSmith — Available Commands
 Project Structure
 ────────────────────────
         `);
-        console.log(scanDir(projectRoot, 0, config))
+        console.log(scanner.scanDir(projectRoot, 0, config))
         process.exit(0)
+    } else if (args.includes("--analyze")){
+      const analysis = analysisModule.analisarProjeto(packageJson, projectRoot)
+      const packageManager = detectors.detectarPackageManager(projectRoot)
+
+      formatters.formatarAnalise(analysis)
+
+      const commands = analysisModule.analisarScripts(packageJson.scripts, packageManager)
+      const warnings = analysisModule.diagnosticarExecucao(commands)
+
+      formatters.formatarExecucao(commands, warnings)
+
+      const issues = analysisModule.healthChecks(packageJson, projectRoot, analysis)
+
+      if (issues.length > 0) {
+          console.log("Health Checks")
+          console.log("────────────────────────")
+          issues.forEach(issue => {
+            let icon = "⚠"
+
+            if (issue.type === "critical") icon = "❌"
+            if (issue.type === "info") icon = "ℹ"
+
+            console.log(`${icon} ${issue.message}`)
+          })
+          console.log()
+      }
+
+      process.exit(0)
     } else if (args.includes("--deps")){
         console.log(`
 Dependencies
 ────────────────────────   
         `)
-        const deps = formatDependencies(packageJson.dependencies)
-        console.log(deps)
+        const deps = core.formatDependencies(packageJson.dependencies)
+        console.log(`${deps}\n`)
+        console.log()
         process.exit(0)
     } else if (args.includes("--readme")){
-        const content = await generateReadme(packageJson, scanDir(projectRoot, 0, config))
+        const content = await readme.generateReadme(packageJson, scanner.scanDir(projectRoot, 0, config), config)
 
         console.log(`
 README Preview
@@ -315,28 +143,22 @@ 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()
+        const confirmResponse = await prompts({
+            type: 'confirm',
+            name: 'generate',
+            message: 'Generate README-MDSMITH.md?',
+            initial: true
+        });
 
-            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)
+        if (confirmResponse.generate) {
+            fs.writeFileSync("README-MDSMITH.md", content);
+            console.log("\nREADME-MDSMITH.md created.\n");
         } else {
-            console.log("\nOperation cancelled.\n")
-            process.exit(0)
+            console.log("\nOperation cancelled.\n");
         }
+
+        process.exit(0);
+
     } else {
         console.log(`
 Unknown command.