Merge pull request #196 from technote-space/release/next-v2.0.45

release: v2.1.0

Author: technote-space

.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 }
+		}]
 	}
 }

jest.config.js

@@ -1,6 +1,6 @@
 {
   "name": "@technote-space/github-action-config-helper",
-  "version": "2.0.45",
+  "version": "2.1.0",
   "description": "Helper for GitHub Action to manage config.",
   "keywords": [
     "github",
@@ -20,38 +20,43 @@
     "email": "[email protected]",
     "url": "https://technote.space"
   },
-  "main": "dist/index.js",
+  "type": "module",
+  "exports": "./dist/index.mjs",
+  "main": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsc",
-    "cover": "jest --coverage",
-    "lint": "eslint 'src/**/*.ts' '__tests__/**/*.ts' --cache",
-    "lint:fix": "eslint --fix 'src/**/*.ts' '__tests__/**/*.ts'",
-    "test": "yarn lint && yarn cover",
+    "build": "tsc && rm -f dist/*.js && rollup -c",
+    "cover": "vitest run --coverage",
+    "lint": "eslint 'src/**/*.ts' --cache",
+    "lint:fix": "eslint --fix 'src/**/*.ts'",
+    "test": "yarn lint && yarn typecheck && yarn cover",
+    "typecheck": "tsc --noEmit",
     "update": "npm_config_yes=true npx npm-check-updates -u --timeout 100000 && yarn install && yarn upgrade && yarn audit"
   },
   "dependencies": {
-    "@actions/github": "^5.0.0",
+    "@actions/github": "^5.0.1",
     "@octokit/plugin-rest-endpoint-methods": "^5.13.0",
-    "@technote-space/github-action-helper": "^5.2.27",
+    "@technote-space/github-action-helper": "^5.3.1",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "@technote-space/github-action-test-helper": "^0.7.40",
-    "@types/jest": "^27.4.1",
+    "@rollup/plugin-typescript": "^8.3.2",
+    "@sindresorhus/tsconfig": "^2.0.0",
+    "@technote-space/github-action-test-helper": "^0.9.2",
     "@types/js-yaml": "^4.0.5",
-    "@types/node": "^17.0.22",
-    "@typescript-eslint/eslint-plugin": "^5.16.0",
-    "@typescript-eslint/parser": "^5.16.0",
-    "eslint": "^8.11.0",
-    "jest": "^27.5.1",
-    "jest-circus": "^27.5.1",
+    "@types/node": "^17.0.25",
+    "@typescript-eslint/eslint-plugin": "^5.20.0",
+    "@typescript-eslint/parser": "^5.20.0",
+    "c8": "^7.11.0",
+    "eslint": "^8.13.0",
+    "eslint-plugin-import": "^2.26.0",
     "nock": "^13.2.4",
-    "ts-jest": "^27.1.3",
-    "typescript": "^4.6.2"
+    "rollup": "^2.70.2",
+    "typescript": "^4.6.3",
+    "vitest": "^0.9.3"
   },
   "publishConfig": {
     "access": "public"

jest.setup.ts

@@ -0,0 +1,12 @@
+import pluginTypescript from '@rollup/plugin-typescript';
+
+export default {
+  input: 'src/index.ts',
+  output: {
+    file: 'dist/index.mjs',
+    format: 'es',
+  },
+  plugins: [
+    pluginTypescript(),
+  ],
+};

package.json

@@ -0,0 +1,7 @@
+import { expect, it } from 'vitest';
+import { getConfig, parseConfig } from '.';
+
+it('helper methods should be imported', () => {
+  expect(getConfig).not.toBeFalsy();
+  expect(parseConfig).not.toBeFalsy();
+});

rollup.config.js

@@ -1,2 +1,2 @@
-export {getConfig} from './utils';
-export {parseConfig} from './misc';
+export { getConfig } from './utils';
+export { parseConfig } from './misc';

__tests__/fixtures/config.json renamed to src/fixtures/config.json

@@ -1,7 +1,8 @@
 /* eslint-disable no-magic-numbers */
-import {encodeContent, spyOnStdout, stdoutCalledWith, getLogStdout} from '@technote-space/github-action-test-helper';
-import {parseConfig} from '../src';
-import {isYaml, parseYamlConfig, parseJsonConfig} from '../src/misc';
+import { encodeContent, spyOnStdout, stdoutCalledWith, getLogStdout } from '@technote-space/github-action-test-helper';
+import { describe, expect, it } from 'vitest';
+import { parseConfig } from '../src';
+import { isYaml, parseYamlConfig, parseJsonConfig } from './misc';
 
 describe('isYaml', () => {
   it('should return true', () => {
@@ -20,8 +21,8 @@ describe('isYaml', () => {
 
 describe('parseYamlConfig', () => {
   it('should parse config', async() => {
-    expect(parseYamlConfig('a: b')).toEqual({a: 'b'});
-    expect(parseYamlConfig('a:\n  - b\n  - c')).toEqual({a: ['b', 'c']});
+    expect(parseYamlConfig('a: b')).toEqual({ a: 'b' });
+    expect(parseYamlConfig('a:\n  - b\n  - c')).toEqual({ a: ['b', 'c'] });
   });
 
   it('should return empty if empty', () => {
@@ -51,8 +52,8 @@ describe('parseYamlConfig', () => {
 
 describe('parseJsonConfig', () => {
   it('should parse config', async() => {
-    expect(parseJsonConfig('{"a": "b"}')).toEqual({a: 'b'});
-    expect(parseJsonConfig('{"a": ["b", "c"]}')).toEqual({a: ['b', 'c']});
+    expect(parseJsonConfig('{"a": "b"}')).toEqual({ a: 'b' });
+    expect(parseJsonConfig('{"a": ["b", "c"]}')).toEqual({ a: ['b', 'c'] });
   });
 
   it('should return empty if error', () => {
@@ -68,12 +69,12 @@ describe('parseJsonConfig', () => {
 
 describe('parseConfig', () => {
   it('should parse yaml', async() => {
-    expect(parseConfig(encodeContent('a: b'))).toEqual({a: 'b'});
-    expect(parseConfig(encodeContent('a: b'), 'test.yaml')).toEqual({a: 'b'});
+    expect(parseConfig(encodeContent('a: b'))).toEqual({ a: 'b' });
+    expect(parseConfig(encodeContent('a: b'), 'test.yaml')).toEqual({ a: 'b' });
   });
 
   it('should parse json', () => {
-    expect(parseConfig(encodeContent('{"a": "b"}'), 'test.json')).toEqual({a: 'b'});
-    expect(parseConfig(encodeContent('{"a": "b"}'), '.eslintrc')).toEqual({a: 'b'});
+    expect(parseConfig(encodeContent('{"a": "b"}'), 'test.json')).toEqual({ a: 'b' });
+    expect(parseConfig(encodeContent('{"a": "b"}'), '.eslintrc')).toEqual({ a: 'b' });
   });
 });

__tests__/fixtures/config.yml renamed to src/fixtures/config.yml

@@ -1,4 +1,4 @@
-import {load} from 'js-yaml';
+import { load } from 'js-yaml';
 
 export const isYaml = (filename: string): boolean => ['yaml', 'yml'].includes(String(filename.split('.').pop()));
 

__tests__/fixtures/error.yml renamed to src/fixtures/error.yml

@@ -0,0 +1,3 @@
+import { setupGlobal } from '@technote-space/github-action-test-helper';
+
+setupGlobal();

src/index.test.ts

@@ -1,8 +1,9 @@
 /* eslint-disable no-magic-numbers */
+import { resolve } from 'path';
+import { disableNetConnect, getConfigFixture, getContext, getOctokit } from '@technote-space/github-action-test-helper';
 import nock from 'nock';
-import {resolve} from 'path';
-import {disableNetConnect, getConfigFixture, getContext, getOctokit} from '@technote-space/github-action-test-helper';
-import {getConfig} from '../src';
+import { describe, expect, it } from 'vitest';
+import { getConfig } from './utils';
 
 const fixturesDir = resolve(__dirname, 'fixtures');
 
@@ -38,7 +39,7 @@ describe('getConfig', () => {
         owner: 'hello',
         repo: 'world',
       },
-    }), {ref: 'feature/change', configPath: ''});
+    }), { ref: 'feature/change', configPath: '' });
 
     expect(config).toHaveProperty('Backlog');
     expect(config['Backlog']).toHaveProperty('test1');
@@ -69,6 +70,6 @@ describe('getConfig', () => {
         owner: 'hello',
         repo: 'world',
       },
-    }), {configPath: '.test'})).rejects.toThrow();
+    }), { configPath: '.test' })).rejects.toThrow();
   });
 });

src/index.ts

@@ -1,12 +1,12 @@
-import {join} from 'path';
-import {Context} from '@actions/github/lib/context';
-import {Octokit} from '@technote-space/github-action-helper/dist/types';
-import {parseConfig} from './misc';
-import {NOT_FOUND_STATUS} from './constant';
+import type { Context } from '@actions/github/lib/context';
+import type { Octokit } from '@technote-space/github-action-helper/dist/types';
+import { join } from 'path';
+import { NOT_FOUND_STATUS } from './constant';
+import { parseConfig } from './misc';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const getConfig = async(fileName: string, octokit: Octokit, context: Context, options: { configPath?: string; ref?: string } = {}): Promise<{ [key: string]: any } | false> | never => {
-  const {configPath = '.github', ref} = options;
+  const { configPath = '.github', ref } = options;
   try {
     const params: {
       owner: string;