pipe-scripts v0.0.24

pipe-automater

Inline SVG Support

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

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.