feat: use vitest

technote-space · technote-space · commit d6d205639463 · 2022-04-23T03:28:45.000+09:00
diff --git a/__tests__/config.test.ts b/__tests__/config.test.ts
@@ -1,11 +1,12 @@
 /* eslint-disable no-magic-numbers */
+import { beforeEach, describe, expect, it } from 'vitest';
 import {resolve} from 'path';
-import {getParams} from '@technote-space/release-github-actions/lib/utils/misc';
+import {Misc} from '@technote-space/release-github-actions';
 import {normalizeConfigKey, normalizeConfigKeys, getActionDefaultInputs, getConfig} from '../src/config';
 
 const fixturesDir = resolve(__dirname, 'fixtures');
 beforeEach(() => {
-  getParams.clear();
+  Misc.getParams.clear();
 });
 
 describe('normalizeConfigKey', () => {
diff --git a/__tests__/env.test.ts b/__tests__/env.test.ts
@@ -1,12 +1,13 @@
 /* eslint-disable no-magic-numbers */
+import { beforeEach, describe, expect, it } from 'vitest';
 import {resolve} from 'path';
 import {testEnv} from '@technote-space/github-action-test-helper';
-import {getParams} from '@technote-space/release-github-actions/lib/utils/misc';
+import {Misc} from '@technote-space/release-github-actions';
 import {setEnv, loadTokenFromEnv} from '../src/env';
 
 const fixturesDir = resolve(__dirname, 'fixtures');
 beforeEach(() => {
-  getParams.clear();
+  Misc.getParams.clear();
 });
 
 describe('setEnv', () => {
diff --git a/__tests__/index.test.ts b/__tests__/index.test.ts
@@ -1,4 +1,5 @@
 /* eslint-disable no-magic-numbers */
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 import {
   testEnv,
   spyOnStdout,
@@ -10,14 +11,14 @@ import {
   setChildProcessParams,
 } from '@technote-space/github-action-test-helper';
 import {Logger} from '@technote-space/github-action-log-helper';
-import {getParams} from '@technote-space/release-github-actions/lib/utils/misc';
+import {Misc} from '@technote-space/release-github-actions';
 import {execute} from '../src';
 
 const setExists = testFs(false);
 const saveArgv  = process.argv;
 beforeEach(() => {
   Logger.resetForTesting();
-  getParams.clear();
+  Misc.getParams.clear();
 });
 
 describe('execute', () => {
diff --git a/__tests__/misc.test.ts b/__tests__/misc.test.ts
@@ -1,13 +1,14 @@
 /* eslint-disable no-magic-numbers */
+import { beforeEach, describe, expect, it } from 'vitest';
 import {resolve} from 'path';
 import {testEnv, testFs, setChildProcessParams} from '@technote-space/github-action-test-helper';
-import {getParams} from '@technote-space/release-github-actions/lib/utils/misc';
+import {Misc} from '@technote-space/release-github-actions';
 import {getRepository, getContext, getContextArgs, getGitHelper} from '../src/misc';
 
 const fixturesDir = resolve(__dirname, 'fixtures');
 testFs(true);
 beforeEach(() => {
-  getParams.clear();
+  Misc.getParams.clear();
 });
 
 describe('getRepository', () => {
diff --git a/jest.config.js b/jest.config.js
diff --git a/jest.setup.ts b/jest.setup.ts
diff --git a/package.json b/package.json
@@ -30,7 +30,7 @@
   ],
   "scripts": {
     "build": "yarn install && tsc && yarn install --production",
-    "cover": "jest --coverage",
+    "cover": "vitest run --coverage",
     "postinstall": "[ -n \"$CI\" ] || [ ! -f node_modules/.bin/husky ] || husky install",
     "lint": "eslint 'src/**/*.ts' '__tests__/**/*.ts' --cache",
     "lint:fix": "eslint --fix 'src/**/*.ts' '__tests__/**/*.ts'",
@@ -43,7 +43,7 @@
   "dependencies": {
     "@technote-space/github-action-helper": "^5.3.5",
     "@technote-space/github-action-log-helper": "^0.2.4",
-    "@technote-space/release-github-actions": "^7.2.0",
+    "@technote-space/release-github-actions": "^7.2.1",
     "commander": "^9.2.0",
     "cosmiconfig": "^7.0.1",
     "dotenv": "^16.0.0",
@@ -53,18 +53,16 @@
     "@commitlint/cli": "^16.2.3",
     "@commitlint/config-conventional": "^16.2.1",
     "@technote-space/github-action-test-helper": "^0.9.5",
-    "@types/jest": "^27.4.1",
     "@types/node": "^17.0.25",
     "@typescript-eslint/eslint-plugin": "^5.20.0",
     "@typescript-eslint/parser": "^5.20.0",
+    "c8": "^7.11.2",
     "eslint": "^8.13.0",
     "husky": "^7.0.4",
-    "jest": "^27.5.1",
-    "jest-circus": "^27.5.1",
     "lint-staged": "^12.4.0",
     "pinst": "^3.0.0",
-    "ts-jest": "^27.1.4",
-    "typescript": "^4.6.3"
+    "typescript": "^4.6.3",
+    "vitest": "^0.9.4"
   },
   "publishConfig": {
     "access": "public"
diff --git a/src/config.ts b/src/config.ts
@@ -1,6 +1,6 @@
 import type {Config} from './types';
 import {cosmiconfigSync} from 'cosmiconfig';
-import {existsSync, readFileSync} from 'fs';
+import fs from 'fs';
 import {resolve} from 'path';
 import {load} from 'js-yaml';
 import {getRepository} from './misc';
@@ -12,12 +12,12 @@ export const normalizeConfigKeys = (config: { [key: string]: string }): { [key:
 })));
 
 /* istanbul ignore next */
-const getActionSettingFile = (): string => existsSync(resolve(__dirname, '../../release-github-actions/action.yml')) ?
+const getActionSettingFile = (): string => fs.existsSync(resolve(__dirname, '../../release-github-actions/action.yml')) ?
   resolve(__dirname, '../../release-github-actions/action.yml') :
   resolve(__dirname, '../node_modules/@technote-space/release-github-actions/action.yml');
 
 export const getActionDefaultInputs = (): { [key: string]: string } => {
-  const actionSetting = load(readFileSync(getActionSettingFile(), 'utf8'));
+  const actionSetting = load(fs.readFileSync(getActionSettingFile(), 'utf8'));
   const inputs        = actionSetting['inputs'];
   return Object.assign({}, ...Object.keys(inputs).filter(key => 'default' in inputs[key]).map(key => ({
     [normalizeConfigKey(key)]: `${inputs[key].default}`,
diff --git a/src/env.ts b/src/env.ts
@@ -1,14 +1,14 @@
 import type {Config} from './types';
 import dotenv from 'dotenv';
-import {existsSync, readFileSync} from 'fs';
+import fs from 'fs';
 import {resolve} from 'path';
 
 export const loadTokenFromEnv = (dir: string): string | undefined => {
-  if (!existsSync(resolve(dir, '.env'))) {
+  if (!fs.existsSync(resolve(dir, '.env'))) {
     return;
   }
 
-  const config = dotenv.parse(readFileSync(resolve(dir, '.env')));
+  const config = dotenv.parse(fs.readFileSync(resolve(dir, '.env')));
   return config.token ?? config.TOKEN;
 };
 
diff --git a/src/misc.ts b/src/misc.ts
@@ -1,12 +1,12 @@
 import type {Context} from '@actions/github/lib/context';
 import type {Config, ContextArgs} from './types';
-import {readFileSync} from 'fs';
+import fs from 'fs';
 import {resolve} from 'path';
 import {GitHelper} from '@technote-space/github-action-helper';
 import {Logger} from '@technote-space/github-action-log-helper';
 
 export const getRepository = (dir: string): { owner: string; repo: string } | never => {
-  const json = JSON.parse(readFileSync(resolve(dir, 'package.json'), {encoding: 'utf8'}));
+  const json = JSON.parse(fs.readFileSync(resolve(dir, 'package.json'), {encoding: 'utf8'}));
   const url  = json ? json.repository?.url ?? json.homepage ?? json.bugs?.url : '';
   if (!url) {
     throw new Error('Invalid package file.');
diff --git a/src/setup.ts b/src/setup.ts
@@ -0,0 +1,3 @@
+import { setupGlobal } from '@technote-space/github-action-test-helper';
+
+setupGlobal();
diff --git a/src/wrapper.ts b/src/wrapper.ts
@@ -1,25 +1,24 @@
 import type {Context} from '@actions/github/lib/context';
 import type {GitHelper} from '@technote-space/github-action-helper';
 import type {ContextArgs} from './types';
-import {mkdirSync} from 'fs';
+import fs from 'fs';
 import {Command} from '@technote-space/github-action-helper';
 import {Logger} from '@technote-space/github-action-log-helper';
-import * as command from '@technote-space/release-github-actions/lib/utils/command';
-import * as misc from '@technote-space/release-github-actions/lib/utils/misc';
+import {Command as ReleaseCommand, Misc} from '@technote-space/release-github-actions';
 import {getContext} from './misc';
 
-export const isValidContext = (args: ContextArgs): boolean => misc.isValidContext(getContext(args));
+export const isValidContext = (args: ContextArgs): boolean => Misc.isValidContext(getContext(args));
 
-export const prepareFiles = async(logger: Logger, com: Command, helper: GitHelper, args: ContextArgs, context: Context): Promise<void> => {
-  const {buildDir, pushDir} = misc.getParams(context);
-  mkdirSync(buildDir, {recursive: true});
+export const prepareFiles = async(logger: Logger, command: Command, helper: GitHelper, args: ContextArgs, context: Context): Promise<void> => {
+  const {buildDir, pushDir} = Misc.getParams(context);
+  fs.mkdirSync(buildDir, {recursive: true});
 
   if (args.branch) {
     logger.startProcess('Cloning the remote repo for build...');
     await helper.checkout(buildDir, context);
   } else {
     logger.startProcess('Copying current source to build directory...');
-    await com.execAsync({
+    await command.execAsync({
       command: 'rsync',
       args: [
         '-ac',
@@ -39,33 +38,33 @@ export const prepareFiles = async(logger: Logger, com: Command, helper: GitHelpe
   }
 
   logger.startProcess('Running build for release...');
-  await helper.runCommand(buildDir, misc.getBuildCommands(buildDir, pushDir));
+  await helper.runCommand(buildDir, Misc.getBuildCommands(buildDir, pushDir));
 };
 
 export const prepare = async(helper: GitHelper, args: ContextArgs): Promise<void> => {
   const context             = getContext(args);
-  const {buildDir, pushDir} = misc.getParams(context);
-  const logger              = new Logger(command.replaceDirectory(context));
-  const com                 = new Command(logger);
+  const {buildDir, pushDir} = Misc.getParams(context);
+  const logger              = new Logger(ReleaseCommand.replaceDirectory(context));
+  const command             = new Command(logger);
 
-  await com.execAsync({command: `rm -rdf ${buildDir} ${pushDir}`});
-  await command.clone(logger, helper, context);
-  await command.checkBranch(await helper.getCurrentBranchName(pushDir), logger, helper, context);
-  await prepareFiles(logger, com, helper, args, context);
-  await command.createBuildInfoFile(logger, context);
-  await command.copyFiles(logger, com, context);
+  await command.execAsync({command: `rm -rdf ${buildDir} ${pushDir}`});
+  await ReleaseCommand.clone(logger, helper, context);
+  await ReleaseCommand.checkBranch(await helper.getCurrentBranchName(pushDir), logger, helper, context);
+  await prepareFiles(logger, command, helper, args, context);
+  await ReleaseCommand.createBuildInfoFile(logger, context);
+  await ReleaseCommand.copyFiles(logger, command, context);
 };
 
 export const commit = async(helper: GitHelper, args: ContextArgs): Promise<void> => {
   const context = getContext(args);
-  const logger  = new Logger(command.replaceDirectory(context));
-  await command.config(logger, helper, context);
-  await command.commit(helper, context);
+  const logger  = new Logger(ReleaseCommand.replaceDirectory(context));
+  await ReleaseCommand.config(logger, helper, context);
+  await ReleaseCommand.commit(helper, context);
 };
 
 export const push = async(helper: GitHelper, args: ContextArgs): Promise<void> => {
   const context = getContext(args);
-  const logger  = new Logger(command.replaceDirectory(context));
-  await command.push(logger, helper, getContext(args));
+  const logger  = new Logger(ReleaseCommand.replaceDirectory(context));
+  await ReleaseCommand.push(logger, helper, getContext(args));
 };
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -72,6 +72,6 @@
     "node_modules",
     "__tests__",
     "lib/**/*",
-    "jest.setup.ts"
+    "vite.config.ts"
   ]
 }
diff --git a/vite.config.ts b/vite.config.ts
@@ -0,0 +1,18 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vite';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  test: {
+    setupFiles: './src/setup.ts',
+    clearMocks: true,
+    mockReset: true,
+    restoreMocks: true,
+    coverage: {
+      reporter: ['html', 'lcov', 'text'],
+    },
+    deps: {
+      inline: [/github-action-test-helper/, /github-action-helper/],
+    },
+  },
+});
diff --git a/yarn.lock b/yarn.lock
