test: upgrade to oclif test v4 and add jest

Author: brettstack

.mocharc.json

@@ -0,0 +1,7 @@
+import type { JestConfigWithTsJest } from 'ts-jest'
+
+const jestConfig: JestConfigWithTsJest = {
+  preset: 'ts-jest/presets/default-esm',
+}
+
+export default jestConfig

jest.config.ts

@@ -50,14 +50,15 @@
     "underscore.string": "^3.3.6"
   },
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^3",
+    "@oclif/test": "^4",
     "@types/adm-zip": "^0.5.5",
     "@types/archiver": "^6.0.2",
     "@types/chai": "^4",
     "@types/debug": "^4.1.12",
+    "@types/jest": "^29.5.12",
     "@types/lodash.assign": "^4.2.9",
-    "@types/mocha": "^10",
     "@types/node": "20.11.0",
     "@types/underscore.string": "^0.0.41",
     "chai": "^4",
@@ -66,9 +67,10 @@
     "eslint-config-oclif-typescript": "^3",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-jsdoc": "^48.0.2",
-    "mocha": "^10",
+    "jest": "^29.7.0",
     "oclif": "^4.1.3",
     "shx": "^0.3.4",
+    "ts-jest": "^29.1.3",
     "ts-node": "^10.9.2",
     "tsx": "^4.7.3",
     "typescript": "^5"
@@ -96,7 +98,7 @@
     "posttest": "npm run lint",
     "prepack": "npm run build && oclif manifest && oclif readme",
     "prepare": "npm run build",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest",
     "version": "oclif readme && git add README.md"
   }
-}
+}

package-lock.json

@@ -1,8 +1,8 @@
 import { Command } from '@oclif/core'
 import axios from 'axios'
 import createDebug from 'debug'
-import { CodeGenieConfig, getCodeGenieConfig, updateCodeGenieConfig } from './config.js'
-import { getOpenIdClient } from './openid-client.js'
+import { CodeGenieConfig, getCodeGenieConfig, updateCodeGenieConfig } from './config'
+import { getOpenIdClient } from './openid-client'
 
 const API_ENDPOINT = process.env.API_ENDPOINT || 'https://api.codegenie.codes'
 axios.defaults.baseURL = API_ENDPOINT

package.json

@@ -0,0 +1,9 @@
+import { describe, expect, test } from '@jest/globals'
+import { runCommand } from '@oclif/test'
+
+describe('generate', () => {
+  test('help', async () => {
+    const { stdout } = await runCommand(['generate', '--help'])
+    expect(stdout).toMatch(/USAGE/)
+  })
+})

src/AuthCommand.ts

@@ -4,18 +4,18 @@ import axios, { AxiosError } from 'axios'
 import AdmZip from 'adm-zip'
 import { cosmiconfig } from 'cosmiconfig'
 import createDebug from 'debug'
-import { awsCredentialsFileExists } from '../aws-creds.js'
-import sleep from '../sleep.js'
+import { awsCredentialsFileExists } from '../aws-creds'
+import sleep from '../sleep'
 import { execSync } from 'node:child_process'
 import { cwd } from 'node:process'
-import { AppDefinition } from '../input/types.js'
-import { generateIcons } from '../generate-icons.js'
+import { AppDefinition } from '../input/types'
+import { generateIcons } from '../generate-icons'
 import { dirname, join, resolve } from 'node:path'
 import { inspect } from 'node:util'
 import { copyFile, mkdir } from 'node:fs/promises'
 import { fileURLToPath } from 'node:url'
-import { AuthCommand } from '../AuthCommand.js'
-import { convertCliAppDefinitionToDatabaseModel } from '../convert-cli-app-definition-to-database-model.js'
+import { AuthCommand } from '../AuthCommand'
+import { convertCliAppDefinitionToDatabaseModel } from '../convert-cli-app-definition-to-database-model'
 const __dirname = dirname(fileURLToPath(import.meta.url))
 
 const debug = createDebug('codegenie:generate')

src/commands/generate.test.ts

@@ -4,10 +4,10 @@ import { Command, ux } from '@oclif/core'
 import { generators } from 'openid-client'
 import open from 'open'
 import createDebug from 'debug'
-import sleep from '../sleep.js'
-import { updateCodeGenieConfig } from '../config.js'
-import { REDIRECT_URL, getOpenIdClient } from '../openid-client.js'
-import { getRandom } from '../get-random.js'
+import sleep from '../sleep'
+import { updateCodeGenieConfig } from '../config'
+import { REDIRECT_URL, getOpenIdClient } from '../openid-client'
+import { getRandom } from '../get-random'
 
 const debug = createDebug('codegenie:Login')
 

src/commands/generate.ts

@@ -1,6 +1,6 @@
-import { expect, test } from '@oclif/test'
-import { convertCliAppDefinitionToDatabaseModel } from '../src/convert-cli-app-definition-to-database-model.js'
-import { AppDefinition } from '../src/input/types.js'
+import { describe, expect, test } from '@jest/globals'
+import { convertCliAppDefinitionToDatabaseModel } from '../src/convert-cli-app-definition-to-database-model'
+import type { AppDefinition } from '../src/input/types'
 
 const appDefinition: AppDefinition = {
   appId: 'xxx',
@@ -25,25 +25,23 @@ const appDefinition: AppDefinition = {
   entities: {},
 }
 describe('convertCliAppDefinitionToDatabaseModel', () => {
-  test.it('converts CLI to DB', () => {
+  test('convertCliAppDefinitionToDatabaseModel', () => {
     const converted = convertCliAppDefinitionToDatabaseModel({ appDefinition })
-    expect(JSON.stringify(converted)).to.eq(
-      JSON.stringify({
-        appId: 'xxx',
-        name: 'Name',
-        description: 'Description',
-        region: 'us-west-2',
-        domainName: 'example.com',
-        appDomainName: 'app.example.com',
-        apiDomainName: 'api.example.com',
-        verifyUserEmail: '[email protected]',
-        organizationInviteEmail: '[email protected]',
-        alarmNotificationEmail: '[email protected]',
-        defaultAuthRouteEntityName: 'App',
-        permissionModel: 'Organization',
-        themePrimaryColor: '#579ddd',
-        authIdentityProviders: ['Google'],
-      })
-    )
+    expect(converted).toEqual({
+      appId: 'xxx',
+      name: 'Name',
+      description: 'Description',
+      region: 'us-west-2',
+      domainName: 'example.com',
+      appDomainName: 'app.example.com',
+      apiDomainName: 'api.example.com',
+      verifyUserEmail: '[email protected]',
+      organizationInviteEmail: '[email protected]',
+      alarmNotificationEmail: '[email protected]',
+      defaultAuthRouteEntityName: 'App',
+      permissionModel: 'Organization',
+      themePrimaryColor: '#579ddd',
+      authIdentityProviders: ['Google'],
+    })
   })
 })

src/commands/login.ts

@@ -1,18 +1,18 @@
 {
   "compilerOptions": {
     "declaration": true,
-    "module": "Node16",
+    "module": "es2022",
     "outDir": "dist",
     "rootDir": "src",
     "strict": true,
     "target": "es2022",
-    "moduleResolution": "node16",
+    "moduleResolution": "Node",
     "composite": true,
     "sourceMap": true,
-    "declarationMap": true
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "allowJs": true,
+    "types": ["jest"]
   },
-  "include": ["./src/**/*"],
-  "ts-node": {
-    "esm": true
-  }
+  "include": ["./src/**/*"]
 }