Merge pull request #40 from dependabot/feelepxyz/workflow-changes

Setup editor integrations and clean up linting

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+end_of_line = lf
+trim_trailing_whitespace = true
+charset = utf-8
+insert_final_newline = true
+
+[*.json, *.ts]
+indent_size = 2
+indent_style = space
+
+[*.md]
+trim_trailing_whitespace = false
+indent_size = 2

.eslintrc.json

@@ -1,23 +1,23 @@
 {
     "plugins": ["jest", "@typescript-eslint"],
-    "extends": ["plugin:github/recommended"],
+    "extends": ["plugin:github/recommended", "prettier"],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
       "ecmaVersion": 9,
       "sourceType": "module",
-      "project": "./tsconfig.json"
+      "project": "./tsconfig.eslint.json"
     },
     "rules": {
       "eslint-comments/no-use": "off",
       "import/no-namespace": "off",
       "no-unused-vars": "off",
+      "camelcase": "off",
       "@typescript-eslint/no-unused-vars": "error",
       "@typescript-eslint/explicit-member-accessibility": ["error", {"accessibility": "no-public"}],
       "@typescript-eslint/no-require-imports": "error",
       "@typescript-eslint/array-type": "error",
       "@typescript-eslint/await-thenable": "error",
       "@typescript-eslint/ban-ts-comment": "error",
-      "camelcase": "off",
       "@typescript-eslint/consistent-type-assertions": "error",
       "@typescript-eslint/explicit-function-return-type": ["error", {"allowExpressions": true}],
       "@typescript-eslint/func-call-spacing": ["error", "never"],
@@ -41,8 +41,6 @@
       "@typescript-eslint/promise-function-async": "error",
       "@typescript-eslint/require-array-sort-compare": "error",
       "@typescript-eslint/restrict-plus-operands": "error",
-      "semi": "off",
-      "@typescript-eslint/semi": ["error", "never"],
       "@typescript-eslint/type-annotation-spacing": "error",
       "@typescript-eslint/unbound-method": "error",
       "@typescript-eslint/no-shadow": "error",
@@ -53,4 +51,4 @@
       "es6": true,
       "jest/globals": true
     }
-  }
+  }

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install lint-staged

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "EditorConfig.editorconfig",
+    "Orta.vscode-jest",
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "eslint.validate": ["javascript", "typescript"],
+  "eslint.alwaysShowStatus": true,
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": false,
+  "editor.formatOnType": false
+}

README.md

@@ -1,34 +1,21 @@
-<p align="center">
-  <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
-</p>
-
-# Create a JavaScript Action using TypeScript
-
-Use this template to bootstrap the creation of a TypeScript action.:rocket:
-
-This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.  
-
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
-
-## Create an action from this template
-
-Click the `Use this Template` and provide the new repo details for your action
-
-## Code in Main
+## Setup
 
 > First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
 
-Install the dependencies  
+Install the dependencies
+
 ```bash
 $ npm install
 ```
 
 Build the typescript and package it for distribution
+
 ```bash
-$ npm run build && npm run package
+$ npm run package
 ```
 
-Run the tests :heavy_check_mark:  
+Run the tests :heavy_check_mark:
+
 ```bash
 $ npm test
 
@@ -57,9 +44,9 @@ import * as core from '@actions/core';
 ...
 
 async function run() {
-  try { 
+  try {
       ...
-  } 
+  }
   catch (error) {
     core.setFailed(error.message);
   }
@@ -72,9 +59,10 @@ See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/R
 
 ## Publish to a distribution branch
 
-Actions are run from GitHub repos so we will checkin the packed dist folder. 
+Actions are run from GitHub repos so we will checkin the packed dist folder.
 
 Then run [ncc](https://github.com/zeit/ncc) and push the results:
+
 ```bash
 $ npm run package
 $ git add dist
@@ -84,7 +72,7 @@ $ git push origin releases/v1
 
 Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
 
-Your action is now published! :rocket: 
+Your action is now published! :rocket:
 
 See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
 

__tests__/main.test.ts

@@ -1,13 +1,2 @@
-import * as process from 'process'
-import * as cp from 'child_process'
-import * as path from 'path'
-
 // shows how the runner will run a javascript action with env / stdout protocol
-test('test runs', () => {
-  const np = process.execPath
-  const ip = path.join(__dirname, '..', 'lib', 'main.js')
-  const options: cp.ExecFileSyncOptions = {
-    env: process.env
-  }
-  console.log(cp.execFileSync(np, [ip], options).toString())
-})
+test('test runs', () => {})

__tests__/updater-integration.test.ts

@@ -22,27 +22,37 @@ describe('Updater', () => {
       if (!containers) return
 
       containers.forEach(function (containerInfo) {
-        if (containerInfo.Image.includes('docker.pkg.github.com/dependabot/dependabot-updater')) {
-          console.log('removing');
+        if (
+          containerInfo.Image.includes(
+            'docker.pkg.github.com/dependabot/dependabot-updater'
+          )
+        ) {
+          console.log('removing')
 
-          docker.getContainer(containerInfo.Id).remove();
+          docker.getContainer(containerInfo.Id).remove()
         }
-      });
-    });
-  });
+      })
+    })
+  })
 
   jest.setTimeout(20000)
   it('should fetch manifests', async () => {
     mockDependabotAPI.getJobDetails.mockImplementation(() => {
-      return JSON.parse(fs.readFileSync(path.join(__dirname, "fixtures/job-details/npm.json")).toString()).data.attributes
+      return JSON.parse(
+        fs
+          .readFileSync(path.join(__dirname, 'fixtures/job-details/npm.json'))
+          .toString()
+      ).data.attributes
     })
     mockDependabotAPI.getCredentials.mockImplementation(() => {
-      return [{
-        type: "git_source",
-        host: "github.com",
-        username: "x-access-token",
-        password: process.env.GITHUB_TOKEN,
-      }]
+      return [
+        {
+          type: 'git_source',
+          host: 'github.com',
+          username: 'x-access-token',
+          password: process.env.GITHUB_TOKEN
+        }
+      ]
     })
 
     await updater.pullImage()