chore(): add tests configuration and packages updates

.codacy.yml

@@ -4,3 +4,4 @@ exclude_paths:
   - '.vscode/**'
   - '.husky/**'
   - '**.md'
+  - '**.json'

.eslintignore

@@ -1,4 +1,7 @@
 node_modules/
 .vscode/
 *.md
-*.config.*
+*.config.*
+dist/
+**/*/*.spec.*
+jest.config.js

.eslintrc

@@ -14,10 +14,7 @@
         "tsconfigRootDir": "."
     },
     "rules": {
-        "comma-dangle": [
-            "error",
-            "always-multiline"     
-        ],
+        "comma-dangle": "off",
         "unused-imports/no-unused-imports": "error",
         "unused-imports/no-unused-vars": [
             "warn",
@@ -46,6 +43,17 @@
                     "ignoreCase": true
                 }
             }
+        ],
+        "prettier/prettier": [
+            "error",
+            {
+                "trailingComma": "es5",
+                "tabWidth": 4,
+                "semi": false,
+                "singleQuote": true,
+                "endOfLine": "auto"
+            }
+
         ]
     },
     "plugins": [

.husky/pre-commit → .husky/pre-push

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-yarn lint
+yarn test

.vscode/launch.json

@@ -0,0 +1,40 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/index.ts",
+            "runtimeArgs": [
+                "-r",
+                "ts-node/register",
+                "-r",
+                "tsconfig-paths/register"
+            ],
+            "preLaunchTask": "tsc: build - tsconfig.json",
+            "outFiles": [
+                "${workspaceFolder}/**/*.js"
+            ]
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug Tests: Current File",
+            "env": { "NODE_OPTIONS": "--experimental-vm-modules" },
+            "program": "${workspaceFolder}/node_modules/.bin/jest",
+            "args": ["${fileBasenameNoExtension}", "--config", "jest.config.js"],
+            "preLaunchTask": "tsc: build - tsconfig.test.json",
+            "console": "integratedTerminal",
+            "windows": {
+              "program": "${workspaceFolder}/node_modules/jest/bin/jest"
+            }
+          }
+    ]
+}

.vscode/settings.json

@@ -1,13 +1,7 @@
 {
-    "github.copilot.enable": {
-        "*": false,
-        "yaml": false,
-        "plaintext": false,
-        "markdown": false
-    },
     "typescript.tsdk": "./node_modules/typescript/lib",
     "editor.formatOnSave": false,
     "editor.codeActionsOnSave": {
-        "source.fixAll.eslint": true
+        "source.fixAll.eslint": "explicit"
     },
 }

README.md

@@ -20,11 +20,16 @@ Just execute the command `yarn start`
 * [Ora](https://github.com/sindresorhus/ora/tree/v5.4.1)
 * [Inquirer](https://github.com/SBoudrias/Inquirer.js/tree/inquirer%408.2.3)
 * [Yargs](https://github.com/yargs/yargs/tree/v17.5.1)
+* [ESM](https://nodejs.org/api/esm.html)
 
 ## Dev Environment
 
 * [Typescript](https://github.com/microsoft/TypeScript/tree/v4.7.4)
 * [ESlint](https://github.com/eslint/eslint/tree/v8.19.0)
 * [Prettier](https://github.com/prettier/prettier/tree/2.7.1)
 * [Husky](https://typicode.github.io/husky/#/)
-* [Commit Lint](https://commitlint.js.org/#/)
+* [Commit Lint](https://commitlint.js.org/#/)
+
+## Common problems testing Typescript + ESM + Jest
+
+- See https://dev.to/logto/migrate-a-60k-loc-typescript-nodejs-repo-to-esm-and-testing-become-4x-faster-22-4a4k

index.ts

@@ -1,41 +1,39 @@
 #!/usr/bin/env node
 
-import { questions, args } from './src/services/index.js'
-import { showSpinner, stopSpinner, showMessage } from './src/utils/index.js'
-
+import { questions, args, logging } from './src/apis/index.js'
 ;(async () => {
     const commandArgs = args.parseArgs(process.argv).parseSync()
 
-    const answers = await questions.start()
+    const isHappy = await questions.areYouHappy()
 
-    await showSpinner({ text: 'Starting process ...', color: 'blue' })
+    await logging.showSpinner({ text: 'Starting process ...', color: 'blue' })
 
     if (commandArgs.debug) {
-        await showMessage({
+        await logging.showMessage({
             text: 'Showing a more detailed log',
             color: 'yellow',
-        }) 
-        await showMessage({
-            text: JSON.stringify(answers, null, 2),
+        })
+        await logging.showMessage({
+            text: isHappy ? 'You are happy!' : 'You are not happy!',
             color: 'yellow',
         })
     }
 
-    if (answers.isHappy) {
-        await showMessage({
+    if (isHappy) {
+        await logging.showMessage({
             text: "If you are happy, I'm happy too!",
             color: 'green',
             clear: true,
         })
     } else {
-        await showMessage({
-            text: "Sorry to hear that!",
+        await logging.showMessage({
+            text: 'Sorry to hear that!',
             color: 'red',
             clear: true,
-        })   
+        })
     }
 
-    await showSpinner({ text: 'Finishing process...', color: 'green' })
+    await logging.showSpinner({ text: 'Finishing process...', color: 'green' })
 
-    stopSpinner()
+    logging.stopSpinner()
 })()

jest.config.js

@@ -0,0 +1,4 @@
+/** @type {import('jest').Config} */
+export default {
+    roots: ['./dist'], // Point to the build directory
+}