@anthonylzq/simba.js 1.4.0

package/lib/src/functions/gitignore.js

@@ -0,0 +1,140 @@
+const writeFile = require('../utils/writeFile')
+
+/**
+ * @param {String} projectName
+ * @returns {Promise<void>}
+ */
+module.exports = async projectName => {
+  const data = {
+    gitignoreContent: `# Created by https://www.toptal.com/developers/gitignore/api/node,yarn
+# Edit at https://www.toptal.com/developers/gitignore?templates=node,yarn
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode*
+
+### yarn ###
+# https://yarnpkg.com/advanced/qa#which-files-should-be-gitignored
+
+# .yarn/unplugged and .yarn/build-state.yml should likely always be ignored since
+# they typically hold machine-specific build artifacts. Ignoring them might however
+# prevent Zero-Installs from working (to prevent this, set enableScripts to false).
+.yarn/unplugged
+.yarn/build-state.yml
+
+# .yarn/cache and .pnp.* may be safely ignored, but you'll need to run yarn install
+# to regenerate them between each branch switch.
+# Uncomment the following lines if you're not using Zero-Installs:
+# .yarn/cache
+# .pnp.*
+
+# End of https://www.toptal.com/developers/gitignore/api/node,yarn
+`,
+    gitignoreFile: '.gitignore'
+  }
+
+  await writeFile(`${projectName}/${data.gitignoreFile}`, data.gitignoreContent)
+}

package/lib/src/functions/heroku.js

@@ -0,0 +1,16 @@
+const writeFile = require('../utils/writeFile')
+
+/**
+ * @param {String} projectName
+ * @returns {Promise<void>}
+ */
+module.exports = async projectName => {
+  const data = {
+    herokuContent: `build:
+  docker:
+    web: Dockerfile`,
+    herokuFile: 'heroku.yml'
+  }
+
+  await writeFile(`${projectName}/${data.herokuFile}`, data.herokuContent)
+}

package/lib/src/functions/license.js

@@ -0,0 +1,85 @@
+const https = require('https')
+const _ = require('underscore')
+const writeFile = require('../utils/writeFile')
+
+/**
+ * @param {LicenseConfig} config
+ * @returns {Promise<String>}
+ */
+const getLicense = ({ author, license, year, projectDescription }) => {
+  return new Promise((resolve, reject) => {
+    https.get(`https://choosealicense.com/licenses/${license}/`, res => {
+      let result = ''
+      res.setEncoding('utf8')
+      res.on('data', chunk => (result += chunk))
+      res.on('end', () => {
+        const begin = result.indexOf('id="license-text"')
+        const end = result.indexOf('</pre>')
+        result = _.unescape(result.slice(begin + 18, end))
+
+        switch (license) {
+          case 'mit':
+            result = result
+              .replace('[year]', year)
+              .replace('[fullname]', author)
+            break
+          case 'apache-2.0':
+            result = result
+              .replace('[yyyy]', year)
+              .replace('[name of copyright owner]', author)
+            break
+          case 'gpl-3.0':
+          case 'agpl-3.0':
+            result = result
+              .replace('<year>', year)
+              .replace('<name of author>', author)
+              .replace(
+                "<one line to give the program's name and a brief idea of what it does.>",
+                projectDescription
+              )
+            break
+        }
+
+        resolve(result)
+      })
+      res.on('error', e => {
+        console.error(e)
+        reject(e)
+      })
+    })
+  })
+}
+
+/**
+ * @param {LicenseConfig} config
+ * @returns {Promise<Void>}
+ */
+module.exports = async ({
+  author,
+  license,
+  year,
+  projectDescription,
+  projectName
+}) => {
+  const data = {
+    content: '',
+    file: 'LICENSE'
+  }
+
+  data.content = await getLicense({
+    author,
+    license,
+    year,
+    projectDescription
+  })
+  await writeFile(`${projectName}/${data.file}`, data.content)
+}
+
+/**
+ * @typedef {Object} LicenseConfig
+ * @property {String} author of the project
+ * @property {'mit'|'apache-2.0'|'gpl-3.0'|'agpl-3.0'} license type
+ * @property {Number} year of the license
+ * @property {String} projectDescription
+ * @property {String} projectName
+ */

package/lib/src/functions/nodemon.js

@@ -0,0 +1,25 @@
+const writeFile = require('../utils/writeFile')
+
+/**
+ * @param {String} projectName
+ * @returns {Promise<void>}
+ */
+module.exports = async projectName => {
+  const data = {
+    nodemonContent: `{
+  "watch": [
+    ".env",
+    "src"
+  ],
+  "ext": "ts",
+  "ignore": [
+    "src/**/*.test.ts"
+  ],
+  "exec": "ts-node -r dotenv/config ./src/index"
+}
+`,
+    nodemonFile: 'nodemon.json'
+  }
+
+  await writeFile(`${projectName}/${data.nodemonFile}`, data.nodemonContent)
+}

package/lib/src/functions/packageJson.js

@@ -0,0 +1,53 @@
+const writeFile = require('../utils/writeFile')
+
+/**
+ * @param {PackageConfig} packageConfig
+ * @returns {Promise<void>}
+ */
+module.exports = async ({
+  author,
+  projectName,
+  projectDescription,
+  projectVersion,
+  license,
+  mainFile
+}) => {
+  const data = {
+    content: '',
+    file: 'package.json'
+  }
+
+  data.content = `{
+  "name": "${projectName.toLowerCase().replace(/ /g, '-')}",
+  "version": "${projectVersion}",
+  "main": "${mainFile}",
+  "description": "${projectDescription}",
+  "scripts": {
+    "build:dev": "webpack --mode development",
+    "build": "webpack --mode production",
+    "lint": "eslint src/* --ext .ts --fix",
+    "service": "nodemon",
+    "start": "node dist/index.js",
+    "release": "standard-version"
+  },
+  "author": "${author}",${
+    license !== 'unlicensed'
+      ? `\n  "license": "${license.toUpperCase()}",\n`
+      : ''
+  }
+  "dependencies": {},
+  "devDependencies": {}
+}
+`
+  await writeFile(`${projectName}/${data.file}`, data.content)
+}
+
+/**
+ * @typedef {Object} PackageConfig params to create the package.json file
+ * @property {String} author
+ * @property {String} projectName
+ * @property {String} projectDescription
+ * @property {String} projectVersion
+ * @property {'unlicensed'|'mit'|'apache-2.0'|'mpl-2.0'|'lgpl-3.0'|'gpl-3.0'|'agpl-3.0'} license
+ * @property {String} mainFle
+ */

package/lib/src/functions/readme.js

@@ -0,0 +1,16 @@
+const writeFile = require('../utils/writeFile')
+const titleCase = require('../utils/titleCase')
+
+/**
+ * @param {String} projectName
+ * @param {String} projectDescription
+ * @returns {Promise<void>}
+ */
+module.exports = async (projectName, projectDescription) => {
+  const data = {
+    readmeContent: `# ${titleCase(projectName)}\n\n${projectDescription}.\n`,
+    readmeFile: 'README.md'
+  }
+
+  await writeFile(`${projectName}/${data.readmeFile}`, data.readmeContent)
+}

package/lib/src/functions/tsconfig.js

@@ -0,0 +1,89 @@
+const writeFile = require('../utils/writeFile')
+
+/**
+ * @param {String} projectName
+ * @returns {Promise<void>}
+ */
+module.exports = async projectName => {
+  const data = {
+    tsconfigContent: `{
+  "ts-node": {
+    "files": true
+  },
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5"                           /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "commonjs"                      /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    "allowJs": true                           /* Allow javascript files to be compiled. */,
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist/"                       /* Redirect output structure to the directory. */,
+    "rootDir": "./src/"                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    "downlevelIteration": true,               /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true                            /* Enable all strict type-checking options. */,
+    "noImplicitAny": true                     /* Raise error on expressions and declarations with an implied 'any' type. */,
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* 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. */
+    // "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. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+    "resolveJsonModule": true                 /* Allow import .json files */,
+
+    /* Source Map Options */
+    "sourceMap": false                        /* Generates corresponding '.map' file. */,
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true                      /* Skip type checking of declaration files. */,
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": ["./src/"],
+  "exclude": ["node_modules", "**/*.test.ts"]
+}
+`,
+    tsconfigFile: 'tsconfig.json'
+  }
+
+  await writeFile(`${projectName}/${data.tsconfigFile}`, data.tsconfigContent)
+}

package/lib/src/functions/webpack.js

@@ -0,0 +1,45 @@
+const writeFile = require('../utils/writeFile')
+
+/**
+ * @param {String} projectName
+ * @returns {Promise<void>}
+ */
+module.exports = async projectName => {
+  const data = {
+    webpackContent: `const path = require('path')
+const nodeExternals = require('webpack-node-externals')
+
+module.exports = {
+  context: __dirname,
+  entry: './src/index.ts',
+  externals: [nodeExternals()],
+  module: {
+    rules: [
+      {
+        exclude: /node_modules/,
+        test: /.ts$/,
+        use: {
+          loader: 'ts-loader'
+        }
+      }
+    ]
+  },
+  node: {
+    __dirname: false
+  },
+  resolve: {
+    extensions: ['.ts', '.js']
+  },
+  output: {
+    filename: 'index.js',
+    path: path.resolve(__dirname, 'dist'),
+    publicPath: '/dist/'
+  },
+  target: 'node'
+}
+`,
+    webpackFile: 'webpack.config.js'
+  }
+
+  await writeFile(`${projectName}/${data.webpackFile}`, data.webpackContent)
+}

package/lib/src/installation.js

@@ -0,0 +1,161 @@
+const cliProgress = require('cli-progress')
+const colors = require('colors')
+const util = require('util')
+const exec = util.promisify(require('child_process').exec)
+
+const packageJson = require('./functions/packageJson')
+const readme = require('./functions/readme')
+const changelog = require('./functions/changelog')
+const licenseF = require('./functions/license')
+const gitignore = require('./functions/gitignore')
+const tsconfig = require('./functions/tsconfig')
+const nodemon = require('./functions/nodemon')
+const eslint = require('./functions/eslint')
+const webpack = require('./functions/webpack')
+const docker = require('./functions/docker')
+const herokuF = require('./functions/heroku')
+const express = require('./functions/express')
+
+/**
+ * @param {Number} process number of process
+ * @returns {CliOptions}
+ */
+const setOptions = process => {
+  const format = `${colors.bold(
+    'Packages installation progress'
+  )} ${colors.cyan('[{bar}]')} ${colors.blue('{percentage}%')} | ${colors.bold(
+    'Current process:'
+  )} ${colors.yellow('{value}')} of ${process} | ${colors.bold(
+    'Duration:'
+  )} ${colors.green('{duration_formatted}')}`
+
+  return { format, hideCursor: false, synchronousUpdate: false }
+}
+
+/**
+ * @param {Config} config configuration to build the project
+ */
+module.exports = async ({
+  author,
+  email,
+  projectName,
+  projectDescription,
+  heroku,
+  license,
+  version,
+  licenseYear,
+  manager,
+  mainFile
+}) => {
+  const process = 4
+  let i = 0
+
+  const options = setOptions(process)
+  const bar = new cliProgress.SingleBar(
+    options,
+    cliProgress.Presets.shades_classic
+  )
+
+  const prodPackages = `${manager} express mongoose morgan http-errors joi swagger-ui-express`
+  const devPackages = `${manager} -D \
+@types/node \
+@typescript-eslint/eslint-plugin \
+@typescript-eslint/parser \
+dotenv \
+eslint \
+eslint-config-prettier \
+eslint-config-standard \
+eslint-plugin-import \
+eslint-plugin-prettier \
+eslint-plugin-sort-keys-fix \
+eslint-plugin-typescript-sort-keys \
+nodemon \
+prettier \
+ts-loader \
+ts-node \
+typescript \
+webpack \
+webpack-cli \
+webpack-node-externals \
+@types/express \
+@types/morgan \
+@types/swagger-ui-express \
+@types/http-errors \
+standard-version`
+
+  bar.start(process, i)
+
+  try {
+    await exec(`mkdir ${projectName}`)
+    bar.update(++i)
+
+    const functions = [
+      packageJson({
+        author: `${author} <${email}>`,
+        projectName,
+        projectDescription,
+        projectVersion: version,
+        license,
+        mainFile
+      }),
+      readme(projectName, projectDescription),
+      changelog(projectName),
+      gitignore(projectName),
+      tsconfig(projectName),
+      nodemon(projectName),
+      eslint(projectName),
+      webpack(projectName),
+      docker(projectName),
+      express(projectName, version, email),
+      exec('git init', { cwd: `./${projectName}` })
+    ]
+
+    if (license !== 'unlicensed')
+      functions.push(
+        licenseF({
+          author,
+          license,
+          year: licenseYear,
+          projectDescription,
+          projectName
+        })
+      )
+
+    if (heroku) functions.push(herokuF(projectName))
+
+    await Promise.all(functions)
+    bar.update(++i)
+
+    await exec(prodPackages, { cwd: `./${projectName}` })
+    bar.update(++i)
+
+    await exec(devPackages, { cwd: `./${projectName}` })
+    bar.update(++i)
+
+    bar.stop()
+  } catch (e) {
+    console.error(e)
+  }
+}
+
+/**
+ * @typedef {Object} Config configuration to initialize a project
+ * @property {String} author author of the project
+ * @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 {String} mainFile main file of the project
+ */
+
+/**
+ * @typedef {Object} CliOptions
+ * @property {String} format cli format to show the progress to the user
+ * @property {Boolean} hideCursor
+ * @property {Boolean} synchronousUpdate
+ */

package/lib/src/utils/titleCase.js

@@ -0,0 +1,16 @@
+/**
+ * @param {String} projectName
+ * @returns {String}
+ */
+module.exports = projectName => {
+  const pn = projectName.toLowerCase().split('-')
+  let title = ''
+
+  pn.forEach((word, index, array) => {
+    title += `${word[0].toUpperCase()}${word.slice(1)} `
+
+    if (index !== array.length - 1) title += ' '
+  })
+
+  return title
+}

package/lib/src/utils/writeFile.js

@@ -0,0 +1,15 @@
+const fs = require('fs')
+
+/**
+ * @param {String} filename
+ * @param {String} data
+ * @returns {Promise<String>}
+ */
+module.exports = (filename, data) => {
+  return new Promise((resolve, reject) => {
+    fs.writeFile(filename, data, error => {
+      if (error) reject(error.message)
+      else resolve('Saved successfully')
+    })
+  })
+}