@anthonylzq/simba.js 9.0.1 → 9.1.0

package/lib/src/functions/api/utils.js

@@ -1,441 +1,19 @@
-const { platform } = require('node:os')
-const { promisify } = require('node:util')
-const exec = promisify(require('node:child_process').exec)
+const mkdirs = require('../../utils/mkdirs')
 const writeFile = require('../../utils/writeFile')
+const { renderTemplate } = require('../../utils/renderTemplate')
 
 /**
  * @param {Object} args
- * @param {Boolean} args.fastify
  * @param {String} args.projectName
- * @param {String} args.email
- * @param {String} args.projectVersion
- * @param {String} args.graphQL
  */
-module.exports = async ({
-  fastify,
-  projectName,
-  email,
-  projectVersion,
-  graphQL
-}) => {
-  const createFoldersCommand = `mkdir ${projectName}/src/utils`
+module.exports = async ({ projectName }) => {
+  await mkdirs(`${projectName}/src/utils`)
 
-  if (platform() === 'win32')
-    await exec(createFoldersCommand.replaceAll('/', '\\'))
-  else await exec(createFoldersCommand)
+  const t = (templatePath, data = {}) =>
+    renderTemplate(`api/utils/${templatePath}`, data)
 
-  const utils = {
-    index: {
-      content: `${
-        fastify ? '' : "export { default as docs } from './docs.json'\n"
-      }export * from './Logger'\n`,
-      file: `${projectName}/src/utils/index.ts`
-    },
-    logger: {
-      content: `import { type Debugger } from 'debug'
-
-export interface Log {
-  log({
-    origin,
-    method,
-    value,
-    content
-  }: {
-    origin?: string
-    method: string
-    value: string
-    content: unknown
-  }): void
-}
-
-class Logger implements Log {
-  #debug: Debugger
-
-  constructor(debug: Debugger) {
-    this.#debug = debug
-  }
-
-  log({
-    origin,
-    method,
-    value,
-    content
-  }: {
-    origin: string
-    method: string
-    value: string
-    content: unknown
-  }) {
-    this.#debug(
-      \`\${origin} -> \${method} ~ value: \${value} ~ content: \${JSON.stringify(
-        content
-      )}\`
-    )
-  }
-}
-
-export { Logger }\n`,
-      file: `${projectName}/src/utils/Logger.ts`
-    },
-    ...(!fastify && {
-      docs: {
-        content: `{
-  "openapi": "3.0.0",
-  "info": {
-    "title": "${projectName}",
-    "description": "Documentation of the test",
-    "contact": {
-      "email": "${email}"
-    },
-    "license": {
-      "name": "MIT",
-      "url": "https://opensource.org/licenses/MIT"
-    },
-    "version": "${projectVersion}"
-  },
-  "servers": [
-    {
-      "url": "http://localhost:1996/api",
-      "description": "${projectName} local API"
-    }
-  ],
-  "tags": [
-    {
-      "name": "user",
-      "description": "Operations related to the user"
-    }
-  ]${
-    !graphQL
-      ? `,
-  "paths": {
-    "/users": {
-      "post": {
-        "tags": [
-          "user"
-        ],
-        "summary": "Save a user in the database",
-        "operationId": "store",
-        "requestBody": {
-          "$ref": "#/components/requestBodies/UserDTO"
-        },
-        "responses": {
-          "201": {
-            "description": "User successfully stored",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/User"
-                }
-              }
-            }
-          },
-          "422": {
-            "description": "Invalid request format",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          },
-          "500": {
-            "description": "Internal server error",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/user/{id}": {
-      "get": {
-        "tags": [
-          "user"
-        ],
-        "summary": "Get an specific user",
-        "operationId": "getOne",
-        "parameters": [
-          {
-            "name": "id",
-            "in": "path",
-            "description": "MongoDB user id",
-            "required": true,
-            "style": "simple",
-            "explode": false,
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "User stored in the database",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/User"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "User not found",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          },
-          "422": {
-            "description": "Invalid request format",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          },
-          "500": {
-            "description": "Internal server error",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          }
-        }
-      },
-      "patch": {
-        "tags": [
-          "user"
-        ],
-        "summary": "Update the user data",
-        "operationId": "update",
-        "parameters": [
-          {
-            "name": "id",
-            "in": "path",
-            "description": "MongoDB user id",
-            "required": true,
-            "style": "simple",
-            "explode": false,
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "$ref": "#/components/requestBodies/UserDTO"
-        },
-        "responses": {
-          "200": {
-            "description": "User successfully updated",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/User"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "User not found",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          },
-          "422": {
-            "description": "Invalid request format",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          },
-          "500": {
-            "description": "Internal server error",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          }
-        }
-      },
-      "delete": {
-        "tags": [
-          "user"
-        ],
-        "summary": "Delete one user from the database",
-        "operationId": "delete",
-        "parameters": [
-          {
-            "name": "id",
-            "in": "path",
-            "description": "MongoDB user id",
-            "required": true,
-            "style": "simple",
-            "explode": false,
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "User successfully deleted",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultSuccess"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "User not found",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          },
-          "422": {
-            "description": "Invalid request format",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          },
-          "500": {
-            "description": "Internal server error",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  },
-  "components": {
-    "schemas": {
-      "User": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string"
-          },
-          "lastName": {
-            "type": "string"
-          },
-          "name": {
-            "type": "string"
-          }
-        }
-      },
-      "DefaultSuccess": {
-        "type": "object",
-        "properties": {
-          "error": {
-            "type": "boolean",
-            "default": false
-          },
-          "message": {
-            "type": "object",
-            "properties": {
-              "result": {
-                "type": "string"
-              }
-            }
-          }
-        }
-      },
-      "DefaultError": {
-        "type": "object",
-        "properties": {
-          "error": {
-            "type": "boolean",
-            "default": true
-          },
-          "message": {
-            "type": "object",
-            "properties": {
-              "result": {
-                "type": "string"
-              }
-            }
-          }
-        }
-      }
-    },
-    "requestBodies": {
-      "UserDTO": {
-        "description": "User name and last name",
-        "content": {
-          "application/json": {
-            "schema": {
-              "type": "object",
-              "properties": {
-                "args": {
-                  "type": "object",
-                  "properties": {
-                    "name": {
-                      "type": "string"
-                    },
-                    "lastName": {
-                      "type": "string"
-                    }
-                  }
-                }
-              }
-            }
-          }
-        },
-        "required": true
-      }
-    }
-  }
-  }`
-      : '\n}'
-  }`,
-        file: `${projectName}/src/utils/docs.json`
-      }
-    })
-  }
-
-  const processes = [
-    writeFile(utils.index.file, utils.index.content),
-    writeFile(utils.logger.file, utils.logger.content)
-  ]
-
-  if (!fastify) processes.push(writeFile(utils.docs.file, utils.docs.content))
-
-  await Promise.all(processes)
+  await Promise.all([
+    writeFile(`${projectName}/src/utils/index.ts`, t('index.ts.ejs')),
+    writeFile(`${projectName}/src/utils/Logger.ts`, t('Logger.ts.ejs'))
+  ])
 }

package/lib/src/functions/biome.js

@@ -76,7 +76,8 @@ module.exports = async ({ projectName }) => {
   // En Biome 2.1.3, los decoradores de TypeScript se configuran diferente
   // Si necesitas decoradores para GraphQL, se pueden habilitar via tsconfig.json
 
-  // Configuración específica para Jest (equivalente al env jest: true)
+  // Configuración específica para archivos de test
+  // Vitest usa imports explícitos, pero mantenemos globals por compatibilidad
   biomeConfig.overrides = [
     {
       includes: [
@@ -95,7 +96,7 @@ module.exports = async ({ projectName }) => {
           'afterAll',
           'beforeEach',
           'afterEach',
-          'jest'
+          'vi'
         ]
       }
     }

package/lib/src/functions/changelog.js

@@ -1,15 +1,15 @@
 const writeFile = require('../utils/writeFile')
 const titleCase = require('../utils/titleCase')
+const { renderTemplate } = require('../utils/renderTemplate')
 
 /**
  * @param {String} projectName
  * @returns {Promise<void>}
  */
 module.exports = async projectName => {
-  const data = {
-    changelogContent: `# ${titleCase(projectName)}`,
-    changelogFile: 'CHANGELOG.md'
-  }
+  const content = renderTemplate('config/CHANGELOG.md.ejs', {
+    titleCaseName: titleCase(projectName)
+  })
 
-  await writeFile(`${projectName}/${data.changelogFile}`, data.changelogContent)
+  await writeFile(`${projectName}/CHANGELOG.md`, content)
 }

package/lib/src/functions/docker.js

@@ -1,4 +1,5 @@
 const writeFile = require('../utils/writeFile')
+const { renderTemplate } = require('../utils/renderTemplate')
 
 /**
  * @param {Object} args
@@ -10,47 +11,14 @@ const writeFile = require('../utils/writeFile')
 module.exports = async ({ projectName, manager }) => {
   const managerName = manager.split(' ')[0]
 
-  const data = {
-    dockerContent: `FROM node:18-alpine
-${managerName === 'pnpm' ? '\nRUN corepack enable\n' : ''}
-WORKDIR /app
-
-COPY . ./
-
-RUN ${
-      managerName === 'yarn' ? 'yarn' : managerName === 'npm' ? 'npm' : 'pnpm'
-    } i
-
-CMD [ "${managerName}", "start" ]`,
-    dockerFile: 'Dockerfile',
-    dockerIgnoreContent: `.eslintignore
-.eslintrc
-
-.git
-.gitignore
-.github
-
-*.md
-LICENSE
-
-*.http
-nodemon.json
-
-jest.config.ts
-*.log
-
-test
-
-# optionally you may want to ignore the .env file, but that depends on your own implementation
-.env`,
-    dockerIgnoreFile: '.dockerignore'
-  }
-
   await Promise.all([
-    writeFile(`${projectName}/${data.dockerFile}`, data.dockerContent),
     writeFile(
-      `${projectName}/${data.dockerIgnoreFile}`,
-      data.dockerIgnoreContent
+      `${projectName}/Dockerfile`,
+      renderTemplate('config/Dockerfile.ejs', { managerName })
+    ),
+    writeFile(
+      `${projectName}/.dockerignore`,
+      renderTemplate('config/.dockerignore.ejs')
     )
   ])
 }

package/lib/src/functions/ghat.js

@@ -1,7 +1,6 @@
-const { platform } = require('node:os')
-const { promisify } = require('node:util')
-const exec = promisify(require('node:child_process').exec)
+const mkdirs = require('../utils/mkdirs')
 const writeFile = require('../utils/writeFile')
+const { renderTemplate } = require('../utils/renderTemplate')
 
 /**
  * @param {String} projectName
@@ -9,13 +8,9 @@ const writeFile = require('../utils/writeFile')
  * @returns {Promise<void>}
  */
 module.exports = async (projectName, manager) => {
-  const createFoldersCommand = `mkdir ${projectName}/.github \
-${projectName}/.github/workflows`
   const managerName = manager.split(' ')[0]
 
-  if (platform() === 'win32')
-    await exec(createFoldersCommand.replaceAll('/', '\\'))
-  else await exec(createFoldersCommand)
+  await mkdirs(`${projectName}/.github/workflows`)
 
   const installCmd =
     managerName === 'yarn'
@@ -42,93 +37,16 @@ ${projectName}/.github/workflows`
           version: 9.x.x\n`
       : ''
 
-  const data = {
-    linting: {
-      content: `name: Lint - ${projectName}
-
-on: [push]
-
-jobs:
-  run-linters:
-    name: Run linters
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Check out Git repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-${pnpmSetup}
-      - name: Install Node.js dependencies
-        run: ${installCmd}
-
-      - name: Revert changes into the ${lockFile} file
-        run: git checkout -- ${lockFile}
-
-      - name: Run lint
-        run: ${runCmd} lint
-
-      - name: Check for changes
-        id: verify-changed-files
-        run: |
-          if [ -n "$(git status --porcelain)" ]; then
-            echo "changed=true" >> $GITHUB_OUTPUT
-            echo "✅ Changes detected after linting, preparing to commit..."
-          else
-            echo "changed=false" >> $GITHUB_OUTPUT
-            echo "ℹ️ No changes after linting, nothing to do, skipping commit"
-          fi
-
-      - name: Commit lint fixes
-        if: steps.verify-changed-files.outputs.changed == 'true'
-        uses: stefanzweifel/git-auto-commit-action@v6
-        with:
-          commit_message: 'feat: automated lint with biome'
-          file_pattern: '.'`,
-      file: `${projectName}/.github/workflows/lint.yml`
-    },
-    test: {
-      content: `name: Tests - ${projectName}
-
-on: [push]
-
-jobs:
-  test:
-    environment: Test
-    name: Testing Simba.js API
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Check out Git repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-${pnpmSetup}
-      - name: Install Node.js dependencies
-        run: ${installCmd}
-
-      - name: Run test
-        run: ${runCmd} test:ci
-        env:
-          DATABASE_URL: \${{ secrets.DATABASE_URL }}
-          NODE_ENV: ci
-`,
-      file: `${projectName}/.github/workflows/test.yml`
-    }
-  }
+  const data = { projectName, installCmd, lockFile, runCmd, pnpmSetup }
 
   await Promise.all([
-    writeFile(data.linting.file, data.linting.content),
-    writeFile(data.test.file, data.test.content)
+    writeFile(
+      `${projectName}/.github/workflows/lint.yml`,
+      renderTemplate('config/ghat/lint.yml.ejs', data)
+    ),
+    writeFile(
+      `${projectName}/.github/workflows/test.yml`,
+      renderTemplate('config/ghat/test.yml.ejs', data)
+    )
   ])
 }