# @nycopportunity/pttrn-plugin-feather

> A plugin script for the @NYCOpportunity Pattern CLI that will compile a feather icon sprite from the source.

Latest version **1.0.2** (published 2021-01-21) · GPL-3.0+ license · 0 weekly downloads

## Install

```sh
npm install @nycopportunity/pttrn-plugin-feather
pnpm add @nycopportunity/pttrn-plugin-feather
yarn add @nycopportunity/pttrn-plugin-feather
bun add @nycopportunity/pttrn-plugin-feather
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-01-21 |
| First published | 2021-01-15 |
| Weekly downloads | 0 |
| License | GPL-3.0+ |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 39.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | NYC Opportunity |
| Maintainers | devowhippit, kimpenguin, theasteve, yone920 |

## Links

- npm: https://www.npmjs.com/package/@nycopportunity/pttrn-plugin-feather
- Repository: https://github.com/CityOfNewYork/patterns-plugin-feather
- Homepage: https://github.com/CityOfNewYork/patterns-plugin-feather#readme
- Issues: https://github.com/CityOfNewYork/patterns-plugin-feather/issues
- npm.io page: https://npm.io/package/@nycopportunity/pttrn-plugin-feather

## Dependencies (2)

- [svgstore](https://npm.io/package/svgstore.md) ^3.0.0-2
- [feather-icons](https://npm.io/package/feather-icons.md) ^4.28.0

## Recent versions

- 1.0.2 (latest) — 2021-01-21
- 1.0.1 — 2021-01-15
- 1.0.0 — 2021-01-15

## README

# Patterns CLI Feather Plugin

This command plugin will compile a SVG icon sprite from the [Feather Icon](https://feathericons.com/) set.

## Usage

Install as a development dependency in a project that uses the [Patterns CLI](https://github.com/CityOfNewYork/patterns-cli).

```shell
$ npm install @nycopportunity/pttrn-plugin-feather -D
```

Add a proxy command script in the **./bin/** directory:

```shell
$ touch bin/feather.js
$ echo "module.exports = require('@nycopportunity/pttrn-plugin-feather');"
```

This will make the command available to the CLI. Compile the sprite by running:

```shell
$ npx pttrn feather
$ ✨ Feather sprite written to ./dist/svg/feather.svg
```

An optional config file can be added with the following options:

Option   | Description
---------|-
`src`    | The source directory for Feather icons.
`dist`   | The distribution path and file name for the compiled sprite.
`ext`    | The extension name for the icons files (this shouldn't change).
`prefix` | The prefix to add to the `<svg>` element ID attribute.

**Config Sample**

```JavaScript
const path = require('path');

module.exports = {
  'src': path.join(process.env.PWD, 'node_modules/feather-icons/dist/icons'),
  'dist': path.join(process.env.PWD, 'dist', 'svg', 'feather.svg'),
  'ext': '.svg',
  'prefix': 'feather-'
};
```

---
_Source: https://npm.io/package/@nycopportunity/pttrn-plugin-feather · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._