mdsmith 1.1.2 → 1.2.1

package/src/readme/index.js

@@ -0,0 +1,286 @@
+const fs = require("fs")
+const path = require("path")
+const prompts = require('prompts');
+
+const detectors = require("../../src/detectors")
+const scanner = require("../../src/scanner")
+const interactive = require("../../src/interactive")
+
+const projectRoot = process.cwd();
+
+const i18n = {
+  en: {
+    // Sections
+    projectInfo: "Project Info",
+    projectStructure: "Project Structure",
+    techStack: "Tech Stack",
+    gettingStarted: "Getting Started",
+    environmentVariables: "Environment Variables",
+    databaseSetup: "Database Setup",
+    server: "Server",
+
+    // Labels
+    version: "Version",
+    packageManager: "Package Manager",
+    type: "Type",
+    generatedBy: "Generated by",
+
+    // Text blocks
+    notSpecified: "Not specified",
+    createEnvFile: "Create a `.env` file in the project root with the following variables:",
+    runMigrations: "Run Prisma migrations:",
+    serverRunning: "After starting, the server will run at:",
+
+    // Project types
+    nodeProject: "Node.js Project",
+    frontendReact: "React Frontend",
+    nextApp: "Next.js Application",
+    expressApi: "REST API (Express)",
+    typescriptProject: "TypeScript Project"
+  },
+
+  pt: {
+    projectInfo: "Informações do Projeto",
+    projectStructure: "Estrutura do Projeto",
+    techStack: "Tecnologias",
+    gettingStarted: "Primeiros Passos",
+    environmentVariables: "Variáveis de Ambiente",
+    databaseSetup: "Configuração do Banco de Dados",
+    server: "Servidor",
+
+    version: "Versão",
+    packageManager: "Gerenciador de Pacotes",
+    type: "Tipo",
+    generatedBy: "Gerado por",
+
+    notSpecified: "Não especificado",
+    createEnvFile: "Crie um arquivo `.env` na raiz do projeto com as seguintes variáveis:",
+    runMigrations: "Execute as migrations do Prisma:",
+    serverRunning: "Após iniciar, o servidor estará disponível em:",
+
+    nodeProject: "Projeto Node.js",
+    frontendReact: "Frontend React",
+    nextApp: "Aplicação Next.js",
+    expressApi: "API REST (Express)",
+    typescriptProject: "Projeto TypeScript"
+  },
+
+  es: {
+    projectInfo: "Información del Proyecto",
+    projectStructure: "Estructura del Proyecto",
+    techStack: "Stack Tecnológico",
+    gettingStarted: "Primeros Pasos",
+    environmentVariables: "Variables de Entorno",
+    databaseSetup: "Configuración de Base de Datos",
+    server: "Servidor",
+
+    version: "Versión",
+    packageManager: "Administrador de Paquetes",
+    type: "Tipo",
+    generatedBy: "Generado por",
+
+    notSpecified: "No especificado",
+    createEnvFile: "Crea un archivo `.env` en la raíz del proyecto con las siguientes variables:",
+    runMigrations: "Ejecuta las migraciones de Prisma:",
+    serverRunning: "Después de iniciar, el servidor estará disponible en:",
+
+    nodeProject: "Proyecto Node.js",
+    frontendReact: "Frontend React",
+    nextApp: "Aplicación Next.js",
+    expressApi: "API REST (Express)",
+    typescriptProject: "Proyecto TypeScript"
+  }
+}
+
+
+async function generateReadme(packageJson, tree, config){
+
+  const deps = {
+    ...packageJson.dependencies,
+    ...packageJson.devDependencies
+  }
+
+  const techStack = detectors.detectarTechStack(deps)
+  const techSection = gerarTechStackSection(techStack)
+
+
+
+
+  const envVars = detectors.detectarEnvVars(projectRoot)
+  const envSection = gerarEnvSection(envVars)
+
+  const nomeProjeto = await interactive.buscarNome(packageJson.name);
+  const descricaoProjeto = await interactive.buscarDescricao(packageJson.description);
+  const idioma = await interactive.escolherLingua()
+  const t = i18n[idioma] || i18n.en
+
+  const packageManager = detectors.detectarPackageManager(projectRoot)
+
+  const scanData = scanner.scanProjectFiles(projectRoot)
+  let port = detectors.detectarPorta(scanData)
+
+  if (!port) {
+    port = await interactive.perguntarPortaManual()
+  }
+
+  const hasPrisma = detectors.detectarPrisma(projectRoot, packageJson)
+  const dbSection = hasPrisma ? gerarDatabaseSection(packageManager) : ""
+
+  const gettingStartedCommands = gerarGettingStarted(
+    packageManager,
+    packageJson.scripts,
+    hasPrisma
+  )
+
+
+
+const content = `
+# ${nomeProjeto}
+
+${descricaoProjeto}
+
+## ${config.emojis ? "🔖" : ""} ${t.projectInfo}
+- **${t.version}:** ${packageJson.version || t.notSpecified}
+- **${t.packageManager}:** ${packageManager}
+- **${t.type}:** ${detectarTipoProjeto(packageJson)}
+
+## 🛠 ${t.techStack}
+${techSection}
+
+## ${config.emojis ? "📁" : ""} ${t.projectStructure}
+\`\`\`
+${tree}
+\`\`\`
+
+## 🚀 ${t.gettingStarted}
+${gettingStartedCommands}
+
+## 🔑 ${t.environmentVariables}
+${t.createEnvFile}
+${envSection}
+
+## 🗄 ${t.databaseSetup}
+${t.runMigrations}
+${dbSection}
+
+${port ? `
+## 🌐 ${t.server}
+
+${t.serverRunning}
+
+http://localhost:${port}
+
+` : ""}
+
+
+---
+
+${t.generatedBy} **mdSmith**
+`
+    
+    return content 
+
+}
+
+function getRunCommand(script, packageManager) {
+  if (packageManager === "yarn") return `yarn ${script}`
+  if (packageManager === "pnpm") return `pnpm ${script}`
+  return `npm run ${script}`
+}
+
+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 gerarEnvSection(vars) {
+  if (!vars.length) return ""
+
+  let section = "\n\n"
+
+  vars.forEach(v => {
+    section += `- ${v}\n`
+  })
+
+  return section + "\n"
+}
+
+function gerarDatabaseSection(packageManager) {
+  let section = "\n\n"
+  section += "\n\n"
+  section += "```bash\n"
+
+  if (packageManager === "npm") {
+    section += "npx prisma migrate dev\n"
+    section += "npx prisma generate\n"
+  } else {
+    section += "npx prisma migrate dev\n"
+    section += "npx prisma generate\n"
+  }
+
+  section += "```\n\n"
+
+  return section
+}
+
+
+function gerarGettingStarted(packageManager = "npm", scripts = {}, hasPrisma) {
+  const lines = []
+
+  lines.push(
+    packageManager === "npm"
+      ? "npm install"
+      : `${packageManager} install`
+  )
+
+  if (hasPrisma) {
+    lines.push("npx prisma migrate dev")
+  }
+
+  if (scripts.dev) {
+    lines.push(getRunCommand("dev", packageManager))
+  } else if (scripts.start) {
+    lines.push(getRunCommand("start", packageManager))
+  }
+
+  return `
+
+\`\`\`bash
+${lines.join("\n")}
+\`\`\`
+
+`
+}
+
+function gerarTechStackSection(stack) {
+  if (!stack.length) return ""
+
+  let section = "\n\n"
+
+  stack.forEach(tech => {
+    section += `- ${tech}\n`
+  })
+
+  return section + "\n"
+}
+
+
+
+
+module.exports = {
+generateReadme,
+gerarEnvSection,
+gerarDatabaseSection,
+gerarGettingStarted,
+gerarTechStackSection
+}

package/src/scanner/index.js

@@ -0,0 +1,113 @@
+const fs = require("fs")
+const path = require("path")
+
+
+function scanDir(dirPath, padding, config) { 
+      let entries
+      try {
+        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)
+          })
+      } catch {
+        return ""
+      }
+
+    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 scanProjectFiles(projectRoot) {
+  const result = {
+    allFiles: [],
+    jsFiles: [],
+    tsFiles: [],
+    envFiles: [],
+    hasDockerfile: false,
+    hasPrisma: false,
+    hasSrcFolder: false,
+  }
+
+  function walk(dir) {
+    let files
+    try {
+      files = fs.readdirSync(dir)
+    } catch {
+      return
+    }
+
+    for (const file of files) {
+      const fullPath = path.join(dir, file)
+
+      // ignorar node_modules e .git
+      if (
+        fullPath.includes("node_modules") ||
+        fullPath.includes(".git")
+      ) continue
+
+      let stat
+      try {
+        stat = fs.lstatSync(fullPath)
+
+        if (stat.isSymbolicLink()) continue
+      } catch {
+        continue
+      }
+
+      if (stat.isDirectory()) {
+        if (file === "src") {
+          result.hasSrcFolder = true
+        }
+        walk(fullPath)
+      } else {
+        result.allFiles.push(fullPath)
+
+        if (file.endsWith(".js")) result.jsFiles.push(fullPath)
+        if (file.endsWith(".ts")) result.tsFiles.push(fullPath)
+        if (file.startsWith(".env")) result.envFiles.push(fullPath)
+
+        if (file === "Dockerfile") result.hasDockerfile = true
+        if (fullPath.includes("prisma")) result.hasPrisma = true
+      }
+    }
+  }
+
+  walk(projectRoot)
+
+  return result
+}
+
+module.exports = {
+scanDir,
+scanProjectFiles
+}