chore: add eslint, prettier, github action

Author: erezrokah

.eslintrc.js

@@ -0,0 +1,15 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true,
+  },
+  extends: 'eslint:recommended',
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly',
+  },
+  parserOptions: {
+    ecmaVersion: 11,
+  },
+};

.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Node CI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*'
+
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v2
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: log versions
+        run: node --version && npm --version && yarn --version
+      - name: install dependencies
+        run: yarn --frozen-lockfile
+      - name: run linter
+        run: yarn lint
+      - name: check formatting
+        run: yarn format:ci

.prettierrc

@@ -0,0 +1,14 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "useTabs": false,
+  "overrides": [
+    {
+      "files": "*.json",
+      "options": { "printWidth": 200 }
+    }
+  ]
+}

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

package.json

@@ -1,11 +1,15 @@
 {
   "name": "@netlify/plugin-lighthouse",
   "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
+  "description": "Netlify Plugin to run Lighthouse on each build",
+  "main": "src/index.js",
   "scripts": {
-    "local": "node -e 'require(\"./index.js\").onSuccess()'",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "local": "node -e 'require(\"./src/index.js\").onSuccess()'",
+    "lint": "eslint 'src/**/*.js'",
+    "format": "prettier --write 'src/**/*.js'",
+    "format:ci": "prettier --check 'src/**/*.js'",
+    "tag": "git tag \"v$npm_package_version\" && git push --tags",
+    "postpublish": "npm run tag"
   },
   "keywords": [
     "netlify",
@@ -23,5 +27,17 @@
   },
   "engines": {
     "node": ">=10.13"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^8.1.0",
+    "@commitlint/config-conventional": "^8.1.0",
+    "eslint": "^7.0.0",
+    "husky": "^4.0.7",
+    "prettier": "^2.0.0"
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
   }
 }

index.js renamed to src/index.js

@@ -1,8 +1,8 @@
-const httpServer = require("http-server");
-const puppeteer = require("puppeteer");
-const lighthouse = require("lighthouse");
-const chromeLauncher = require("chrome-launcher");
-require("dotenv").config();
+const httpServer = require('http-server');
+const puppeteer = require('puppeteer');
+const lighthouse = require('lighthouse');
+const chromeLauncher = require('chrome-launcher');
+require('dotenv').config();
 
 const getServer = (url, serveDir) => {
   if (url) {
@@ -18,13 +18,13 @@ const getServer = (url, serveDir) => {
   }
 
   if (!serveDir) {
-    throw new Error("Empty publish dir");
+    throw new Error('Empty publish dir');
   }
 
   console.log(`Serving and scanning site from directory '${serveDir}'`);
   const s = httpServer.createServer({ root: serveDir });
   const port = 5000;
-  const host = "localhost";
+  const host = 'localhost';
   const server = {
     listen: (func) => s.listen(port, host, func),
     close: () => s.close(),
@@ -35,7 +35,7 @@ const getServer = (url, serveDir) => {
 const belowThreshold = (id, expected, results) => {
   const category = results.find((c) => c.id === id);
   if (!category) {
-    console.warn("Could not find category", id);
+    console.warn('Could not find category', id);
   }
   const actual = category ? category.score : Number.MAX_SAFE_INTEGER;
   return actual < expected;
@@ -67,15 +67,15 @@ module.exports = {
         },
       };
 
-      if (typeof thresholds === "string") {
+      if (typeof thresholds === 'string') {
         thresholds = JSON.parse(thresholds);
       }
 
       const { server, url } = getServer(auditUrl, serveDir);
       const browserFetcher = puppeteer.createBrowserFetcher();
       const revisions = await browserFetcher.localRevisions();
       if (revisions.length <= 0) {
-        throw new Error("Could not find local browser");
+        throw new Error('Could not find local browser');
       }
       const info = await browserFetcher.revisionInfo(revisions[0]);
 
@@ -85,7 +85,7 @@ module.exports = {
           try {
             chrome = await chromeLauncher.launch({
               chromePath: info.executablePath,
-              chromeFlags: ["--headless", "--no-sandbox", "--disable-gpu"],
+              chromeFlags: ['--headless', '--no-sandbox', '--disable-gpu'],
             });
             const results = await lighthouse(url, {
               port: chrome.port,
@@ -108,7 +108,7 @@ module.exports = {
         throw error;
       } else {
         const categories = Object.values(
-          results.lhr.categories
+          results.lhr.categories,
         ).map(({ title, score, id }) => ({ title, score, id }));
 
         const errors = Object.entries(thresholds)
@@ -122,7 +122,7 @@ module.exports = {
         });
 
         if (errors.length > 0) {
-          throw new Error(errors.join("\n"));
+          throw new Error(errors.join('\n'));
         }
       }
     } catch (error) {