@anthonylzq/simba.js 5.2.0 → 6.2.0

package/lib/src/functions/eslint.js

@@ -8,11 +8,17 @@ module.exports = async projectName => {
   const data = {
     eslintContent: `{
   "env": {
-    "node": true
+    "node": true,
+    "jest/globals": true
   },
   "root": true,
   "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint", "import", "prettier"],
+  "plugins": [
+    "@typescript-eslint",
+    "import",
+    "prettier",
+    "jest"
+  ],
   "extends": [
     "standard",
     "eslint:recommended",
@@ -23,7 +29,10 @@ module.exports = async projectName => {
   "rules": {
     "@typescript-eslint/no-var-requires": "off",
     "@typescript-eslint/no-empty-interface": "off",
-    "arrow-parens": ["error", "as-needed"],
+    "arrow-parens": [
+      "error",
+      "as-needed"
+    ],
     "import/extensions": [
       2,
       {
@@ -35,9 +44,17 @@ module.exports = async projectName => {
     "import/no-extraneous-dependencies": [
       "error",
       {
-        "devDependencies": ["**/*.test.js", "webpack.config.js"],
-        "optionalDependencies": ["**/*.test.js"],
-        "peerDependencies": ["**/*.test.js"]
+        "devDependencies": [
+          "**/*.test.ts",
+          "webpack.config.js",
+          "jest.config.ts"
+        ],
+        "optionalDependencies": [
+          "**/*.test.ts"
+        ],
+        "peerDependencies": [
+          "**/*.test.ts"
+        ]
       }
     ],
     "max-len": [
@@ -53,8 +70,14 @@ module.exports = async projectName => {
       }
     ],
     "newline-before-return": "error",
-    "object-curly-spacing": ["error", "always"],
-    "object-shorthand": ["error", "always"],
+    "object-curly-spacing": [
+      "error",
+      "always"
+    ],
+    "object-shorthand": [
+      "error",
+      "always"
+    ],
     "prefer-const": "error",
     "prettier/prettier": [
       "error",
@@ -69,11 +92,16 @@ module.exports = async projectName => {
         "trailingComma": "none"
       }
     ],
-    "radix": ["error", "as-needed"],
-    "spaced-comment": ["error", "always"]
+    "radix": [
+      "error",
+      "as-needed"
+    ],
+    "spaced-comment": [
+      "error",
+      "always"
+    ]
   }
-}
-`,
+}`,
     eslintFile: '.eslintrc',
     eslintIgnoreContent: '/dist',
     eslintIgnoreFile: '.eslintignore'

package/lib/src/functions/ghat.js

@@ -0,0 +1,65 @@
+const { platform } = require('os')
+const { promisify } = require('util')
+const exec = promisify(require('child_process').exec)
+const writeFile = require('../utils/writeFile')
+
+/**
+ * @param {String} projectName
+ * @param {'yarn add'|'npm i'} manager
+ * @returns {Promise<void>}
+ */
+module.exports = async (projectName, manager) => {
+  const createFoldersCommand = `mkdir ${projectName}/.github \
+${projectName}/.github/workflows`
+  const managerName = manager.split()[0]
+
+  if (platform() === 'win32')
+    await exec(createFoldersCommand.replaceAll('/', '\\'))
+  else await exec(createFoldersCommand)
+
+  const data = {
+    test: {
+      content: `name: Tests - ${projectName}
+
+on: [push]
+
+jobs:
+  test:
+    name: Testing Simba.js API
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Install Node.js dependencies
+        run: ${
+          managerName === 'yarn' ? 'yarn install --frozen-lockfile' : 'npm ci'
+        }
+
+      - name: Revert changes into the ${
+        managerName === 'yarn' ? 'yarn.lock' : 'package-lock.json'
+      } file
+        run: git checkout -- ${
+          managerName === 'yarn' ? 'yarn.lock' : 'package-lock.json'
+        }
+
+      - name: Run test
+        run: ${managerName === 'yarn' ? 'yarn' : 'npm run'} test:ci
+        env:
+          MONGO_URI: \${{ secrets.MONGO_URI }}
+          NODE_ENV: ci
+`,
+      file: `${projectName}/.github/workflows/test.yml`
+    }
+  }
+
+  await writeFile(data.test.file, data.test.content)
+}

package/lib/src/functions/gitignore.js

@@ -134,6 +134,7 @@ typings/
 # End of https://www.toptal.com/developers/gitignore/api/node,yarn
 
 dist
+test/setEnvVars.ts
 `,
     gitignoreFile: '.gitignore'
   }

package/lib/src/functions/packageJson.js

@@ -10,7 +10,8 @@ module.exports = async ({
   projectDescription,
   projectVersion,
   license,
-  mainFile
+  mainFile,
+  tests
 }) => {
   const data = {
     content: '',
@@ -31,7 +32,14 @@ module.exports = async ({
     "lint": "eslint src/* --ext .ts --fix",
     "service": "nodemon",
     "start": "node dist/index.js",
-    "release": "standard-version"
+    "release": "standard-version"\
+    ${
+      tests
+        ? `,
+    "test:ci": "jest --ci -i",
+    "test:local": "NODE_ENV=local jest --ci -i"`
+        : ''
+    }
   },
   "author": "${author}",${
     license !== 'unlicensed'
@@ -53,4 +61,5 @@ module.exports = async ({
  * @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
+ * @property {Boolean} tests
  */