@anthonylzq/simba.js 9.0.1 → 9.1.0

package/lib/src/functions/gitignore.js

@@ -1,143 +1,12 @@
 const writeFile = require('../utils/writeFile')
+const { renderTemplate } = require('../utils/renderTemplate')
 
 /**
  * @param {String} projectName
  * @returns {Promise<void>}
  */
 module.exports = async projectName => {
-  const data = {
-    gitignoreContent: `# Created by https://www.toptal.com/developers/gitignore/api/node,yarn
-# Edit at https://www.toptal.com/developers/gitignore?templates=node,yarn
+  const content = renderTemplate('config/.gitignore.ejs')
 
-### Node ###
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
-.next
-
-# Nuxt.js build / generate output
-.nuxt
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode*
-
-### yarn ###
-# https://yarnpkg.com/advanced/qa#which-files-should-be-gitignored
-
-# .yarn/unplugged and .yarn/build-state.yml should likely always be ignored since
-# they typically hold machine-specific build artifacts. Ignoring them might however
-# prevent Zero-Installs from working (to prevent this, set enableScripts to false).
-.yarn/unplugged
-.yarn/build-state.yml
-
-# .yarn/cache and .pnp.* may be safely ignored, but you'll need to run yarn install
-# to regenerate them between each branch switch.
-# Uncomment the following lines if you're not using Zero-Installs:
-# .yarn/cache
-# .pnp.*
-
-# End of https://www.toptal.com/developers/gitignore/api/node,yarn
-
-dist
-test/setEnvVars.ts
-`,
-    gitignoreFile: '.gitignore'
-  }
-
-  await writeFile(`${projectName}/${data.gitignoreFile}`, data.gitignoreContent)
+  await writeFile(`${projectName}/.gitignore`, content)
 }

package/lib/src/functions/index.js

@@ -9,6 +9,5 @@ module.exports = {
   packageJson: require('./packageJson'),
   readme: require('./readme'),
   testsF: require('./tests'),
-  tsconfig: require('./tsconfig'),
-  ghatF: require('./ghat')
+  tsconfig: require('./tsconfig')
 }

package/lib/src/functions/license.js

@@ -1,7 +1,15 @@
 const https = require('node:https')
-const _ = require('underscore')
 const writeFile = require('../utils/writeFile')
 
+const htmlUnescape = str =>
+  str
+    .replace(/&/g, '&')
+    .replace(/&lt;/g, '<')
+    .replace(/&gt;/g, '>')
+    .replace(/&quot;/g, '"')
+    .replace(/&#x27;/g, "'")
+    .replace(/&#x60;/g, '`')
+
 /**
  * @param {LicenseConfig} config
  * @returns {Promise<String>}
@@ -17,7 +25,7 @@ const getLicense = ({ author, license, year, projectDescription }) => {
       res.on('end', () => {
         const begin = result.indexOf('id="license-text"')
         const end = result.indexOf('</pre>')
-        result = _.unescape(result.slice(begin + 18, end))
+        result = htmlUnescape(result.slice(begin + 18, end))
 
         switch (license) {
           case 'mit':

package/lib/src/functions/packageJson.js

@@ -1,4 +1,5 @@
 const writeFile = require('../utils/writeFile')
+const { renderTemplate } = require('../utils/renderTemplate')
 
 /**
  * @param {PackageConfig} packageConfig
@@ -12,46 +13,21 @@ module.exports = async ({
   license,
   mainFile
 }) => {
-  const data = {
-    content: `{
-  "name": "${projectName
+  const sanitizedName = projectName
     .toLowerCase()
     .replaceAll(' ', '-')
-    .replaceAll('/', '-')}",
-  "version": "${projectVersion}",
-  "main": "${mainFile}",
-  "description": "${projectDescription}",
-  "scripts": {
-    "lint": "biome check --write src/",
-    "service": "nodemon",
-    "start": "ts-node src/index.ts",
-    "release": "standard-version",
-    "test:ci": "jest --ci -i",
-    "test:local": "NODE_ENV=local jest --ci -i --setupFiles dotenv/config"
-  },
-  "author": "${author}",${
-    license !== 'unlicensed'
-      ? `\n  "license": "${license.toUpperCase()}",\n`
-      : ''
-  }
-  "dependencies": {},
-  "devDependencies": {},
-  "nodemonConfig": {
-    "watch": [
-      ".env",
-      "src"
-    ],
-    "ext": "ts",
-    "ignore": [
-      "src/**/*.test.ts"
-    ],
-    "exec": "DEBUG=App:* npx ts-node -r dotenv/config ./src/index"
-  }
-}\n`,
-    file: 'package.json'
-  }
+    .replaceAll('/', '-')
 
-  await writeFile(`${projectName}/${data.file}`, data.content)
+  const content = renderTemplate('config/package.json.ejs', {
+    sanitizedName,
+    projectVersion,
+    mainFile,
+    projectDescription,
+    author,
+    license
+  })
+
+  await writeFile(`${projectName}/package.json`, content)
 }
 
 /**

package/lib/src/functions/readme.js

@@ -1,5 +1,6 @@
 const writeFile = require('../utils/writeFile')
 const titleCase = require('../utils/titleCase')
+const { renderTemplate } = require('../utils/renderTemplate')
 
 /**
  * @param {String} projectName
@@ -7,10 +8,10 @@ const titleCase = require('../utils/titleCase')
  * @returns {Promise<void>}
  */
 module.exports = async (projectName, projectDescription) => {
-  const data = {
-    readmeContent: `# ${titleCase(projectName)}\n\n${projectDescription}.\n`,
-    readmeFile: 'README.md'
-  }
+  const content = renderTemplate('config/README.md.ejs', {
+    titleCaseName: titleCase(projectName),
+    projectDescription
+  })
 
-  await writeFile(`${projectName}/${data.readmeFile}`, data.readmeContent)
+  await writeFile(`${projectName}/README.md`, content)
 }

package/lib/src/functions/tests.js

@@ -1,333 +1,30 @@
-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 {String} args.projectName
  * @param {Boolean} args.graphql
  * @param {Boolean} args.dbIsSQL
+ * @param {import('../../utils/entity').EntityContext} args.entityContext
  * @returns {Promise<void>}
  */
-module.exports = async ({ projectName, graphql, dbIsSQL }) => {
-  const createFoldersCommand = `mkdir ${projectName}/test`
-
-  if (platform() === 'win32')
-    await exec(createFoldersCommand.replaceAll('/', '\\'))
-  else await exec(createFoldersCommand)
-
-  const data = {
-    jestConfig: {
-      content: `import { Config } from '@jest/types'
-
-const config: Config.InitialOptions = {
-  verbose: true,
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  testTimeout: 1 * 60 * 1000,
-  modulePaths: ['<rootDir>/src', '<rootDir>/node_modules'],
-  roots: ['.'],
-  moduleFileExtensions: ['js', 'json', 'ts'],
-  testRegex: '.test.ts$',
-  transform: {
-    '^.+\\\\.(t|j)s$': 'ts-jest'
-  }
-}
-
-export default config
-`,
-      file: `${projectName}/jest.config.ts`
-    },
-    test: {
-      index: {
-        content: graphql
-          ? `import axios from 'axios'
-import z from 'zod'
-
-import { Server } from '../src/network'
-import { userDto } from '../src/schemas'
-
-const BASE_URL = \`http://localhost:\${process.env.PORT || 1996}\`
-const baseResponseDto = z.object({
-  error: z.boolean(),
-  message: z.string()
-})
-
-type BaseResponseDTO = z.infer<typeof baseResponseDto>
-
-describe('Simba.js tests', () => {
-  beforeAll(async () => {
-    await Server.start()
-  })
-
-  describe('API endpoints tests', () => {
-    let userID = ${dbIsSQL ? 0 : "''"}
-
-    describe('API: GET /', () => {
-      it('Should return 200 with a successful operation', async () => {
-        const result = await axios.get<BaseResponseDTO>(BASE_URL)
-
-        expect(result.status).toBe(200)
-        expect(result.data.error).toBe(false)
-        expect(baseResponseDto.parse(result.data).error).toBe(false)
-      })
-    })
-
-    describe('API: storeUser mutation', () => {
-      const storeUserResponse = z.object({
-        data: z.object({
-          user: userDto
-        })
-      })
-
-      type StoreUserDTO = z.infer<typeof storeUserResponse>
-
-      it('Should create a user successfully', async () => {
-        const result = await axios.post<StoreUserDTO>(\`\${BASE_URL}/graphql\`, {
-          query: \`mutation store($user: UserInput!) {
-            user: store(user: $user) {
-              id
-              name
-              lastName
-              createdAt
-              updatedAt
-            }
-          }\`,
-          variables: {
-            user: {
-              lastName: 'Lzq',
-              name: 'Anthony'
-            }
-          }
-        })
-
-        userID = result.data.data.user.id ?? userID
-        expect(userID).toBeTruthy()
-        expect(result.status).toBe(200)
-        expect(storeUserResponse.safeParse(result.data).success).toBe(true)
-      })
-    })
-
-    describe('API: getUser query', () => {
-      const getUserResponse = z.object({
-        data: z.object({
-          user: userDto
-        })
-      })
-
-      type GetOneUserDTO = z.infer<typeof getUserResponse>
-
-      it('Should return a user', async () => {
-        const result = await axios.post<GetOneUserDTO>(\`\${BASE_URL}/graphql\`, {
-          query: \`query getById($id: ${dbIsSQL ? 'Float' : 'String'}!) {
-            user: getById(id: $id) {
-              id
-              name
-              lastName
-              createdAt
-              updatedAt
-            }
-          }\`,
-          variables: {
-            id: userID
-          }
-        })
-
-        expect(result.status).toBe(200)
-        expect(getUserResponse.safeParse(result.data).success).toBe(true)
-      })
-    })
-
-    describe('API: updateUser mutation', () => {
-      const updateUserResponse = z.object({
-        data: z.object({
-          user: userDto
-        })
-      })
-
-      type UpdateUserDTO = z.infer<typeof updateUserResponse>
-
-      it('Should update a user successfully', async () => {
-        const result = await axios.post<UpdateUserDTO>(\`\${BASE_URL}/graphql\`, {
-          query: \`mutation update($id: ${
-            dbIsSQL ? 'Float' : 'String'
-          }!, $user: UserInput!) {
-            user: update(id: $id, user: $user) {
-              id
-              name
-              lastName
-              createdAt
-              updatedAt
-            }
-          }\`,
-          variables: {
-            id: userID,
-            user: {
-              lastName: 'Luzquiños',
-              name: 'Anthony'
-            }
-          }
-        })
-
-        expect(result.status).toBe(200)
-        expect(updateUserResponse.safeParse(result.data).success).toBe(true)
-      })
-    })
-
-    describe('API: deleteUser mutation', () => {
-      const deleteUserResponse = z.object({
-        data: z.object({
-          result: z.string()
-        })
-      })
-
-      type DeleteUserDTO = z.infer<typeof deleteUserResponse>
-
-      it('Should delete the created user', async () => {
-        const result = await axios.post<DeleteUserDTO>(\`\${BASE_URL}/graphql\`, {
-          query: \`mutation deleteById($id: ${dbIsSQL ? 'Float' : 'String'}!) {
-            result: deleteById(id: $id)
-          }\`,
-          variables: {
-            id: userID
-          }
-        })
-
-        expect(result.status).toBe(200)
-        expect(deleteUserResponse.safeParse(result.data).success).toBe(true)
-      })
-    })
-  })
-
-  afterAll(async () => {
-    await Server.stop()
-  })
-})\n`
-          : `import axios from 'axios'
-import z from 'zod'
-
-import { Server } from '../src/network'
-import { userDto } from '../src/schemas'
-
-const BASE_URL = \`http://localhost:\${process.env.PORT || 1996}\`
-const baseResponseDto = z.object({
-  error: z.boolean(),
-  message: z.string()
-})
-
-type BaseResponseDTO = z.infer<typeof baseResponseDto>
-
-describe('Simba.js tests', () => {
-  beforeAll(async () => {
-    await Server.start()
-  })
-
-  describe('API endpoints tests', () => {
-    let userID = ${dbIsSQL ? 0 : "''"}
-
-    describe('API: GET /', () => {
-      it('Should return 200 with a successful operation', async () => {
-        const result = await axios.get<BaseResponseDTO>(BASE_URL)
-
-        expect(result.status).toBe(200)
-        expect(result.data.error).toBe(false)
-        expect(baseResponseDto.parse(result.data).error).toBe(false)
-      })
-    })
-
-    describe('API: POST /api/users', () => {
-      const storeUserResponse = z.object({
-        error: z.boolean(),
-        message: userDto
-      })
-
-      type StoreUserDTO = z.infer<typeof storeUserResponse>
-
-      it('Should create a user successfully', async () => {
-        const result = await axios.post<StoreUserDTO>(\`\${BASE_URL}/api/users\`, {
-          args: {
-            lastName: 'Lzq',
-            name: 'Anthony'
-          }
-        })
-
-        userID = result.data.message.id ?? userID
-        expect(userID).toBeTruthy()
-        expect(result.status).toBe(201)
-        expect(result.data.error).toBe(false)
-        expect(storeUserResponse.parse(result.data).error).toBe(false)
-      })
-    })
-
-    describe('API: GET /api/user/:id', () => {
-      const getOneUserResponse = z.object({
-        error: z.boolean(),
-        message: userDto
-      })
-
-      type GetOneUserDTO = z.infer<typeof getOneUserResponse>
-
-      it('Should return a user', async () => {
-        const result = await axios.get<GetOneUserDTO>(
-          \`\${BASE_URL}/api/user/\${userID}\`
-        )
-
-        expect(result.status).toBe(200)
-        expect(result.data.error).toBe(false)
-        expect(getOneUserResponse.parse(result.data).error).toBe(false)
-      })
-    })
-
-    describe('API: PATCH /api/user/:id', () => {
-      const updateUserResponse = z.object({
-        error: z.boolean(),
-        message: userDto
-      })
-
-      type UpdateUserDTO = z.infer<typeof updateUserResponse>
-
-      it('Should update a user successfully', async () => {
-        const result = await axios.patch<UpdateUserDTO>(
-          \`\${BASE_URL}/api/user/\${userID}\`,
-          {
-            args: {
-              lastName: 'Luzquiños',
-              name: 'Anthony'
-            }
-          }
-        )
-
-        expect(result.status).toBe(200)
-        expect(result.data.error).toBe(false)
-        expect(updateUserResponse.parse(result.data).error).toBe(false)
-      })
-    })
-
-    describe('API: DELETE /api/user/:id', () => {
-      it('Should delete the created user', async () => {
-        const result = await axios.delete<BaseResponseDTO>(
-          \`\${BASE_URL}/api/user/\${userID}\`
-        )
-
-        expect(result.status).toBe(200)
-        expect(result.data.error).toBe(false)
-        expect(baseResponseDto.parse(result.data).error).toBe(false)
-      })
-    })
-  })
-
-  afterAll(async () => {
-    await Server.stop()
-  })
-})\n`,
-        file: `${projectName}/test/index.test.ts`
-      }
-    }
-  }
+module.exports = async ({ projectName, graphql, dbIsSQL, entityContext }) => {
+  await mkdirs(`${projectName}/test`)
 
   await Promise.all([
-    writeFile(data.jestConfig.file, data.jestConfig.content),
-    writeFile(data.test.index.file, data.test.index.content)
+    writeFile(
+      `${projectName}/vitest.config.ts`,
+      renderTemplate('config/vitest.config.ts.ejs', { graphql })
+    ),
+    writeFile(
+      `${projectName}/test/index.test.ts`,
+      renderTemplate('config/test/index.test.ts.ejs', {
+        graphql,
+        dbIsSQL,
+        ...entityContext
+      })
+    )
   ])
 }