fix: Remove unused polyfills and update build config

Removes polyfills for `Object.assign` and `Set` which, as far as I can tell, are unused in the
codebase. Updates `webpack` from 3 to 4. Replaces `babel-preset-es2015` with `babel-preset-env`.
Reduces the minified bundle size (`feather.min.js`) by **9.3kB** (72.4kB to 63.1kB). Does not change
any functionality of the library.

.babelrc

@@ -1,4 +1,13 @@
 {
-  "presets": ["es2015"],
-  "plugins": ["transform-object-rest-spread"]
+  "presets": [
+    [
+      "env",
+      {
+        "targets": {
+          "browsers": ["last 2 versions"]
+        }
+      }
+    ],
+    "stage-2"
+  ]
 }

.eslintignore

@@ -1 +1,2 @@
-dist
+dist
+coverage

.gitignore

@@ -3,3 +3,4 @@ node_modules
 dist
 sandbox
 stash
+coverage

.travis.yml

@@ -8,6 +8,12 @@ node_js: 8
 before_script:
   - npm prune
 script:
-  - npm start
+  - npm run all
 after_success:
-  - npm run semantic-release
+  - npx codecov
+  - npx babel-node ./bin/sync-algolia.js
+deploy:
+  provider: script
+  skip_cleanup: true
+  script:
+    - npx semantic-release

README.md

@@ -1,9 +1,11 @@
 # Feather
 
-[![Travis branch](https://img.shields.io/travis/feathericons/feather/master.svg?style=flat-square)](https://travis-ci.org/feathericons/feather)
-[![npm downloads](https://img.shields.io/npm/dm/feather-icons.svg?style=flat-square)](https://npm-stat.com/charts.html?package=feather-icons&from=2017-06-01)
+[![Build status](https://img.shields.io/travis/feathericons/feather/master.svg?style=flat-square)](https://travis-ci.org/feathericons/feather)
+[![Coverage](https://img.shields.io/codecov/c/github/feathericons/feather/master.svg?style=flat-square)](https://codecov.io/gh/feathericons/feather)
+[![npm downloads](https://img.shields.io/npm/dm/feather-icons.svg?style=flat-square)](https://www.npmjs.com/package/feather-icons)
 [![npm version](https://img.shields.io/npm/v/feather-icons.svg?style=flat-square)](https://www.npmjs.com/package/feather-icons)
 [![CDNJS version](https://img.shields.io/cdnjs/v/feather-icons.svg?style=flat-square)](https://cdnjs.com/libraries/feather-icons)
+[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=G6CPFZ6PQRZW8&lc=US&item_name=Feather&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)
 
 ## What is Feather?
 
@@ -25,13 +27,14 @@ npm install feather-icons
 
 * [Quick Start](#quick-start)
 * [Usage](#usage)
-  * [Client-side](#client-side)
+  * [Client-side JavaScript](#client-side-javascript)
   * [Node](#node)
+  * [SVG Sprite](#svg-sprite)
 * [API Reference](#api-reference)
 	* [`feather.icons`](#feathericons)
 	* [`feather.icons[name].toSvg()`](#feathericonsnametosvgattrs)
 	* [`feather.replace()`](#featherreplaceattrs)
-	* [[Deprecated] `feather.toSvg()`](#deprecated-feathertosvgname-attrs)
+	* [(DEPRECATED) `feather.toSvg()`](#deprecated-feathertosvgname-attrs)
 * [Roadmap](#roadmap)
 * [Contributing](#contributing)
 * [Related Projects](#related-projects)
@@ -66,7 +69,7 @@ At its core, Feather is a collection of [SVG](https://svgontheweb.com/#svg) file
 
 The following are additional ways you can use Feather.
 
-### Client-side
+### Client-side JavaScript
 
 #### 1. Install
 
@@ -166,6 +169,60 @@ feather.icons.x.toSvg({ class: 'foo bar', 'stroke-width': 1, color: 'red' })
 
 See the [API Reference](#api-reference) for more information about the available properties and methods of the `feather` object.
 
+### SVG Sprite
+
+#### 1. Install
+
+> **Note:** If you intend to use Feather with a CDN, you can skip this installation step.
+
+Install with [npm](https://docs.npmjs.com/getting-started/what-is-npm).
+
+```
+npm install feather-icons --save
+```
+
+Or just copy [`feather-sprite.svg`](https://unpkg.com/feather-icons/dist/feather-sprite.svg) into your project directory.
+
+#### 2. Use
+
+In your HTML, you can include an icon like so:
+
+```html
+<svg
+  width="24"
+  height="24"
+  fill="none"
+  stroke="currentColor"
+  stroke-width="2"
+  stroke-linecap="round"
+  stroke-linejoin="round"
+>
+  <use xlink:href="path/to/feather-sprite.svg#circle"/>
+</svg>
+```
+
+> **Note:** `circle` in the above example can be replaced with any valid icon name. See the complete list of icon names at [feathericons.com](https://feathericons.com).
+
+However, this markup can be simplified using a simple CSS class to avoid repetition of SVG attributes between icons.
+
+```css
+.feather {
+  width: 24px;
+  height: 24px;
+  stroke: currentColor;
+  stroke-width: 2;
+  stroke-linecap: round;
+  stroke-linejoin: round;
+  fill: none;
+}
+```
+
+```html
+<svg class="feather">
+  <use xlink:href="path/to/dist/feather-sprite.svg#circle"/>
+</svg>
+```
+
 ## API Reference
 
 ### `feather.icons`
@@ -198,6 +255,8 @@ feather.icons.x.toString()
 // '<line ... /><line ... />'
 ```
 
+> **Note:** `x` in the above example can be replaced with any valid icon name. See the complete list of icon names at [feathericons.com](https://feathericons.com). Icons with multi-word names (e.g. `arrow-right`) **cannot** be accessed using dot notation (e.g. `feather.icons.x`). Instead, use bracket notation (e.g. `feather.icons['arrow-right']`).
+
 [View Source](https://github.com/colebemis/feather/blob/master/src/icons.js)
 
 ---
@@ -287,7 +346,7 @@ All attributes on the placeholder element (i.e. `<i>`) will be copied to the `<s
 
 ---
 
-### [Deprecated] `feather.toSvg(name, [attrs])`
+### (DEPRECATED) `feather.toSvg(name, [attrs])`
 
 > **Note:** `feather.toSvg()` is deprecated. Please use `feather.icons[name].toSvg()` instead.
 
@@ -318,7 +377,6 @@ feather.toSvg('circle', { class: 'foo bar' })
 ## Roadmap
 
 - [ ] Write icon design guidelines
-- [ ] Track code coverage
 - [ ] Improve SVG accessibility
 - [ ] Handle usage of custom icons
 - [ ] Add usage examples

bin/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "rules": {
+    "import/no-extraneous-dependencies": "off",
+    "no-console": "off"
+  }
+}

bin/__tests__/__snapshots__/build-sprite-string.test.js.snap

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`builds sprite correctly 1`] = `"<svg xmlns=\\"http://www.w3.org/2000/svg\\"><defs><symbol id=\\"icon1\\" viewBox=\\"0 0 24 24\\"><line x1=\\"23\\" y1=\\"1\\" x2=\\"1\\" y2=\\"23\\"></line><line x1=\\"1\\" y1=\\"1\\" x2=\\"23\\" y2=\\"23\\"></line></symbol><symbol id=\\"icon2\\" viewBox=\\"0 0 24 24\\"><circle cx=\\"12\\" cy=\\"12\\" r=\\"11\\"></circle></symbol></defs></svg>"`;

bin/__tests__/build-sprite-string.test.js

@@ -0,0 +1,12 @@
+/* eslint-env jest */
+import buildSpriteString from '../build-sprite-string';
+
+const icons = {
+  icon1:
+    '<line x1="23" y1="1" x2="1" y2="23"></line><line x1="1" y1="1" x2="23" y2="23"></line>',
+  icon2: '<circle cx="12" cy="12" r="11"></circle>',
+};
+
+test('builds sprite correctly', () => {
+  expect(buildSpriteString(icons)).toMatchSnapshot();
+});

bin/build-icons-json.js

@@ -6,7 +6,7 @@ import buildIconsObject from './build-icons-object';
 const IN_DIR = path.resolve(__dirname, '../icons');
 const OUT_FILE = path.resolve(__dirname, '../dist/icons.json');
 
-console.log(`Building ${OUT_FILE}`); // eslint-disable-line no-console
+console.log(`Building ${OUT_FILE}...`);
 
 const svgFiles = fs
   .readdirSync(IN_DIR)

bin/build-icons-object.js

@@ -1,12 +1,11 @@
-/* eslint-disable import/no-extraneous-dependencies */
 import path from 'path';
 import cheerio from 'cheerio';
 import { minify } from 'html-minifier';
 
 /**
  * Build an object in the format: `{ <name>: <contents> }`.
- * @param {string[]} svgFiles - A list of file names.
- * @param {Function} getSvg - A function that returns the contents of an SVG file.
+ * @param {string[]} svgFiles - A list of filenames.
+ * @param {Function} getSvg - A function that returns the contents of an SVG file given a filename.
  * @returns {Object}
  */
 function buildIconsObject(svgFiles, getSvg) {
@@ -26,6 +25,7 @@ function buildIconsObject(svgFiles, getSvg) {
 /**
  * Get contents between opening and closing `<svg>` tags.
  * @param {string} svg
+ * @returns {string}
  */
 function getSvgContents(svg) {
   const $ = cheerio.load(svg);

bin/build-sprite-string.js

@@ -0,0 +1,28 @@
+import DEFAULT_ATTRS from '../src/default-attrs.json';
+
+/**
+ * Build an SVG sprite string containing SVG symbols.
+ * @param {Object} icons
+ * @returns {string}
+ */
+function buildSpriteString(icons) {
+  const symbols = Object.keys(icons)
+    .map(icon => toSvgSymbol(icon, icons[icon]))
+    .join('');
+
+  return `<svg xmlns="${DEFAULT_ATTRS.xmlns}"><defs>${symbols}</defs></svg>`;
+}
+
+/**
+ * Create an SVG symbol string.
+ * @param {string} name - Icon name
+ * @param {string} contents - SVG contents
+ * @returns {string}
+ */
+function toSvgSymbol(name, contents) {
+  return `<symbol id="${name}" viewBox="${DEFAULT_ATTRS.viewBox}">${
+    contents
+  }</symbol>`;
+}
+
+export default buildSpriteString;

bin/build-sprite.js

@@ -0,0 +1,10 @@
+import fs from 'fs';
+import path from 'path';
+import icons from '../dist/icons.json';
+import buildSpriteString from './build-sprite-string';
+
+const OUT_FILE = path.resolve(__dirname, '../dist/feather-sprite.svg');
+
+console.log(`Building ${OUT_FILE}...`);
+
+fs.writeFileSync(OUT_FILE, buildSpriteString(icons));

bin/build-svgs.js

@@ -4,7 +4,7 @@ import icons from '../src/icons';
 
 const OUT_DIR = path.resolve(__dirname, '../dist/icons');
 
-console.log(`Building SVGs in ${OUT_DIR}`); // eslint-disable-line no-console
+console.log(`Building SVGs in ${OUT_DIR}...`);
 
 Object.keys(icons).forEach(name => {
   const svg = icons[name].toSvg();

bin/build.sh

@@ -1,14 +1,25 @@
 #!/bin/bash
 
+# Process SVG files
 ./node_modules/.bin/babel-node bin/process-svgs.js
 
+# Create dist directory
 ./node_modules/.bin/rimraf dist
 mkdir dist
+
+# Build icons.json
 ./node_modules/.bin/babel-node bin/build-icons-json.js
 
+# Build SVG sprite
+./node_modules/.bin/babel-node bin/build-sprite.js
+
+# Create dist/icons directory
 ./node_modules/.bin/rimraf dist/icons
 mkdir dist/icons
+
+# Build SVG icons
 ./node_modules/.bin/babel-node bin/build-svgs.js
 
-./node_modules/.bin/webpack --output-filename feather.js
-./node_modules/.bin/webpack --output-filename feather.min.js -p
+# Build JavaScript library
+./node_modules/.bin/webpack --output-filename feather.js --mode development
+./node_modules/.bin/webpack --output-filename feather.min.js --mode production

bin/process-svg.js

@@ -1,4 +1,3 @@
-/* eslint-disable import/no-extraneous-dependencies */
 import Svgo from 'svgo';
 import cheerio from 'cheerio';
 import { format } from 'prettier';

bin/process-svgs.js

@@ -5,7 +5,7 @@ import processSvg from './process-svg';
 
 const IN_DIR = path.resolve(__dirname, '../icons');
 
-console.log(`Processing SVGs in ${IN_DIR}`); // eslint-disable-line no-console
+console.log(`Processing SVGs in ${IN_DIR}...`);
 
 fs
   .readdirSync(IN_DIR)

bin/sync-algolia.js

@@ -0,0 +1,36 @@
+import algolia from 'algoliasearch';
+import icons from '../dist/icons.json';
+import tags from '../src/tags.json';
+
+const ALGOLIA_APP_ID = '5EEOG744D0';
+
+if (
+  process.env.TRAVIS_PULL_REQUEST === 'false' &&
+  process.env.TRAVIS_BRANCH === 'master'
+) {
+  console.log('Syncing Algolia records...');
+  syncAlgolia();
+} else {
+  console.log('Skipped Algolia sync.');
+}
+
+function syncAlgolia() {
+  const client = algolia(ALGOLIA_APP_ID, process.env.ALGOLIA_ADMIN_KEY);
+
+  const index = client.initIndex('icons');
+
+  const records = Object.keys(icons).map(name => ({
+    name,
+    tags: tags[name] || [],
+  }));
+
+  index.clearIndex((err, content) => {
+    if (err) throw err;
+    console.log(content);
+
+    index.addObjects(records, (err, content) => {
+      if (err) throw err;
+      console.log(content);
+    });
+  });
+}

commitlint.config.js

@@ -1,6 +1,8 @@
 module.exports = {
-  extends: ['@commitlint/config-angular'],
+  extends: ['@commitlint/config-conventional'],
   rules: {
-    'subject-case': 'sentence-case',
+    'scope-case': [0],
+    'subject-case': [2, 'always', 'sentence-case'],
+    'header-max-length': [0],
   },
 };

icons/archive.svg

@@ -0,0 +1,15 @@
+<svg
+  xmlns="http://www.w3.org/2000/svg"
+  width="24"
+  height="24"
+  viewBox="0 0 24 24"
+  fill="none"
+  stroke="currentColor"
+  stroke-width="2"
+  stroke-linecap="round"
+  stroke-linejoin="round"
+>
+  <polyline points="21 8 21 21 3 21 3 8" />
+  <rect x="1" y="3" width="22" height="5" />
+  <line x1="10" y1="12" x2="14" y2="12" />
+</svg>

icons/gift.svg

@@ -0,0 +1,17 @@
+<svg
+  xmlns="http://www.w3.org/2000/svg"
+  width="24"
+  height="24"
+  viewBox="0 0 24 24"
+  fill="none"
+  stroke="currentColor"
+  stroke-width="2"
+  stroke-linecap="round"
+  stroke-linejoin="round"
+>
+  <polyline points="20 12 20 22 4 22 4 12" />
+  <rect x="2" y="7" width="20" height="5" />
+  <line x1="12" y1="22" x2="12" y2="7" />
+  <path d="M12 7H7.5a2.5 2.5 0 0 1 0-5C11 2 12 7 12 7z" />
+  <path d="M12 7h4.5a2.5 2.5 0 0 0 0-5C13 2 12 7 12 7z" />
+</svg>

icons/help-circle.svg

@@ -9,7 +9,7 @@
   stroke-linecap="round"
   stroke-linejoin="round"
 >
-  <path d="M9.09 9a3 3 0 0 1 5.83 1c0 2-3 3-3 3" />
   <circle cx="12" cy="12" r="10" />
+  <path d="M9.09 9a3 3 0 0 1 5.83 1c0 2-3 3-3 3" />
   <line x1="12" y1="17" x2="12" y2="17" />
 </svg>

icons/youtube.svg

@@ -0,0 +1,14 @@
+<svg
+  xmlns="http://www.w3.org/2000/svg"
+  width="24"
+  height="24"
+  viewBox="0 0 24 24"
+  fill="none"
+  stroke="currentColor"
+  stroke-width="2"
+  stroke-linecap="round"
+  stroke-linejoin="round"
+>
+  <path d="M22.54 6.42a2.78 2.78 0 0 0-1.94-2C18.88 4 12 4 12 4s-6.88 0-8.6.46a2.78 2.78 0 0 0-1.94 2A29 29 0 0 0 1 11.75a29 29 0 0 0 .46 5.33A2.78 2.78 0 0 0 3.4 19c1.72.46 8.6.46 8.6.46s6.88 0 8.6-.46a2.78 2.78 0 0 0 1.94-2 29 29 0 0 0 .46-5.25 29 29 0 0 0-.46-5.33z" />
+  <polygon points="9.75 15.02 15.5 11.75 9.75 8.48 9.75 15.02" />
+</svg>

package.json

@@ -7,50 +7,56 @@
     "dist"
   ],
   "scripts": {
-    "start": "npm-run-all --sequential build lint test",
+    "all": "npm-run-all --sequential build lint test:coverage",
     "build": "./bin/build.sh",
     "lint": "eslint .",
-    "test": "jest",
+    "test": "jest --watch",
+    "test:coverage": "jest --coverage",
     "cm": "git-cz",
     "precommit": "lint-staged",
-    "commitmsg": "commitlint --edit",
-    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+    "commitmsg": "commitlint --edit"
   },
   "config": {
     "commitizen": {
       "path": "cz-conventional-changelog"
     }
   },
+  "jest": {
+    "collectCoverageFrom": [
+      "src/**/*.js"
+    ]
+  },
   "dependencies": {
-    "classnames": "^2.2.5"
+    "classnames": "^2.2.5",
+    "core-js": "^2.5.3"
   },
   "devDependencies": {
     "@commitlint/cli": "^5.2.5",
-    "@commitlint/config-angular": "^5.1.1",
+    "@commitlint/config-conventional": "^6.1.3",
+    "algoliasearch": "^3.27.1",
     "babel-cli": "^6.24.1",
     "babel-loader": "^7.1.1",
-    "babel-plugin-transform-object-rest-spread": "^6.26.0",
-    "babel-preset-es2015": "^6.24.1",
-    "babel-register": "^6.24.1",
+    "babel-preset-env": "^1.7.0",
+    "babel-preset-stage-2": "^6.24.1",
     "cheerio": "^1.0.0-rc.2",
     "commitizen": "^2.9.6",
-    "core-js": "^2.5.3",
     "cz-conventional-changelog": "^2.1.0",
-    "eslint": "^4.13.1",
+    "eslint": "^4.15.0",
     "eslint-config-airbnb-base": "^12.1.0",
     "eslint-config-prettier": "^2.9.0",
     "eslint-plugin-import": "^2.5.0",
-    "eslint-plugin-prettier": "^2.4.0",
-    "html-minifier": "^3.5.7",
+    "eslint-plugin-prettier": "^2.5.0",
+    "html-minifier": "^3.5.8",
     "husky": "^0.14.3",
     "jest": "^21.2.1",
     "lint-staged": "^6.0.0",
     "npm-run-all": "^4.1.2",
     "prettier": "^1.8.2",
     "rimraf": "^2.6.2",
-    "semantic-release": "^8.2.0",
+    "semantic-release": "^12.2.2",
     "svgo": "^0.7.2",
-    "webpack": "^3.10.0"
+    "webpack": "^4.8.3",
+    "webpack-cli": "^2.1.3"
   },
   "repository": {
     "type": "git",

src/__tests__/__snapshots__/replace.node.test.js.snap

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`throws an error when run in node environment 1`] = `"\`feather.replace()\` only works in a browser environment."`;

src/__tests__/index.test.js

@@ -1,5 +1,5 @@
 /* eslint-env jest */
-import feather from '../..';
+import feather from '../index';
 
 test('has correct properties', () => {
   expect(feather).toHaveProperty('icons');

src/__tests__/replace.node.test.js

@@ -0,0 +1,10 @@
+/**
+ * @jest-environment node
+ */
+
+/* eslint-env jest */
+import replace from '../replace';
+
+test('throws an error when run in node environment', () => {
+  expect(replace).toThrowErrorMatchingSnapshot();
+});

src/tags.json

@@ -53,6 +53,7 @@
   "folder-minus": ["directory"],
   "folder-plus": ["directory"],
   "folder": ["directory"],
+  "gift": ["present", "box", "birthday", "party"],
   "git-branch": ["code", "version control"],
   "git-commit": ["code", "version control"],
   "git-merge": ["code", "version control"],
@@ -150,6 +151,7 @@
   "x-circle": ["cancel", "close", "delete", "remove", "times"],
   "x-square": ["cancel", "close", "delete", "remove", "times"],
   "x": ["cancel", "close", "delete", "remove", "times"],
+  "youtube": ["logo", "video", "play"],
   "zap-off": ["flash", "camera", "lightning"],
   "zap": ["flash", "camera", "lightning"]
 }

webpack.config.js

@@ -1,12 +1,7 @@
-import path from 'path';
+const path = require('path');
 
-export default {
-  entry: [
-    'core-js/fn/array/from',
-    'core-js/fn/object/assign',
-    'core-js/fn/set',
-    path.resolve(__dirname, 'src/index.js'),
-  ],
+module.exports = {
+  entry: ['core-js/fn/array/from', path.resolve(__dirname, 'src/index.js')],
   output: {
     path: path.resolve(__dirname, 'dist'),
     libraryTarget: 'umd',