@anthonylzq/simba.js 7.2.0 → 8.0.0

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

@@ -5,27 +5,79 @@ const writeFile = require('../../utils/writeFile')
 
 /**
  * @param {Object} args
- * @param {Boolean} args.express
+ * @param {Boolean} args.fastify
  * @param {String} args.projectName
  * @param {String} args.email
  * @param {String} args.projectVersion
- * @param {String} args.graphql
+ * @param {String} args.graphQL
  */
 module.exports = async ({
-  express,
+  fastify,
   projectName,
   email,
   projectVersion,
-  graphql
+  graphQL
 }) => {
-  if (express) {
-    const createFoldersCommand = `mkdir ${projectName}/src/utils`
+  const createFoldersCommand = `mkdir ${projectName}/src/utils`
 
-    if (platform() === 'win32')
-      await exec(createFoldersCommand.replaceAll('/', '\\'))
-    else await exec(createFoldersCommand)
+  if (platform() === 'win32')
+    await exec(createFoldersCommand.replaceAll('/', '\\'))
+  else await exec(createFoldersCommand)
 
-    const utils = {
+  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 { 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",
@@ -53,9 +105,9 @@ module.exports = async ({
       "description": "Operations related to the user"
     }
   ]
-${
-  !graphql
-    ? `,
+  ${
+    !graphQL
+      ? `,
   "paths": {
     "/users": {
       "post": {
@@ -99,81 +151,6 @@ ${
             }
           }
         }
-      },
-      "get": {
-        "tags": [
-          "user"
-        ],
-        "summary": "Get all the users in the database",
-        "operationId": "getAll",
-        "responses": {
-          "200": {
-            "description": "All the users in the database",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "error": {
-                      "type": "boolean",
-                      "default": false
-                    },
-                    "message": {
-                      "type": "object",
-                      "properties": {
-                        "result": {
-                          "type": "array",
-                          "items": {
-                            "$ref": "#/components/schemas/User"
-                          }
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "500": {
-            "description": "Internal server error",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          }
-        }
-      },
-      "delete": {
-        "tags": [
-          "user"
-        ],
-        "summary": "Delete all the users in the database",
-        "operationId": "deleteAll",
-        "responses": {
-          "200": {
-            "description": "All the users in the database",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultSuccess"
-                }
-              }
-            }
-          },
-          "500": {
-            "description": "Internal server error",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DefaultError"
-                }
-              }
-            }
-          }
-        }
       }
     },
     "/user/{id}": {
@@ -446,21 +423,20 @@ ${
       }
     }
   }
-}`
-    : '}'
-}`,
+  }`
+      : '}'
+  }`,
         file: `${projectName}/src/utils/docs.json`
-      },
-      index: {
-        content: "export { default as docs } from './docs.json'\n",
-        file: `${projectName}/src/utils/index.ts`
       }
-    }
-
-    if (express)
-      await Promise.all([
-        writeFile(utils.docs.file, utils.docs.content),
-        writeFile(utils.index.file, utils.index.content)
-      ])
+    })
   }
+
+  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)
 }

package/lib/src/functions/docker.js

@@ -1,47 +1,56 @@
 const writeFile = require('../utils/writeFile')
 
 /**
- * @param {String} projectName
+ * @param {Object} args
+ * @param {String} args.projectName
+ * @param {String} args.manager
  * @returns {Promise<void>}
  */
-module.exports = async projectName => {
-  const data = {
-    dockerContent: `FROM node:16-alpine
+// TODO: add the correct package manager
+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 yarn install --prod
-
-RUN yarn add webpack webpack-node-externals tsconfig-paths-webpack-plugin -D
+RUN ${
+      managerName === 'yarn' ? 'yarn' : managerName === 'npm' ? 'npm' : 'pnpm'
+    } i
 
-RUN yarn build
-
-RUN yarn remove webpack webpack-node-externals tsconfig-paths-webpack-plugin
-
-CMD [ "yarn", "start" ]
-`,
+CMD [ "${managerName}", "start" ]`,
     dockerFile: 'Dockerfile',
     dockerIgnoreContent: `.eslintignore
 .eslintrc
+
+.git
 .gitignore
-CHANGELOG.md
-Dockerfile
-heroku.yml
-*.http
+.github
+
+*.md
 LICENSE
+
+*.http
 nodemon.json
-README.md
+
+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 writeFile(`${projectName}/${data.dockerFile}`, data.dockerContent)
-  await writeFile(
-    `${projectName}/${data.dockerIgnoreFile}`,
-    data.dockerIgnoreContent
-  )
+  await Promise.all([
+    writeFile(`${projectName}/${data.dockerFile}`, data.dockerContent),
+    writeFile(
+      `${projectName}/${data.dockerIgnoreFile}`,
+      data.dockerIgnoreContent
+    )
+  ])
 }

package/lib/src/functions/eslint.js

@@ -3,22 +3,23 @@ const writeFile = require('../utils/writeFile')
 /**
  * @param {Object} args
  * @param {String} args.projectName
- * @param {Boolean} args.tests
  * @param {Boolean} args.dbIsSQL
  * @returns {Promise<void>}
  */
-module.exports = async ({ projectName, tests, dbIsSQL }) => {
+module.exports = async ({ projectName, dbIsSQL }) => {
   const data = {
     eslintContent: `{
   "env": {
-    "node": true${tests ? ',\n    "jest": true' : ''}
+    "node": true,
+    "jest": true
   },
   "root": true,
   "parser": "@typescript-eslint/parser",
   "plugins": [
     "@typescript-eslint",
     "import",
-    "prettier"${tests ? ',\n    "jest"' : ''}
+    "prettier",
+    "jest"
   ],
   "extends": [
     "standard",
@@ -47,9 +48,10 @@ module.exports = async ({ projectName, tests, dbIsSQL }) => {
       {
         "devDependencies": [
           "**/*.test.ts",
-          "webpack.config.js"${tests ? ',\n          "jest.config.ts"' : ''}${
-      dbIsSQL ? ',\n          "src/database/postgres/config.js"' : ''
-    }
+          "webpack.config.js",
+          "jest.config.ts"${
+            dbIsSQL ? ',\n          "src/database/postgres/config.js"' : ''
+          }
         ],
         "optionalDependencies": [
           "**/*.test.ts"

package/lib/src/functions/ghat.js

@@ -5,7 +5,7 @@ const writeFile = require('../utils/writeFile')
 
 /**
  * @param {String} projectName
- * @param {'yarn add'|'npm i'} manager
+ * @param {'yarn add'|'npm i'|'pnpm i'} manager
  * @returns {Promise<void>}
  */
 module.exports = async (projectName, manager) => {
@@ -37,27 +37,31 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
-
+          node-version: 18.x
+${
+  managerName === 'pnpm'
+    ? `
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 6.x.x\n`
+    : ''
+}
       - name: Install Node.js dependencies
         run: ${
-          managerName === 'yarn' ? 'yarn install --frozen-lockfile' : 'npm ci'
-        }
-
-      - name: Revert changes into the ${
-        managerName === 'yarn' ? 'yarn.lock' : 'package-lock.json'
-      } file
-        run: git checkout -- ${
-          managerName === 'yarn' ? 'yarn.lock' : 'package-lock.json'
+          managerName === 'yarn'
+            ? 'yarn install --frozen-lockfile'
+            : managerName
+            ? 'pnpm i --frozen-lockfile'
+            : 'npm ci'
         }
 
       - name: Run linters
-        uses: wearerequired/lint-action@v1
+        uses: wearerequired/lint-action@v2
         with:
           auto_fix: true
           eslint: true
-          eslint_extensions: js
-`,
+          eslint_extensions: js\n`,
       file: `${projectName}/.github/workflows/lint.yml`
     },
     test: {
@@ -80,24 +84,29 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
-
+          node-version: 18.x
+${
+  managerName === 'pnpm'
+    ? `
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 6.x.x\n`
+    : ''
+}
       - name: Install Node.js dependencies
         run: ${
-          managerName === 'yarn' ? 'yarn install --frozen-lockfile' : 'npm ci'
-        }
-
-      - name: Revert changes into the ${
-        managerName === 'yarn' ? 'yarn.lock' : 'package-lock.json'
-      } file
-        run: git checkout -- ${
-          managerName === 'yarn' ? 'yarn.lock' : 'package-lock.json'
+          managerName === 'yarn'
+            ? 'yarn install --frozen-lockfile'
+            : managerName
+            ? 'pnpm i --frozen-lockfile'
+            : 'npm ci'
         }
 
       - name: Run test
-        run: ${managerName === 'yarn' ? 'yarn' : 'npm run'} test:ci
+        run: ${managerName === 'npm' ? 'npm' : managerName} test:ci
         env:
-          DB_URI: \${{ secrets.DB_URI }}
+          DATABASE_URL: \${{ secrets.DATABASE_URL }}
           NODE_ENV: ci
 `,
       file: `${projectName}/.github/workflows/test.yml`

package/lib/src/functions/index.js

@@ -5,12 +5,10 @@ module.exports = {
   eslint: require('./eslint'),
   ghat: require('./ghat'),
   gitignore: require('./gitignore'),
-  herokuF: require('./heroku'),
   licenseF: require('./license'),
   packageJson: require('./packageJson'),
   readme: require('./readme'),
   testsF: require('./tests'),
   tsconfig: require('./tsconfig'),
-  ghatF: require('./ghat'),
-  webpack: require('./webpack')
+  ghatF: require('./ghat')
 }

package/lib/src/functions/packageJson.js

@@ -10,15 +10,10 @@ module.exports = async ({
   projectDescription,
   projectVersion,
   license,
-  mainFile,
-  tests
+  mainFile
 }) => {
   const data = {
-    content: '',
-    file: 'package.json'
-  }
-
-  data.content = `{
+    content: `{
   "name": "${projectName
     .toLowerCase()
     .replaceAll(' ', '-')
@@ -27,19 +22,12 @@ module.exports = async ({
   "main": "${mainFile}",
   "description": "${projectDescription}",
   "scripts": {
-    "build:dev": "webpack --mode development",
-    "build": "webpack --mode production",
     "lint": "eslint src/* --ext .ts --fix",
     "service": "nodemon",
-    "start": "node dist/index.js",
-    "release": "standard-version"\
-    ${
-      tests
-        ? `,
+    "start": "ts-node src/index.ts",
+    "release": "standard-version",
     "test:ci": "jest --ci -i",
-    "test:local": "NODE_ENV=local jest --ci -i"`
-        : ''
-    }
+    "test:local": "NODE_ENV=local jest --ci -i --setupFiles dotenv/config"
   },
   "author": "${author}",${
     license !== 'unlicensed'
@@ -57,10 +45,12 @@ module.exports = async ({
     "ignore": [
       "src/**/*.test.ts"
     ],
-    "exec": "npx ts-node -r dotenv/config ./src/index"
+    "exec": "DEBUG=App:* npx ts-node -r dotenv/config ./src/index"
   }
-}
-`
+}\n`,
+    file: 'package.json'
+  }
+
   await writeFile(`${projectName}/${data.file}`, data.content)
 }
 
@@ -72,5 +62,4 @@ module.exports = async ({
  * @property {String} projectVersion
  * @property {'unlicensed'|'mit'|'apache-2.0'|'mpl-2.0'|'lgpl-3.0'|'gpl-3.0'|'agpl-3.0'} license
  * @property {String} mainFle
- * @property {Boolean} tests
  */