feat: allow publishing the generated html repo (#180)

Author: erezrokah

.eslintrc.js

@@ -13,4 +13,16 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 11,
   },
+  overrides: [
+    {
+      files: ['cypress/**/*.js'],
+      parserOptions: {
+        sourceType: 'module',
+      },
+      env: {
+        'cypress/globals': true,
+      },
+      plugins: ['cypress'],
+    },
+  ],
 };

.gitignore

@@ -3,4 +3,7 @@ node_modules
 .vscode
 yarn-error.log
 # Local Netlify folder
-.netlify
+.netlify
+reports
+cypress/videos
+cypress/screenshots

README.md

@@ -27,6 +27,10 @@ Then add the plugin to your `netlify.toml` configuration file:
     best-practices = 0.9
     seo = 0.9
     pwa = 0.9
+
+  # optional, deploy the lighthouse report to a path under your site
+  [plugins.inputs]
+    output_path = "reports/lighthouse.html"
 ```
 
 By default, the plugin will serve and audit the build directory of the site.
@@ -44,6 +48,9 @@ You can customize the behavior via the `audits` input:
   [[plugins.inputs.audits]]
     path = "route1"
 
+    # you can specify output_path per audit, relative to the path
+    output_path = "reports/route1.html"
+
   # to audit a specific absolute url
   [[plugins.inputs.audits]]
     url = "https://www.example.com"

cypress.json

@@ -0,0 +1 @@
+{}

cypress/integration/e2e.js

@@ -0,0 +1,16 @@
+describe('Generates Lighthouse reports', () => {
+  it('Verify report on root path', () => {
+    cy.visit('/reports/lighthouse.html');
+    cy.contains('Performance');
+  });
+
+  it('Verify report on route1', () => {
+    cy.visit('/route1/reports/route1.html');
+    cy.contains('Performance');
+  });
+
+  it('Verify report on route2', () => {
+    cy.visit('/route2/reports/lighthouse.html');
+    cy.contains('Performance');
+  });
+});

cypress/plugins/index.js

@@ -0,0 +1 @@
+module.exports = () => {}

cypress/support/index.js

@@ -9,6 +9,10 @@ inputs:
     required: false
     description: Key value mapping of thresholds that will fail the build when not passed.
 
+  - name: output_path
+    required: false
+    description: Path to save the generated HTML Lighthouse report
+
   - name: audits
     required: false
     description: A list of audits to perform. Each list item is an object with either a url/path to scan and an optional thresholds mapping.

manifest.yml

@@ -8,12 +8,25 @@ NODE_VERSION = "15"
 [[plugins]]
 package = "./src/index.js"
 
+[plugins.inputs]
+output_path = "reports/lighthouse.html"
+
 [plugins.inputs.thresholds]
 performance = 0.9
 
 [[plugins.inputs.audits]]
+output_path = "reports/route1.html"
 path = "route1"
 [[plugins.inputs.audits]]
 path = "route2"
 [[plugins.inputs.audits]]
 path = ""
+
+[[plugins]]
+package = "netlify-plugin-cypress"
+# do not run tests after deploy
+[plugins.inputs]
+enable = false
+# run tests after build
+[plugins.inputs.postBuild]
+enable = true