# pipe-scripts

> #### Inline SVG Support It process your SVG file and returns a React component. **Important: file extension must be .inline.svg**

Latest version **0.0.24** (published 2019-11-28) · 0 weekly downloads

## Install

```sh
npm install pipe-scripts
pnpm add pipe-scripts
yarn add pipe-scripts
bun add pipe-scripts
```

Provides the command `pipe-scripts`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.24 |
| Published | 2019-11-28 |
| First published | 2017-11-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 1 |
| Unpacked size | 76.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | pipe-modules, tom-morse |

## Links

- npm: https://www.npmjs.com/package/pipe-scripts
- npm.io page: https://npm.io/package/pipe-scripts

## Dependencies (1)

- [pipe-services](https://npm.io/package/pipe-services.md) ^0.1.1

## Recent versions

- 0.0.24 (latest) — 2019-11-28
- 0.0.23 — 2019-02-22
- 0.0.22 — 2019-02-21
- 0.0.21 — 2019-02-15
- 0.0.18 — 2019-02-05
- 0.0.17 — 2019-01-14
- 0.0.16 — 2019-01-14
- 0.0.15 — 2019-01-14
- 0.0.14 — 2019-01-09
- 0.0.13 — 2019-01-08
- 0.0.12 — 2019-01-07
- 0.0.11 — 2018-12-18
- 0.0.10 — 2018-12-18
- 0.0.9 — 2018-12-18
- 0.0.8 — 2018-12-18
- … 7 more at https://npm.io/package/pipe-scripts/versions

## README

# pipe-automater

#### Inline SVG Support
It process your SVG file and returns a React component. 
**Important: file extension must be .inline.svg**

```jsx
import React from 'react'
import IconRemove from './icons/remove.inline.svg'
/** Inline SVG Component */ 
const RemoveIcon = () => (
    <IconRemove />
)
```

## Scripts

### add
Add is a CLI that guides you through the process of adding a react component, module or view.
#### Installation
1. Run `$ npm install pipe-automater` in your project directory
2. Add `"add": "pipe-automater add",`to the "scripts" in your package.json
#### Usage
1. Run `$ npm run add` in your project directory

### flow
flow is a CLI that guides you through the process of git flow in any git project. You only need to follow the CLI and the flow script will take care of the correct starting, finishing and merging of hotfix, feature and release branches.
#### Installation
1. Run `$ npm install pipe-scripts` in your project directory
2. Add `"flow": "pipe-scripts flow",`to the "scripts" in your package.json
#### Usage
1. Run `$ npm run flow` in your project directory
2. The CLI will guide you through starting/finishing a hotfix, feature or release

### import
import is a script that makes it possible to import icon fonts to your project. You only have to unzip your icoMoon export folder and copy the content into the root folder /importer in your project. The import script will then import the fonts and generate a documentation of all available icons.
#### Installation
1. Run `$ npm install pipe-scripts` in your project directory
2. Add `"import": "pipe-scripts import",`to the "scripts" in your package.json
3. Add a `/importer` to your root directory
#### Usage
1. Run `$ npm run import` in your project directory
2. Put the source files in the `/imorter` folder
3. The script will then import the icon fonts and generate all needed files for documentation and usage of the icons

### licensecheck
Check which of your projects' dependencies or devDependencies have critical licenses by running this script. It is possible to configure what licenses are white or black listed. Any other license will be listed as grey.
#### Installation
1. Run `$ npm install pipe-scripts` in your project directory
2. Add `"licensecheck": "pipe-scripts licensecheck",`to the "scripts" in your package.json
3. Add empty report file to your project directory. Either to `./docs/licensecheck/report.md` or any directory you configured in the `pipe-manifest.json`.
#### Usage
1. Run `$ npm run licensecheck` in your project directory
2. The script will then write the license report for you
3. You can configure the report path and the white/black list of licenses in the `pipe-manifest.json`.

### extend
Add extensions to your project with this CLI. You can choose between setups for pipe-components and pipe-services as well as setting up an Icon component or the NavigationController.
#### Installation
1. Run `$ npm install pipe-scripts` in your project directory
2. Add `"extend": "pipe-scripts extend",` to "scripts" in your package.json
#### Usage
1. Run `$ npm run extend` in your project directory
2. You can now choose which extension you want to add.

---
_Source: https://npm.io/package/pipe-scripts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
