@anthonylzq/simba.js 1.7.0 → 1.8.0

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 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)
 
 

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

@@ -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,7 +53,7 @@ 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
@@ -101,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 = {
@@ -353,8 +352,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]
 
@@ -429,8 +428,6 @@ class Server {
     this._connection = mongoose.connection
     const connection = {
       keepAlive: true,
-      useCreateIndex: true,
-      useFindAndModify: false,
       useNewUrlParser: true,
       useUnifiedTopology: true
     }
@@ -516,9 +513,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()
 
@@ -1148,22 +1145,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 +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

@@ -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.8.0",
   "description": "set up a modern backend app by running one command",
   "main": "lib/index.js",
   "directories": {