Merge pull request #4 from netlify-labs/refactor/use_puppeteer_chrome

Refactor: use puppeteer chrome

Author: erezrokah

.env.example

@@ -0,0 +1,6 @@
+# Url to audit
+AUDIT_URL=https://www.example.com
+# Ignored when AUDIT_URL is configured
+PUBLISH_DIR=FULL_PATH_TO_LOCAL_BUILD_DIRECTORY
+# JSON string of thresholds to enforce
+THRESHOLDS={"performance":0.9,"accessibility":0.9,"best-practices":0.9,"seo":0.9,"pwa":0.9}

.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

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.env
+.vscode

.prettierrc

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

CONTRIBUTING.md

@@ -1,15 +1,18 @@
-## Contributing
+# Contributing
 
-First fork this project.  
+First fork this project
 
-* git clone <your-forked-repo>
-* npm install
+```bash
+git clone <your-forked-repo>
+yarn install
+git checkout -b my-fix
+```
 
-* git checkout -b my-fix
+Then fix some code and
 
-#### fix some code...
+```bash
+git commit -m "added this feature"
+git push origin my-fix
+```
 
-* git commit -m "added this feature"
-* git push origin my-fix
-
-Lastly, open a pull request on Github.
+Lastly, open a pull request on Github.

LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2019-2020 Netlify <[email protected]>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,34 +1,30 @@
-## Netlify Plugin Lighthouse
+# Netlify Plugin Lighthouse
 
-this does a basic lighthouse run and reports and stores the results. if it there has been a previous run, it also diffs
-the results to report improvements.
-
-This shows the diffs:
-
-![image](https://user-images.githubusercontent.com/6764957/62481118-8749c880-b77f-11e9-91d9-44ae028c452b.png)
+A Netlify plugin to generate a lighthouse report for every deploy
 
 ## Usage
 
-Inside your `netlify.yml`:
+This plugin can be included via npm. Install it as a dependency with the following command:
 
-```yaml
-plugins:
-  - type: '@netlify/plugin-lighthouse'
-    config:
-      currentVersion: '0.0.3'
-      compareWithVersion: '0.0.1'
+```bash
+npm install --save "@netlify/plugin-lighthouse"
 ```
 
-you can pin lighthouse result versions:
-
-```yaml
-plugins:
-  - type: '@netlify/plugin-lighthouse'
-    config:
-      currentVersion: '0.0.3'
-      compareWithVersion: '0.0.1'
+To use a build plugin, create a `plugins` in your `netlify.toml` like so:
+
+```toml
+[[plugins]]
+package = "@netlify/plugin-lighthouse"
+  [plugins.inputs]
+  # optional, defaults to scanning the current built version of the site
+  audit_url = 'https://www.my-custom-site.com'
+  # optional, fails build when a category is below a threshold
+  [plugins.inputs.thresholds]
+    performance = 0.9
+    accessibility = 0.9
+    best-practices = 0.9
+    seo = 0.9
+    pwa = 0.9
 ```
 
-## TODO
-
-https://github.com/netlify/build/issues/27
+Run `netlify build` locally to check that the plugin works

commitlint.config.js

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

example/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Empty Site</title>
+  </head>
+  <body>
+    Empty Site
+  </body>
+</html>