Add possibility to save to directory

emazzotta · Nov 19, 2018 · cf18b69 · cf18b69
1 parent 630d09c
commit cf18b69
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 1,529 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,6 @@
 [![Greenkeeper badge](https://badges.greenkeeper.io/emazzotta/lighthouse-badges.svg)](https://greenkeeper.io/)
 [![NPM version](https://img.shields.io/npm/v/lighthouse-badges.svg)](https://www.npmjs.org/package/lighthouse-badges)
 [![License](http://img.shields.io/:license-mit-blue.svg?style=flat)](https://emanuelemazzotta.com/mit-license) 
-[![Twitter](https://img.shields.io/badge/Twitter-emazzotta-00aced.svg?style=flat)](https://twitter.com/emazzotta)
 
 # Lighthouse Badges
 
@@ -59,15 +58,16 @@ Required arguments:
 ### Run
 
 ```bash
-# Option 1: Using npm
-npm i -g lighthouse-badges
-# The badges will be saved in your current directory
-lighthouse-badges --urls https://www.youtube.com/ https://www.youtube.com/feed/trending
-
-# Option 2: Using Docker
-docker pull emazzotta/lighthouse-badges
-# Replace $(pwd) with the report/svg save path on your host 
-docker run -v $(pwd):/home/chrome/reports emazzotta/lighthouse-badges /bin/sh -c "lighthouse-badges --urls https://www.youtube.com/ https://www.youtube.com/feed/trending"
+# Option 1: npm
+npm i -g lighthouse-badges && \
+    mkdir test_results && \
+    lighthouse-badges --urls https://www.youtube.com/ https://www.youtube.com/feed/trending -o test_results
+
+# Option 2: Docker
+docker run --rm \
+    -v $PWD/test_results:/home/chrome/reports \
+    emazzotta/lighthouse-badges \
+    /bin/sh -c "lighthouse-badges --urls https://www.youtube.com/ https://www.youtube.com/feed/trending"
 ```
 
 ## Contributing

diff --git a/assets/fonts/Verdana.ttf b/assets/fonts/Verdana.ttf
diff --git a/lib/lighthouse-badges.js b/lib/lighthouse-badges.js
@@ -11,14 +11,19 @@ const { percentageToColor } = require('./calculations');
 const maxBuffer = 1024 * 50000;
 
 
-const metricsToSvg = async (lighthouseMetrics, template, outputPath) => {
+const metricsToSvg = async (lighthouseMetrics, badgeStyle, outputPath) => {
   Object.keys(lighthouseMetrics).map((lighthouseMetricKey) => {
-    const fontPath = path.join(__dirname, '..', 'assets', 'fonts', 'Verdana.ttf');
     const filepath = path.join(outputPath, `${lighthouseMetricKey.replace(/ /g, '_')}.svg`);
     const text = [lighthouseMetricKey, `${lighthouseMetrics[lighthouseMetricKey]}%`];
-    const colorscheme = percentageToColor(lighthouseMetrics[lighthouseMetricKey]);
-    const badgeFactory = new BadgeFactory({ fontPath });
-    const svg = badgeFactory.create({ text, colorscheme, template });
+    const badgeColor = percentageToColor(lighthouseMetrics[lighthouseMetricKey]);
+    const bf = new BadgeFactory();
+    const format = {
+      text,
+      format: 'svg',
+      colorscheme: badgeColor,
+      template: badgeStyle,
+    };
+    const svg = bf.create(format);
     fs.writeFile(filepath, svg, (err) => {
       if (err) {
         throw new Error(`Failed to save svg files to ${outputPath}`);
@@ -83,7 +88,7 @@ const processParameters = async (args, lighthouseMetricFunction) => {
   await generateArtifacts({
     reports,
     svg: { results: metricsResults, style: args.badge_style },
-    path: args.output_path,
+    savePath: args.output_path,
   });
 };
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "lighthouse-badges",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "🚦Generate gh-badges (shields.io) based on Lighthouse performance.",
   "main": "bin/index.js",
   "bin": {
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "argparse": "^1.0.10",
-    "gh-badges": "^2.0.0",
+    "gh-badges": "^2.1.0",
     "lighthouse": "^3.1.1"
   },
   "devDependencies": {