feat(eslint): add jest and unicorn plugin

- adjust code according to eslint issues

Author: gregoranders

.eslintrc.js

@@ -0,0 +1,36 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["prettier", "jest", "unicorn", "@typescript-eslint"],
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:jest/recommended",
+    "plugin:unicorn/recommended",
+    "plugin:prettier/recommended",
+    "prettier/@typescript-eslint"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "ecmaFeatures": {}
+  },
+  "env": {
+    "es2020": true,
+    "es6": true,
+    "browser": false,
+    "jest": true
+  },
+  "rules": {
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "sort-imports": [
+      "error",
+      {
+        "ignoreCase": false,
+        "ignoreDeclarationSort": true,
+        "ignoreMemberSort": false,
+        "memberSyntaxSortOrder": ["none", "all", "multiple", "single"]
+      }
+    ]
+  },
+  "settings": {}
+}

.eslintrc.json

@@ -29,7 +29,7 @@
   "jest": {
     "collectCoverage": true,
     "coveragePathIgnorePatterns": [
-      "testUtils.ts",
+      "test-utils.ts",
       "/node_modules/"
     ],
     "coverageReporters": [
@@ -68,16 +68,18 @@
   "devDependencies": {
     "@types/jest": "26.0.3",
     "@types/mime": "2.0.2",
-    "@zeit/ncc": "0.22.3",
     "@typescript-eslint/eslint-plugin": "3.4.0",
     "@typescript-eslint/parser": "3.4.0",
+    "@zeit/ncc": "0.22.3",
     "eslint": "7.3.1",
     "eslint-config-prettier": "6.11.0",
+    "eslint-plugin-jest": "23.17.1",
     "eslint-plugin-prettier": "3.1.4",
+    "eslint-plugin-unicorn": "20.1.0",
     "husky": "4.2.5",
     "jest": "26.1.0",
-    "prettier": "2.0.5",
     "mime": "2.4.6",
+    "prettier": "2.0.5",
     "rimraf": "3.0.2",
     "ts-jest": "26.1.1",
     "ts-node": "8.10.2",

package.json

@@ -1,4 +1,4 @@
-import { clearTestEnvironment, uploadReleaseAssetMock, setInput, setOutputMock } from './testUtils';
+import { clearTestEnvironment, setInput, setOutputMock, uploadReleaseAssetMock } from './test-utils';
 
 import { run as testSubject } from './action';
 
@@ -10,12 +10,12 @@ describe('nodejs-upload-asset', () => {
 
   it('no id provided', async () => {
     setInput('path', 'bar');
-    return expect(testSubject()).rejects.toStrictEqual(Error('Input required and not supplied: id'));
+    return expect(testSubject()).rejects.toStrictEqual(new Error('Input required and not supplied: id'));
   });
 
   it('no path provided', async () => {
     setInput('id', '1');
-    return expect(testSubject()).rejects.toStrictEqual(Error('Input required and not supplied: path'));
+    return expect(testSubject()).rejects.toStrictEqual(new Error('Input required and not supplied: path'));
   });
 
   it('missing GITHUB_TOKEN', async () => {

src/action.spec.ts

@@ -1,6 +1,6 @@
 import * as core from '@actions/core';
 import { context, getOctokit } from '@actions/github';
-import { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods/dist-types/';
+import { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods/dist-types';
 
 import * as fs from 'fs';
 import { getType } from 'mime';
@@ -9,9 +9,9 @@ import { basename, resolve } from 'path';
 type GitHub = ReturnType<typeof getOctokit>;
 type ReposUploadReleaseAssetParams = RestEndpointMethodTypes['repos']['uploadReleaseAsset']['parameters'];
 
-const uploadAsset = async (client: GitHub, params: ReposUploadReleaseAssetParams) => {
-  core.startGroup(`Uploading asset ${params.name} to release ${params.url}`);
-  const response = await client.repos.uploadReleaseAsset(params);
+const uploadAsset = async (client: GitHub, parameters: ReposUploadReleaseAssetParams) => {
+  core.startGroup(`Uploading asset ${parameters.name} to release ${parameters.url}`);
+  const response = await client.repos.uploadReleaseAsset(parameters);
   core.info(`Release asset ${response.data.name} created [id: ${response.data.id}]`);
   core.endGroup();
   return response.data;
@@ -24,7 +24,7 @@ const prepareHeaders = (fullPathChecked: string, mime: string) => {
   };
 };
 
-const prepareParams = (
+const prepareParameters = (
   data: string,
   headers: { 'content-length': number; 'content-type': string },
   label: string,
@@ -38,7 +38,7 @@ const prepareParams = (
     headers,
     label,
     name,
-    release_id: parseInt(release_id),
+    release_id: Number.parseInt(release_id),
     owner,
     repo,
   };
@@ -54,7 +54,7 @@ export const run = async (): Promise<void> => {
 
   try {
     if (!process.env.GITHUB_TOKEN) {
-      throw Error('Missing GITHUB_TOKEN');
+      throw new Error('Missing GITHUB_TOKEN');
     }
 
     const github = getOctokit(process.env.GITHUB_TOKEN);
@@ -64,7 +64,7 @@ export const run = async (): Promise<void> => {
 
     const asset = await uploadAsset(
       github,
-      prepareParams(data, headers, label, name, id, context.repo.owner, context.repo.repo),
+      prepareParameters(data, headers, label, name, id, context.repo.owner, context.repo.repo),
     );
 
     core.setOutput('id', asset.id.toString());

src/action.ts

@@ -25,7 +25,7 @@ const actionsCoreMock = jest.mock('@actions/core', () => {
         options.required &&
         !Object.keys(process.env).find((key) => `INPUT_${name.toUpperCase()}` === key)
       ) {
-        throw Error(`Input required and not supplied: ${name}`);
+        throw new Error(`Input required and not supplied: ${name}`);
       }
       return process.env[`INPUT_${name.toUpperCase()}`];
     },
@@ -74,19 +74,19 @@ export const clearTestEnvironment = () => {
 };
 
 expect.extend({
-  // tslint:disable-next-line: object-literal-shorthand space-before-function-paren
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   toHaveBeenCalledNthWith: function (recieved: jest.Mock, times: number, match: any) {
-    const passTimes = recieved.mock.calls.length && recieved.mock.calls.length === times ? true : false;
+    const passTimes = recieved.mock.calls.length > 0 && recieved.mock.calls.length === times ? true : false;
     const options = {
       comment: 'Error.message equality',
       isNot: this.isNot,
       promise: this.promise,
     };
-    const callParams = recieved.mock.calls[0][0];
+    const callParameters = recieved.mock.calls[0][0];
     const expectedKeys = Object.keys(match);
     const matchData = Object.create({});
     expectedKeys.forEach((key) => {
-      matchData[key] = callParams[key];
+      matchData[key] = callParameters[key];
     });
     const passDiff = expectedKeys.find((key) => {
       if (matchData[key] !== match[key]) {
@@ -124,9 +124,9 @@ expect.extend({
       pass,
     };
   },
-  toHaveCoreError(recieved: jest.Mock, msg: RegExp) {
-    const error = setFailedMock.mock.calls.length ? (setFailedMock.mock.calls[0][0] as Error) : undefined;
-    const pass = error && error.message.match(msg) ? true : false;
+  toHaveCoreError(recieved: jest.Mock, message: RegExp) {
+    const error = setFailedMock.mock.calls.length > 0 ? (setFailedMock.mock.calls[0][0] as Error) : undefined;
+    const pass = error && error.message.match(message) ? true : false;
     const options = {
       comment: 'Error.message equality',
       isNot: this.isNot,
@@ -136,12 +136,12 @@ expect.extend({
     return {
       message: () => {
         if (pass) {
-          return this.utils.matcherHint('toHaveCoreError', error?.message, `${msg}`, options);
+          return this.utils.matcherHint('toHaveCoreError', error?.message, `${message}`, options);
         } else {
-          const diff = this.utils.diff(msg, error?.message, {
+          const diff = this.utils.diff(message, error?.message, {
             expand: this.expand,
           });
-          return this.utils.matcherHint('toHaveCoreError', error?.message, `${msg}`, options) + `\n\n${diff}`;
+          return this.utils.matcherHint('toHaveCoreError', error?.message, `${message}`, options) + `\n\n${diff}`;
         }
       },
       pass,