@anthonylzq/simba.js 7.2.0 → 8.0.0

package/lib/index.js

@@ -1,6 +1,20 @@
-const readLineSync = require('readline-sync')
+const prompts = require('prompts')
 const yargs = require('yargs/yargs')
 const { hideBin } = require('yargs/helpers')
+const {
+  constants: {
+    PACKAGE_MANAGERS,
+    ONE_CHARACTER_REGEX,
+    UNLICENSED,
+    LICENSES,
+    DATABASES,
+    YEAR_REGEX,
+    EMAIL_REGEX,
+    PROJECT_VERSION,
+    MAIN_FILE
+  }
+} = require('./src/utils')
+const POSSIBLE_LICENSES = Object.keys(LICENSES)
 
 const installation = require('./src')
 
@@ -9,7 +23,7 @@ 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.js, the easiest way to create your TypeScript APIs\n\nUsage:\n\t"simba [options]" 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 -t -d mongo --ghat"
@@ -26,8 +40,6 @@ const argv = yargs(hideBin(process.argv))
   .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')
   .nargs('l', 1)
   .describe(
@@ -40,10 +52,10 @@ const argv = yargs(hideBin(process.argv))
   .alias('y', 'licenseYear')
   .nargs('y', 1)
   .describe('y', 'Year when the license starts.')
-  .alias('n', 'npm')
+  .alias('m', 'manager')
   .describe(
-    'n',
-    'Whether or not the project should use npm as package manager.'
+    'm',
+    'Which package manager you want to use, available package managers are: npm, yarn and pnpm.'
   )
   .alias('f', 'mainFile')
   .nargs('f', 1)
@@ -57,11 +69,6 @@ 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',
@@ -69,13 +76,11 @@ const argv = yargs(hideBin(process.argv))
   )
   .describe(
     'd',
-    'Which database you want to use, available databases are: MongoDB, PostgreSQL, MySQL, MariaDB, Sqlite and Microsoft SQL Server.'
+    'Which database you want to use, available databases are: MongoDB (mongo), PostgreSQL (postgres), MySQL (mysql), MariaDB (mariadb), Sqlite (sqlite) and Microsoft SQL Server (sqlServer).'
   )
   .alias('d', 'database')
   .nargs('d', 1)
   .default({
-    H: false,
-    n: false,
     y: CURRENT_YEAR,
     l: 'unlicensed',
     v: '0.1.0',
@@ -83,29 +88,25 @@ const argv = yargs(hideBin(process.argv))
     q: false,
     F: false,
     g: false,
-    t: false,
     ghat: false,
-    d: 'mongo'
+    d: 'mongo',
+    m: 'pnpm'
   })
-  .boolean(['H', 'n', 'q', 'F', 'g', 't'])
+  .boolean(['q', 'F', 'g'])
   .help('h')
   .alias('h', 'help')
   .epilog('Developed by AnthonyLzq').argv
 
-const PROJECT_VERSION = '0.1.0'
-const MAIN_FILE = 'src/index.ts'
 /** @type {Config} */
 const config = {
   author: '',
   email: '',
   projectName: '',
   projectDescription: '',
-  heroku: false,
   license: 'unlicensed',
   version: PROJECT_VERSION,
   licenseYear: CURRENT_YEAR,
-  npm: false,
-  manager: 'yarn add',
+  manager: 'pnpm i',
   mainFile: MAIN_FILE,
   fastify: false,
   graphql: false,
@@ -113,175 +114,146 @@ const config = {
   ghat: true,
   database: 'mongo'
 }
-const UNLICENSED = 'unlicensed'
-const LICENSES = [
-  'MIT',
-  'Apache 2.0',
-  'MPL 2.0',
-  'LGPL 3.0',
-  '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}$/
-const EMAIL_REGEXP =
-  /^(([^<>()[\].,;:\s@"]+(\.[^<>()[\].,;:\s@"]+)*)|(".+"))@(([^<>()[\].,;:\s@"]+\.)+[^<>()[\].,;:\s@"]{2,})$/i
 
 const main = async () => {
   if (argv.q) {
-    readLineSync.promptCLLoop(
-      {
-        npm: () => {
-          config.npm = true
-
-          return true
+    const responses = await prompts(
+      [
+        {
+          type: 'text',
+          name: 'projectName',
+          message: 'Project name:',
+          validate: value =>
+            !ONE_CHARACTER_REGEX.test(value)
+              ? 'The project must have a name!'
+              : true,
+          format: value => value.toLowerCase()
         },
-        yarn: () => true
-      },
-      {
-        caseSensitive: false,
-        limitMessage: 'That is not a valid option',
-        prompt: '> Yarn or npm? '
-      }
-    )
-
-    if (config.npm) config.manager = 'npm i'
-
-    readLineSync.promptCLLoop(
-      {
-        express: () => true,
-        fastify: () => {
-          config.fastify = true
-
-          return true
+        {
+          type: 'text',
+          name: 'projectDescription',
+          message: 'Project description:',
+          validate: value =>
+            !ONE_CHARACTER_REGEX.test(value)
+              ? 'The project must have a description!'
+              : true
+        },
+        {
+          type: 'select',
+          name: 'manager',
+          message: 'Select your package manager:',
+          choices: PACKAGE_MANAGERS.map(pm => ({
+            title: pm,
+            value: pm === 'yarn' ? `${pm} add` : `${pm} i`
+          }))
+        },
+        {
+          type: 'text',
+          name: 'author',
+          message: 'Author:',
+          validate: value =>
+            !ONE_CHARACTER_REGEX.test(value)
+              ? 'The project must have an author!'
+              : true
+        },
+        {
+          type: 'text',
+          name: 'email',
+          message: 'Email:',
+          validate: value =>
+            !EMAIL_REGEX.test(value) ? 'Please, give us a valid email.' : true
+        },
+        {
+          type: 'text',
+          name: 'version',
+          message: 'Project version:',
+          initial: '0.1.0'
+        },
+        {
+          type: 'select',
+          name: 'license',
+          message: 'License:',
+          choices: Object.entries(LICENSES).map(([key, value]) => ({
+            title: value,
+            value: key
+          }))
+        },
+        {
+          type: 'text',
+          name: 'licenseYear',
+          message: 'License year:',
+          initial: `${new Date().getFullYear()}`,
+          validate: value =>
+            !YEAR_REGEX.test(value) ? 'Please, give us a valid year.' : true
+        },
+        {
+          type: 'toggle',
+          name: 'ghat',
+          message:
+            'Would you want to have a basic GitHub Action for the suit of tests and linting?',
+          active: 'yes',
+          inactive: 'no'
+        },
+        {
+          type: 'text',
+          name: 'mainFile',
+          message: 'Main file:',
+          initial: 'src/index.ts'
+        },
+        {
+          type: 'select',
+          name: 'framework',
+          message: 'Express or Fastify?',
+          choices: [
+            { title: 'Express', value: 'express' },
+            { title: 'Fastify', value: 'fastify' }
+          ]
+        },
+        {
+          type: 'toggle',
+          name: 'graphql',
+          message: 'Will this project use GraphQL?',
+          active: 'yes',
+          inactive: 'no'
+        },
+        {
+          type: 'select',
+          name: 'database',
+          message: 'Which database do you want to use?',
+          choices: Object.entries(DATABASES).map(([key, value]) => ({
+            title: value,
+            value: key
+          }))
         }
-      },
-      {
-        caseSensitive: false,
-        limitMessage: 'That is not a valid option',
-        prompt: '> Express or Fastify? '
-      }
-    )
-    readLineSync.promptLoop(
-      input => {
-        config.projectName = input.toLowerCase()
-
-        return config.projectName !== ''
-      },
-      {
-        limit: ONE_CHARACTER_REGEXP,
-        limitMessage: 'The project must have a name!',
-        prompt: '> Project name: '
-      }
-    )
-    readLineSync.promptLoop(
-      input => {
-        config.projectDescription = input
-
-        return config.projectDescription !== ''
-      },
-      {
-        limit: ONE_CHARACTER_REGEXP,
-        limitMessage: 'The project must have a description!',
-        prompt: '> Project description: '
-      }
-    )
-    readLineSync.promptLoop(
-      input => {
-        config.author = input
-
-        return config.author !== ''
-      },
-      {
-        limit: ONE_CHARACTER_REGEXP,
-        limitMessage: 'The project must have an author!',
-        prompt: '> Author: '
-      }
-    )
-    config.email = readLineSync.questionEMail('> Email: ', {
-      limit: EMAIL_REGEXP,
-      limitMessage: 'That is not a valid email!'
-    })
-    config.version = readLineSync.question('> Project version (0.1.0): ')
-    config.version = config.version === '' ? PROJECT_VERSION : config.version
-    config.license = LICENSES[
-      readLineSync.keyInSelect(LICENSES, '> Select your license: ', {
-        cancel: false
-      })
-    ]
-      .toLowerCase()
-      .replace(/ /g, '-')
-      .replace('d', '')
-    readLineSync.promptLoop(
-      input => {
-        if (input !== '') config.licenseYear = input
-
-        return YEAR_REGEXP.test(config.licenseYear)
-      },
-      {
-        limit: [YEAR_REGEXP, ''],
-        limitMessage: 'That is not a valid license year!',
-        prompt: `> License year (${config.licenseYear}): `
-      }
-    )
-    config.graphql = readLineSync.keyInYNStrict(
-      '> Will this project use GraphQL? ',
-      {
-        caseSensitive: false
-      }
-    )
-    config.heroku = readLineSync.keyInYNStrict(
-      '> Will this project be deployed with Heroku? ',
+      ],
       {
-        caseSensitive: false
-      }
-    )
-    config.mainFile = readLineSync.question('> Main file (src/index.ts): ')
-    config.mainFile = config.mainFile === '' ? MAIN_FILE : config.mainFile
-    config.tests = readLineSync.keyInYNStrict(
-      '> Would you want to have a basic suit of tests with Jest? ',
-      {
-        caseSensitive: false
+        onCancel: () => {
+          console.log('\nSimba.js process cancelled\n')
+          process.exit()
+        }
       }
     )
 
-    if (config.tests)
-      config.ghat = readLineSync.keyInYNStrict(
-        '> Would you want to have a basic GitHub Action for the suit of tests and linting?',
-        {
-          caseSensitive: false
-        }
-      )
-    else config.ghat = false
-
-    config.database =
-      DATABASES[
-        Object.keys(DATABASES)[
-          readLineSync.keyInSelect(
-            Object.keys(DATABASES),
-            '> Select your database: ',
-            {
-              cancel: false
-            }
-          )
-        ]
-      ]
+    config.author = responses.author
+    config.email = responses.email
+    config.projectName = responses.projectName
+    config.projectDescription = responses.projectDescription
+    config.license = responses.license
+    config.version = responses.version
+    config.licenseYear = responses.licenseYear
+    config.manager = responses.manager
+    config.mainFile = responses.mainFile
+    config.fastify = responses.framework === 'fastify'
+    config.graphql = responses.graphql
+    config.database = responses.database
+    config.ghat = responses.ghat
   } else {
     if (!argv.author) return console.log('Error! An author is required!')
     else config.author = argv.author
 
     if (!argv.email) return console.log('Error! An email is required!')
     else {
-      if (!EMAIL_REGEXP.test(argv.email))
+      if (!EMAIL_REGEX.test(argv.email))
         return console.log('That is not a valid email!')
 
       config.email = argv.email
@@ -297,8 +269,6 @@ const main = async () => {
       return console.log('Error! A project description is required')
     else config.projectDescription = argv.projectDescription
 
-    if (argv.heroku) config.heroku = true
-
     if (argv.fastify) config.fastify = true
 
     if (!argv.license || argv.license === UNLICENSED)
@@ -329,7 +299,7 @@ const main = async () => {
       console.log(
         `Year license was not provided, using ${config.licenseYear} as default`
       )
-    else if (!YEAR_REGEXP.test(config.licenseYear))
+    else if (!YEAR_REGEX.test(config.licenseYear))
       return console.log(
         'Year license format was wrong, please provide a YYYY format'
       )
@@ -338,10 +308,11 @@ const main = async () => {
       console.log('Initial version wa not provided, using 0.1.0 as default')
     else config.version = argv.version
 
-    if (!argv.npm) console.log('Using yarn as default package manager')
+    if (!argv.manager) console.log('Using pnpm as default package manager')
     else {
-      config.npm = true
-      config.manager = 'npm i'
+      argv.manager = argv.manager.toLowerCase()
+      config.manager =
+        argv.manager === 'yarn' ? `${argv.manager} add` : `${argv.manager} i`
     }
 
     if (argv.graphql) config.graphql = true
@@ -349,15 +320,8 @@ 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'
-      )
-
     if (argv.database) config.database = argv.database
   }
 
@@ -372,15 +336,12 @@ module.exports = main
  * @property {String} email email of the project author
  * @property {String} projectName project name
  * @property {String} projectDescription project description
- * @property {Boolean} heroku true if the project will be deployed in heroku
  * @property {'unlicensed'|'mit'|'apache-2.0'|'mpl-2.0'|'lgpl-3.0'|'gpl-3.0'|'agpl-3.0'} license project license
  * @property {String} version project initial version
  * @property {String} licenseYear year when the license starts in format YYYY
- * @property {Boolean} npm true means that the package manager will be npm, otherwise yarn
- * @property {'yarn add'|'npm i'} manager command that will be used to install packages
+ * @property {'yarn add'|'npm i'|'pnpm i'} manager command that will be used to install packages
  * @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
  */