feat(config): add recommended config

README.md

@@ -26,16 +26,31 @@ These are the possible options for the configuration file:
 
 | Option        | Description   | Default |
 | ------------- | ------------- | ------------- |
+| extends | name of a predefined set of configurations | optional |
 | urls | array of URLs to scan | `[]` |
 | extendedInfo | display extended info of the audit | `false` by default. If the audit is not satisfied extendInfo turns true |
 | allAudits| indicates if all audits should be evaluated | `false` |
 | onlyAudits| array of audit keys to evaluate (see below) | `[]` |
 | scores| object of minimum scores per category (see below) to obtain | `{}` |
 
+#### Recommended Options
+
+There is a predefined set of options called 'recommended. This looks like this:
+
+```json
+skipAudits: [
+  "uses-webp-images",
+  "hreflang",
+  "webapp-install-banner",
+  "without-javascript",
+]
+```
+
 #### Example
 
 ```json
 {
+  "extends": "recommended",
   "urls": [
     "https://www.example.com/"
   ],

dist/bundle.js

@@ -1,5 +1,14 @@
 'use strict';
 
+var recommendedOptions = {
+  skipAudits: [
+    'uses-webp-images',
+    'hreflang',
+    'webapp-install-banner',
+    'without-javascript',
+  ],
+};
+
 const fs = require('fs');
 const { argv } = require('yargs');
 
@@ -8,7 +17,18 @@ const getConfig = () => {
   let options = {};
   if (configFile) {
     const data = fs.readFileSync(configFile, 'utf8');
-    options = JSON.parse(data);
+    const parsedOptions = JSON.parse(data);
+
+    options = {
+      ...parsedOptions,
+    };
+
+    if (parsedOptions.extends === 'recommended') {
+      options = {
+        ...recommendedOptions,
+        ...options,
+      };
+    }
   } else {
     const { url } = argv;
     options.urls = [url];

example-config.json

@@ -1,4 +1,5 @@
 {
+  "extends": "recommended",
   "urls": [
     "https://www.example.com/"
   ],

lib/config.js

@@ -1,3 +1,5 @@
+import recommendedOptions from './configs/recommended'
+
 const fs = require('fs')
 const { argv } = require('yargs')
 
@@ -6,7 +8,18 @@ const getConfig = () => {
   let options = {}
   if (configFile) {
     const data = fs.readFileSync(configFile, 'utf8')
-    options = JSON.parse(data)
+    const parsedOptions = JSON.parse(data)
+
+    options = {
+      ...parsedOptions,
+    }
+
+    if (parsedOptions.extends === 'recommended') {
+      options = {
+        ...recommendedOptions,
+        ...options,
+      }
+    }
   } else {
     const { url } = argv
     options.urls = [url]

lib/configs/recommended.js

@@ -0,0 +1,8 @@
+export default {
+  skipAudits: [
+    'uses-webp-images',
+    'hreflang',
+    'webapp-install-banner',
+    'without-javascript',
+  ],
+}