@anthonylzq/simba.js 1.7.0 → 1.10.0

package/README.md

@@ -192,6 +192,7 @@ simba -N myProject -D 'This is a test' -a myName -e myEmail@email.com -H
 - To check the content of the files generated, please check the `example` folder.
 - If you provide a project name that contains spaces, something like 'My awesome Project',  every space will be replaced with a hyphen. So at the end your project name will be 'My-awesome-project', but in its README.md file, the hyphens will be removed and the project name will be parsed to title case (My Awesome Project).
 - Finally, `git` will be initialized and a list of libraries will be installed. Check the [**notes**](#notes).
+- Relative imports is already configured, you do not need to import a file using `../../../some/very/nested/stuff/in/other/folder`, you can use `some/very/nested/stuff/in/other/folder` assuming that your folder is under the `src` folder.
 
 ## What is new?
 
@@ -221,6 +222,8 @@ Here is the list of the packages that are being installed, as `devDependencies`:
 - [`standard-version`](https://www.npmjs.com/package/standard-version)
 - [`ts-loader`](https://www.npmjs.com/package/ts-loader)
 - [`ts-node`](https://www.npmjs.com/package/ts-node)
+- [`tsconfig-paths`](https://www.npmjs.com/package/tsconfig-paths)
+- [`tsconfig-paths-webpack-plugin`](https://www.npmjs.com/package/tsconfig-paths-webpack-plugin)
 - [`typescript`](https://www.npmjs.com/package/typescript)
 - [`webpack`](https://www.npmjs.com/package/webpack)
 - [`webpack-cli`](https://www.npmjs.com/package/webpack-cli)

package/lib/src/functions/docker.js

@@ -14,6 +14,12 @@ COPY package.json ./
 
 RUN yarn install --prod
 
+RUN yarn add webpack webpack-node-externals -D
+
+RUN yarn build
+
+RUN yarn remove webpack webpack-node-externals
+
 COPY dist /app/dist
 
 CMD [ "yarn", "start" ]

package/lib/src/functions/eslint.js

@@ -12,11 +12,7 @@ module.exports = async projectName => {
   },
   root: true,
   parser: '@typescript-eslint/parser',
-  plugins: [
-    '@typescript-eslint',
-    'import',
-    'prettier'
-  ],
+  plugins: ['@typescript-eslint', 'import', 'prettier'],
   extends: [
     'standard',
     'eslint:recommended',
@@ -27,10 +23,7 @@ module.exports = async projectName => {
   rules: {
     '@typescript-eslint/no-var-requires': 'off',
     '@typescript-eslint/no-empty-interface': 'off',
-    'arrow-parens': [
-      'error',
-      'as-needed'
-    ],
+    'arrow-parens': ['error', 'as-needed'],
     'import/extensions': [
       2,
       {
@@ -60,37 +53,29 @@ module.exports = async projectName => {
       }
     ],
     'newline-before-return': 'error',
-    'object-curly-spacing': [
-      'error',
-      'always'
-    ],
+    'object-curly-spacing': ['error', 'always'],
+    "object-shorthand": ["error", "always"],
     'prefer-const': 'error',
     'prettier/prettier': [
       'error',
       {
-        'arrowParens': 'avoid',
-        'bracketSpacing': true,
-        'printWidth': 80,
-        'quoteProps': 'as-needed',
-        'semi': false,
-        'singleQuote': true,
-        'tabWidth': 2,
-        'trailingComma': 'none'
+        arrowParens: 'avoid',
+        bracketSpacing: true,
+        printWidth: 80,
+        quoteProps: 'as-needed',
+        semi: false,
+        singleQuote: true,
+        tabWidth: 2,
+        trailingComma: 'none'
       }
     ],
-    radix: [
-      'error',
-      'as-needed'
-    ],
+    radix: ['error', 'as-needed'],
     'spaced-comment': ['error', 'always']
   }
 }
 `,
     eslintFile: '.eslintrc.js',
-    eslintIgnoreContent: `/dist
-.eslintrc.js
-webpack.config.js
-`,
+    eslintIgnoreContent: '/dist',
     eslintIgnoreFile: '.eslintignore'
   }
 

package/lib/src/functions/express.js

@@ -5,7 +5,7 @@ const writeFile = require('../utils/writeFile')
 /*
  * src
  * |- @types:
- * |  |- global: content, file
+ * |  |- index: content, file
  * |- controllers:
  * |  |- utils:
  * |  |  |- messages:
@@ -35,7 +35,6 @@ const writeFile = require('../utils/writeFile')
  * |  |- index.http: content, file
  * |- utils:
  * |  |- docs.json: content, file
- * |  |- response: content, file
  * |  |- index: content, file
  * |- .env: content, file
  * |- index: content, file
@@ -54,18 +53,17 @@ module.exports = async (projectName, projectVersion, email) => {
 import { IncomingHttpHeaders } from 'http'
 import { Request, Response } from 'express'
 
-import { DtoUser } from '../dto-interfaces'
+import { DtoUser } from 'dto-interfaces'
 
 declare global {
-  // This variable is global, so it will be available everywhere in the code
-  var response = (
-    error: boolean,
-    message: unknown,
-    res: Response,
+  interface ResponseProps {
+    error: boolean
+    message: unknown
+    res: Response
     status: number
-  ): void => {
-    res.status(status).send({ error, message })
   }
+  // This variable is global, so it will be available everywhere in the code
+  var response: ({ error, message, res, status }: ResponseProps) => void
 
   // We can personalize the response and request objects in case we need it by
   // adding new optional attributes to this interface
@@ -101,8 +99,8 @@ export { User }
       user: {
         content: `import httpErrors from 'http-errors'
 
-import { DtoUser } from '../dto-interfaces'
-import { IUser, UserModel } from '../models'
+import { DtoUser } from 'dto-interfaces'
+import { IUser, UserModel } from 'models'
 import { EFU, MFU, GE, errorHandling } from './utils'
 
 type Process = {
@@ -164,7 +162,10 @@ class User {
     try {
       const usersDeleted = await UserModel.deleteMany({})
 
-      if (usersDeleted.acknowledged) return MFU.ALL_USERS_DELETED
+      if (usersDeleted.deletedCount >= 1) return MFU.ALL_USERS_DELETED
+
+      if (usersDeleted.deletedCount === 0)
+        throw new httpErrors.BadRequest(EFU.NOTHING_TO_DELETE)
 
       throw new httpErrors.InternalServerError(GE.INTERNAL_SERVER_ERROR)
     } catch (e) {
@@ -258,7 +259,8 @@ export { EFU, MFU, GenericErrors as GE }
       },
       user: {
         content: `enum ErrorForUser {
-  NOT_FOUND = 'The requested user does not exists'
+  NOT_FOUND = 'The requested user does not exists',
+  NOTHING_TO_DELETE = 'There is no user to be deleted'
 }
 
 enum MessageForUser {
@@ -353,8 +355,8 @@ export { IUser, UserModel }
 import swaggerUi from 'swagger-ui-express'
 import httpErrors from 'http-errors'
 
-import { Home, User } from '../routes'
-import { docs } from '../utils'
+import { Home, User } from 'routes'
+import { docs } from 'utils'
 
 const routers = [User]
 
@@ -374,7 +376,12 @@ const applyRoutes = (app: Application): void => {
       res: Response,
       next: NextFunction
     ) => {
-      response(true, error.message, res, error.status)
+      response({
+        error: true,
+        message: error.message,
+        res,
+        status: error.status
+      })
       next()
     }
   )
@@ -422,6 +429,17 @@ class Server {
         next()
       }
     )
+
+    // setting up the global response
+    global.response = ({
+      error,
+      message,
+      res,
+      status
+    }: ResponseProps): void => {
+      res.status(status).send({ error, message })
+    }
+
     applyRoutes(this._app)
   }
 
@@ -429,8 +447,6 @@ class Server {
     this._connection = mongoose.connection
     const connection = {
       keepAlive: true,
-      useCreateIndex: true,
-      useFindAndModify: false,
       useNewUrlParser: true,
       useUnifiedTopology: true
     }
@@ -496,7 +512,12 @@ export { applyRoutes, Server }
 const Home = Router()
 
 Home.route('').get((req: Request, res: Response) => {
-  response(false, 'Welcome to your Express Backend!', res, 200)
+  response({
+    error: false,
+    message: 'Welcome to your Express Backend!',
+    res,
+    status: 200
+  })
 })
 
 export { Home }
@@ -516,9 +537,9 @@ export { Home, User }
 import httpErrors from 'http-errors'
 import { ValidationError } from 'joi'
 
-import { User as UserC } from '../controllers/user'
-import { DtoUser } from '../dto-interfaces'
-import { idSchema, userSchema } from '../schemas'
+import { User as UserC } from 'controllers/user'
+import { DtoUser } from 'dto-interfaces'
+import { idSchema, userSchema } from 'schemas'
 
 const User = Router()
 
@@ -536,7 +557,7 @@ User.route('/users')
 
       try {
         const result = await u.process({ type: 'store' })
-        response(false, result, res, 201)
+        response({ error: false, message: result, res, status: 201 })
       } catch (e) {
         next(e)
       }
@@ -552,7 +573,7 @@ User.route('/users')
 
       try {
         const result = await u.process({ type: 'getAll' })
-        response(false, result, res, 200)
+        response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         next(e)
       }
@@ -568,7 +589,7 @@ User.route('/users')
 
       try {
         const result = await u.process({ type: 'deleteAll' })
-        response(false, result, res, 200)
+        response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         next(e)
       }
@@ -590,7 +611,7 @@ User.route('/user/:id')
         await idSchema.validateAsync(id)
         const u = new UserC({ id } as DtoUser)
         const result = await u.process({ type: 'getOne' })
-        response(false, result, res, 200)
+        response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         if (e instanceof ValidationError)
           return next(new httpErrors.UnprocessableEntity(e.message))
@@ -618,7 +639,7 @@ User.route('/user/:id')
         await userSchema.validateAsync(user)
         const u = new UserC(user)
         const result = await u.process({ type: 'update' })
-        response(false, result, res, 200)
+        response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         if (e instanceof ValidationError)
           return next(new httpErrors.UnprocessableEntity(e.message))
@@ -641,7 +662,7 @@ User.route('/user/:id')
         await idSchema.validateAsync(id)
         const u = new UserC({ id } as DtoUser)
         const result = await u.process({ type: 'delete' })
-        response(false, result, res, 200)
+        response({ error: false, message: result, res, status: 200 })
       } catch (e) {
         if (e instanceof ValidationError)
           return next(new httpErrors.UnprocessableEntity(e.message))
@@ -1148,22 +1169,6 @@ DELETE http://localhost:1996/api/user/60e7e3b93b01c1a7aa74cd6b
 export { docs }
 `,
         file: `${projectName}/src/utils/index.ts`
-      },
-      response: {
-        content: `import { Response } from 'express'
-
-const response = (
-  error: boolean,
-  message: unknown,
-  res: Response,
-  status: number
-): void => {
-  res.status(status).send({ error, message })
-}
-
-export { response }
-`,
-        file: `${projectName}/src/utils/response.ts`
       }
     },
     '.env': {
@@ -1249,7 +1254,6 @@ ${projectName}/src/utils
 
   // /utils
   await writeFile(data.utils.docs.file, data.utils.docs.content)
-  await writeFile(data.utils.response.file, data.utils.response.content)
   await writeFile(data.utils.index.file, data.utils.index.content)
 
   // .env

package/lib/src/functions/gitignore.js

@@ -132,6 +132,8 @@ typings/
 # .pnp.*
 
 # End of https://www.toptal.com/developers/gitignore/api/node,yarn
+
+dist
 `,
     gitignoreFile: '.gitignore'
   }

package/lib/src/functions/tsconfig.js

@@ -8,7 +8,8 @@ module.exports = async projectName => {
   const data = {
     tsconfigContent: `{
   "ts-node": {
-    "files": true
+    "files": true,
+    "require": ["tsconfig-paths/register"]
   },
   "compilerOptions": {
     /* Visit https://aka.ms/tsconfig.json to read more about this file */
@@ -52,7 +53,7 @@ module.exports = async projectName => {
 
     /* Module Resolution Options */
     "moduleResolution": "node"                /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    "baseUrl": "./src",                       /* Base directory to resolve non-absolute module names. */
     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                       /* List of folders to include type definitions from. */

package/lib/src/functions/webpack.js

@@ -8,6 +8,7 @@ module.exports = async projectName => {
   const data = {
     webpackContent: `const path = require('path')
 const nodeExternals = require('webpack-node-externals')
+const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin')
 
 module.exports = {
   context: __dirname,
@@ -28,7 +29,12 @@ module.exports = {
     __dirname: false
   },
   resolve: {
-    extensions: ['.ts', '.js']
+    extensions: ['.ts', '.js'],
+    plugins: [
+      new TsconfigPathsPlugin({
+        baseUrl: './src'
+      })
+    ]
   },
   output: {
     filename: 'index.js',

package/lib/src/installation.js

@@ -78,6 +78,8 @@ prettier \
 standard-version \
 ts-loader \
 ts-node \
+tsconfig-paths \
+tsconfig-paths-webpack-plugin \
 typescript \
 webpack \
 webpack-cli \

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anthonylzq/simba.js",
-  "version": "1.7.0",
+  "version": "1.10.0",
   "description": "set up a modern backend app by running one command",
   "main": "lib/index.js",
   "directories": {
@@ -10,7 +10,7 @@
   "scripts": {
     "service": "node ./bin",
     "release": "standard-version",
-    "test": "npm run rm && node ./bin -a AnthonyLzq -e sluzquinosa@uni.pe -N example -D 'This is a test'",
+    "test": "npm run rm && node ./bin -N example -D 'This is a test' -a AnthonyLzq -e sluzquinosa@uni.pe -l mit -H",
     "lint": "eslint --ext js lib/ --fix",
     "rm": "if [ -d \"example\" ]; then rm -rf example; fi"
   },
@@ -33,11 +33,11 @@
     "cli-progress": "^3.9.1",
     "colors": "^1.4.0",
     "readline-sync": "^1.4.10",
-    "underscore": "^1.13.1",
+    "underscore": "^1.13.2",
     "yargs": "^17.3.0"
   },
   "devDependencies": {
-    "eslint": "^7.32.0",
+    "eslint": "^8.5.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-import": "^2.25.3",
@@ -52,5 +52,9 @@
   "bugs": {
     "url": "https://github.com/AnthonyLzq/simba.js/issues"
   },
-  "homepage": "https://github.com/AnthonyLzq/simba.js#readme"
+  "homepage": "https://github.com/AnthonyLzq/simba.js#readme",
+  "files": [
+    "lib",
+    "bin"
+  ]
 }

package/CHANGELOG.md

@@ -1,90 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-## [1.7.0](https://github.com/AnthonyLzq/simba.js/compare/v1.6.0...v1.7.0) (2021-12-12)
-
-
-### Features
-
-* updated docs and minor changes ([e6b32ca](https://github.com/AnthonyLzq/simba.js/commit/e6b32ca309603544e3506c9d18717f0e45ef0457))
-
-## [1.6.0](https://github.com/AnthonyLzq/simba.js/compare/v1.5.0...v1.6.0) (2021-12-12)
-
-
-### Features
-
-* implemented default mongo connection to local database ([1e66e98](https://github.com/AnthonyLzq/simba.js/commit/1e66e982b03eca5c2c3846a10ad827150683da21))
-
-## [1.5.0](https://github.com/AnthonyLzq/simba.js/compare/v1.3.1...v1.5.0) (2021-12-12)
-
-
-### Features
-
-* moving response function to the global variables and cleaning user route ([52f44aa](https://github.com/AnthonyLzq/simba.js/commit/52f44aadad180816d710b1e03dcc1c809b2be424))
-* simplified the code ([dde8f2e](https://github.com/AnthonyLzq/simba.js/commit/dde8f2e27f86f60321af2f12b53546227d0ffe64))
-
-## [1.4.0](https://github.com/AnthonyLzq/simba.js/compare/v1.3.1...v1.4.0) (2021-12-12)
-
-
-### Features
-
-* simplified the code ([dde8f2e](https://github.com/AnthonyLzq/simba.js/commit/dde8f2e27f86f60321af2f12b53546227d0ffe64))
-
-### [1.3.1](https://github.com/AnthonyLzq/simba.js/compare/v1.3.0...v1.3.1) (2021-12-12)
-
-
-### Features
-
-* updated docs ([809afaa](https://github.com/AnthonyLzq/simba.js/commit/809afaad2c1c3046fab509842118064ec6a61d5f))
-
-## [1.3.0](https://github.com/AnthonyLzq/simba.js/compare/v1.2.0...v1.3.0) (2021-12-12)
-
-
-### Features
-
-* implemented eslint rules ([748fb91](https://github.com/AnthonyLzq/simba.js/commit/748fb91a031102855dd7ba08344cc1ec3e181a4f))
-* implemented support for global variables (Node.js v16), linted all the code, fixed unlicensed project bug and simplified project structure ([ae4876f](https://github.com/AnthonyLzq/simba.js/commit/ae4876f249ff7dfd16fd4af7e41b3388c7de0f6a))
-
-## [1.2.0](https://github.com/AnthonyLzq/simba.js/compare/v1.1.3...v1.2.0) (2021-10-18)
-
-
-### Features
-
-* implemented support for project names with more than a word and updated dependencies ([2600413](https://github.com/AnthonyLzq/simba.js/commit/2600413bf7a5ef92e554738066e9bc4aea892f6f))
-
-### [1.1.3](https://github.com/AnthonyLzq/simba.js/compare/v1.1.2...v1.1.3) (2021-10-17)
-
-
-### Bug Fixes
-
-* fixed bin path ([bf194ff](https://github.com/AnthonyLzq/simba.js/commit/bf194ff21e6aaf63dd1a80c104b8a3567f0887b1))
-
-### [1.1.2](https://github.com/AnthonyLzq/simba.js/compare/v1.1.1...v1.1.2) (2021-10-17)
-
-
-### Bug Fixes
-
-* updated eslint package (eslint-config-airbnb -> eslint-config-airbnb-base) ([06547bc](https://github.com/AnthonyLzq/simba.js/commit/06547bc618e79f9f6e47e3b0fbd188358befe408))
-
-### [1.1.1](https://github.com/AnthonyLzq/simba.js/compare/v1.0.1...v1.1.1) (2021-10-17)
-
-
-### Features
-
-* added new eslint package and some new rules ([d79426c](https://github.com/AnthonyLzq/simba.js/commit/d79426c23fc899128d68c8b2e79ed7c5c0e4b18b))
-
-### [1.0.1](https://github.com/AnthonyLzq/simba.js/compare/v1.0.0...v1.0.1) (2021-10-01)
-
-
-### Bug Fixes
-
-* flag for unlicensed ([6b20a5b](https://github.com/AnthonyLzq/simba.js/commit/6b20a5b8a9ad60e5278b38252849fe5c3b2d54a4))
-
-## 1.0.0 (2021-09-28)
-
-
-### Features
-
-* first simba.js release ([d10fa01](https://github.com/AnthonyLzq/simba.js/commit/d10fa0199a8bff941da186c33fc16b512295a037))
-* updated package name and added standard-version command ([d0d0906](https://github.com/AnthonyLzq/simba.js/commit/d0d09064587a814f97d7a63b865b28a6f05030ad))