Merge pull request #9 from gregoranders/development

Development

Author: gregoranders

.eslintrc.js

@@ -0,0 +1,13 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  extends: ['plugin:@typescript-eslint/recommended', 'prettier/@typescript-eslint', 'plugin:prettier/recommended'],
+  parserOptions: {
+    ecmaVersion: 2016,
+    sourceType: 'module',
+    ecmaFeatures: {},
+  },
+  rules: {
+    '@typescript-eslint/explicit-function-return-type': 'off',
+  },
+  settings: {},
+};

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  semi: true,
+  trailingComma: "all",
+  singleQuote: true,
+  printWidth: 120,
+  tabWidth: 2
+};

.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "program": "${workspaceFolder}/src/index.ts",
+      "preLaunchTask": "tsc: build - tsconfig.json",
+      "outFiles": ["${workspaceFolder}/dist/**/*.js"]
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "eslint.validate": ["javascript", { "language": "typescript", "autoFix": true }],
+  "editor.formatOnSave": true,
+  "[javascript]": {
+    "editor.formatOnSave": false
+  },
+  "[typescript]": {
+    "editor.formatOnSave": false
+  }
+}

.vscode/workspace.code-workspace

@@ -0,0 +1,33 @@
+{
+  "folders": [
+    {
+      "path": "../"
+    }
+  ],
+  "settings": {
+    "editor.defaultFormatter": "vscode.typescript-language-features",
+    "workbench.colorTheme": "Nord Deep",
+    "workbench.iconTheme": "material-icon-theme",
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    },
+    "eslint.validate": ["javascript", { "language": "typescript", "autoFix": true }]
+  },
+  "extensions": {
+    "recommendations": [
+      "coenraads.bracket-pair-colorizer",
+      "msjsdiag.debugger-for-chrome",
+      "editorconfig.editorconfig",
+      "dsznajder.es7-react-js-snippets",
+      "dbaeumer.vscode-eslint",
+      "orta.vscode-jest",
+      "pkief.material-icon-theme",
+      "marlosirapuan.nord-deep",
+      "eg2.vscode-npm-script",
+      "esbenp.prettier-vscode",
+      "rvest.vs-code-prettier-eslint",
+      "pflannery.vscode-versionlens",
+      "visualstudioexptteam.vscodeintellicode"
+    ]
+  }
+}

README.md

@@ -24,10 +24,10 @@ This action uploads an asset to a release, so your workflow can access it.
     ...
     - name: nodejs project information
       id: projectinfo
-      uses: gregoranders/nodejs-project-info@v0.0.4
+      uses: gregoranders/nodejs-project-info@v0.0.5
     - name: create release
       id: createrelease
-      uses: gregoranders/nodejs-create-release@v0.0.4
+      uses: gregoranders/nodejs-create-release@v0.0.5
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
@@ -36,7 +36,7 @@ This action uploads an asset to a release, so your workflow can access it.
         target: ${{ github.ref }}
     - name: upload asset
       id: uploadasset
-      uses: gregoranders/nodejs-upload-asset@v0.0.4
+      uses: gregoranders/nodejs-upload-asset@v0.0.5
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:

dist/index.js

@@ -1,13 +1,13 @@
 {
   "name": "nodejs-upload-asset",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "NodeJS Upload Asset",
   "main": "./dist/index.js",
   "scripts": {
     "clear": "rimraf ./node_modules ./dist ./coverage ./package-lock.json",
     "prestart": "npm run build",
     "start": "node ./dist/index.js",
-    "prebuild": "tslint --project ./",
+    "prebuild": "tsc --noEmit --project ./ && eslint ./src/**/*.ts --quiet --fix",
     "build": "ncc build ./src/index.ts -m -o ./dist/",
     "pretest": "rimraf ./coverage",
     "test": "jest",
@@ -21,6 +21,11 @@
     "jest",
     "typescript"
   ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsc --noEmit --project ./ && eslint ./src/**/*.ts --quiet && npm run test"
+    }
+  },
   "jest": {
     "collectCoverage": true,
     "coveragePathIgnorePatterns": [
@@ -64,13 +69,18 @@
     "@types/jest": "25.2.1",
     "@types/mime": "2.0.1",
     "@zeit/ncc": "0.22.1",
-    "jest": "25.3.0",
+    "@typescript-eslint/eslint-plugin": "2.28.0",
+    "@typescript-eslint/parser": "2.28.0",
+    "eslint": "6.8.0",
+    "eslint-config-prettier": "6.10.1",
+    "eslint-plugin-prettier": "3.1.3",
+    "husky": "4.2.5",
+    "jest": "25.4.0",
+    "prettier": "2.0.4",
     "mime": "2.4.4",
     "rimraf": "3.0.2",
-    "ts-jest": "25.3.1",
-    "ts-loader": "6.2.2",
+    "ts-jest": "25.4.0",
     "ts-node": "8.8.2",
-    "tslint": "6.1.1",
     "typescript": "3.8.3"
   }
 }

package.json

@@ -1,79 +1,77 @@
-import { clearTestEnvironment, uploadReleaseAssetMock, setInput, setOutputMock } from "./testUtils";
+/* eslint-disable @typescript-eslint/camelcase */
+import { clearTestEnvironment, uploadReleaseAssetMock, setInput, setOutputMock } from './testUtils';
 
-import { run as testSubject } from "./action";
-
-describe("nodejs-upload-asset", () => {
+import { run as testSubject } from './action';
 
+describe('nodejs-upload-asset', () => {
   beforeEach(() => {
     clearTestEnvironment();
-    Reflect.deleteProperty(process.env, "GITHUB_TOKEN");
+    Reflect.deleteProperty(process.env, 'GITHUB_TOKEN');
   });
 
-  it("no url provided", async () => {
-    setInput("path", "bar");
-    return expect(testSubject()).rejects.toStrictEqual(Error("Input required and not supplied: url"));
+  it('no url provided', async () => {
+    setInput('path', 'bar');
+    return expect(testSubject()).rejects.toStrictEqual(Error('Input required and not supplied: url'));
   });
 
-  it("no path provided", async () => {
-    setInput("url", "foo");
-    return expect(testSubject()).rejects.toStrictEqual(Error("Input required and not supplied: path"));
+  it('no path provided', async () => {
+    setInput('url', 'foo');
+    return expect(testSubject()).rejects.toStrictEqual(Error('Input required and not supplied: path'));
   });
 
-  it("missing GITHUB_TOKEN", async () => {
-    setInput("url", "foo");
-    setInput("path", "bar");
+  it('missing GITHUB_TOKEN', async () => {
+    setInput('url', 'foo');
+    setInput('path', 'bar');
     return expect(testSubject()).resolves.toHaveCoreError(/Missing GITHUB_TOKEN/);
   });
 
-  it("invalid path", async () => {
-    setInput("url", "foo");
-    setInput("path", "bar");
-    process.env.GITHUB_TOKEN = "abcd";
+  it('invalid path', async () => {
+    setInput('url', 'foo');
+    setInput('path', 'bar');
+    process.env.GITHUB_TOKEN = 'abcd';
     return expect(testSubject()).resolves.toHaveCoreError(/lstat/);
   });
 
-  it("valid input and GITHUB_TOKEN - upload", async () => {
-    setInput("url", "foo");
-    setInput("path", ".editorconfig");
-    process.env.GITHUB_TOKEN = "abcd";
+  it('valid input and GITHUB_TOKEN - upload', async () => {
+    setInput('url', 'foo');
+    setInput('path', '.editorconfig');
+    process.env.GITHUB_TOKEN = 'abcd';
     uploadReleaseAssetMock.mockReturnValue({
       data: {
-        browser_download_url: "download_url",
+        browser_download_url: 'download_url',
         id: 1,
       },
     });
     return testSubject().then(() => {
       expect(uploadReleaseAssetMock).toHaveBeenCalledNthWith(1, {
-        name: ".editorconfig",
-        url: "foo",
+        name: '.editorconfig',
+        url: 'foo',
       });
       expect(setOutputMock).toHaveBeenCalledTimes(2);
-      expect(setOutputMock).toHaveCoreOutput("id", "1");
-      expect(setOutputMock).toHaveCoreOutput("url", "download_url");
+      expect(setOutputMock).toHaveCoreOutput('id', '1');
+      expect(setOutputMock).toHaveCoreOutput('url', 'download_url');
     });
   });
 
-  it("valid input and GITHUB_TOKEN - upload - custom mime type", async () => {
-    setInput("url", "foo");
-    setInput("path", "package.json");
-    setInput("mime", "application/json");
-    process.env.GITHUB_TOKEN = "abcd";
+  it('valid input and GITHUB_TOKEN - upload - custom mime type', async () => {
+    setInput('url', 'foo');
+    setInput('path', 'package.json');
+    setInput('mime', 'application/json');
+    process.env.GITHUB_TOKEN = 'abcd';
     uploadReleaseAssetMock.mockReturnValue({
       data: {
-        browser_download_url: "download_url",
+        browser_download_url: 'download_url',
         id: 1,
       },
     });
     return testSubject().then(() => {
       expect(uploadReleaseAssetMock).toHaveBeenCalledNthWith(1, {
-        name: "package.json",
-        url: "foo",
+        name: 'package.json',
+        url: 'foo',
       });
       expect(setOutputMock).toHaveBeenCalledTimes(2);
-      expect(setOutputMock).toHaveCoreOutput("id", "1");
-      expect(setOutputMock).toHaveCoreOutput("url", "download_url");
+      expect(setOutputMock).toHaveCoreOutput('id', '1');
+      expect(setOutputMock).toHaveCoreOutput('url', 'download_url');
     });
   });
-
-
 });

src/action.spec.ts

@@ -1,32 +1,37 @@
-import * as core from "@actions/core";
-import { GitHub } from "@actions/github";
+import * as core from '@actions/core';
+import { GitHub } from '@actions/github';
 
-import * as fs from "fs";
-import { getType } from "mime";
-import { basename, resolve } from "path";
+import * as fs from 'fs';
+import { getType } from 'mime';
+import { basename, resolve } from 'path';
 
-import { Octokit } from "@octokit/rest";
+import { Octokit } from '@octokit/rest';
 
 type ReposUploadReleaseAssetParams = Octokit.ReposUploadReleaseAssetParams;
 
 const uploadAsset = async (client: GitHub, params: ReposUploadReleaseAssetParams) => {
   core.startGroup(`Uploading asset ${params.name} to release ${params.url}`);
   // tslint:disable-next-line: no-any
-  const response = await client.repos.uploadReleaseAsset(params) as any;
+  const response = (await client.repos.uploadReleaseAsset(params)) as any;
   core.info(`Release asset ${response.data.name} created [id: ${response.data.id}]`);
   core.endGroup();
   return response.data;
 };
 
 const prepareHeaders = (fullPathChecked: string, mime: string) => {
   return {
-    "content-length": fs.statSync(fullPathChecked).size,
-    "content-type": mime || getType(fullPathChecked.toString()) || "application/zip",
+    'content-length': fs.statSync(fullPathChecked).size,
+    'content-type': mime || getType(fullPathChecked.toString()) || 'application/zip',
   };
 };
 
-const prepareParams = (data: Buffer, headers: { "content-length": number; "content-type": string; },
-  label: string, name: string, url: string): Octokit.ReposUploadReleaseAssetParams => {
+const prepareParams = (
+  data: Buffer,
+  headers: { 'content-length': number; 'content-type': string },
+  label: string,
+  name: string,
+  url: string,
+): Octokit.ReposUploadReleaseAssetParams => {
   return {
     data,
     headers,
@@ -37,16 +42,16 @@ const prepareParams = (data: Buffer, headers: { "content-length": number; "conte
 };
 
 export const run = async () => {
-  const path = core.getInput("path", { required: true });
+  const path = core.getInput('path', { required: true });
 
-  const name = core.getInput("name", { required: false }) || basename(path);
-  const label = core.getInput("label", { required: false });
-  const url = core.getInput("url", { required: true });
-  const mime = core.getInput("mime", { required: false });
+  const name = core.getInput('name', { required: false }) || basename(path);
+  const label = core.getInput('label', { required: false });
+  const url = core.getInput('url', { required: true });
+  const mime = core.getInput('mime', { required: false });
 
   try {
     if (!process.env.GITHUB_TOKEN) {
-      throw Error("Missing GITHUB_TOKEN");
+      throw Error('Missing GITHUB_TOKEN');
     }
 
     const github = new GitHub(process.env.GITHUB_TOKEN);
@@ -56,10 +61,9 @@ export const run = async () => {
 
     const asset = await uploadAsset(github, prepareParams(data, headers, label, name, url));
 
-    core.setOutput("id", asset.id.toString());
-    core.setOutput("url", asset.browser_download_url);
+    core.setOutput('id', asset.id.toString());
+    core.setOutput('url', asset.browser_download_url);
   } catch (error) {
     core.setFailed(error);
   }
 };
-