@anthonylzq/simba.js 1.6.0 → 1.7.0

package/CHANGELOG.md

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

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,28 @@ 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`. By default, we will try to connect to a local database. The content of the `.env` file is:
+- 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}
@@ -208,8 +210,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)

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/express.js

@@ -467,9 +467,9 @@ class Server {
     })
 
     try {
-    this._mongo()
+      this._mongo()
     } catch (e) {
-    console.error(e)
+      console.error(e)
     }
   }
 }

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,13 @@ eslint-plugin-sort-keys-fix \
 eslint-plugin-typescript-sort-keys \
 nodemon \
 prettier \
+standard-version \
 ts-loader \
 ts-node \
 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.6.0",
+  "version": "1.7.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"]
-  }
-}