feat: use vitest to make unitest

.github/workflows/ci.yml

@@ -27,6 +27,7 @@ jobs:
         env:
           CYPRESS_INSTALL_BINARY: 0
       - run: pnpm build
+      - run: pnpm test:unit
 
       # Use cache to share the output across different jobs
       # No need to cache node_modules because they are all bundled

__test__/__snapshots__/getCommand.spec.ts.snap

@@ -0,0 +1,19 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`should generate correct command > for npm 1`] = `"npm install"`;
+
+exports[`should generate correct command > for npm 2`] = `"npm run dev"`;
+
+exports[`should generate correct command > for npm 3`] = `"npm run build"`;
+
+exports[`should generate correct command > for pnpm 1`] = `"pnpm install"`;
+
+exports[`should generate correct command > for pnpm 2`] = `"pnpm dev"`;
+
+exports[`should generate correct command > for pnpm 3`] = `"pnpm build"`;
+
+exports[`should generate correct command > for yarn 1`] = `"yarn"`;
+
+exports[`should generate correct command > for yarn 2`] = `"yarn dev"`;
+
+exports[`should generate correct command > for yarn 3`] = `"yarn build"`;

__test__/getCommand.spec.ts

@@ -0,0 +1,31 @@
+import { it, describe, expect } from 'vitest'
+import getCommand from '../utils/getCommand'
+
+describe("should generate correct command", () => {
+    it('for yarn', () => {
+        expect(getCommand('yarn', 'install')).toBe('yarn')
+        expect(getCommand('yarn', 'install')).toMatchSnapshot()
+        expect(getCommand('yarn', 'dev')).toBe('yarn dev')
+        expect(getCommand('yarn', 'dev')).toMatchSnapshot()
+        expect(getCommand('yarn', 'build')).toBe('yarn build')
+        expect(getCommand('yarn', 'build')).toMatchSnapshot()
+
+    })
+    it('for npm', () => {
+        expect(getCommand('npm', 'install')).toBe('npm install')
+        expect(getCommand('npm', 'install')).toMatchSnapshot()
+        expect(getCommand('npm', 'dev')).toBe('npm run dev')
+        expect(getCommand('npm', 'dev')).toMatchSnapshot()
+        expect(getCommand('npm', 'build')).toBe('npm run build')
+        expect(getCommand('npm', 'build')).toMatchSnapshot()
+
+    })
+    it('for pnpm', () => {
+        expect(getCommand('pnpm', 'install')).toBe('pnpm install')
+        expect(getCommand('pnpm', 'install')).toMatchSnapshot()
+        expect(getCommand('pnpm', 'dev')).toBe('pnpm dev')
+        expect(getCommand('pnpm', 'dev')).toMatchSnapshot()
+        expect(getCommand('pnpm', 'build')).toBe('pnpm build')
+        expect(getCommand('pnpm', 'build')).toMatchSnapshot()
+    })
+})

__test__/locale.spec.ts

@@ -0,0 +1,44 @@
+import { describe, it, expect } from 'vitest'
+import { resolve } from 'node:path'
+import { readdirSync } from 'node:fs'
+import { Language } from '../utils/getLanguage'
+import { includeAllKeys, excludeKeys } from './utils'
+
+const locales = readdirSync(resolve(__dirname, '../locales')).filter((file) => {
+  return file.includes('.json')
+})
+
+describe('should match name regex', () => {
+  /**
+   * 
+   * both can match normal locale or reusable locale
+   * 
+   * @example normal locale: en-US
+   * @example reusable locale: zh-Hant
+   */
+  const regex = /^[a-zA-Z]{2}(-[a-zA-Z]{2})*.json$|^[a-zA-Z]{2}(-[a-zA-z]{4})*.json$/
+
+  locales.forEach((locale) => {
+    it(`for ${locale}`, () => {
+      expect(locale).toMatch(regex)
+    })
+  })
+})
+
+describe('should include full keys', () => {
+  const structure = require('../schema/locale.json') as Language
+  locales.forEach((locale) => {
+    it(`for ${locale}`, () => {
+      expect(includeAllKeys(require(`../locales/${locale}`), structure)).toBeTruthy()
+    })
+  })
+})
+
+describe("should not include extra keys", () => {
+  const structure = require('../schema/locale.json') as Language
+  locales.forEach((locale) => {
+    it(`for ${locale}`, () => {
+      expect(excludeKeys(require(`../locales/${locale}`), structure)).toBeTruthy()
+    })
+  })
+})

__test__/sortDependencies.spec.ts

@@ -0,0 +1,80 @@
+import { it, describe, expect } from 'vitest'
+import sortDependencies from '../utils/sortDependencies'
+
+describe('should output correct sorted value', () => {
+  it('#1', () => {
+    const packageJson = {
+      "devDependencies": {
+        "@vitejs/plugin-vue": "^4.4.0",
+        "@vitejs/plugin-vue-jsx": "^3.0.2",
+        "eslint": "^8.49.0",
+        "eslint-plugin-cypress": "^2.15.1",
+        "vite": "^4.4.11",
+        "vitest": "^0.34.6",
+        "@vue/test-utils": "^2.4.1",
+        "cypress": "^13.3.1",
+        "eslint-plugin-vue": "^9.17.0",
+        "jsdom": "^22.1.0",
+        "start-server-and-test": "^2.0.1",
+      }
+    }
+    expect(sortDependencies(packageJson)).toStrictEqual({
+      "devDependencies": {
+        "@vitejs/plugin-vue": "^4.4.0",
+        "@vitejs/plugin-vue-jsx": "^3.0.2",
+        "@vue/test-utils": "^2.4.1",
+        "cypress": "^13.3.1",
+        "eslint": "^8.49.0",
+        "eslint-plugin-cypress": "^2.15.1",
+        "eslint-plugin-vue": "^9.17.0",
+        "jsdom": "^22.1.0",
+        "start-server-and-test": "^2.0.1",
+        "vite": "^4.4.11",
+        "vitest": "^0.34.6"
+      }
+    }
+    )
+  })
+  it('#2', () => {
+    const packageJson = {
+      "dependencies": {
+        "vue": "^3.3.4",
+        "vue-router": "^4.2.5",
+        "pinia": "^2.1.7",
+      },
+      "devDependencies": {
+        "@vitejs/plugin-vue-jsx": "^3.0.2",
+        "jsdom": "^22.1.0",
+        "start-server-and-test": "^2.0.1",
+        "vite": "^4.4.11",
+        "@vue/test-utils": "^2.4.1",
+        "cypress": "^13.3.1",
+        "eslint": "^8.49.0",
+        "@vitejs/plugin-vue": "^4.4.0",
+        "eslint-plugin-cypress": "^2.15.1",
+        "eslint-plugin-vue": "^9.17.0",
+        "vitest": "^0.34.6"
+      }
+    }
+    expect(sortDependencies(packageJson)).toStrictEqual({
+      "dependencies": {
+        "pinia": "^2.1.7",
+        "vue": "^3.3.4",
+        "vue-router": "^4.2.5"
+      },
+      "devDependencies": {
+        "@vitejs/plugin-vue": "^4.4.0",
+        "@vitejs/plugin-vue-jsx": "^3.0.2",
+        "@vue/test-utils": "^2.4.1",
+        "cypress": "^13.3.1",
+        "eslint": "^8.49.0",
+        "eslint-plugin-cypress": "^2.15.1",
+        "eslint-plugin-vue": "^9.17.0",
+        "jsdom": "^22.1.0",
+        "start-server-and-test": "^2.0.1",
+        "vite": "^4.4.11",
+        "vitest": "^0.34.6"
+      }
+    })
+  })
+})

__test__/utils.ts

@@ -0,0 +1,48 @@
+/**
+ *
+ * @param obj object that needs to be validated
+ * @param schema template for validation
+ * @returns whether missed some keys
+ */
+export function includeAllKeys(obj: Object, schema: Object) {
+  for (let key in schema) {
+    if (!obj.hasOwnProperty(key)) {
+      console.log(`key '${key}' lost`)
+      return false
+    }
+    if (schema[key] !== null) {
+      if (typeof schema[key] === 'string') {
+        if (typeof obj[key] !== schema[key]) {
+          console.error(`the type of ${key} is incorrect`)
+          return false
+        }
+      } else if (typeof schema[key] === 'object') {
+        if (!includeAllKeys(obj[key], schema[key])) {
+          return false
+        }
+      }
+    }
+  }
+  return true
+}
+
+/**
+ *
+ * @param obj object that needs to be validated
+ * @param schema template for validation
+ * @returns whether include extra keys
+ */
+export function excludeKeys(obj: Object, schema: Object) {
+  for (let key in obj) {
+    if (!schema.hasOwnProperty(key)) {
+      console.error(`unexpected key: ${key}`)
+      return false
+    }
+    if (schema[key] !== null && typeof schema[key] === 'object') {
+      if (!excludeKeys(obj[key], schema[key])) {
+        return false
+      }
+    }
+  }
+  return true
+}

package.json

@@ -21,6 +21,8 @@
     "snapshot": "zx ./scripts/snapshot.mjs",
     "pretest": "run-s build snapshot",
     "test": "zx ./scripts/test.mjs",
+    "test:unit": "vitest",
+    "test:update-snapshot": "vitest run -u",
     "prepublishOnly": "zx ./scripts/prepublish.mjs"
   },
   "repository": {
@@ -51,6 +53,7 @@
     "npm-run-all2": "^6.1.1",
     "prettier": "^3.1.0",
     "prompts": "^2.4.2",
+    "vitest": "^0.34.6",
     "zx": "^7.2.3"
   },
   "lint-staged": {

schema/locale.json

@@ -0,0 +1,68 @@
+{
+  "projectName": {
+    "message": "string"
+  },
+  "shouldOverwrite": {
+    "dirForPrompts": {
+      "current": "string",
+      "target": "string"
+    },
+    "message": "string"
+  },
+  "packageName": {
+    "message": "string",
+    "invalidMessage": "string"
+  },
+  "needsTypeScript": {
+    "message": "string"
+  },
+  "needsJsx": {
+    "message": "string"
+  },
+  "needsRouter": {
+    "message": "string"
+  },
+  "needsPinia": {
+    "message": "string"
+  },
+  "needsVitest": {
+    "message": "string"
+  },
+  "needsE2eTesting": {
+    "message": "string",
+    "hint": "string",
+    "selectOptions": {
+      "negative": {
+        "title": "string"
+      },
+      "cypress": {
+        "title": "string",
+        "desc": "string"
+      },
+      "nightwatch": {
+        "title": "string",
+        "desc": "string"
+      },
+      "playwright": {
+        "title": "string"
+      }
+    }
+  },
+  "needsEslint": {
+    "message": "string"
+  },
+  "needsPrettier": {
+    "message": "string"
+  },
+  "errors": {
+    "operationCancelled": "string"
+  },
+  "defaultToggleOptions": {
+    "active": "string",
+    "inactive": "string"
+  },
+  "infos": {
+    "scaffolding": "string",
+    "done": "string"
+  }
+}

utils/getLanguage.ts

@@ -18,7 +18,7 @@ interface LanguageItem {
   }
 }
 
-interface Language {
+export interface Language {
   projectName: LanguageItem
   shouldOverwrite: LanguageItem
   packageName: LanguageItem

vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    include: ['__test__/**.spec.ts']
+  }
+})