@anthonylzq/simba.js 1.4.0 → 1.8.0

package/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 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.8.0](https://github.com/AnthonyLzq/simba.js/compare/v1.7.0...v1.8.0) (2021-12-13)
+
+
+### Features
+
+* implemented baseUrl config with ts and webpack to avoid "../../.. ..." ([9b9e9d2](https://github.com/AnthonyLzq/simba.js/commit/9b9e9d20cae8b4bbdaef58364220512514dac1a4))
+* updated docker file and ignored git folder to be generated manually by docker ([33c1b0d](https://github.com/AnthonyLzq/simba.js/commit/33c1b0df9cfac4e686ece884aa3102e9ad49e6ab))
+* updated docs ([ba72b64](https://github.com/AnthonyLzq/simba.js/commit/ba72b643ea45af7ce7dd7a9adaf8b4f27eacd266))
+
+
+### Bug Fixes
+
+* fixed eslint ignore ([1405884](https://github.com/AnthonyLzq/simba.js/commit/1405884ab10cf869d6811fbf588ba0b0efb04de2))
+* fixed mongo connection ([57f8580](https://github.com/AnthonyLzq/simba.js/commit/57f85803701253be2308b1c45f537db5b59c92d4))
+
+## [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)
 
 

package/README.md

@@ -1,5 +1,7 @@
 # Simba.js
 
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
 Set up a modern backend app by running one command. This project has the goal to create a complete setup for a backend application using `TypeScript` and `Express`. It will create many files that are usually created manually. Currently the following files are being created:
 
 - `.env`
@@ -59,14 +61,14 @@ simba -h
 This will generate the following output:
 
 ```bash
-Usage: npx simba [options] or simba [options] (if you it installed globally) or
-only simba if you want to be asked for the options one by one
+simba [options] (if you it installed globally) or only simba if you want to be
+asked for the options one by one
 
 Options:
-  -a, --author              Author of the project
-  -e, --email               Email of the author
   -N, --projectName         Project name
   -D, --projectDescription  Project description
+  -a, --author              Author of the project
+  -e, --email               Email of the author
   -H, --heroku              Whether or not the project will be deployed using
                             Heroku                    [boolean] [default: false]
   -l, --license             Type of license for the project, it can be one of:
@@ -84,8 +86,8 @@ Options:
   -h, --help                Show help                                  [boolean]
 
 Examples:
-  simba -a Anthony -e sluzquinosa@uni.pe -N "Project Name" -D "Project
-  description"
+  simba  -N "Project Name" -D "Project description -a Anthony -e
+  sluzquinosa@uni.pe"
 
 Developed by AnthonyLzq
 ```
@@ -139,28 +141,34 @@ Regardless of the option chosen, a new folder will be generated with the name of
 Let's suppose you want to build a project that will be deployed to Heroku, so should run:
 
 ```bash
-simba -a myName -e myEmail@email.com -N myProject -D 'This is a test' -H -l mit
+simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H
 ```
 
-Here we are specifying that we want to create a new project called `myProject` using the `MIT` license, and my name and my email are respectively: `myName` and `myEmail@email.com`.
+Here we are specifying that we want to create a new project called `myProject` using the `MIT` license, my name and my email are respectively: `myName` and `myEmail@email.com` and I want to use heroku to deploy this server.
 
-As default, `yarn` is selected as package manager, but you don't want to use it, so you can pass the flag `-n` or `--npm` as follows:
+As default, `yarn` is selected as package manager, but if you don't want to use it, you can pass the flag `-n` or `--npm` as follows:
 
 ```bash
-simba -a myName -e myEmail@email.com -N myProject -D 'This is a test' -H -l mit -n
+simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -n
 ```
 
 Finally, you may not want to use a license or one of the available licenses, don't worry, just don't pass the flag `-l` neither `--license` as follows:
 
 ```bash
-simba -a myName -e myEmail@email.com -N myProject -D 'This is a test' -H
+simba -N myProject -D 'This is a test' -a myName -e myEmail@email.com -H
 ```
 
 ### Some considerations
 
 - This project is based in other project from my own, [`typescript-project-generator`](https://www.npmjs.com/package/typescript-project-generator), but only considering the `express-mongoose-node` part.
-- You are able to run a server that has one main route, `home` (`/`), and another one, `user` (`/user` or `/user/:userId`).
-- To connect your server with your `MongoDB` database, you need to provide your `uri` in the `.env`.
+- You are able to run a server that has one main route, `home` (`/`), `user` (`api/user` or `api/user/:userId`) and `docs` (`api/docs`).
+- To connect your server with your `MongoDB` database, you need to provide your `uri` in the `.env`. By default, Simba will try to connect to a local database. The content of the `.env` file is:
+
+  ```bash
+  MONGO_URI = mongodb://mongo:mongo@mongo:27017/${projectName}
+  ```
+
+  Where `${projectName}` will be replaced by the name of the project you provided in lowercase.
 - Once you have done that, now you can perform the following `HTTP REQUEST`: `GET`, `POST`, `PATCH` and `DELETE`.
 - In order to use global variables, just add the one you need in the `src/@types/index.d.ts` file, and add a new `var` with its type to the `global` interface, as follows:
     ```ts
@@ -184,6 +192,7 @@ simba -a myName -e myEmail@email.com -N myProject -D 'This is a test' -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?
 
@@ -202,8 +211,8 @@ Here is the list of the packages that are being installed, as `devDependencies`:
 - [`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser)
 - [`dotenv`](https://www.npmjs.com/package/dotenv)
 - [`eslint`](https://www.npmjs.com/package/eslint)
-- [`eslint-config-airbnb-typescript`](https://www.npmjs.com/package/eslint-config-airbnb-typescript)
 - [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)
+- [`eslint-config-standard`](https://www.npmjs.com/package/eslint-config-standard)
 - [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import)
 - [`eslint-plugin-prettier`](https://www.npmjs.com/package/eslint-plugin-prettier)
 - [`eslint-plugin-sort-keys-fix`](https://www.npmjs.com/package/eslint-plugin-sort-keys-fix)
@@ -213,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/index.js

@@ -7,24 +7,25 @@ const installation = require('./src/installation')
 const CURRENT_YEAR = `${new Date().getFullYear()}`
 const argv = yargs(hideBin(process.argv))
   .version(false)
+  // Pending to test it using npx
   .usage(
-    'Usage: npx simba [options] or simba [options] (if you it installed globally) or only simba if you want to be asked for the options one by one'
+    'simba [options] (if you it installed globally) or only simba if you want to be asked for the options one by one'
   )
   .example(
-    'simba -a Anthony -e sluzquinosa@uni.pe -N "Project Name" -D "Project description"'
+    'simba  -N "Project Name" -D "Project description -a Anthony -e sluzquinosa@uni.pe"'
   )
-  .alias('a', 'author')
-  .nargs('a', 1)
-  .describe('a', 'Author of the project')
-  .alias('e', 'email')
-  .nargs('e', 1)
-  .describe('e', 'Email of the author')
   .alias('N', 'projectName')
   .nargs('N', 1)
   .describe('N', 'Project name')
   .alias('D', 'projectDescription')
   .nargs('D', 1)
   .describe('D', 'Project description')
+  .alias('a', 'author')
+  .nargs('a', 1)
+  .describe('a', 'Author of the project')
+  .alias('e', 'email')
+  .nargs('e', 1)
+  .describe('e', 'Email of the author')
   .alias('H', 'heroku')
   .describe('H', 'Whether or not the project will be deployed using Heroku')
   .alias('l', 'license')
@@ -45,6 +46,7 @@ const argv = yargs(hideBin(process.argv))
   .nargs('f', 1)
   .describe('f', 'Main file of the project')
   .alias('q', 'questions')
+  .nargs('q', 1)
   .describe(
     'q',
     'Whether or not you want to be asked to answer the questions related to the project one by one'

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

@@ -87,10 +87,7 @@ module.exports = async projectName => {
 }
 `,
     eslintFile: '.eslintrc.js',
-    eslintIgnoreContent: `/dist
-.eslintrc.js
-webpack.config.js
-`,
+    eslintIgnoreContent: '/dist',
     eslintIgnoreFile: '.eslintignore'
   }
 

package/lib/src/functions/express.js

@@ -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,11 +53,18 @@ 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 myGlobalVariable: unknown
+  var response = (
+    error: boolean,
+    message: unknown,
+    res: Response,
+    status: number
+  ): void => {
+    res.status(status).send({ error, message })
+  }
 
   // We can personalize the response and request objects in case we need it by
   // adding new optional attributes to this interface
@@ -94,8 +100,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 = {
@@ -346,8 +352,8 @@ export { IUser, UserModel }
 import swaggerUi from 'swagger-ui-express'
 import httpErrors from 'http-errors'
 
-import { Home, User } from '../routes'
-import { response, docs } from '../utils'
+import { Home, User } from 'routes'
+import { docs } from 'utils'
 
 const routers = [User]
 
@@ -422,8 +428,6 @@ class Server {
     this._connection = mongoose.connection
     const connection = {
       keepAlive: true,
-      useCreateIndex: true,
-      useFindAndModify: false,
       useNewUrlParser: true,
       useUnifiedTopology: true
     }
@@ -485,7 +489,6 @@ export { applyRoutes, Server }
     routes: {
       home: {
         content: `import { Response, Request, Router } from 'express'
-import { response } from '../utils'
 
 const Home = Router()
 
@@ -499,7 +502,7 @@ export { Home }
       },
       index: {
         content: `import { Home } from './home'
-import { User } from './users'
+import { User } from './user'
 
 export { Home, User }
 `,
@@ -507,18 +510,22 @@ export { Home, User }
       },
       user: {
         content: `import { Router, NextFunction } from 'express'
+import httpErrors from 'http-errors'
+import { ValidationError } from 'joi'
 
-import { Response, Request } from '../custom'
-import { response } from '../utils'
-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()
 
 User.route('/users')
   .post(
-    async (req: Request, res: Response, next: NextFunction): Promise<void> => {
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
       const {
         body: { args }
       } = req
@@ -533,7 +540,11 @@ User.route('/users')
     }
   )
   .get(
-    async (req: Request, res: Response, next: NextFunction): Promise<void> => {
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
       const u = new UserC()
 
       try {
@@ -545,7 +556,11 @@ User.route('/users')
     }
   )
   .delete(
-    async (req: Request, res: Response, next: NextFunction): Promise<void> => {
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
       const u = new UserC()
 
       try {
@@ -559,7 +574,11 @@ User.route('/users')
 
 User.route('/user/:id')
   .get(
-    async (req: Request, res: Response, next: NextFunction): Promise<void> => {
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
       const {
         params: { id }
       } = req
@@ -570,13 +589,19 @@ User.route('/user/:id')
         const result = await u.process({ type: 'getOne' })
         response(false, result, res, 200)
       } catch (e) {
-        if (e.isJoi) e.status = 422
+        if (e instanceof ValidationError)
+          return next(new httpErrors.UnprocessableEntity(e.message))
+
         next(e)
       }
     }
   )
   .patch(
-    async (req: Request, res: Response, next: NextFunction): Promise<void> => {
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
       const {
         body: { args },
         params: { id }
@@ -592,13 +617,19 @@ User.route('/user/:id')
         const result = await u.process({ type: 'update' })
         response(false, result, res, 200)
       } catch (e) {
-        if (e.isJoi) e.status = 422
+        if (e instanceof ValidationError)
+          return next(new httpErrors.UnprocessableEntity(e.message))
+
         next(e)
       }
     }
   )
   .delete(
-    async (req: Request, res: Response, next: NextFunction): Promise<void> => {
+    async (
+      req: CustomRequest,
+      res: CustomResponse,
+      next: NextFunction
+    ): Promise<void> => {
       const {
         params: { id }
       } = req
@@ -609,7 +640,9 @@ User.route('/user/:id')
         const result = await u.process({ type: 'delete' })
         response(false, result, res, 200)
       } catch (e) {
-        if (e.isJoi) e.status = 422
+        if (e instanceof ValidationError)
+          return next(new httpErrors.UnprocessableEntity(e.message))
+
         next(e)
       }
     }
@@ -617,7 +650,7 @@ User.route('/user/:id')
 
 export { User }
 `,
-        file: `${projectName}/src/routes/users.ts`
+        file: `${projectName}/src/routes/user.ts`
       }
     },
     schemas: {
@@ -1108,31 +1141,14 @@ DELETE http://localhost:1996/api/user/60e7e3b93b01c1a7aa74cd6b
       },
       index: {
         content: `import docs from './docs.json'
-import { response } from './response'
 
-export { docs, response }
+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': {
-      content: 'MONGO_URI = ',
+      content: `MONGO_URI = mongodb://mongo:mongo@mongo:27017/${projectName}`,
       file: `${projectName}/.env`
     },
     index: {
@@ -1214,7 +1230,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

@@ -58,7 +58,11 @@ module.exports = async ({
 
   const prodPackages = `${manager} express mongoose morgan http-errors joi swagger-ui-express`
   const devPackages = `${manager} -D \
+@types/express \
+@types/http-errors \
+@types/morgan \
 @types/node \
+@types/swagger-ui-express \
 @typescript-eslint/eslint-plugin \
 @typescript-eslint/parser \
 dotenv \
@@ -71,17 +75,15 @@ eslint-plugin-sort-keys-fix \
 eslint-plugin-typescript-sort-keys \
 nodemon \
 prettier \
+standard-version \
 ts-loader \
 ts-node \
+tsconfig-paths \
+tsconfig-paths-webpack-plugin \
 typescript \
 webpack \
 webpack-cli \
-webpack-node-externals \
-@types/express \
-@types/morgan \
-@types/swagger-ui-express \
-@types/http-errors \
-standard-version`
+webpack-node-externals`
 
   bar.start(process, i)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anthonylzq/simba.js",
-  "version": "1.4.0",
+  "version": "1.8.0",
   "description": "set up a modern backend app by running one command",
   "main": "lib/index.js",
   "directories": {

package/.eslintrc

@@ -1,64 +0,0 @@
-{
-  "env": {
-    "node": true
-  },
-  "root": true,
-  "plugins": [
-    "import",
-    "prettier"
-  ],
-  "extends": [
-    "standard",
-    "eslint:recommended",
-    "prettier"
-  ],
-  "rules": {
-    "@typescript-eslint/no-var-requires": "off",
-    "arrow-parens": [
-      "error",
-      "as-needed"
-    ],
-    "import/no-extraneous-dependencies": [
-      "error",
-      {
-        "devDependencies": true
-      }
-    ],
-    "max-len": [
-      "error",
-      {
-        "code": 80,
-        "ignoreComments": true,
-        "ignoreRegExpLiterals": true,
-        "ignoreTemplateLiterals": true,
-        "ignoreTrailingComments": true,
-        "ignoreStrings": true,
-        "ignoreUrls": true
-      }
-    ],
-    "newline-before-return": "error",
-    "object-curly-spacing": [
-      "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"
-      }
-    ],
-    "radix": [
-      "error",
-      "as-needed"
-    ],
-    "spaced-comment": ["error", "always"]
-  }
-}