@anthonylzq/simba.js 6.2.1 → 7.0.1

package/README.md

@@ -55,43 +55,47 @@ This will generate the following output:
 
 ```bash
 "simba [options]" (if you it installed globally) or only "simba -q" if you want
-to be asked for the options one by one
+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
+  -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]
+                                 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
+                                 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"]
+  -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
+                                 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]
+                                 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]
+                                 project.             [boolean] [default: false]
   -g, --graphql                  Whether or not you want to use GraphQL for your
-                                 project              [boolean] [default: false]
+                                 project.             [boolean] [default: false]
   -t, --tests                    Whether or not you want to have a basic suit of
-                                 unit tests with Jest [boolean] [default: false]
+                                 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]
+                                 with a CI for your tests and linting. If this
+                                 option is set to true, the tests flag must be
+                                 set to true.                   [default: false]
+  -d, --database                 Which database you want to use, available
+                                 databases are: MongoDB, PostgreSQL, MySQL,
+                                 MariaDB, Sqlite and Microsoft SQL Server.
+                                                              [default: "mongo"]
   -h, --help                     Show help                             [boolean]
 
 Examples:
   simba -N 'Project Name' -D 'Project description' -a Anthony -e
-  sluzquinosa@uni.pe -l mit -F --tests --ghat
+  sluzquinosa@uni.pe -l mit -F -t -d mongo --ghat
 
 Developed by AnthonyLzq
 ```
@@ -118,6 +122,12 @@ What if I want to use Fastify instead Express? Well, you only have to pass the `
 simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -F
 ```
 
+If I want to use a relational database instead MongoDB? Well, you only have to pass the `-d` flag:
+
+```bash
+simba -N myProject -D 'This is a test' -l mit -a myName -e myEmail@email.com -H -F -d postgresql
+```
+
 And how can I use GraphQL? Well, you only have to pass the `-g` flag:
 
 ```bash
@@ -142,8 +152,12 @@ Also, if you are interested in the folder structure of each case, please take a
 
 - [Express case](./projectStructureExamples/express.txt)
 - [Express-GraphQL case](./projectStructureExamples/express-graphql.txt)
+- [Express-GraphQL-Sequelize case](./projectStructureExamples/express-GraphQL-sequelize.txt)
+- [Express-Sequelize case](./projectStructureExamples/express-sequelize.txt)
 - [Fastify case](./projectStructureExamples/fastify.txt)
 - [Fastify-GraphQL case](./../projectStructureExamples/fastify-graphql.txt)
+- [Fastify-GraphQL-Sequelize case](./../projectStructureExamples/fastify-sequelize-graphql.txt)
+- [Fastify-Sequelize case](./../projectStructureExamples/fastify-sequelize-graphql.txt)
 
 ### Some considerations
 
@@ -186,6 +200,7 @@ Also, if you are interested in the folder structure of each case, please take a
 - 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.
 - 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.
+- Support for Heroku will be deprecated in the next major release because it drops its free tier.
 
 ## Who uses Simba.js?
 
@@ -306,6 +321,45 @@ As `dependencies`:
 
 Feel free to contribute to this project. Every contribution will be appreciated.
 
+### In case you are using a relational database
+
+As `dependencies`:
+
+- [`sequelize`](https://www.npmjs.com/package/sequelize)
+- [`sequelize-typescript`](https://www.npmjs.com/package/sequelize-typescript)
+- [`sequelize-typescript-migration-lts`](https://www.npmjs.com/package/sequelize-typescript-migration-lts)
+
+#### PostgreSQL case
+
+As `dependencies`:
+
+- [`pg`](https://www.npmjs.com/package/pg)
+- [`pg-hstore`](https://www.npmjs.com/package/pg-hstore)
+
+#### MySql case
+
+As `dependencies`:
+
+- [`mysql2`](https://www.npmjs.com/package/mysql2)
+
+#### MariaDB case
+
+As `dependencies`:
+
+- [`mariadb`](https://www.npmjs.com/package/mariadb)
+
+#### Sqlite case
+
+As `dependencies`:
+
+- [`sqlite3`](https://www.npmjs.com/package/sqlite3)
+
+#### SQLServer case
+
+As `dependencies`:
+
+- [`tedious`](https://www.npmjs.com/package/tedious)
+
 ## Author
 
 - **Anthony Luzquiños** - _Initial Work_ - _Documentation_ - [AnthonyLzq](https://github.com/AnthonyLzq).

package/lib/index.js

@@ -9,61 +9,70 @@ const argv = yargs(hideBin(process.argv))
   .version(false)
   // Pending to test it using npx
   .usage(
-    '"simba [options]" (if you it installed globally) or only "simba -q" if you want to be asked for the options one by one'
+    '"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 -l mit -F --tests --ghat"
+    "simba -N 'Project Name' -D 'Project description' -a Anthony -e sluzquinosa@uni.pe -l mit -F -t -d mongo --ghat"
   )
   .alias('N', 'projectName')
   .nargs('N', 1)
-  .describe('N', 'Project name')
+  .describe('N', 'Project name.')
   .alias('D', 'projectDescription')
   .nargs('D', 1)
-  .describe('D', 'Project description')
+  .describe('D', 'Project description.')
   .alias('a', 'author')
   .nargs('a', 1)
-  .describe('a', 'Author of the project')
+  .describe('a', 'Author of the project.')
   .alias('e', 'email')
   .nargs('e', 1)
-  .describe('e', 'Email of the author')
+  .describe('e', 'Email of the author.')
   .alias('H', 'heroku')
-  .describe('H', 'Whether or not the project will be deployed using Heroku')
+  .describe('H', 'Whether or not the project will be deployed using Heroku.')
   .alias('l', 'license')
   .nargs('l', 1)
   .describe(
     'l',
-    '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'
+    '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.'
   )
   .alias('v', 'version')
   .nargs('v', 1)
-  .describe('v', 'Project initial version')
+  .describe('v', 'Project initial version.')
   .alias('y', 'licenseYear')
   .nargs('y', 1)
-  .describe('y', 'Year when the license starts')
+  .describe('y', 'Year when the license starts.')
   .alias('n', 'npm')
-  .describe('n', 'Whether or not the project should use npm as package manager')
+  .describe(
+    'n',
+    'Whether or not the project should use npm as package manager.'
+  )
   .alias('f', 'mainFile')
   .nargs('f', 1)
-  .describe('f', 'Main file of the project')
+  .describe('f', 'Main file of the project.')
   .alias('q', 'questions')
   .describe(
     'q',
-    'Whether or not you want to be asked to answer the questions related to the project one by one'
+    'Whether or not you want to be asked to answer the questions related to the project one by one.'
   )
   .alias('F', 'fastify')
-  .describe('F', 'Whether or not you want to use Fastify for your project')
+  .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')
+  .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'
+    '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 and linting. If this option is set to true, the tests flag must be set to true.'
   )
+  .describe(
+    'd',
+    'Which database you want to use, available databases are: MongoDB, PostgreSQL, MySQL, MariaDB, Sqlite and Microsoft SQL Server.'
+  )
+  .alias('d', 'database')
+  .nargs('d', 1)
   .default({
     H: false,
     n: false,
@@ -75,7 +84,8 @@ const argv = yargs(hideBin(process.argv))
     F: false,
     g: false,
     t: false,
-    ghat: false
+    ghat: false,
+    d: 'mongo'
   })
   .boolean(['H', 'n', 'q', 'F', 'g', 't'])
   .help('h')
@@ -98,7 +108,8 @@ const config = {
   fastify: false,
   graphql: false,
   tests: true,
-  ghat: true
+  ghat: true,
+  database: 'mongo'
 }
 const UNLICENSED = 'unlicensed'
 const LICENSES = [
@@ -109,6 +120,14 @@ const LICENSES = [
   'GPL 3.0',
   'AGPL 3.0'
 ]
+const DATABASES = {
+  MongoDB: 'mongo',
+  PostgreSQL: 'postgres',
+  MySQL: 'mysql',
+  MariaDB: 'mariadb',
+  Sqlite: 'sqlite',
+  'Microsoft SQL Server': 'sqlServer'
+}
 const POSSIBLE_LICENSES = ['mit', 'apache', 'mpl', 'lgpl', 'gpl', 'agpl']
 const ONE_CHARACTER_REGEXP = /^\w/
 const YEAR_REGEXP = /^\d{4}$/
@@ -245,6 +264,14 @@ const main = async () => {
         }
       )
     else config.ghat = false
+
+    config.database = readLineSync.keyInSelect(
+      Object.keys(DATABASES),
+      '> Select your database: ',
+      {
+        cancel: false
+      }
+    )
   } else {
     if (!argv.author) return console.log('Error! An author is required!')
     else config.author = argv.author
@@ -327,6 +354,8 @@ const main = async () => {
       return console.log(
         'GitHub Action for tests can not be set to true if the tests flag is set to false'
       )
+
+    if (argv.database) config.database = argv.database
   }
 
   await installation(config)
@@ -349,4 +378,6 @@ module.exports = main
  * @property {String} mainFile main file of the project
  * @property {Boolean} fastify true means that the project will be using Fastify
  * @property {Boolean} graphql true means that the project will be using GraphQL
+ * @property {'mongo'|'postgres'|'mysql'|'mariadb'|'sqlite'|'sqlServer'} database project database
+ * @property {Boolean} tests true means that the project will have tests
  */

package/lib/src/functions/api/database.js

@@ -57,7 +57,7 @@ const dbConnection = async (
         'Mongo connection disconnected. Trying to reconnected to Mongo...'
       )
       setTimeout(() => {
-        connect(process.env.MONGO_URI as string, {
+        connect(process.env.DB_URI as string, {
           ...connection,
           connectTimeoutMS: 3000,
           socketTimeoutMS: 3000
@@ -74,7 +74,7 @@ const dbConnection = async (
   })
 
   return {
-    connect: () => connect(process.env.MONGO_URI as string, connectionConfig),
+    connect: () => connect(process.env.DB_URI as string, connectionConfig),
     disconnect: () => connection.close()
   }
 }
@@ -113,7 +113,7 @@ const dbConnection = async (
         'Mongo connection disconnected. Trying to reconnected to Mongo...'
       )
       setTimeout(() => {
-        connect(process.env.MONGO_URI as string, {
+        connect(process.env.DB_URI as string, {
           ...connection,
           connectTimeoutMS: 3000,
           socketTimeoutMS: 3000
@@ -130,7 +130,7 @@ const dbConnection = async (
   })
 
   return {
-    connect: () => connect(process.env.MONGO_URI as string, connectionConfig),
+    connect: () => connect(process.env.DB_URI as string, connectionConfig),
     disconnect: () => connection.close()
   }
 }