Merge pull request #10 from gregoranders/development

gregoranders · web-flow · commit 036d9cd71e62 · 2020-04-20T01:26:43.000+02:00
Development
diff --git a/.eslintrc.js b/.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: {},
+};
diff --git a/.github/workflows/development.yml b/.github/workflows/development.yml
@@ -21,6 +21,11 @@ jobs:
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
+    - name: nodejs project info
+      id: projectinfo
+      uses: gregoranders/nodejs-project-info@master
+      env:
+        CI: true
     - name: npm install
       run: |
         npm install
diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml
@@ -23,7 +23,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - name: nodejs project info
       id: projectinfo
-      uses: gregoranders/nodejs-project-info@v0.0.2
+      uses: gregoranders/nodejs-project-info@master
       env:
         CI: true
     - name: npm install
@@ -59,7 +59,7 @@ jobs:
         debug: true
     - name: create release
       id: createrelease
-      uses: gregoranders/nodejs-create-release@v0.0.3
+      uses: gregoranders/nodejs-create-release@master
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         PACKAGE_JSON: ${{ steps.projectinfo.outputs.context }}
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,7 @@
+module.exports = {
+  semi: true,
+  trailingComma: "all",
+  singleQuote: true,
+  printWidth: 120,
+  tabWidth: 2
+};
diff --git a/.vscode/launch.json b/.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"]
+    }
+  ]
+}
diff --git a/.vscode/settings.json b/.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
+  }
+}
diff --git a/.vscode/workspace.code-workspace b/.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"
+    ]
+  }
+}
diff --git a/README.md b/README.md
@@ -24,10 +24,10 @@ This action provides the *name* and *version* and the content of **package.json*
     ...
     - name: nodejs project information
       id: projectinfo
-      uses: gregoranders/nodejs-project-info@v0.0.3
+      uses: gregoranders/nodejs-project-info@v0.0.5
     - name: create release action
       id: createrelease
-      uses: gregoranders/nodejs-create-release@master
+      uses: gregoranders/nodejs-create-release@v0.0.5
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         PACKAGE_JSON: ${{ steps.projectinfo.outputs.context }}
diff --git a/dist/index.js b/dist/index.js
diff --git a/package.json b/package.json
@@ -1,13 +1,13 @@
 {
   "name": "nodejs-project-info",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "NodeJS Project Information",
   "main": "./dist/index.js",
   "scripts": {
     "clear": "rimraf ./node_modules ./dist ./coverage ./package-lock.json ./webpack.conf.js",
     "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",
@@ -19,8 +19,14 @@
   },
   "keywords": [
     "jest",
+    "eslint",
     "typescript"
   ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsc --noEmit --project ./ && eslint ./src/**/*.ts --quiet"
+    }
+  },
   "jest": {
     "collectCoverage": true,
     "coveragePathIgnorePatterns": [
@@ -58,18 +64,23 @@
   "homepage": "https://gregoranders.github.io/nodejs-project-info/",
   "dependencies": {
     "@actions/core": "1.2.3",
-    "semver": "7.2.1"
+    "semver": "7.3.2"
   },
   "devDependencies": {
     "@types/jest": "25.2.1",
-    "@types/node": "13.11.1",
+    "@types/node": "13.13.0",
     "@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",
     "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"
   }
 }
diff --git a/src/action.spec.ts b/src/action.spec.ts
@@ -1,45 +1,41 @@
+import { clearTestEnvironment, expectOutputError, setInput } from './fixtures/testUtils';
 
-import { clearTestEnvironment, expectOutputError, setInput } from "./fixtures/testUtils";
+import { run as testSubject } from './action';
 
-import { run as testSubject } from "./action";
-
-describe("nodejs-project-info", () => {
-
-  const fixturesPath = "./src/fixtures";
+describe('nodejs-project-info', () => {
+  const fixturesPath = './src/fixtures';
 
   beforeEach(() => {
     clearTestEnvironment();
   });
 
-  describe("path", () => {
-
-    it("default", async () => {
-      return expect(testSubject()).resolves.toHaveCoreOutput("name", "nodejs-project-info");
+  describe('path', () => {
+    it('default', async () => {
+      return expect(testSubject()).resolves.toHaveCoreOutput('name', 'nodejs-project-info');
     });
 
-    it("valid", async () => {
-      setInput("path", `${fixturesPath}/valid-package.json`);
-      return expect(testSubject()).resolves.toHaveCoreOutput("version", "0.0.1");
+    it('valid', async () => {
+      setInput('path', `${fixturesPath}/valid-package.json`);
+      return expect(testSubject()).resolves.toHaveCoreOutput('version', '0.0.1');
     });
 
-    it("invalid", async () => {
-      setInput("path", "invalidfile");
+    it('invalid', async () => {
+      setInput('path', 'invalidfile');
       return expect(testSubject()).resolves.toHaveCoreError(/^ENOENT: no such file or directory/);
     });
 
-    it("directory", async () => {
-      setInput("path", "./node_modules");
+    it('directory', async () => {
+      setInput('path', './node_modules');
       return expect(testSubject()).resolves.toHaveCoreError(/^EISDIR: illegal operation on a directory/);
     });
   });
 
-  describe("version", () => {
-
-    it("missing", async () => {
+  describe('version', () => {
+    it('missing', async () => {
       return expectOutputError(testSubject, `${fixturesPath}/missing-version-package.json`, /Missing version/);
     });
 
-    it("invalid", async () => {
+    it('invalid', async () => {
       // tslint:disable-next-line: max-line-length
       return expectOutputError(testSubject, `${fixturesPath}/invalid-version-package.json`, /Invalid version a\.b\.c/);
     });
diff --git a/src/action.ts b/src/action.ts
@@ -1,12 +1,12 @@
-import * as core from "@actions/core";
+import * as core from '@actions/core';
 
-import { readFile, realpath } from "fs";
+import { readFile, realpath } from 'fs';
 
-import * as SemVer from "semver/functions/valid";
+import * as SemVer from 'semver/functions/valid';
 
 const valid = SemVer as (value: string) => boolean;
 
-import { IPackageJSON } from "./package-json";
+import { PackageJSON } from './package-json';
 
 const readfile = async (path: string) => {
   return new Promise<string>((resolve, reject) => {
@@ -33,12 +33,12 @@ const resolvePath = (path: string) => {
 };
 
 export const run = async () => {
-  const path = core.getInput("path", { required: false }) || "./package.json";
+  const path = core.getInput('path', { required: false }) || './package.json';
 
   try {
     const resolved = await resolvePath(path);
     const buffer = await readfile(resolved);
-    const pkg = JSON.parse(buffer) as IPackageJSON;
+    const pkg = JSON.parse(buffer) as PackageJSON;
 
     if (!pkg.version) {
       throw Error(`Missing version`);
@@ -48,9 +48,9 @@ export const run = async () => {
       throw Error(`Invalid version ${pkg.version}`);
     }
 
-    core.setOutput("name", pkg.name);
-    core.setOutput("version", pkg.version);
-    core.setOutput("context", buffer);
+    core.setOutput('name', pkg.name);
+    core.setOutput('version', pkg.version);
+    core.setOutput('context', buffer);
   } catch (error) {
     core.setFailed(error);
   }
diff --git a/src/fixtures/testUtils.ts b/src/fixtures/testUtils.ts
@@ -1,5 +1,5 @@
-
 declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace jest {
     // tslint:disable-next-line: interface-name
     interface Matchers<R, T> {
@@ -12,7 +12,7 @@ declare global {
 const setFailedMock = jest.fn();
 const setOutputMock = jest.fn();
 
-const actionsCoreMock = jest.mock("@actions/core", () => {
+const actionsCoreMock = jest.mock('@actions/core', () => {
   return {
     getInput: (name: string, options?: { required: boolean }) => {
       return process.env[`INPUT_${name.toUpperCase()}`];
@@ -41,24 +41,23 @@ export const clearTestEnvironment = () => {
 expect.extend({
   // tslint:disable-next-line: object-literal-shorthand space-before-function-paren
   toHaveCoreError: function (recieved: jest.Mock, msg: RegExp) {
-    const error = setFailedMock.mock.calls.length ? setFailedMock.mock.calls[0][0] as Error : undefined;
+    const error = setFailedMock.mock.calls.length ? (setFailedMock.mock.calls[0][0] as Error) : undefined;
     const pass = error && error.message.match(msg) ? true : false;
     const options = {
-      comment: "Error.message equality",
+      comment: 'Error.message equality',
       isNot: this.isNot,
       promise: this.promise,
     };
 
     return {
       message: () => {
         if (pass) {
-          return this.utils.matcherHint("toHaveCoreError", error?.message, `${msg}`, options);
+          return this.utils.matcherHint('toHaveCoreError', error?.message, `${msg}`, options);
         } else {
           const diff = this.utils.diff(msg, error?.message, {
             expand: this.expand,
           });
-          return this.utils.matcherHint("toHaveCoreError", error?.message, `${msg}`, options)
-            + `\n\n${diff}`;
+          return this.utils.matcherHint('toHaveCoreError', error?.message, `${msg}`, options) + `\n\n${diff}`;
         }
       },
       pass,
@@ -77,12 +76,19 @@ expect.extend({
     return {
       message: () => {
         if (pass) {
-          return this.utils.matcherHint("toHaveCoreOutput", `${match[0]}=${match[1]}`, `${key}=${value}`, options);
+          return this.utils.matcherHint('toHaveCoreOutput', `${match[0]}=${match[1]}`, `${key}=${value}`, options);
         } else {
-          const diff = this.utils.diff(`${key}=${value}`, keyMatch ? `${keyMatch[0]}=${keyMatch[1]}` : "", {
+          const diff = this.utils.diff(`${key}=${value}`, keyMatch ? `${keyMatch[0]}=${keyMatch[1]}` : '', {
             expand: this.expand,
           });
-          return this.utils.matcherHint("toHaveCoreError", keyMatch ? `${keyMatch[0]}=${keyMatch[1]}` : "", `${key}=${value}`, options) + `\n\n${diff}`;
+          return (
+            this.utils.matcherHint(
+              'toHaveCoreError',
+              keyMatch ? `${keyMatch[0]}=${keyMatch[1]}` : '',
+              `${key}=${value}`,
+              options,
+            ) + `\n\n${diff}`
+          );
         }
       },
       pass,
@@ -91,7 +97,6 @@ expect.extend({
 });
 
 export const expectOutputError = (promise: () => Promise<void>, path: string, regex: RegExp) => {
-  setInput("path", `${path}`);
+  setInput('path', `${path}`);
   return expect(promise()).resolves.toHaveCoreError(regex);
 };
-
diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,3 @@
-import { run } from "./action";
+import { run } from './action';
 
 run();
diff --git a/src/package-json.ts b/src/package-json.ts
diff --git a/tslint.json b/tslint.json
