@anthonylzq/simba.js 5.2.0 → 6.2.0

package/README.md

@@ -3,11 +3,13 @@
   <a href="https://simbajs.notion.site/783092dc7d444067b4c56a25d671f658?v=31060f3d17524ca58870e86c2960a6df"><img src="https://i.ibb.co/QFX0WnH/simba-pink.png" alt="Simba.js"></a>
 </h1>
 
+
 [![NPM version](https://img.shields.io/npm/v/@anthonylzq/simba.js.svg?style=flat)](https://www.npmjs.com/package/@anthonylzq/simba.js)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AnthonyLzq/simba.js/blob/master/LICENSE)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
 [![Lint](https://github.com/AnthonyLzq/simba.js/actions/workflows/lint.yml/badge.svg)](https://github.com/AnthonyLzq/simba.js/actions/workflows/lint.yml)
+[![Tests for Simba APIs](https://github.com/AnthonyLzq/simba.js/actions/workflows/test.yml/badge.svg)](https://github.com/AnthonyLzq/simba.js/actions/workflows/test.yml)
 
 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` or `Fastify`. It will create many files that are usually created manually. Think about Simba.js like a [CRA](https://create-react-app.dev/), but for backend development. Check the [**project structure**](#project-structure) for more information.
 
@@ -38,8 +40,10 @@ By doing this your prompt will ask you the following questions:
 - `Project version (0.1.0):` the initial version of the project, `0.1.0` as default.
 - `Select your license [1...7]:`, the license you have chosen for the project.
 - `License year (current year):`, the year where your license starts, current year as default.
-- `Will this project use GraphQL?  [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
+- `Will this project use GraphQL? [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
 - `Will this project be deployed with Heroku? [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
+- `Would you want to have a basic suit of tests with Jest? [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
+- `Would you want to have a basic GitHub Action for the suit of tests? [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
 
 The second option you have is by passing flags in one single command. If you need help, please run:
 
@@ -54,33 +58,40 @@ This will generate the following output:
 to be asked for the options one by one
 
 Options:
-  -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:
-                            MIT, Apache 2.0, MPL 2.0, LGPL 3.0, GPL 3.0 and AGPL
-                            3.0, in lowercase without its version
+  -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: MIT, Apache 2.0, MPL 2.0, LGPL 3.0, GPL 3.0
+                                 and AGPL 3.0, in lowercase without its version
                                                          [default: "unlicensed"]
-  -v, --version             Project initial version           [default: "0.1.0"]
-  -y, --licenseYear         Year when the license starts       [default: "2022"]
-  -n, --npm                 Whether or not the project should use npm as package
-                            manager                   [boolean] [default: false]
-  -f, --mainFile            Main file of the project   [default: "src/index.ts"]
-  -q, --questions           Whether or not you want to be asked to answer the
-                            questions related to the project one by one
+  -v, --version                  Project initial version      [default: "0.1.0"]
+  -y, --licenseYear              Year when the license starts  [default: "2022"]
+  -n, --npm                      Whether or not the project should use npm as
+                                 package manager      [boolean] [default: false]
+  -f, --mainFile                 Main file of the project
+                                                       [default: "src/index.ts"]
+  -q, --questions                Whether or not you want to be asked to answer
+                                 the questions related to the project one by one
                                                       [boolean] [default: false]
-  -F, --fastify             Whether or not you want to use Fastify for your
-                            project                   [boolean] [default: false]
-  -g, --graphql             Whether or not you want to use GraphQL for your
-                            project                   [boolean] [default: false]
-  -h, --help                Show help                                  [boolean]
+  -F, --fastify                  Whether or not you want to use Fastify for your
+                                 project              [boolean] [default: false]
+  -g, --graphql                  Whether or not you want to use GraphQL for your
+                                 project              [boolean] [default: false]
+  -t, --tests                    Whether or not you want to have a basic suit of
+                                 unit tests with Jest [boolean] [default: false]
+      --ghat, --gh-action-tests  Whether or not you want to have a GitHub Action
+                                 with a CI for your tests. If this option is set
+                                 to true, the tests flag must be set to true.
+                                                                [default: false]
+  -h, --help                     Show help                             [boolean]
 
 Examples:
   simba -N 'Project Name' -D 'Project description' -a Anthony -e
-  sluzquinosa@uni.pe
+  sluzquinosa@uni.pe -l mit -F --tests --ghat
 
 Developed by AnthonyLzq
 ```
@@ -119,289 +130,20 @@ Finally, you may not want to use a license or one of the available licenses, don
 simba -N myProject -D 'This is a test' -a myName -e myEmail@email.com -H
 ```
 
-#### Why didn't you use [`TypeGraphQL`](https://typegraphql.com/)?
+#### Why I didn't you use [`TypeGraphQL`](https://typegraphql.com/)?
 
 [They don't support GraphQL v16.x.x](https://github.com/MichalLytek/type-graphql/issues/1100), until then.
 
 ## <a name="project-structure"></a>Project structure
 
-Regardless of the option chosen, a new folder will be generated with the name of the project, it will contain the following structure, depending if you have chosen Express or Fastify:
-
-### Express case
-
-```
-📂node_modules
-📂src
- ┣ 📂@types
- ┃ ┣ 📂custom
- ┃ ┃ ┣ 📜request.d.ts
- ┃ ┃ ┗ 📜response.d.ts
- ┃ ┣ 📂models
- ┃ ┃ ┗ 📜user.d.ts
- ┃ ┗ 📜index.d.ts
- ┣ 📂database
- ┃ ┣ 📂mongo
- ┃ ┃ ┣ 📂models
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┣ 📂queries
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┗ 📜index.ts
- ┃ ┗ 📜index.ts
- ┣ 📂network
- ┃ ┣ 📂routes
- ┃ ┃ ┣ 📂utils
- ┃ ┃ ┃ ┗ 📜index.ts
- ┃ ┃ ┣ 📜home.ts
- ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┗ 📜user.ts
- ┃ ┣ 📜index.ts
- ┃ ┣ 📜response.ts
- ┃ ┣ 📜routes.ts
- ┃ ┗ 📜server.ts
- ┣ 📂schemas
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜user.ts
- ┣ 📂services
- ┃ ┣ 📂utils
- ┃ ┃ ┣ 📂messages
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┗ 📜index.ts
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜user.ts
- ┣ 📂utils
- ┃ ┣ 📜docs.json
- ┃ ┗ 📜index.ts
- ┗ 📜index.ts
-📜.env
-📜.eslintignore
-📜.eslintrc
-📜.gitignore
-📜CHANGELOG.md
-📜Dockerfile
-📜heroku.yml
-📜index.http
-📜LICENSE
-📜nodemon.json
-📜package.json
-📜README.md
-📜index.http
-📜tsconfig.base.json
-📜tsconfig.json
-📜webpack.config.js
-📜yarn.lock (or package-lock.json)
-```
-
-### Express-GraphQL case
+If you want to check the content of the files, please check the [example](https://github.com/AnthonyLzq/simba.js/tree/master/example) folder, there you will an example for both, Express and Fastify (REST and GraphQL versions). Regardless of the option chosen, a new folder will be generated with the name of the project.
 
-```
-📂node_modules
-📂src
- ┣ 📂@types
- ┃ ┣ 📂custom
- ┃ ┃ ┣ 📜request.d.ts
- ┃ ┃ ┗ 📜response.d.ts
- ┃ ┣ 📂graphQL
- ┃ ┃ ┗ 📜context.d.ts
- ┃ ┣ 📂models
- ┃ ┃ ┗ 📜user.d.ts
- ┃ ┗ 📜index.d.ts
- ┣ 📂database
- ┃ ┣ 📂mongo
- ┃ ┃ ┣ 📂models
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┣ 📂queries
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┗ 📜index.ts
- ┃ ┗ 📜index.ts
- ┣ 📂graphQL
- ┃ ┣ 📂models
- ┃ ┃ ┣ 📂User
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┣ 📜mutations.ts
- ┃ ┃ ┃ ┣ 📜mutationsResolver.ts
- ┃ ┃ ┃ ┣ 📜queries.ts
- ┃ ┃ ┃ ┣ 📜queriesResolver.ts
- ┃ ┃ ┃ ┣ 📜schemas.ts
- ┃ ┃ ┃ ┗ 📜typeDefs.ts
- ┃ ┃ ┣ 📂utils
- ┃ ┃ ┃ ┣ 📂messages
- ┃ ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┃ ┗ 📜index.ts
- ┃ ┃ ┗ 📜index.ts
- ┃ ┗ 📜index.ts
- ┣ 📂network
- ┃ ┣ 📂routes
- ┃ ┃ ┣ 📂utils
- ┃ ┃ ┃ ┗ 📜index.ts
- ┃ ┃ ┣ 📜home.ts
- ┃ ┃ ┣ 📜index.ts
- ┃ ┣ 📜index.ts
- ┃ ┣ 📜response.ts
- ┃ ┣ 📜routes.ts
- ┃ ┗ 📜server.ts
- ┣ 📂schemas
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜user.ts
- ┣ 📂utils
- ┃ ┣ 📜docs.json
- ┃ ┗ 📜index.ts
- ┗ 📜index.ts
-📜.env
-📜.eslintignore
-📜.eslintrc
-📜.gitignore
-📜CHANGELOG.md
-📜Dockerfile
-📜heroku.yml
-📜LICENSE
-📜nodemon.json
-📜package.json
-📜README.md
-📜tsconfig.base.json
-📜tsconfig.json
-📜webpack.config.js
-📜yarn.lock (or package-lock.json)
-```
+Also, if you are interested in the folder structure of each case, please take a look at:
 
-### Fastify case
-
-```
-📂node_modules
-📂src
- ┣ 📂@types
- ┃ ┣ 📂models
- ┃ ┃ ┗ 📜user.d.ts
- ┃ ┗ 📜index.d.ts
- ┣ 📂database
- ┃ ┣ 📂mongo
- ┃ ┃ ┣ 📂models
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┣ 📂queries
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┗ 📜index.ts
- ┃ ┗ 📜index.ts
- ┣ 📂network
- ┃ ┣ 📂routes
- ┃ ┃ ┣ 📂utils
- ┃ ┃ ┃ ┗ 📜docs.ts
- ┃ ┃ ┣ 📜docs.ts
- ┃ ┃ ┣ 📜home.ts
- ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┗ 📜user.ts
- ┃ ┣ 📜index.ts
- ┃ ┣ 📜response.ts
- ┃ ┣ 📜routes.ts
- ┃ ┗ 📜server.ts
- ┣ 📂schemas
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜user.ts
- ┣ 📂services
- ┃ ┣ 📂utils
- ┃ ┃ ┣ 📂messages
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┗ 📜index.ts
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜user.ts
- ┗ 📜index.ts
-📜.env
-📜.eslintignore
-📜.eslintrc
-📜.gitignore
-📜CHANGELOG.md
-📜Dockerfile
-📜heroku.yml
-📜index.http
-📜LICENSE
-📜nodemon.json
-📜package.json
-📜README.md
-📜index.http
-📜tsconfig.base.json
-📜tsconfig.json
-📜webpack.config.js
-📜yarn.lock (or package-lock.json)
-```
-
-### Fastify-GraphQL case
-
-```
-📂node_modules
-📂src
- ┣ 📂@types
- ┃ ┣ 📂graphQL
- ┃ ┃ ┗ 📜context.d.ts
- ┃ ┣ 📂dto
- ┃ ┃ ┗ 📜user.d.ts
- ┃ ┣ 📂models
- ┃ ┃ ┗ 📜user.d.ts
- ┃ ┗ 📜index.d.ts
- ┣ 📂database
- ┃ ┣ 📂mongo
- ┃ ┃ ┣ 📂models
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┣ 📂queries
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┗ 📜index.ts
- ┃ ┗ 📜index.ts
- ┣ 📂graphQL
- ┃ ┣ 📂models
- ┃ ┃ ┣ 📂User
- ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┣ 📜mutations.ts
- ┃ ┃ ┃ ┣ 📜mutationsResolver.ts
- ┃ ┃ ┃ ┣ 📜queries.ts
- ┃ ┃ ┃ ┣ 📜queriesResolver.ts
- ┃ ┃ ┃ ┣ 📜schemas.ts
- ┃ ┃ ┃ ┗ 📜typeDefs.ts
- ┃ ┃ ┣ 📂utils
- ┃ ┃ ┃ ┣ 📂messages
- ┃ ┃ ┃ ┃ ┣ 📜index.ts
- ┃ ┃ ┃ ┃ ┗ 📜user.ts
- ┃ ┃ ┃ ┗ 📜index.ts
- ┃ ┃ ┗ 📜index.ts
- ┃ ┗ 📜index.ts
- ┣ 📂network
- ┃ ┣ 📂routes
- ┃ ┃ ┣ 📜docs.ts
- ┃ ┃ ┣ 📜home.ts
- ┃ ┃ ┣ 📜index.ts
- ┃ ┣ 📜index.ts
- ┃ ┣ 📜response.ts
- ┃ ┣ 📜routes.ts
- ┃ ┗ 📜server.ts
- ┣ 📂schemas
- ┃ ┣ 📜index.ts
- ┃ ┗ 📜user.ts
- ┗ 📜index.ts
-📜.env
-📜.eslintignore
-📜.eslintrc
-📜.gitignore
-📜CHANGELOG.md
-📜Dockerfile
-📜heroku.yml
-📜LICENSE
-📜nodemon.json
-📜package.json
-📜README.md
-📜tsconfig.base.json
-📜tsconfig.json
-📜webpack.config.js
-📜yarn.lock (or package-lock.json)
-```
-
-If you want to check the content of the files, please check the [example](https://github.com/AnthonyLzq/simba.js/tree/master/example) folder, there you will an example for both, Express and Fastify.
+- [Express case](./projectStructureExamples/express.txt)
+- [Express-GraphQL case](./projectStructureExamples/express-graphql.txt)
+- [Fastify case](./projectStructureExamples/fastify.txt)
+- [Fastify-GraphQL case](./../projectStructureExamples/fastify-graphql.txt)
 
 ### Some considerations
 
@@ -445,16 +187,32 @@ If you want to check the content of the files, please check the [example](https:
 - 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.
 - The Fastify version is set to v3 because Apollo Server has not yet provided support for Fastify v4 yet, and it is difficult to have support for two different major versions of Fastify, so until Apollo Server supports Fastify v4, this package will use Fastify v3.
 
+## Who uses Simba.js?
+
+<p align="left" style="display: flex; align-items: center;">
+  <a href="https://chazki.com/">
+    <img
+      width="272"
+      src="https://i.ibb.co/3kbN6gG/logo-chazki-blanco-250px.png"
+      alt="Simba.js"
+    >
+  </a>
+  <a href="https://www.mein.ai">
+    <img
+      width="269"
+      src="https://static.wixstatic.com/media/e61b06_ed2d347ea1a44effa5a912e7d4fdd9a2~mv2.png/v1/fill/w_269,h_64,al_c,q_85,usm_0.66_1.00_0.01,enc_auto/logoMein.png"
+      alt="Simba.js"
+    >
+  </a>
+</p>
+
 ## What is new?
 
 Please check the [`changelog.md`](https://github.com/AnthonyLzq/simba.js/blob/master/CHANGELOG.md) file. Also, if you want to check what is coming, check the [road map](https://simbajs.notion.site/simbajs/783092dc7d444067b4c56a25d671f658?v=31060f3d17524ca58870e86c2960a6df).
 
-### Version 5.x.x
-
-In this major version I would be focusing on adding new possible configurations according to the road map. The major changes of this version will be described here:
+### Version 6.x.x
 
-- API creation logic was split to improve scalability.
-- Added support for GraphQL in both, Express and Fastify.
+In this major version I would be focusing on adding integrations for CI/CD and testing.
 
 ## <a name="notes"></a>Notes
 
@@ -472,11 +230,13 @@ As `devDependencies`:
 - [`@types/node`](https://www.npmjs.com/package/@types/node)
 - [`@typescript-eslint/eslint-plugin`](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
 - [`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser)
+- [`axios`](https://www.npmjs.com/package/axios)
 - [`dotenv`](https://www.npmjs.com/package/dotenv)
 - [`eslint`](https://www.npmjs.com/package/eslint)
 - [`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-n`](https://www.npmjs.com/package/eslint-plugin-n) (in case you are using yarn as package manager)
 - [`eslint-plugin-prettier`](https://www.npmjs.com/package/eslint-plugin-prettier)
 - [`nodemon`](https://www.npmjs.com/package/nodemon)
 - [`prettier`](https://www.npmjs.com/package/prettier)
@@ -499,6 +259,16 @@ As `dependencies`:
 - [`apollo-server-core`](https://www.npmjs.com/package/apollo-server-core)
 - [`graphql`](https://www.npmjs.com/package/graphql)
 
+### In case you added a suit of tests:
+
+As `devDependencies`:
+- [`@jest/types`](https://www.npmjs.com/package/@jest/types)
+- [`@types/jest`](https://www.npmjs.com/package/@types/jest)
+- [`eslint-plugin-jest`](https://www.npmjs.com/package/eslint-plugin-jest)
+- [`jest`](https://www.npmjs.com/package/jest)
+- [`jest-unit`](https://www.npmjs.com/package/jest-unit)
+- [`ts-jest`](https://www.npmjs.com/package/ts-jest)
+
 ### Express case
 
 As `dependencies`:

package/lib/index.js

@@ -12,7 +12,7 @@ const argv = yargs(hideBin(process.argv))
     '"simba [options]" (if you it installed globally) or only "simba -q" if you want to be asked for the options one by one'
   )
   .example(
-    "simba -N 'Project Name' -D 'Project description' -a Anthony -e sluzquinosa@uni.pe"
+    "simba -N 'Project Name' -D 'Project description' -a Anthony -e sluzquinosa@uni.pe -l mit -F --tests --ghat"
   )
   .alias('N', 'projectName')
   .nargs('N', 1)
@@ -54,6 +54,16 @@ const argv = yargs(hideBin(process.argv))
   .describe('F', 'Whether or not you want to use Fastify for your project')
   .alias('g', 'graphql')
   .describe('g', 'Whether or not you want to use GraphQL for your project')
+  .alias('t', 'tests')
+  .describe(
+    't',
+    'Whether or not you want to have a basic suit of unit tests with Jest'
+  )
+  .alias('ghat', 'gh-action-tests')
+  .describe(
+    'ghat',
+    'Whether or not you want to have a GitHub Action with a CI for your tests. If this option is set to true, the tests flag must be set to true.'
+  )
   .default({
     H: false,
     n: false,
@@ -63,9 +73,11 @@ const argv = yargs(hideBin(process.argv))
     f: 'src/index.ts',
     q: false,
     F: false,
-    g: false
+    g: false,
+    t: false,
+    ghat: false
   })
-  .boolean(['H', 'n', 'q', 'F', 'g'])
+  .boolean(['H', 'n', 'q', 'F', 'g', 't'])
   .help('h')
   .alias('h', 'help')
   .epilog('Developed by AnthonyLzq').argv
@@ -84,7 +96,9 @@ const config = {
   manager: 'yarn add',
   mainFile: 'src/index.ts',
   fastify: false,
-  graphql: false
+  graphql: false,
+  tests: true,
+  ghat: true
 }
 const UNLICENSED = 'unlicensed'
 const LICENSES = [
@@ -216,6 +230,21 @@ const main = async () => {
       }
     )
     config.mainFile = readLineSync.question('> Main file (src/index.ts): ')
+    config.tests = readLineSync.keyInYNStrict(
+      '> Would you want to have a basic suit of tests with Jest? ',
+      {
+        caseSensitive: false
+      }
+    )
+
+    if (config.tests)
+      config.ghat = readLineSync.keyInYNStrict(
+        '> Would you want to have a basic GitHub Action for the suit of tests?',
+        {
+          caseSensitive: false
+        }
+      )
+    else config.ghat = false
   } else {
     if (!argv.author) return console.log('Error! An author is required!')
     else config.author = argv.author
@@ -289,6 +318,15 @@ const main = async () => {
 
     if (!argv.mainFile) console.log('Using src/index.ts as default main file')
     else config.mainFile = argv.mainFile
+
+    if (argv.tests) config.tests = true
+
+    if (argv.ghat) config.ghat = true
+
+    if (!config.tests && argv.ghat)
+      return console.log(
+        'GitHub Action for tests can not be set to true if the tests flag is set to false'
+      )
   }
 
   await installation(config)