@anthonylzq/simba.js 6.2.0 → 6.2.1

package/README.md

@@ -41,9 +41,9 @@ By doing this your prompt will ask you the following questions:
 - `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 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.
+- `Will this project be deployed with Heroku? [y/n]:`.
+- `Would you want to have a basic suit of tests with Jest? [y/n]:`.
+- `Would you want to have a basic GitHub Action for the suit of tests and linting? [y/n]:`.
 
 The second option you have is by passing flags in one single command. If you need help, please run:
 

package/lib/index.js

@@ -62,7 +62,7 @@ const argv = yargs(hideBin(process.argv))
   .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.'
+    '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.'
   )
   .default({
     H: false,
@@ -239,7 +239,7 @@ const main = async () => {
 
     if (config.tests)
       config.ghat = readLineSync.keyInYNStrict(
-        '> Would you want to have a basic GitHub Action for the suit of tests?',
+        '> Would you want to have a basic GitHub Action for the suit of tests and linting?',
         {
           caseSensitive: false
         }

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

@@ -93,12 +93,11 @@ interface CustomResponse extends ExpressResponse {
     writeFile(types.models.user.file, types.models.user.content)
   ]
 
-  if (express) {
+  if (express)
     processes.concat([
       writeFile(types.custom.request.file, types.custom.request.content),
       writeFile(types.custom.response.file, types.custom.response.content)
     ])
-  }
 
   if (graphql)
     processes.push(

package/lib/src/functions/eslint.js

@@ -4,20 +4,18 @@ const writeFile = require('../utils/writeFile')
  * @param {String} projectName
  * @returns {Promise<void>}
  */
-module.exports = async projectName => {
+module.exports = async (projectName, tests) => {
   const data = {
     eslintContent: `{
   "env": {
-    "node": true,
-    "jest/globals": true
+    "node": true${tests ? ',\n    "jest": true' : ''}
   },
   "root": true,
   "parser": "@typescript-eslint/parser",
   "plugins": [
     "@typescript-eslint",
     "import",
-    "prettier",
-    "jest"
+    "prettier"${tests ? ',\n    "jest"' : ''}
   ],
   "extends": [
     "standard",
@@ -46,8 +44,7 @@ module.exports = async projectName => {
       {
         "devDependencies": [
           "**/*.test.ts",
-          "webpack.config.js",
-          "jest.config.ts"
+          "webpack.config.js"${tests ? ',\n          "jest.config.ts"' : ''}
         ],
         "optionalDependencies": [
           "**/*.test.ts"
@@ -99,6 +96,10 @@ module.exports = async projectName => {
     "spaced-comment": [
       "error",
       "always"
+    ],
+    "curly": [
+      "error",
+      "multi"
     ]
   }
 }`,

package/lib/src/functions/ghat.js

@@ -18,6 +18,48 @@ ${projectName}/.github/workflows`
   else await exec(createFoldersCommand)
 
   const data = {
+    linting: {
+      content: `name: Lint - ${projectName}
+
+on: [push]
+
+jobs:
+  run-linters:
+    name: Run linters
+    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 linters
+        uses: wearerequired/lint-action@v1
+        with:
+          auto_fix: true
+          eslint: true
+          eslint_extensions: js
+`,
+      file: `${projectName}/.github/workflows/lint.yml`
+    },
     test: {
       content: `name: Tests - ${projectName}
 
@@ -61,5 +103,8 @@ jobs:
     }
   }
 
-  await writeFile(data.test.file, data.test.content)
+  await Promise.all([
+    writeFile(data.linting.file, data.linting.content),
+    writeFile(data.test.file, data.test.content)
+  ])
 }

package/lib/src/index.js

@@ -103,9 +103,10 @@ webpack-node-externals`
   devPackages += ` ${fastify ? fastifyDevPackages : expressDevPackages}`
 
   if (tests)
-    devPackages += ` @jest/types @types/jest eslint-plugin-jest jest jest-unit ts-jest`
+    devPackages +=
+      ' @jest/types @types/jest eslint-plugin-jest jest jest-unit ts-jest'
 
-  if (manager === 'yarn add') devPackages += ` eslint-plugin-n`
+  if (manager === 'yarn add') devPackages += ' eslint-plugin-n'
 
   bar.start(process, i)
 
@@ -128,7 +129,7 @@ webpack-node-externals`
       gitignore(projectName),
       tsconfig(projectName),
       nodemon(projectName),
-      eslint(projectName),
+      eslint(projectName, tests),
       webpack(projectName),
       docker(projectName),
       api({ projectName, version, email, fastify, graphql }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anthonylzq/simba.js",
-  "version": "6.2.0",
+  "version": "6.2.1",
   "description": "set up a modern backend app by running one command",
   "main": "lib/index.js",
   "scripts": {
@@ -15,6 +15,7 @@
     "build:fastify": "npm run rm:fastify && npm run cd:mv:example && node -r dotenv/config ./bin -N example/fastify -D 'This is a test using fastify' -a AnthonyLzq -e sluzquinosa@uni.pe -l mit -H -F --tests --ghat && npm run rm:git:fastify",
     "build:express:graphql": "npm run rm:express:graphql && npm run cd:mv:example && node -r dotenv/config ./bin -N example/express-graphql -D 'This is a test using express with GraphQL' -a AnthonyLzq -e sluzquinosa@uni.pe -l mit -H -g && npm run rm:git:express:graphql",
     "build:fastify:graphql": "npm run rm:fastify:graphql && npm run cd:mv:example && node -r dotenv/config ./bin -N example/fastify-graphql -D 'This is a test using fastify with GraphQL' -a AnthonyLzq -e sluzquinosa@uni.pe -l mit -H -F -g && npm run rm:git:fastify:graphql",
+    "build:and:test:only": "npm run build && npm run test:only",
     "lint": "eslint --ext js lib/ --fix",
     "rm": "if [ -d \"example\" ]; then rm -rf example; fi",
     "rm:express": "if [ -d \"example/express\" ]; then rm -rf example/express; fi",