feat: Add coffee icon

docs: Update issue templates
* Create icon_request.md * Delete ISSUE_TEMPLATE.md * Create bug_report.md * creating an example bug report * Using same bug report from issue template
2023-08-10 21:13:24 +03:00 · 2018-10-27 21:05:59 -07:00 · 2018-07-18 18:34:53 -07:00 · 2018-05-21 14:04:00 -07:00 · 2018-05-18 19:08:46 -07:00 · 2018-05-18 18:08:14 -07:00
11 changed files with 2896 additions and 1807 deletions
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@ -1,10 +0,0 @@
-<!--
-If you'd like to request an icon, please provide the following information:
- icon name
- at least one use case
- screenshots of similar icons
-
-Please create one issue for each icon request.
-->
-
-
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@ -0,0 +1,67 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+<!--
+Before reporting an issue, please search to see if someone has filed a similar issue before. If there is already an open issue, please add a 👍 and/or leave a comment with additional information.
+-->
+
+## Prerequisites
+
+* Version:
+* Are you running from source/master:
+* Are you using a released build:
+* Operating system: 
+* Bits:
+
+## Step to reproduce
+
+*(Type here)*
+
+### Actual behavior
+
+## Any message or error
+
+*(Type here)*
+
+## Resources
+
+* Links
+* Screenshots
+
+
+Here is what a great bug report would look like:
+
+```
+## Prerequisites
+
+Version: Release v3.1.0
+Running from: Import using webpack
+Operating system: Mac OSX
+Bits: 64 bits
+
+## Step to reproduce
+
+ - Import `check` icon
+ - Add to a React component/view
+ - Run the react app
+ - Notice that the `check` isn't rendering correctly which seems a encoding problem
+ 
+### Actual behavior:
+
+ - Import `check` icon
+ - Add to a React component/view
+ - Run the react app
+ - Check is displayed with correct encoding (e.g UTF-8)
+
+## Any message or error
+
+No console output
+...
+
+## Resources
+
+No resources
+...
+```
--- a/.github/ISSUE_TEMPLATE/icon_request.md
+++ b/.github/ISSUE_TEMPLATE/icon_request.md
@ -0,0 +1,14 @@
+---
+name: Icon request
+about: Suggest an new icon for this project
+---
+
+<!--
+Before creating an icon request, please search to see if someone has requested the icon already. If there is an open request, please add a 👍.
+-->
+
+## Icon Request
+
+* Icon name:
+* Use case:
+* Screenshots of similar icons:
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -37,24 +37,36 @@ When creating a new issue make sure to include the following:
 - A screenshot of any visual bug.

 Here is what a great bug report would look like:
+
 ```
-Check not rendering properly
+## Prerequisites

 Version: Release v3.1.0
-Downloaded from: Import using webpack
-OS: Mac OSX
+Running from: Import using webpack
+Operating system: Mac OSX
+Bits: 64 bits
+
+## Step to reproduce

-How to reproduce:
 - Import `check` icon
 - Add to a React component/view
 - Run the react app
 - Notice that the `check` isn't rendering correctly which seems a encoding problem
-Actual result:
+ 
+### Actual behavior:
+
 - Import `check` icon
 - Add to a React component/view
 - Run the react app
 - Check is displayed with correct encoding (e.g UTF-8)

+## Any message or error
+
 No console output
 ...
+
+## Resources
+
+No resources
+...
 ```
--- a/README.md
+++ b/README.md
@ -13,7 +13,7 @@ Feather is a collection of simply beautiful open source icons. Each icon is desi

 https://feathericons.com

-```sh
+```shell
 npm install feather-icons
 ```

@ -50,7 +50,7 @@ Or copy and paste the following code snippet into a blank `html` file.
 <!DOCTYPE html>
 <html lang="en">
  <title></title>
-  <script src="https://unpkg.com/feather-icons/dist/feather.min.js"></script>
+  <script src="https://unpkg.com/feather-icons"></script>
  <body>

    <!-- example icon -->
@ -77,7 +77,7 @@ The following are additional ways you can use Feather.

 Install with [npm](https://docs.npmjs.com/getting-started/what-is-npm).

-```
+```shell
 npm install feather-icons --save
 ```

@ -85,25 +85,27 @@ Or just copy [`feather.js`](https://unpkg.com/feather-icons/dist/feather.js) or

 #### 2. Include

-Include `feather.js` or `feather.min.js` with a `<script>` tag. These files are located in the `dist` directory of the npm package.
+Include `feather.js` or `feather.min.js` with a `<script>` tag:

 ```html
 <script src="path/to/dist/feather.js"></script>
 ```

-Or load the script from a CDN provider.
+> **Note:** `feather.js` and `feather.min.js` are located in the `dist` directory of the npm package.
+
+Or load the script from a CDN provider:

 ```html
 <!-- choose one -->
+<script src="https://unpkg.com/feather-icons"></script>
 <script src="https://cdn.jsdelivr.net/npm/feather-icons/dist/feather.min.js"></script>
-<script src="https://unpkg.com/feather-icons/dist/feather.min.js"></script>
 ```

 After including the script, `feather` will be available as a global variable.

 #### 3. Use

-To use an icon on your page, add a `data-feather` attribute with the icon name to an element.
+To use an icon on your page, add a `data-feather` attribute with the icon name to an element:

 ```html
 <i data-feather="circle"></i>
@ -113,7 +115,7 @@ See the complete list of icons at [feathericons.com](https://feathericons.com).

 #### 4. Replace

-Call the `feather.replace()` method.
+Call the `feather.replace()` method:

 ```html
 <script>
@ -126,15 +128,15 @@ All elements that have a `data-feather` attribute will be replaced with SVG mark
 ### Node
 #### 1. Install

-Install with [npm](https://docs.npmjs.com/getting-started/what-is-npm).
+Install with [npm](https://docs.npmjs.com/getting-started/what-is-npm):

-```
+```shell
 npm install feather-icons --save
 ```

 #### 2. Require

-```javascript
+```js
 const feather = require('feather-icons')
 ```

@ -157,7 +159,8 @@ feather.icons.x
 //      'stroke-width': 2,
 //      'stroke-linecap': 'round',
 //      'stroke-linejoin': 'round',
-//    }
+//    },
+//    toSvg: [Function],
 // }

 feather.icons.x.toSvg()
@ -177,7 +180,7 @@ See the [API Reference](#api-reference) for more information about the available

 Install with [npm](https://docs.npmjs.com/getting-started/what-is-npm).

-```
+```shell
 npm install feather-icons --save
 ```

@ -185,7 +188,7 @@ Or just copy [`feather-sprite.svg`](https://unpkg.com/feather-icons/dist/feather

 #### 2. Use

-In your HTML, you can include an icon like so:
+Include an icon on your page with the following markup:

 ```html
 <svg
@ -203,7 +206,7 @@ In your HTML, you can include an icon like so:

 > **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.
+However, this markup can be simplified using a simple CSS class to avoid repetition of SVG attributes between icons:

 ```css
 .feather {
@ -248,7 +251,8 @@ feather.icons.x
 //      'stroke-width': 2,
 //      'stroke-linecap': 'round',
 //      'stroke-linejoin': 'round',
-//    }
+//    },
+//    toSvg: [Function],
 // }

 feather.icons.x.toString()
@ -271,9 +275,17 @@ Returns an SVG string.
 | --------- | ------ | ----------- |
 | `attrs` (optional) | Object |  Key-value pairs in the `attrs` object will be mapped to HTML attributes on the `<svg>` tag (e.g. `{ foo: 'bar' }` maps to `foo="bar"`). All default attributes on the `<svg>` tag can be overridden with the `attrs` object. |

+> **Hint:** You might find these SVG attributes helpful for manipulating icons:
+> * [`color`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/color)
+> * [`width`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width)
+> * [`height`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height)
+> * [`stroke-width`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width)
+> * [`stroke-linecap`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap)
+> * [`stroke-linejoin`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin)
+
 #### Usage

-```javascript
+```js
 feather.icons.circle.toSvg()
 // '<svg class="feather feather-circle" 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"><circle cx="12" cy="12" r="10"></circle></svg>'

@ -361,7 +373,7 @@ Returns an SVG string.

 #### Usage

-```javascript
+```js
 feather.toSvg('circle')
 // '<svg class="feather feather-circle" 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"><circle cx="12" cy="12" r="10"></circle></svg>'

--- a/bin/build.sh
+++ b/bin/build.sh
@ -1,25 +1,25 @@
 #!/bin/bash

 # Process SVG files
-./node_modules/.bin/babel-node bin/process-svgs.js
+npx babel-node bin/process-svgs.js

 # Create dist directory
-./node_modules/.bin/rimraf dist
+npx rimraf dist
 mkdir dist

 # Build icons.json
-./node_modules/.bin/babel-node bin/build-icons-json.js
+npx babel-node bin/build-icons-json.js

 # Build SVG sprite
-./node_modules/.bin/babel-node bin/build-sprite.js
+npx babel-node bin/build-sprite.js

 # Create dist/icons directory
-./node_modules/.bin/rimraf dist/icons
+npx rimraf dist/icons
 mkdir dist/icons

 # Build SVG icons
-./node_modules/.bin/babel-node bin/build-svgs.js
+npx babel-node bin/build-svgs.js

 # Build JavaScript library
-./node_modules/.bin/webpack --output-filename feather.js --mode development
-./node_modules/.bin/webpack --output-filename feather.min.js --mode production
+npx webpack --output-filename feather.js --mode development
+npx webpack --output-filename feather.min.js --mode production
--- a/bin/sync-algolia.js
+++ b/bin/sync-algolia.js
@ -8,29 +8,66 @@ 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() {
+  // ALGOLIA_ADMIN_KEY must be added as an environment variable in Travis CI
  const client = algolia(ALGOLIA_APP_ID, process.env.ALGOLIA_ADMIN_KEY);

+  console.log('Initializing target and temporary indexes...');
  const index = client.initIndex('icons');
+  const indexTmp = client.initIndex('icons_tmp');

-  const records = Object.keys(icons).map(name => ({
-    name,
-    tags: tags[name] || [],
-  }));
+  console.log(
+    "Copying target index's settings, synonyms and rules into temporary index...",
+  );
+  scopedCopyIndex(client, index.indexName, indexTmp.indexName)
+    .then(() => {
+      const objects = Object.keys(icons).map(name => ({
+        name,
+        tags: tags[name] || [],
+      }));

-  index.clearIndex((err, content) => {
-    if (err) throw err;
-    console.log(content);
+      console.log('Adding objects to the temporary index...');
+      return addObjects(indexTmp, objects);
+    })
+    .then(() => {
+      console.log('Moving temporary index to target index...');
+      return moveIndex(client, indexTmp.indexName, index.indexName);
+    });
+}

-    index.addObjects(records, (err, content) => {
-      if (err) throw err;
-      console.log(content);
+function scopedCopyIndex(
+  client,
+  indexNameSrc,
+  indexNameDest,
+  scope = ['settings', 'synonyms', 'rules'],
+) {
+  return new Promise((resolve, reject) => {
+    client.copyIndex(indexNameSrc, indexNameDest, scope, (error, contents) => {
+      if (error) reject(error);
+      resolve(contents);
+    });
+  });
+}
+
+function addObjects(index, objects) {
+  return new Promise((resolve, reject) => {
+    index.addObjects(objects, (error, contents) => {
+      if (error) reject(error);
+      resolve(contents);
+    });
+  });
+}
+
+function moveIndex(client, indexNameSrc, indexNameDest) {
+  return new Promise((resolve, reject) => {
+    client.moveIndex(indexNameSrc, indexNameDest, (error, contents) => {
+      if (error) reject(error);
+      resolve(contents);
    });
  });
 }
--- a/icons/coffee.svg
+++ b/icons/coffee.svg
@ -0,0 +1,17 @@
+<svg
+  viewBox="0 0 24 24"
+  width="24"
+  height="24"
+  xmlns="http://www.w3.org/2000/svg"
+  fill="none"
+  stroke="currentColor"
+  stroke-width="2"
+  stroke-linecap="round"
+  stroke-linejoin="round"
+>
+  <path d="M18 8h1a4 4 0 0 1 0 8h-1" />
+  <path d="M2 8h16v9a4 4 0 0 1-4 4H6a4 4 0 0 1-4-4V8z" />
+  <line x1="6" y1="1" x2="6" y2="4" />
+  <line x1="10" y1="1" x2="10" y2="4" />
+  <line x1="14" y1="1" x2="14" y2="4" />
+</svg>
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -3,6 +3,7 @@
  "version": "0.0.0-development",
  "description": "Simply beautiful open source icons",
  "main": "dist/feather.js",
+  "unpkg": "dist/feather.min.js",
  "files": [
    "dist"
  ],
@ -41,18 +42,17 @@
    "cheerio": "^1.0.0-rc.2",
    "commitizen": "^2.9.6",
    "cz-conventional-changelog": "^2.1.0",
-    "eslint": "^4.15.0",
+    "eslint": "^4.19.1",
    "eslint-config-airbnb-base": "^12.1.0",
    "eslint-config-prettier": "^2.9.0",
    "eslint-plugin-import": "^2.5.0",
    "eslint-plugin-prettier": "^2.5.0",
    "html-minifier": "^3.5.8",
    "husky": "^0.14.3",
-    "jest": "^21.2.1",
+    "jest": "^22.4.4",
    "lint-staged": "^6.0.0",
    "npm-run-all": "^4.1.2",
    "prettier": "^1.8.2",
-    "rimraf": "^2.6.2",
    "semantic-release": "^12.2.2",
    "svgo": "^0.7.2",
    "webpack": "^4.8.3",
--- a/src/tags.json
+++ b/src/tags.json
@ -22,6 +22,7 @@
  "cloud-snow": ["weather", "blizzard"],
  "cloud": ["weather"],
  "codepen": ["logo"],
+  "coffee": ["drink", "cup", "mug", "tea", "cafe", "hot", "beverage"],
  "command": ["keyboard", "cmd"],
  "compass": ["navigation", "safari", "travel"],
  "copy": ["clone", "duplicate"],
Author	SHA1	Message	Date
Cole Bemis	61803f2129	feat: Add `coffee` icon	2018-10-27 21:05:59 -07:00
Yashu Mittal	8aec53b331	docs: Update issue templates * Create icon_request.md * Delete ISSUE_TEMPLATE.md * Create bug_report.md * creating an example bug report * Using same bug report from issue template	2018-07-18 18:34:53 -07:00
Cole Bemis	156c0919c9	docs: Add info about SVG attributes	2018-05-21 14:04:00 -07:00
Cole Bemis	179b482c03	build: Use promises in algolia script	2018-05-18 19:08:46 -07:00
Cole Bemis	a23698d5be	build: Initialize tmp index settings	2018-05-18 18:08:14 -07:00
Cole Bemis	fb057f1f94	build: Initialize algolia settings in script	2018-05-18 18:06:19 -07:00
Cole Bemis	21bb9fe6d6	build: Only copy settings to tmp index	2018-05-18 17:55:24 -07:00
Cole Bemis	c63f478ff5	chore: Remove console.log	2018-05-18 17:47:05 -07:00
Cole Bemis	b424fa779d	build: Add logs to sync-algolia script	2018-05-18 17:41:39 -07:00
Cole Bemis	01698dea84	Merge branch 'master' of https://github.com/feathericons/feather	2018-05-18 17:23:29 -07:00
Cole Bemis	ae8e149850	build: Refactor algolia script to reindex data atomically	2018-05-18 17:23:23 -07:00
Cole Bemis	9f49fd9560	Merge pull request #415 from feathericons/dependabot/npm_and_yarn/core-js-2.5.6 build: bump core-js from 2.5.3 to 2.5.6	2018-05-18 17:01:29 -07:00
Cole Bemis	742f452232	docs: Update README.md	2018-05-18 16:59:19 -07:00
Cole Bemis	962870d51c	chore: Fix security vulnerabilities	2018-05-18 16:41:56 -07:00
Cole Bemis	ba1b12a712	Merge branch 'master' of https://github.com/feathericons/feather	2018-05-18 16:35:01 -07:00
Cole Bemis	5045ec3b78	chore: Add comment to sync-algolia script	2018-05-18 16:34:56 -07:00
Cole Bemis	0d65b5761b	build: Use npx in build script	2018-05-18 16:34:26 -07:00
Cole Bemis	fcf9aec131	docs: Update unpkg links	2018-05-18 16:20:16 -07:00
Cole Bemis	2ee03d261c	fix: Set unpkg default to feather.min.js	2018-05-18 16:13:35 -07:00
dependabot[bot]	9b157b399d	build: bump core-js from 2.5.3 to 2.5.6 Bumps [core-js](https://github.com/zloirock/core-js) from 2.5.3 to 2.5.6. - [Release notes](https://github.com/zloirock/core-js/releases) - [Changelog](https://github.com/zloirock/core-js/blob/master/CHANGELOG.md) - [Commits](https://github.com/zloirock/core-js/compare/v2.5.3...v2.5.6) Signed-off-by: dependabot[bot] <support@dependabot.com>	2018-05-18 19:28:17 +00:00