open-index/open-npm huggingface dataset:
npm package: @shanzhai/minify-step
Description: A Shanzhai step which can be built upon to create recursive minification build steps.
Latest version: 0.0.11

# `@shanzhai/minify-step` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/minify-step.svg)](https://www.npmjs.com/package/@shanzhai/minify-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minify-step.svg)](https://www.npmjs.com/package/@shanzhai/minify-step)

A Shanzhai step which can be built upon to create recursive minification build steps.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/minify-svg-plugin
Description: A Shanzhai plugin which minifies SVG from the source store.
Latest version: 0.0.15

# `@shanzhai/minify-svg-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/minify-svg-plugin.svg)](https://www.npmjs.com/package/@shanzhai/minify-svg-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minify-svg-plugin.svg)](https://www.npmjs.com/package/@shanzhai/minify-svg-plugin)

A Shanzhai plugin which minifies SVG from the source store.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/minify-svg-step
Description: A Shanzhai step which minifies a SVG file.
Latest version: 0.0.16

# `@shanzhai/minify-svg-step` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/minify-svg-step.svg)](https://www.npmjs.com/package/@shanzhai/minify-svg-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minify-svg-step.svg)](https://www.npmjs.com/package/@shanzhai/minify-svg-step)

A Shanzhai step which minifies a SVG file.

## Usage

Within a trigger's event handler, return an instance of `MinifySvgStep`
similar to the following:

```typescript
new MinifySvgStep(
  `A description of the operation being performed`,
  new AnInputOfUnminifiedSvg(),
  new AnOutputOfMinifiedSvg()
);
```

## Configuration Notes

The configuration used is highly aggressive.  It should be reasonable for static
SVGs.

- Coordinates are rounded to the nearest pixels.
- Colors are reduced from 24 to 12 bits.
- Ids, classes, etc. are all removed.
- Invisible elements are removed.
- Grouping elements which do not alter appearance are flattened.

## Dependencies

This package has the following runtime dependencies:

Name | Version                                                                              
---- | -------------------------------------------------------------------------------------
svgo | [![2.8.0](https://img.shields.io/npm/v/svgo.svg)](https://www.npmjs.com/package/svgo)

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/nop-step
Description: A Shanzhai step which does nothing.
Latest version: 0.0.2

# `@shanzhai/nop-step` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/nop-step.svg)](https://www.npmjs.com/package/@shanzhai/nop-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/nop-step.svg)](https://www.npmjs.com/package/@shanzhai/nop-step)

A Shanzhai step which does nothing.

## Usage

Use whenever a step must be given, but no work is to be done:

```typescript
new NopStep(`Describe the NOP here`);
```

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/null-output
Description: A Shanzhai output which discards any value it is given without taking further action.
Latest version: 0.0.10

# `@shanzhai/null-output` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/null-output.svg)](https://www.npmjs.com/package/@shanzhai/null-output) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/null-output.svg)](https://www.npmjs.com/package/@shanzhai/null-output)

A Shanzhai output which discards any value it is given without taking further action.

## Usage

Provide as an output to discard an output of `Steps`.

```typescript
new ExampleStep(
  new NullOutput()
);
```

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/output-type-script-compiler-options-plugin
Description: A Shanzhai plugin which outputs the current TypeScript compiler options to the current working directory.
Latest version: 0.0.20

# `@shanzhai/output-type-script-compiler-options-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/output-type-script-compiler-options-plugin.svg)](https://www.npmjs.com/package/@shanzhai/output-type-script-compiler-options-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/output-type-script-compiler-options-plugin.svg)](https://www.npmjs.com/package/@shanzhai/output-type-script-compiler-options-plugin)

A Shanzhai plugin which outputs the current TypeScript compiler options to the current working directory.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/output-zip-content-plugin
Description: A Shanzhai plugin which outputs the content of the distributable zip to the dist/content subdirectory of the current working directory.
Latest version: 0.0.10

# `@shanzhai/output-zip-content-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/output-zip-content-plugin.svg)](https://www.npmjs.com/package/@shanzhai/output-zip-content-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/output-zip-content-plugin.svg)](https://www.npmjs.com/package/@shanzhai/output-zip-content-plugin)

A Shanzhai plugin which outputs the content of the distributable zip to the dist/content subdirectory of the current working directory.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/output-zip-plugin
Description: A Shanzhai plugin which outputs the distributable zip to the dist subdirectory of the current working directory.
Latest version: 0.0.15

# `@shanzhai/output-zip-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/output-zip-plugin.svg)](https://www.npmjs.com/package/@shanzhai/output-zip-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/output-zip-plugin.svg)](https://www.npmjs.com/package/@shanzhai/output-zip-plugin)

A Shanzhai plugin which outputs the distributable zip to the dist subdirectory of the current working directory.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parallel-step
Description: A Shanzhai build step which runs any number of child build steps in parallel.
Latest version: 0.0.12

# `@shanzhai/parallel-step` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parallel-step.svg)](https://www.npmjs.com/package/@shanzhai/parallel-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parallel-step.svg)](https://www.npmjs.com/package/@shanzhai/parallel-step)

A Shanzhai build step which runs any number of child build steps in parallel.

## Usage

Within a trigger's event handler, return an instance of `ParallelStep` similar
to the following:

```typescript
new ParallelStep(
  `A description of the operation being performed`,
  [
    new FirstStepToExecute(),
    new SecondStepToExecute(),
    new ThirdStepToExecute(),
  ]
)
```

This will execute each of the steps simultaneously, in parallel.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parse-csv-step
Description: A Shanzhai step which parses CSV files.
Latest version: 0.0.11

# `@shanzhai/parse-csv-step` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parse-csv-step.svg)](https://www.npmjs.com/package/@shanzhai/parse-csv-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parse-csv-step.svg)](https://www.npmjs.com/package/@shanzhai/parse-csv-step)

A Shanzhai step which parses CSV files.

## Usage

If within a trigger's event handler an instance of `ParseCsvStep` similar to the
following were to be returned:

```typescript
new ParseCsvStep(
  `A description of the operation being performed`,
  new ConstantInput(`Example AA, Example AB, Example AC
Example BA, Example BB, Example BC
Example CA, Example CB, Example CC`
  ),
  new OutputForParsedCsv()
);
```

An array similar to the following would be written to the output:

```typescript
[
  [`Example AA`, `Example AB`, `Example AC`],
  [`Example BA`, `Example BB`, `Example BC`],
  [`Example CA`, `Example CB`, `Example CC`],
];
```

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parse-favicons-options-plugin
Description: A Shanzhai plugin which parses previously read favicons options.
Latest version: 0.0.7

# `@shanzhai/parse-favicons-options-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parse-favicons-options-plugin.svg)](https://www.npmjs.com/package/@shanzhai/parse-favicons-options-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parse-favicons-options-plugin.svg)](https://www.npmjs.com/package/@shanzhai/parse-favicons-options-plugin)

A Shanzhai plugin which parses previously read favicons options.

## Usage

If within a trigger's event handler an instance of `ParseJsonStep` similar to the
following were to be returned:

```typescript
new ParseJsonStep(
  `A description of the operation being performed`,
  new ConstantInput(`{"testKey":"testValue"}`),
  new OutputForParsedJson()
);
```

A value similar to the following would be written to the output:

```typescript
{ testKey: `testValue` };
```

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parse-json-step
Description: A Shanzhai step which parses JSON from a string.
Latest version: 0.0.11

# `@shanzhai/parse-json-step` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parse-json-step.svg)](https://www.npmjs.com/package/@shanzhai/parse-json-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parse-json-step.svg)](https://www.npmjs.com/package/@shanzhai/parse-json-step)

A Shanzhai step which parses JSON from a string.

## Usage

If within a trigger's event handler an instance of `ParseJsonStep` similar to the
following were to be returned:

```typescript
new ParseJsonStep(
  `A description of the operation being performed`,
  new ConstantInput(`{"testKey":"testValue"}`),
  new OutputForParsedJson()
);
```

A value similar to the following would be written to the output:

```typescript
{ testKey: `testValue` };
```

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parse-pug-plugin
Description: A Shanzhai plugin which parses Pug source.
Latest version: 0.0.15

# `@shanzhai/parse-pug-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parse-pug-plugin.svg)](https://www.npmjs.com/package/@shanzhai/parse-pug-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parse-pug-plugin.svg)](https://www.npmjs.com/package/@shanzhai/parse-pug-plugin)

A Shanzhai plugin which parses Pug source.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parse-pug-step
Description: A Shanzhai step which parses Pug files.
Latest version: 0.0.11

# `@shanzhai/parse-pug-step` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parse-pug-step.svg)](https://www.npmjs.com/package/@shanzhai/parse-pug-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parse-pug-step.svg)](https://www.npmjs.com/package/@shanzhai/parse-pug-step)

A Shanzhai step which parses Pug files.

## Usage

If within a trigger's event handler an instance of `ParsePugStep` similar to the
following were to be returned:

```typescript
new ParsePugStep(
  `A description of the operation being performed`,
  new InputForUnparsedPug(),
  new OutputForParsedPug()
);
```

A Pug render function would be written to the output.

## Dependencies

This package has the following runtime dependencies:

Name | Version                                                                            
---- | -----------------------------------------------------------------------------------
pug  | [![3.0.2](https://img.shields.io/npm/v/pug.svg)](https://www.npmjs.com/package/pug)

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parse-type-script-plugin
Description: A Shanzhai plugin which parses TypeScript source files.
Latest version: 0.0.17

# `@shanzhai/parse-type-script-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parse-type-script-plugin.svg)](https://www.npmjs.com/package/@shanzhai/parse-type-script-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parse-type-script-plugin.svg)](https://www.npmjs.com/package/@shanzhai/parse-type-script-plugin)

A Shanzhai plugin which parses TypeScript source files.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parse-type-script-step
Description: A Shanzhai step which compiles parsed TypeScript.
Latest version: 0.0.13

# `@shanzhai/parse-type-script-step` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parse-type-script-step.svg)](https://www.npmjs.com/package/@shanzhai/parse-type-script-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parse-type-script-step.svg)](https://www.npmjs.com/package/@shanzhai/parse-type-script-step)

A Shanzhai step which compiles parsed TypeScript.

## Usage

If within a trigger's event handler an instance of `ParseTypeScriptStep` similar
to the following were to be returned:

```typescript
new ParseTypeScriptStep(
  `A description of the operation being performed`,
  new InputForUnparsedTypeScript(),
  new InputForTypeScriptCompilerOptions(),
  new OutputForParsedTypeScript()
);
```

A parsed TypeScript source file would be written to the output.

## Dependencies

This package has the following runtime dependencies:

Name       | Version                                                                                          
---------- | -------------------------------------------------------------------------------------------------
typescript | [![4.6.3](https://img.shields.io/npm/v/typescript.svg)](https://www.npmjs.com/package/typescript)

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parsed-pug-store
Description: A Shanzhai store for parsed Pug.
Latest version: 0.0.9

# `@shanzhai/parsed-pug-store` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parsed-pug-store.svg)](https://www.npmjs.com/package/@shanzhai/parsed-pug-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parsed-pug-store.svg)](https://www.npmjs.com/package/@shanzhai/parsed-pug-store)

A Shanzhai store for parsed Pug.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/parsed-type-script-store
Description: A Shanzhai store for parsed TypeScript source files.
Latest version: 0.0.14

# `@shanzhai/parsed-type-script-store` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/parsed-type-script-store.svg)](https://www.npmjs.com/package/@shanzhai/parsed-type-script-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/parsed-type-script-store.svg)](https://www.npmjs.com/package/@shanzhai/parsed-type-script-store)

A Shanzhai store for parsed TypeScript source files.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/planning-helpers
Description: Helpers which generate a tree of steps to execute to perform a Shanzhai build.
Latest version: 0.0.14

# `@shanzhai/planning-helpers` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/planning-helpers.svg)](https://www.npmjs.com/package/@shanzhai/planning-helpers) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/planning-helpers.svg)](https://www.npmjs.com/package/@shanzhai/planning-helpers)

Helpers which generate a tree of steps to execute to perform a Shanzhai build.

## Usage

This package exports a `plan` function which is to be used to determine exactly
which operations need to be performed during a build.

```typescript
import { plan } from "@shanzhai/planning-helpers";

const theStepToExecute = plan(
  anObjectOfPlugins,
  true, // This is the first run.
  aDiffOfFileNames,
);
```

## Dependencies

This package has the following runtime dependencies:

Name      | Version                                                                                        
--------- | -----------------------------------------------------------------------------------------------
minimatch | [![5.0.1](https://img.shields.io/npm/v/minimatch.svg)](https://www.npmjs.com/package/minimatch)

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/plugin-helpers
Description: Helpers for searching for plugins during a Shanzhai build.
Latest version: 0.0.13

# `@shanzhai/plugin-helpers` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/plugin-helpers.svg)](https://www.npmjs.com/package/@shanzhai/plugin-helpers) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/plugin-helpers.svg)](https://www.npmjs.com/package/@shanzhai/plugin-helpers)

Helpers for searching for plugins during a Shanzhai build.

## Usage

This package exports a `searchForPlugins` function which scans the
`package.json` file in the current working directory to list all Shanzhai
plugins within the current package and its direct dependencies.

```typescript
import { searchForPlugins } from "@shanzhai/plugin-helpers";

const anObjectOfPlugins = await searchForPlugins();
```

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/production-cli
Description: A CLI tool which performs a one-off production build of the Shanzhai project in the current directory.
Latest version: 0.0.23

# `@shanzhai/production-cli` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/production-cli.svg)](https://www.npmjs.com/package/@shanzhai/production-cli) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/production-cli.svg)](https://www.npmjs.com/package/@shanzhai/production-cli)

A CLI tool which performs a one-off production build of the Shanzhai project in the current directory.

## Usage

Execute from the command line to perform a one-off build of the Shanzhai project
in the current working directory:

```
npx @shanzhai/production-cli
```

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/pug-local-store
Description: A Shanzhai store for locals to be passed to Pug templates.
Latest version: 0.0.11

# `@shanzhai/pug-local-store` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/pug-local-store.svg)](https://www.npmjs.com/package/@shanzhai/pug-local-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/pug-local-store.svg)](https://www.npmjs.com/package/@shanzhai/pug-local-store)

A Shanzhai store for locals to be passed to Pug templates.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/pug-source-store
Description: A Shanzhai store for Pug source.
Latest version: 0.0.8

# `@shanzhai/pug-source-store` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/pug-source-store.svg)](https://www.npmjs.com/package/@shanzhai/pug-source-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/pug-source-store.svg)](https://www.npmjs.com/package/@shanzhai/pug-source-store)

A Shanzhai store for Pug source.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/read-binary-file-step
Description: A Shanzhai step which reads the content of a binary file.
Latest version: 0.0.12

# `@shanzhai/read-binary-file-step` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/read-binary-file-step.svg)](https://www.npmjs.com/package/@shanzhai/read-binary-file-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/read-binary-file-step.svg)](https://www.npmjs.com/package/@shanzhai/read-binary-file-step)

A Shanzhai step which reads the content of a binary file.

## Usage

If within a trigger's event handler an instance of `ReadBinaryFileStep` similar
to the following were to be returned:

```typescript
new ReadBinaryFile(
  `A description of the operation being performed`,
  [`A`, `Path`, `To`, `A`, `File`]
  new OutputForReadBinaryFile()
);
```

A Buffer containing the file's content would be written to the output.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/read-favicon-plugin
Description: A Shanzhai plugin which reads the "favicon" file into the favicon store.
Latest version: 0.0.7

# `@shanzhai/read-favicon-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/read-favicon-plugin.svg)](https://www.npmjs.com/package/@shanzhai/read-favicon-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/read-favicon-plugin.svg)](https://www.npmjs.com/package/@shanzhai/read-favicon-plugin)

A Shanzhai plugin which reads the "favicon" file into the favicon store.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/read-favicons-options-plugin
Description: A Shanzhai plugin which reads the "favicons-options.json" file into the favicons options source store.
Latest version: 0.0.7

# `@shanzhai/read-favicons-options-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/read-favicons-options-plugin.svg)](https://www.npmjs.com/package/@shanzhai/read-favicons-options-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/read-favicons-options-plugin.svg)](https://www.npmjs.com/package/@shanzhai/read-favicons-options-plugin)

A Shanzhai plugin which reads the "favicons-options.json" file into the favicons options source store.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)
npm package: @shanzhai/read-pug-files-plugin
Description: A Shanzhai plugin which reads Pug files into the Pug source store.
Latest version: 0.0.15

# `@shanzhai/read-pug-files-plugin` [![Continuous Integration](https://github.com/jameswilddev/shanzhai/workflows/Continuous%20Integration/badge.svg)](https://github.com/jameswilddev/shanzhai/actions) [![License](https://img.shields.io/github/license/jameswilddev/shanzhai.svg)](https://github.com/jameswilddev/shanzhai/blob/master/license) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_shield) [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![npm](https://img.shields.io/npm/v/@shanzhai/read-pug-files-plugin.svg)](https://www.npmjs.com/package/@shanzhai/read-pug-files-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/read-pug-files-plugin.svg)](https://www.npmjs.com/package/@shanzhai/read-pug-files-plugin)

A Shanzhai plugin which reads Pug files into the Pug source store.

## Dependencies

This package has no runtime dependencies.

## Peer Dependencies

This package has no runtime peer dependencies (it does not expect any other packages to be installed alongside itself).

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjameswilddev%2Fshanzhai?ref=badge_large)