docuapi 1.0.3 → 1.0.4

package/README-ANALYZE.md

@@ -0,0 +1,27 @@
+
+# docuapi
+
+CLI de teste para gerar documentação automática de APIs
+
+## 🔖 Informações
+- **Versão:** 1.0.3
+- **Gerenciador:** npm
+- **Tipo:** Backend Node.js
+
+## 🚀 Dependências
+- fs ^0.0.1-security
+- path ^0.12.7
+
+## 📁 Estrutura do Projeto
+```
+ 📂 bin
+   📄 fundamentos.js
+   📄 index.js
+ 📂 node_modules
+ 📄 package-lock.json
+ 📄 package.json
+ 📄 README-ANALYZE.md
+
+```
+
+📄 *README gerado automaticamente pelo **Analyze CLI***  

package/bin/fundamentos.js

@@ -0,0 +1,82 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+// Importa o módulo File System
+
+// Permite:
+// ler arquivos
+// criar arquivos
+// verificar pastas
+// navegar no projeto
+
+const path = require("path");
+// Importa o módulo path
+
+// Serve para montar caminhos sem quebrar em diferentes SO
+
+// Exemplo:
+// path.join("src", "index.js");
+
+// No Windows vira:
+// src\index.js
+
+// No Linux:
+// src/index.js
+
+const projectRoot = process.cwd();
+// process.cwd() - CWD -> current working directory
+// Coletando a pasta em que o usuário rodou o comando
+
+console.log("📁 Analisando projeto em:");
+console.log(projectRoot);
+
+//--------------------------------------------------
+
+if(fs.existsSync(path.join(process.cwd(), "package.json"))){
+    console.log("Projeto é Node")
+}else {
+    console.log("Package.json não encontrado.\nVerifique se você está rodando o comando na raiz do projeto.")
+    process.exit(1)
+}
+
+const packageJsonPath = path.join(projectRoot, "package.json");
+
+console.log(`caminho da pasta: ${packageJsonPath}`)
+
+const packageJsonRaw = fs.readFileSync(packageJsonPath, "utf-8");
+
+//console.log(packageJsonRaw)
+
+const packageJson = JSON.parse(packageJsonRaw);
+
+console.log(`O projeto ${packageJson.name} na versão ${packageJson.version}, tem as seguintes dependencias:`)
+console.log(packageJson.dependencies)
+
+const IGNORE_DIRS = ["node_modules", ".git", ".vscode"]; 
+
+function scanDir(dirPath, padding) { 
+    const entries = fs.readdirSync(dirPath, { withFileTypes: true }); 
+
+    
+    for (const entry of entries) { 
+        
+        const fullPath = path.join(dirPath, entry.name); 
+        
+        if (entry.isDirectory()) { 
+            if (IGNORE_DIRS.includes(entry.name)){
+                console.log(" ".repeat(padding*2), "📂", entry.name);
+            } else {
+                console.log(" ".repeat(padding*2), "📂", entry.name);
+                padding ++
+                scanDir(fullPath, padding);
+                padding --
+            }
+        } else { 
+            console.log(" ".repeat(padding*2), "📄", entry.name); 
+        } 
+    } 
+}
+    
+console.log("\n🌳 Estrutura do projeto:\n"); 
+scanDir(projectRoot, 0);
+

package/bin/index.js

@@ -1,79 +1,116 @@
 #!/usr/bin/env node
 
-const fs = require("fs");
-// Importa o módulo File System
+// npx analyze --help           # ajuda
+// npx analyze --tree     # mostra estrutura
+// npx analyze --deps     # mostra dependências
+// npx analyze --readme   # gera README
 
-// Permite:
-// ler arquivos
-// criar arquivos
-// verificar pastas
-// navegar no projeto
+const fs = require("fs");
 
 const path = require("path");
-// Importa o módulo path
-
-// Serve para montar caminhos sem quebrar em diferentes SO
-
-// Exemplo:
-// path.join("src", "index.js");
-
-// No Windows vira:
-// src\index.js
-
-// No Linux:
-// src/index.js
 
 const projectRoot = process.cwd();
-// process.cwd() - CWD -> current working directory
-// Coletando a pasta em que o usuário rodou o comando
-
-console.log("📁 Analisando projeto em:");
-console.log(projectRoot);
 
-//--------------------------------------------------
-
-if(fs.existsSync(path.join(process.cwd(), "package.json"))){
-    console.log("Projeto é Node")
-}else {
+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.")
     process.exit(1)
 }
 
-const packageJsonPath = path.join(projectRoot, "package.json");
-
-console.log(`caminho da pasta: ${packageJsonPath}`)
-
-const packageJsonRaw = fs.readFileSync(packageJsonPath, "utf-8");
+const packageJson = JSON.parse(fs.readFileSync(path.join(projectRoot, "package.json"), "utf-8"));
 
-//console.log(packageJsonRaw)
+const args = process.argv.slice(2)
 
-const packageJson = JSON.parse(packageJsonRaw);
+const IGNORE_DIRS = ["node_modules", ".git", ".vscode"]; 
 
-console.log(`O projeto ${packageJson.name} na versão ${packageJson.version}, tem as seguintes dependencias:`)
-console.log(packageJson.dependencies)
+function formatDependencies(deps) {
+    if (!deps || Object.keys(deps).length === 0) {
+        return "Projeto sem dependências.";
+    }
 
-const IGNORE_DIRS = ["node_modules", ".git", ".vscode"]; 
+    return Object.entries(deps)
+        .map(([name, version]) => `- ${name} ${version}`)
+        .join("\n");
+}
 
 function scanDir(dirPath, padding) { 
     const entries = fs.readdirSync(dirPath, { withFileTypes: true }); 
 
+    let treeContent = ""
+
     
     for (const entry of entries) { 
-        if (IGNORE_DIRS.includes(entry.name)) continue; 
         
         const fullPath = path.join(dirPath, entry.name); 
         
         if (entry.isDirectory()) { 
-
-            console.log(" ".repeat(padding*2), "📂", entry.name);
-            padding ++
-            scanDir(fullPath, padding);
-            padding --
+            if (IGNORE_DIRS.includes(entry.name)){
+                treeContent += `${" ".repeat(padding*2)} 📂 ${entry.name}\n`
+            } else {
+                treeContent += `${" ".repeat(padding*2)} 📂 ${entry.name}\n`
+                padding ++
+                treeContent += scanDir(fullPath, padding)
+                padding --
+            }
         } else { 
-            console.log(" ".repeat(padding*2), "📄", entry.name); 
+            treeContent += `${" ".repeat(padding*2)} 📄 ${entry.name}\n`
         } 
     } 
+
+    return treeContent
 }
+
+function generateReadme(packageJson, tree){
+const content = `
+# ${packageJson.name}
+
+${packageJson.description || "Projeto Node.js analisado automaticamente pelo Analyze."}
+
+## 🔖 Informações
+- **Versão:** ${packageJson.version}
+- **Gerenciador:** npm
+- **Tipo:** Backend Node.js
+
+## 🚀 Dependências
+${formatDependencies(packageJson.dependencies)}
+
+## 📁 Estrutura do Projeto
+\`\`\`
+${tree}
+\`\`\`
+
+📄 *README gerado automaticamente pelo **Analyze CLI***  
+`
     
-console.log("\n🌳 Estrutura do projeto:\n"); 
-scanDir(projectRoot, 0);
+    return content 
+
+}
+
+if(args.length == 0){
+    console.log(`
+    Bem vindo ao Analyze!
+    Analisador de projetos Node.js
+
+    Digite analyze --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
+    `)  
+} 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-ANALYZE.md", content)
+} else {
+    console.log("❌ Comando não reconhecido. Use --help para ver as opções.")
+}

package/package.json

@@ -3,7 +3,7 @@
   "bin": {
     "analyze": "./bin/index.js"
   },
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "CLI de teste para gerar documentação automática de APIs",
   "main": "index.js",
   "scripts": {