Merge pull request actions#48 from actions/code-quality

jclem · web-flow · commit f498913621f0 · 2020-05-18T11:34:07.000-04:00
Code quality improvements
diff --git a/.eslintrc.yml b/.eslintrc.yml
@@ -0,0 +1,13 @@
+root: true
+parser: '@typescript-eslint/parser'
+plugins: ['@typescript-eslint']
+extends:
+  - eslint:recommended
+  - plugin:@typescript-eslint/eslint-recommended
+  - plugin:@typescript-eslint/recommended
+  - prettier/@typescript-eslint
+rules:
+  # '@typescript-eslint/explicit-function-return-type': 0
+  '@typescript-eslint/no-use-before-define':
+    - 2
+    - functions: false
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,4 +15,5 @@ jobs:
           key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
           restore-keys: ${{runner.os}}-npm-
       - run: npm ci
+      - run: npm run style:check
       - run: npm test
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-node_modules
+/node_modules/
+!/.vscode/
diff --git a/.prettierrc.yml b/.prettierrc.yml
@@ -0,0 +1,5 @@
+arrowParens: avoid
+bracketSpacing: false
+semi: false
+singleQuote: true
+trailingComma: none
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,10 @@
+{
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": true
+  },
+  "files.exclude": {
+    "**/dist": true,
+    "**/node_modules": true
+  }
+}
diff --git a/__test__/async-function.test.ts b/__test__/async-function.test.ts
@@ -1,26 +1,28 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
 import {callAsyncFunction} from '../src/async-function'
 
 describe('callAsyncFunction', () => {
   test('calls the function with its arguments', async () => {
-    const result = await callAsyncFunction({foo: 'bar'}, 'return foo')
+    const result = await callAsyncFunction({foo: 'bar'} as any, 'return foo')
     expect(result).toEqual('bar')
   })
 
   test('throws on ReferenceError', async () => {
     expect.assertions(1)
 
     try {
-      await callAsyncFunction({}, 'proces')
+      await callAsyncFunction({} as any, 'proces')
     } catch (err) {
       expect(err).toBeInstanceOf(ReferenceError)
     }
   })
 
   test('can access process', async () => {
-    await callAsyncFunction({}, 'process')
+    await callAsyncFunction({} as any, 'process')
   })
 
   test('can access console', async () => {
-    await callAsyncFunction({}, 'console')
+    await callAsyncFunction({} as any, 'console')
   })
 })
diff --git a/dist/index.js b/dist/index.js
@@ -9274,7 +9274,7 @@ var core = __webpack_require__(470);
 var lib_github = __webpack_require__(469);
 
 // CONCATENATED MODULE: ./src/async-function.ts
-const AsyncFunction = Object.getPrototypeOf(async () => { }).constructor;
+const AsyncFunction = Object.getPrototypeOf(async () => null).constructor;
 function callAsyncFunction(args, source) {
     const fn = new AsyncFunction(...Object.keys(args), source);
     return fn(...Object.values(args));
@@ -9300,7 +9300,7 @@ async function main() {
         opts.previews = previews.split(',');
     const github = new lib_github.GitHub(token, opts);
     const script = Object(core.getInput)('script', { required: true });
-    // Using property/value shorthand on `require` (e.g. `{require}`) causes compilatin errors.
+    // Using property/value shorthand on `require` (e.g. `{require}`) causes compilation errors.
     const result = await callAsyncFunction({ require: __webpack_require__(875), github, context: lib_github.context, core: core }, script);
     let encoding = Object(core.getInput)('result-encoding');
     encoding = encoding ? encoding : 'json';
@@ -9317,14 +9317,10 @@ async function main() {
     }
     Object(core.setOutput)('result', output);
 }
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function handleError(err) {
     console.error(err);
-    if (err && err.message) {
-        Object(core.setFailed)(err.message);
-    }
-    else {
-        Object(core.setFailed)(`Unhandled error: ${err}`);
-    }
+    Object(core.setFailed)(`Unhandled error: ${err}`);
 }
 
 
diff --git a/docs/development.md b/docs/development.md
@@ -15,7 +15,8 @@ bash> npm run build
 
 It also has a pre-commit hook configured via
 [husky](https://www.npmjs.com/package/husky) that should run the build script
-before each commit.
+before each commit. Additionally, this hook formats code and lints it, as
+well.
 
 ## Releasing
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/src/async-function.ts b/src/async-function.ts
diff --git a/src/main.ts b/src/main.ts

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-node_modules`
	`1`	`+/node_modules/`
	`2`	`+!/.vscode/`