Merge pull request #166 from technote-space/release/next-v0.1.15

release: v0.2.0

.eslintrc

@@ -5,7 +5,8 @@
     "plugin:@typescript-eslint/eslint-recommended"
   ],
   "plugins": [
-    "@typescript-eslint"
+    "@typescript-eslint",
+    "import"
   ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
@@ -30,29 +31,6 @@
         "properties": "always"
       }
     ],
-    "require-jsdoc": [
-      "error",
-      {
-        "require": {
-          "FunctionDeclaration": true,
-          "MethodDefinition": true,
-          "ClassDeclaration": true
-        }
-      }
-    ],
-    "valid-jsdoc": [
-      "error",
-      {
-        "requireReturn": false,
-        "preferType": {
-          "String": "string",
-          "Object": "object",
-          "Number": "number",
-          "Function": "function",
-          "Void": "void"
-        }
-      }
-    ],
     "quotes": [
       "error",
       "single",
@@ -71,12 +49,6 @@
         }
       }
     ],
-    "no-magic-numbers": [
-      "error",
-      {
-        "ignoreArrayIndexes": true
-      }
-    ],
     "eqeqeq": "error",
     "block-scoped-var": "error",
     "complexity": [
@@ -85,7 +57,6 @@
         "maximum": 20
       }
     ],
-    "curly": "error",
     "default-case": "error",
     "dot-location": [
       "error",
@@ -102,16 +73,6 @@
         "after": true
       }
     ],
-    "id-length": [
-      "error",
-      {
-        "min": 2,
-        "properties": "never",
-        "exceptions": [
-          "$"
-        ]
-      }
-    ],
     "indent": [
       "error",
       2,
@@ -144,6 +105,11 @@
     ],
     "semi": [
       "error"
-    ]
+    ],
+    "sort-imports": 0,
+    "import/order": [2, {
+      "groups": ["type", "builtin", "external", "internal", "parent", "sibling", "index", "object"],
+      "alphabetize": { "order": "asc", "caseInsensitive": true },
+    }]
   }
 }

.github/workflows/ci.yml

@@ -50,7 +50,7 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        node: ['12', '14', '16']
+        node: ['14', '16', '17']
     steps:
       - name: Set running flag
         run: echo "RUNNING=1" >> $GITHUB_ENV

package.json

@@ -1,10 +1,9 @@
 {
   "name": "@technote-space/ts-package-template",
-  "version": "0.1.15",
+  "version": "0.2.0",
   "description": "Template for npm package.",
   "keywords": [
-    "github",
-    "github actions"
+    "template"
   ],
   "homepage": "https://github.com/technote-space/ts-package-template",
   "bugs": {
@@ -27,10 +26,10 @@
   ],
   "scripts": {
     "build": "tsc",
-    "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'",
+    "lint": "eslint 'src/**/*.ts' --cache",
+    "lint:fix": "eslint --fix 'src/**/*.ts'",
     "prepublishOnly": "[ -n \"$CI\" ] || [ ! -f node_modules/.bin/pinst ] || pinst --disable",
     "postpublish": "[ -n \"$CI\" ] || [ ! -f node_modules/.bin/pinst ] || pinst --enable",
     "setup": "if [[ $(uname -s) == 'Darwin' ]]; then BASH_ENV=~/.bashrc bash -O expand_aliases bin/setup.sh; else bash bin/setup.sh; fi && if [[ -f __DELETE__ ]]; then rm -rdf bin __DELETE__; fi",
@@ -39,20 +38,19 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@commitlint/cli": "^16.1.0",
-    "@commitlint/config-conventional": "^16.0.0",
-    "@types/jest": "^27.4.0",
-    "@types/node": "^17.0.14",
-    "@typescript-eslint/eslint-plugin": "^5.10.2",
-    "@typescript-eslint/parser": "^5.10.2",
-    "eslint": "^8.8.0",
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
+    "@types/node": "^17.0.23",
+    "@typescript-eslint/eslint-plugin": "^5.19.0",
+    "@typescript-eslint/parser": "^5.19.0",
+    "c8": "^7.11.0",
+    "eslint": "^8.13.0",
+    "eslint-plugin-import": "^2.26.0",
     "husky": "^7.0.4",
-    "jest": "^27.4.7",
-    "jest-circus": "^27.4.6",
-    "lint-staged": "^12.3.3",
-    "pinst": "^2.1.6",
-    "ts-jest": "^27.1.3",
-    "typescript": "^4.5.5"
+    "lint-staged": "^12.3.7",
+    "pinst": "^3.0.0",
+    "typescript": "^4.6.3",
+    "vitest": "^0.9.3"
   },
   "publishConfig": {
     "access": "public"

__tests__/index.test.ts → src/index.test.ts

@@ -1,5 +1,6 @@
 /* eslint-disable no-magic-numbers */
-import {add, repeat} from '../src';
+import { describe, expect, it, vi } from 'vitest';
+import { add, repeat } from '../src';
 
 describe('add', () => {
   it('should add number', () => {
@@ -9,15 +10,15 @@ describe('add', () => {
 
 describe('repeat', () => {
   it('should not call callback', async() => {
-    const callback = jest.fn();
+    const callback = vi.fn();
 
     await repeat(callback, 0);
 
     expect(callback).not.toBeCalled();
   });
 
   it('should call callback 3 times', async() => {
-    const callback = jest.fn();
+    const callback = vi.fn();
 
     await repeat(callback, 3);
 

src/index.ts

@@ -1,4 +1,4 @@
-import {WAIT_MS} from './constant';
+import { WAIT_MS } from './constant';
 
 export const add = (num1: number, num2: number): number => num1 + num2;
 

src/setup.ts

@@ -0,0 +1,5 @@
+import { vi } from 'vitest';
+
+vi.mock('./src/constant', () => Object.assign(vi.importActual('./src/constant'), {
+  INTERVAL_MS: 0,
+}));

vite.config.ts

@@ -0,0 +1,11 @@
+/// <reference types="vitest" />
+
+import { defineConfig } from 'vite';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  test: {
+    globals: true,
+    setupFiles: './src/setup.ts',
+  },
+});