rename input to fail_deploy_on_score_thresholds

Author: aitchiss

README.md

@@ -106,7 +106,7 @@ You can add additional configuration and/or inspect a different path, or multipl
 
 By default, the lighthouse plugin will run _after_ your deploy has been successful, auditing the live deploy content.
 
-To run the plugin _before_ the deploy is live, use the `block_deploy_on_failed_threshold` input to instead run during the `onPostBuild` event. 
+To run the plugin _before_ the deploy is live, use the `fail_deploy_on_score_thresholds` input to instead run during the `onPostBuild` event. 
 This will statically serve your build output folder, and audit the `index.html` (or other file if specified as below). Using this configuration, if minimum threshold scores are supplied and not met, the deploy will fail.
 Set the threshold based on `performance`, `accessibility`, `best-practices`, `seo`, or `pwa`.
 
@@ -116,7 +116,7 @@ Set the threshold based on `performance`, `accessibility`, `best-practices`, `se
 
   # Set the plugin to run prior to deploy, failing the build if minimum thresholds aren't set 
   [plugins.inputs]
-    block_deploy_on_failed_threshold = "true"
+    fail_deploy_on_score_thresholds = "true"
 
   # Set minimum thresholds for each report area
   [plugins.inputs.thresholds]

manifest.yml

@@ -21,6 +21,6 @@ inputs:
     required: false
     description: Lighthouse-specific settings, used to modify reporting criteria
 
-  - name: block_deploy_on_failed_threshold
+  - name: fail_deploy_on_score_thresholds
     required: false
-    description: Prevent deploy if minimum threshold scores are not met
+    description: Fail deploy if minimum threshold scores are not met

package.json

@@ -5,7 +5,7 @@
   "main": "src/index.js",
   "scripts": {
     "local": "node -e 'import(\"./src/index.js\").then(index => index.default()).then(events => events.onSuccess());'",
-    "local-onpostbuild": "node -e 'import(\"./src/index.js\").then(index => index.default({block_deploy_on_failed_threshold: \"true\"})).then(events => events.onPostBuild());'",
+    "local-onpostbuild": "node -e 'import(\"./src/index.js\").then(index => index.default({fail_deploy_on_score_thresholds: \"true\"})).then(events => events.onPostBuild());'",
     "lint": "eslint 'src/**/*.js'",
     "format": "prettier --write 'src/**/*.js'",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --collect-coverage --maxWorkers=1",

src/e2e/fail-threshold-onpostbuild.test.js

@@ -45,12 +45,12 @@ describe('lighthousePlugin with failed threshold run (onPostBuild)', () => {
       '- PWA: 30',
     ];
 
-    await lighthousePlugin({block_deploy_on_failed_threshold: 'true'}).onPostBuild({ utils: mockUtils });
+    await lighthousePlugin({fail_deploy_on_score_thresholds: 'true'}).onPostBuild({ utils: mockUtils });
     expect(formatMockLog(console.log.mock.calls)).toEqual(logs);
   });
 
   it('should not output expected success payload', async () => {
-    await lighthousePlugin({block_deploy_on_failed_threshold: 'true'}).onPostBuild({ utils: mockUtils,  });
+    await lighthousePlugin({fail_deploy_on_score_thresholds: 'true'}).onPostBuild({ utils: mockUtils,  });
     expect(mockUtils.status.show).not.toHaveBeenCalledWith();
   });
 
@@ -67,7 +67,7 @@ describe('lighthousePlugin with failed threshold run (onPostBuild)', () => {
       "   'Manifest doesn't have a maskable icon' received a score of 0",
     ];
 
-    await lighthousePlugin({block_deploy_on_failed_threshold: 'true'}).onPostBuild({ utils: mockUtils });
+    await lighthousePlugin({fail_deploy_on_score_thresholds: 'true'}).onPostBuild({ utils: mockUtils });
     const resultError = console.error.mock.calls[0][0];
     expect(stripAnsi(resultError).split('\n').filter(Boolean)).toEqual(error);
   });
@@ -99,7 +99,7 @@ describe('lighthousePlugin with failed threshold run (onPostBuild)', () => {
       ],
     };
 
-    await lighthousePlugin({block_deploy_on_failed_threshold: 'true'}).onPostBuild({ utils: mockUtils });
+    await lighthousePlugin({fail_deploy_on_score_thresholds: 'true'}).onPostBuild({ utils: mockUtils });
     const [resultMessage, resultPayload] =
       mockUtils.build.failBuild.mock.calls[0];
 

src/e2e/not-found-onpostbuild.test.js

@@ -33,7 +33,7 @@ describe('lighthousePlugin with single not-found run (onPostBuild)', () => {
     ];
 
     await lighthousePlugin({
-      block_deploy_on_failed_threshold: 'true',
+      fail_deploy_on_score_thresholds: 'true',
     }).onPostBuild({ utils: mockUtils });
     expect(formatMockLog(console.log.mock.calls)).toEqual(logs);
   });
@@ -55,7 +55,7 @@ describe('lighthousePlugin with single not-found run (onPostBuild)', () => {
     };
 
     await lighthousePlugin({
-      block_deploy_on_failed_threshold: 'true',
+      fail_deploy_on_score_thresholds: 'true',
     }).onPostBuild({ utils: mockUtils });
     expect(mockUtils.status.show).toHaveBeenCalledWith(payload);
   });
@@ -64,7 +64,7 @@ describe('lighthousePlugin with single not-found run (onPostBuild)', () => {
     mockConsoleError();
 
     await lighthousePlugin({
-      block_deploy_on_failed_threshold: 'true',
+      fail_deploy_on_score_thresholds: 'true',
     }).onPostBuild({ utils: mockUtils });
     expect(console.error).not.toHaveBeenCalled();
     expect(mockUtils.build.failBuild).not.toHaveBeenCalled();

src/e2e/success-onpostbuild.test.js

@@ -35,7 +35,7 @@ describe('lighthousePlugin with single report per run (onPostBuild)', () => {
       '- PWA: 30',
     ];
     await lighthousePlugin({
-      block_deploy_on_failed_threshold: 'true',
+      fail_deploy_on_score_thresholds: 'true',
     }).onPostBuild({ utils: mockUtils });
     expect(formatMockLog(console.log.mock.calls)).toEqual(logs);
   });
@@ -65,7 +65,7 @@ describe('lighthousePlugin with single report per run (onPostBuild)', () => {
     };
 
     await lighthousePlugin({
-      block_deploy_on_failed_threshold: 'true',
+      fail_deploy_on_score_thresholds: 'true',
     }).onPostBuild({ utils: mockUtils });
     expect(mockUtils.status.show).toHaveBeenCalledWith(payload);
   });
@@ -74,7 +74,7 @@ describe('lighthousePlugin with single report per run (onPostBuild)', () => {
     mockConsoleError();
 
     await lighthousePlugin({
-      block_deploy_on_failed_threshold: 'true',
+      fail_deploy_on_score_thresholds: 'true',
     }).onPostBuild({ utils: mockUtils });
     expect(console.error).not.toHaveBeenCalled();
     expect(mockUtils.build.failBuild).not.toHaveBeenCalled();

src/index.js

@@ -7,9 +7,9 @@ dotenv.config();
 
 export default function lighthousePlugin(inputs) {
 
-  // Run onSuccess by default, unless inputs specify we should block_deploy_on_failed_threshold
+  // Run onSuccess by default, unless inputs specify we should fail_deploy_on_score_thresholds
   const defaultEvent =
-    inputs?.block_deploy_on_failed_threshold === 'true' 
+    inputs?.fail_deploy_on_score_thresholds === 'true' 
       ? 'onPostBuild'
       : 'onSuccess';
 

src/index.test.js

@@ -3,7 +3,7 @@ import lighthousePlugin from './index.js';
 describe('lighthousePlugin plugin events', () => {
   describe('onPostBuild', () => {
     it('should return only the expected event function', async () => {
-      const events = lighthousePlugin({block_deploy_on_failed_threshold: 'true'});
+      const events = lighthousePlugin({fail_deploy_on_score_thresholds: 'true'});
       expect(events).toEqual({
         onPostBuild: expect.any(Function),
       });