ES2015ify and require Node.js 4

Author: sindresorhus

.gitattributes

@@ -1 +1,2 @@
 * text=auto
+*.js text eol=lf

.travis.yml

@@ -1,7 +1,5 @@
 sudo: false
 language: node_js
 node_js:
-  - '5'
+  - '6'
   - '4'
-  - '0.12'
-  - '0.10'

README.md

@@ -19,21 +19,21 @@ $ npm install --save psi
 ```js
 const psi = require('psi');
 
-// get the PageSpeed Insights report
+// Get the PageSpeed Insights report
 psi('theverge.com').then(data => {
   console.log(data.ruleGroups.SPEED.score);
   console.log(data.pageStats);
 });
 
-// output a formatted report to the terminal
+// Output a formatted report to the terminal
 psi.output('theverge.com').then(() => {
   console.log('done');
 });
 
 // Supply options to PSI and get back speed and usability scores
 psi('theverge.com', {nokey: 'true', strategy: 'mobile'}).then(data => {
-  console.log('Speed score: ' + data.ruleGroups.SPEED.score);
-  console.log('Usability score: ' + data.ruleGroups.USABILITY.score);
+  console.log('Speed score:', data.ruleGroups.SPEED.score);
+  console.log('Usability score:', data.ruleGroups.USABILITY.score);
 });
 ```
 
@@ -44,7 +44,7 @@ As of PSI 2.x, we expose both the PageSpeed Insights speed and usability scores.
 
 ### psi(url, [options])
 
-Returns a promise for the response data from Google PageSpeed Insights.
+Returns a `Promise` for the response data from Google PageSpeed Insights.
 
 #### url
 
@@ -54,7 +54,7 @@ URL of the page for which the PageSpeed Insights API should generate results.
 
 #### options
 
-Type: `object`
+Type: `Object`
 
 ##### key
 
@@ -67,7 +67,7 @@ When using this module for a production-level build process, registering for an
 
 Type: `string`<br>
 Default: `mobile`<br>
-Values: `mobile`, `desktop`
+Values: `mobile` `desktop`
 
 Strategy to use when analyzing the page.
 
@@ -106,25 +106,25 @@ $ psi --help
   Usage
     $ psi <url>
 
-  Example
-    $ psi todomvc.com --strategy=mobile
-
   Options
-    --key        Google API Key. By default the free tier is used.
+    --key        Google API Key. By default the free tier is used
     --strategy   Strategy to use when analyzing the page: mobile|desktop
-    --format     Output format: cli|json|tap
-    --locale     Locale results should be generated in.
-    --threshold  Threshold score to pass the PageSpeed test.
-    --optimized  Get the URL of optimized resources.
-    --download   Download optimized resources.
+    --format     Output format: cli|json|ta
+    --locale     Locale results should be generated in
+    --threshold  Threshold score to pass the PageSpeed tes
+    --optimized  Get the URL of optimized resources
+    --download   Download optimized resources
+
+  Example
+    $ psi todomvc.com --strategy=mobile
 ```
 
 
 ## Getting PSI into your build process
 
 A sample [Gulp](https://github.com/addyosmani/psi-gulp-sample) project using PSI is available.
 
-If you use Grunt, [grunt-pagespeed](https://github.com/jrcryer/grunt-pagespeed) is a task by James Cryer that uses PSI under the hood.
+If you use Grunt, [`grunt-pagespeed`](https://github.com/jrcryer/grunt-pagespeed) is a task by James Cryer that uses PSI under the hood.
 
 For testing local project, we recommend using [ngrok](http://www.jamescryer.com/2014/06/12/grunt-pagespeed-and-ngrok-locally-testing/).
 

cli.js

@@ -1,36 +1,36 @@
 #!/usr/bin/env node
 'use strict';
-var meow = require('meow');
-var updateNotifier = require('update-notifier');
-var psi = require('./');
+const meow = require('meow');
+const updateNotifier = require('update-notifier');
+const psi = require('.');
 
-var cli = meow([
-  'Usage',
-  '  $ psi <url>',
-  '',
-  'Example',
-  '  $ psi todomvc.com --strategy=mobile',
-  '',
-  'Options',
-  '  --key        Google API Key. By default the free tier is used.',
-  '  --strategy   Strategy to use when analyzing the page: mobile|desktop',
-  '  --format     Output format: cli|json|tap',
-  '  --locale     Locale results should be generated in.',
-  '  --threshold  Threshold score to pass the PageSpeed test.',
-  '  --optimized  Get the URL of optimized resources.',
-  '  --download   Download optimized resources.'
-]);
+const cli = meow(`
+  Usage
+    $ psi <url>
+
+  Options
+    --key        Google API Key. By default the free tier is used
+    --strategy   Strategy to use when analyzing the page: mobile|desktop
+    --format     Output format: cli|json|ta
+    --locale     Locale results should be generated in
+    --threshold  Threshold score to pass the PageSpeed tes
+    --optimized  Get the URL of optimized resources
+    --download   Download optimized resources
+
+  Example
+    $ psi todomvc.com --strategy=mobile
+`);
 
 updateNotifier({pkg: cli.pkg}).notify();
 
 if (!cli.input[0]) {
-  console.error('Please specify a URL');
+  console.error('Specify a URL');
   process.exit(1);
 }
 
-psi.output(cli.input[0], cli.flags).then(function () {
+psi.output(cli.input[0], cli.flags).then(() => {
   process.exit();
-}).catch(function (err) {
+}).catch(err => {
   if (err.noStack) {
     console.error(err.message);
     process.exit(1);

index.js

@@ -1,21 +1,20 @@
 'use strict';
-var Promise = require('pinkie-promise');
-var googleapis = require('googleapis');
-var prependHttp = require('prepend-http');
-var objectAssign = require('object-assign');
-var pify = require('pify');
-var pagespeed = pify(googleapis.pagespeedonline('v2').pagespeedapi.runpagespeed, Promise);
-var output = require('./lib/output');
+const googleapis = require('googleapis');
+const prependHttp = require('prepend-http');
+const pify = require('pify');
+const output = require('./lib/output');
+
+const pagespeed = pify(googleapis.pagespeedonline('v2').pagespeedapi.runpagespeed);
 
 function handleOpts(url, opts) {
-  opts = objectAssign({strategy: 'mobile'}, opts);
+  opts = Object.assign({strategy: 'mobile'}, opts);
   opts.nokey = opts.key === undefined;
   opts.url = prependHttp(url);
   return opts;
 }
 
-var psi = module.exports = function (url, opts) {
-  return Promise.resolve().then(function () {
+const psi = module.exports = (url, opts) => {
+  return Promise.resolve().then(() => {
     if (!url) {
       throw new Error('URL required');
     }
@@ -24,8 +23,4 @@ var psi = module.exports = function (url, opts) {
   });
 };
 
-module.exports.output = function (url, opts) {
-  return psi(url, opts).then(function (data) {
-    return output(handleOpts(url, opts), data);
-  });
-};
+module.exports.output = (url, opts) => psi(url, opts).then(data => output(handleOpts(url, opts), data));

lib/formats/cli.js

@@ -1,26 +1,22 @@
 'use strict';
-var _ = require('lodash');
-var chalk = require('chalk');
-var utils = require('../utils');
+const _ = require('lodash');
+const chalk = require('chalk');
+const utils = require('../utils');
 
-module.exports = function (overview, statistics, ruleSetResults) {
-  var renderOverview = function (item) {
-    var color = item.label === 'Score' ? utils.scoreColor(item.value) : chalk.cyan;
+module.exports = (overview, statistics, ruleSetResults) => {
+  const renderOverview = item => {
+    const color = item.label === 'Score' ? utils.scoreColor(item.value) : chalk.cyan;
     return item.label + ':' + utils.buffer(item.label, 11) + color(item.value);
   };
 
-  var renderSection = function (item) {
-    return utils.labelize(item.label) + chalk.cyan(item.value);
-  };
+  const renderSection = item => utils.labelize(item.label) + chalk.cyan(item.value);
 
   return [
     utils.divider,
     _.map(overview, renderOverview).join('\n') + '\n',
     _.map(statistics, renderSection).join('\n'),
     '',
-    _.map(ruleSetResults.filter(function (el) {
-      return el.value > 0;
-    }), renderSection).join('\n'),
+    _.map(ruleSetResults.filter(x => x.value > 0), renderSection).join('\n'),
     utils.divider
   ].join('\n');
 };

lib/formats/json.js

@@ -1,22 +1,17 @@
 'use strict';
-var _ = require('lodash');
+const _ = require('lodash');
 
-module.exports = function (overview, statistics, ruleSetResults) {
-  var mapSection = function (section) {
-    return section.label;
-  };
-
-  var zip = function (section, labelMapping) {
-    return _.zipObject(_.map(section, labelMapping), _.map(section, 'value'));
-  };
+module.exports = (overview, statistics, ruleSetResults) => {
+  const mapSection = section => section.label;
+  const zip = (section, labelMapping) => _.zipObject(_.map(section, labelMapping), _.map(section, 'value'));
 
   overview = zip(overview, 'label');
   statistics = zip(statistics, mapSection);
   ruleSetResults = zip(ruleSetResults, mapSection);
 
   return JSON.stringify({
-    overview: overview,
-    statistics: statistics,
+    overview,
+    statistics,
     ruleResults: ruleSetResults
   }, null, 2);
 };

lib/formats/tap.js

@@ -1,9 +1,9 @@
 'use strict';
-module.exports = function (overview, statistics, ruleSetResults, threshold) {
-  var outputTest = function (overview, threshold) {
-    var score = overview[1].value;
-    var result = score < threshold ? 'not ok' : 'ok';
-    return result + ' 1 - psi';
+module.exports = (overview, statistics, ruleSetResults, threshold) => {
+  const outputTest = (overview, threshold) => {
+    const score = overview[1].value;
+    const result = score < threshold ? 'not ok' : 'ok';
+    return `${result} 1 - psi`;
   };
 
   return [

lib/output.js

@@ -1,16 +1,16 @@
 'use strict';
-var Promise = require('pinkie-promise');
-var prettyBytes = require('pretty-bytes');
-var sortOn = require('sort-on');
-var humanizeUrl = require('humanize-url');
-var Download = require('download');
-var querystring = require('querystring');
-var pify = require('pify');
-var THRESHOLD = 70;
-var RESOURCE_URL = 'https://developers.google.com/speed/pagespeed/insights/optimizeContents?';
+const querystring = require('querystring');
+const prettyBytes = require('pretty-bytes');
+const sortOn = require('sort-on');
+const humanizeUrl = require('humanize-url');
+const Download = require('download');
+const pify = require('pify');
+
+const THRESHOLD = 70;
+const RESOURCE_URL = 'https://developers.google.com/speed/pagespeed/insights/optimizeContents?';
 
 function overview(url, strategy, scores) {
-  var ret = [];
+  const ret = [];
 
   ret.push({
     label: 'URL',
@@ -38,10 +38,10 @@ function overview(url, strategy, scores) {
 }
 
 function ruleSetResults(rulesets) {
-  var ret = [];
+  const ret = [];
 
-  for (var title in rulesets) {
-    if (rulesets.hasOwnProperty(title)) {
+  for (const title in rulesets) {
+    if (Object.prototype.hasOwnProperty.call(rulesets, title)) {
       ret.push({
         label: title,
         value: Math.ceil(rulesets[title].ruleImpact * 100) / 100
@@ -53,10 +53,10 @@ function ruleSetResults(rulesets) {
 }
 
 function statistics(stats) {
-  var ret = [];
+  const ret = [];
 
-  for (var title in stats) {
-    if (stats.hasOwnProperty(title)) {
+  for (const title in stats) {
+    if (Object.prototype.hasOwnProperty.call(stats, title)) {
       ret.push({
         label: title,
         value: title.indexOf('Bytes') === -1 ? stats[title] : prettyBytes(Number(stats[title]))
@@ -69,14 +69,14 @@ function statistics(stats) {
 
 function getReporter(format) {
   format = ['cli', 'json', 'tap'].indexOf(format) === -1 ? 'cli' : format;
-  return require('./formats/' + format);
+  return require(`./formats/${format}`); // eslint-disable-line import/no-dynamic-require
 }
 
-module.exports = function (parameters, response) {
-  return Promise.resolve().then(function () {
-    var renderer = getReporter(parameters.format);
-    var threshold = typeof parameters.threshold === 'number' ? parameters.threshold : THRESHOLD;
-    var optimizedResourceURL = RESOURCE_URL + querystring.stringify({url: response.id, strategy: parameters.strategy});
+module.exports = (parameters, response) => {
+  return Promise.resolve().then(() => {
+    const renderer = getReporter(parameters.format);
+    const threshold = typeof parameters.threshold === 'number' ? parameters.threshold : THRESHOLD;
+    const optimizedResourceURL = RESOURCE_URL + querystring.stringify({url: response.id, strategy: parameters.strategy});
 
     console.log(renderer(
       overview(humanizeUrl(response.id), parameters.strategy, response.ruleGroups),
@@ -86,21 +86,20 @@ module.exports = function (parameters, response) {
     ));
 
     if (parameters.optimized) {
-      console.log('\nHere are your optimized images: ', humanizeUrl(optimizedResourceURL));
+      console.log('\nHere are your optimized images:', humanizeUrl(optimizedResourceURL));
     }
 
     if (response.ruleGroups.SPEED.score < threshold) {
-      var err = new Error('Threshold of ' + threshold + ' not met with score of ' + response.ruleGroups.SPEED.score);
-      throw err;
+      throw new Error(`Threshold of ${threshold} not met with score of ${response.ruleGroups.SPEED.score}`);
     }
 
     if (parameters.download) {
-      var download = new Download()
+      const download = new Download()
         .get(optimizedResourceURL)
         .dest('.')
         .rename('./optimized.zip');
 
-      return pify(download.run.bind(download), Promise)();
+      return pify(download.run.bind(download))();
     }
   });
 };