open-index/open-npm huggingface dataset:
npm package: @shanzhai/es5-type-script-compiler-options-plugin
Description: A Shanzhai plugin which loads a set of TypeScript compiler options for ES5.
Latest version: 0.0.18

# `@shanzhai/es5-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/es5-type-script-compiler-options-plugin.svg)](https://www.npmjs.com/package/@shanzhai/es5-type-script-compiler-options-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/es5-type-script-compiler-options-plugin.svg)](https://www.npmjs.com/package/@shanzhai/es5-type-script-compiler-options-plugin)

A Shanzhai plugin which loads a set of TypeScript compiler options for ES5.

## Usage

When installed, this plugin will load a configuration into the
[TypeScript compiler options store](@shanzhai/type-script-compiler-options-store).

The full configuration can be found within the source code,
[here](https://github.com/jameswilddev/shanzhai/blob/master/%40shanzhai/es5-type-script-compiler-options-plugin/index.ts),
but the general summary is that:

- All strictness options are enabled.
- The target platform is any ES5-compatible web browser.

## 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/execution-helpers
Description: Helpers which execute a tree of steps to perform a Shanzhai build.
Latest version: 0.0.12

# `@shanzhai/execution-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/execution-helpers.svg)](https://www.npmjs.com/package/@shanzhai/execution-helpers) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/execution-helpers.svg)](https://www.npmjs.com/package/@shanzhai/execution-helpers)

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

## Usage

An `execute` function is exported which executes a step, with a streaming log
output:

```typescript
import { execute } from "@shanzhai/execution-helpers";

// Returns true when successful, otherwise, false.
await execute(new ExampleStep(), process.stderr);
```

## Dependencies

This package has the following runtime dependencies:

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

## 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/favicon-store
Description: A Shanzhai store for the favicon image read from disk.
Latest version: 0.0.4

# `@shanzhai/favicon-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/favicon-store.svg)](https://www.npmjs.com/package/@shanzhai/favicon-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/favicon-store.svg)](https://www.npmjs.com/package/@shanzhai/favicon-store)

A Shanzhai store for the favicon image read from disk.

## 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/favicons-options-source-store
Description: A Shanzhai store for unparsed options for the "favicons" package.
Latest version: 0.0.4

# `@shanzhai/favicons-options-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/favicons-options-source-store.svg)](https://www.npmjs.com/package/@shanzhai/favicons-options-source-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/favicons-options-source-store.svg)](https://www.npmjs.com/package/@shanzhai/favicons-options-source-store)

A Shanzhai store for unparsed options for the "favicons" package.

## 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/favicons-options-store
Description: A Shanzhai store for options for the "favicons" package.
Latest version: 0.0.4

# `@shanzhai/favicons-options-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/favicons-options-store.svg)](https://www.npmjs.com/package/@shanzhai/favicons-options-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/favicons-options-store.svg)](https://www.npmjs.com/package/@shanzhai/favicons-options-store)

A Shanzhai store for options for the "favicons" package.

## 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/favicons-plugin
Description: A Shanzhai plugin which minifies HTML from the source store.
Latest version: 0.0.17

# `@shanzhai/favicons-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/favicons-plugin.svg)](https://www.npmjs.com/package/@shanzhai/favicons-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/favicons-plugin.svg)](https://www.npmjs.com/package/@shanzhai/favicons-plugin)

A Shanzhai plugin which minifies HTML 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/favicons-step
Description: A Shanzhai step which converts an image to HTML headers and files representing favicons.
Latest version: 0.0.2

# `@shanzhai/favicons-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/favicons-step.svg)](https://www.npmjs.com/package/@shanzhai/favicons-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/favicons-step.svg)](https://www.npmjs.com/package/@shanzhai/favicons-step)

A Shanzhai step which converts an image to HTML headers and files representing favicons.

## Dependencies

This package has the following runtime dependencies:

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

## 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/glob-compare-function
Description: A comparison function for sorting glob patterns by priority.
Latest version: 0.0.2

# `@shanzhai/glob-compare-function` [![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/glob-compare-function.svg)](https://www.npmjs.com/package/@shanzhai/glob-compare-function) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/glob-compare-function.svg)](https://www.npmjs.com/package/@shanzhai/glob-compare-function)

A comparison function for sorting glob patterns by priority.

## Usage

```typescript
import { globCompareFunction } from "@shanzhai/glob-compare-function";

console.log([
  `**/some-file.path`,
  `**/*.some-file-path`,
  `**/*.*`,
  `some/file.path`,
  `some-file.*`,
  `file.path`,
  `matched/**/all/*/*`,
  `matched/**/added/*`,
  `matched/**/more-specific/changed/*`,
].sort(globCompareFunction))
```

```json
[
  "file.path",
  "some/file.path",
  "some-file.*",
  "matched/**/more-specific/changed/*",
  "matched/**/all/*/*",
  "matched/**/added/*",
  "**/some-file.path",
  "**/*.some-file-path",
  "**/*.*"
]
```

## 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/global-store
Description: A Shanzhai store for global variables to be included in Javascript builds.
Latest version: 0.0.6
Deprecated: TypeScript

# `@shanzhai/global-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/global-store.svg)](https://www.npmjs.com/package/@shanzhai/global-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/global-store.svg)](https://www.npmjs.com/package/@shanzhai/global-store)

A Shanzhai store for global variables to be included in Javascript builds.

## 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/html-header-pug-local-plugin
Description: A Shanzhai plugin which converts the generated HTML headers to a Pug local.
Latest version: 0.0.7

# `@shanzhai/html-header-pug-local-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/html-header-pug-local-plugin.svg)](https://www.npmjs.com/package/@shanzhai/html-header-pug-local-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/html-header-pug-local-plugin.svg)](https://www.npmjs.com/package/@shanzhai/html-header-pug-local-plugin)

A Shanzhai plugin which converts the generated HTML headers to a Pug local.

## 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/html-header-store
Description: A Shanzhai store for sets of HTML headers.
Latest version: 0.0.7

# `@shanzhai/html-header-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/html-header-store.svg)](https://www.npmjs.com/package/@shanzhai/html-header-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/html-header-store.svg)](https://www.npmjs.com/package/@shanzhai/html-header-store)

A Shanzhai store for sets of HTML headers.

## 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/html-source-store
Description: A Shanzhai store for HTML source.
Latest version: 0.0.11

# `@shanzhai/html-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/html-source-store.svg)](https://www.npmjs.com/package/@shanzhai/html-source-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/html-source-store.svg)](https://www.npmjs.com/package/@shanzhai/html-source-store)

A Shanzhai store for HTML 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/interfaces
Description: TypeScript types used as interfaces between the various components of Shanzhai.
Latest version: 0.0.26

# `@shanzhai/interfaces` [![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/interfaces.svg)](https://www.npmjs.com/package/@shanzhai/interfaces) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/interfaces.svg)](https://www.npmjs.com/package/@shanzhai/interfaces)

TypeScript types used as interfaces between the various components of Shanzhai.

## 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/javascript-source-store
Description: A Shanzhai store for Javascript source files.
Latest version: 0.0.16

# `@shanzhai/javascript-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/javascript-source-store.svg)](https://www.npmjs.com/package/@shanzhai/javascript-source-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/javascript-source-store.svg)](https://www.npmjs.com/package/@shanzhai/javascript-source-store)

A Shanzhai store for Javascript 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/key-value-store
Description: A store which holds a keyed set of values, with inputs and outputs for interacting with Shanzhai build steps and some helper build steps.
Latest version: 0.0.8
Deprecated: Please

# `@shanzhai/key-value-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/key-value-store.svg)](https://www.npmjs.com/package/@shanzhai/key-value-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/key-value-store.svg)](https://www.npmjs.com/package/@shanzhai/key-value-store)

A store which holds a keyed set of values, with inputs and outputs for interacting with Shanzhai build steps and some helper 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/keyed-store-get-all-input
Description: A Shanzhai input which reads all keys and values from a keyed store as an object.
Latest version: 0.0.6

# `@shanzhai/keyed-store-get-all-input` [![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/keyed-store-get-all-input.svg)](https://www.npmjs.com/package/@shanzhai/keyed-store-get-all-input) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/keyed-store-get-all-input.svg)](https://www.npmjs.com/package/@shanzhai/keyed-store-get-all-input)

A Shanzhai input which reads all keys and values from a keyed store as an object.

## Usage

Provide an instance of `KeyedStoreGetAllInput` as an input to a `Step` to
provide an object containing all of a `KeyedStore`'s keys and values to it.

```typescript
new ExampleStep(
  new KeyedStoreGetAllInput(aKeyedStoreFromWhichToRetrieveAllKeysAndValues)
);
```

## 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/keyed-store-get-input
Description: A Shanzhai input which reads a single value from a keyed store.
Latest version: 0.0.6

# `@shanzhai/keyed-store-get-input` [![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/keyed-store-get-input.svg)](https://www.npmjs.com/package/@shanzhai/keyed-store-get-input) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/keyed-store-get-input.svg)](https://www.npmjs.com/package/@shanzhai/keyed-store-get-input)

A Shanzhai input which reads a single value from a keyed store.

## Usage

Provide an instance of `KeyedStoreGetInput` as an input to a `Step` to
provide a particular key's value to it.

```typescript
new ExampleStep(
  new KeyedStoreGetInput(
    aKeyedStoreFromWhichToRetrieveASpecificKeysValue,
    `Example Key To Retrieve`
  )
);
```

## 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/keyed-store-get-keys-input
Description: A Shanzhai input which reads all keys from a keyed store as an array of strings.
Latest version: 0.0.6

# `@shanzhai/keyed-store-get-keys-input` [![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/keyed-store-get-keys-input.svg)](https://www.npmjs.com/package/@shanzhai/keyed-store-get-keys-input) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/keyed-store-get-keys-input.svg)](https://www.npmjs.com/package/@shanzhai/keyed-store-get-keys-input)

A Shanzhai input which reads all keys from a keyed store as an array of strings.

## Usage

Provide an instance of `KeyedStoreGetKeysInput` as an input to a `Step` to
provide an array containing all of a `KeyedStore`'s keys to it.

```typescript
new ExampleStep(
  new KeyedStoreGetKeysInput(aKeyedStoreFromWhichToRetrieveAllKeys)
);
```

## 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/keyed-store-set-output
Description: A Shanzhai output which sets a value in a keyed store.
Latest version: 0.0.6

# `@shanzhai/keyed-store-set-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/keyed-store-set-output.svg)](https://www.npmjs.com/package/@shanzhai/keyed-store-set-output) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/keyed-store-set-output.svg)](https://www.npmjs.com/package/@shanzhai/keyed-store-set-output)

A Shanzhai output which sets a value in a keyed store.

## Usage

Provide an instance of `KeyedStoreSetOutput` as an output to a `Step` to set a
specific key/value in a `KeyedStore`.

```typescript
new ExampleStep(
  new KeyedStoreSetOutput(
    aKeyedStoreInWhichToSetAKeyValue,
    `An Example Key To Set`
  )
);
```

## 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/merge-object-input
Description: A Shanzhai input which builds an object by merging the objects retrieved by other inputs.
Latest version: 0.0.11

# `@shanzhai/merge-object-input` [![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/merge-object-input.svg)](https://www.npmjs.com/package/@shanzhai/merge-object-input) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/merge-object-input.svg)](https://www.npmjs.com/package/@shanzhai/merge-object-input)

A Shanzhai input which builds an object by merging the objects retrieved by other inputs.

## Example

The following two examples are equivalent:

```typescript
new MergeObjectInput([
  new ConstantInput({
    a: 3,
    b: 10,
  }),
  new ConstantInput({
    c: 7,
  }),
]);

new ConstantInput({
  a: 3,
  b: 10,
  c: 7,
});
```

## 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/minified-html-store
Description: A Shanzhai store for minified HTML.
Latest version: 0.0.1
Deprecated: HTML

# `@shanzhai/minified-html-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/minified-html-store.svg)](https://www.npmjs.com/package/@shanzhai/minified-html-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minified-html-store.svg)](https://www.npmjs.com/package/@shanzhai/minified-html-store)

A Shanzhai store for minified HTML.

## 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/minified-javascript-store
Description: A Shanzhai store for minified Javascript files.
Latest version: 0.0.7
Deprecated: Minified

# `@shanzhai/minified-javascript-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/minified-javascript-store.svg)](https://www.npmjs.com/package/@shanzhai/minified-javascript-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minified-javascript-store.svg)](https://www.npmjs.com/package/@shanzhai/minified-javascript-store)

A Shanzhai store for minified Javascript 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/minified-svg-store
Description: A Shanzhai store for minified SVG files.
Latest version: 0.0.7

# `@shanzhai/minified-svg-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/minified-svg-store.svg)](https://www.npmjs.com/package/@shanzhai/minified-svg-store) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minified-svg-store.svg)](https://www.npmjs.com/package/@shanzhai/minified-svg-store)

A Shanzhai store for minified SVG 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/minify-html-plugin
Description: A Shanzhai plugin which minifies HTML from the source store.
Latest version: 0.0.17

# `@shanzhai/minify-html-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-html-plugin.svg)](https://www.npmjs.com/package/@shanzhai/minify-html-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minify-html-plugin.svg)](https://www.npmjs.com/package/@shanzhai/minify-html-plugin)

A Shanzhai plugin which minifies HTML 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-html-step
Description: A Shanzhai step which minifies a HTML file.
Latest version: 0.0.15

# `@shanzhai/minify-html-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-html-step.svg)](https://www.npmjs.com/package/@shanzhai/minify-html-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minify-html-step.svg)](https://www.npmjs.com/package/@shanzhai/minify-html-step)

A Shanzhai step which minifies a HTML file.

## Usage

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

```typescript
new MinifyHtmlStep(
  `A description of the operation being performed`,
  new AnInputOfUnminifiedHtml(),
  new AnOutputOfMinifiedHtml()
);
```

## Configuration Notes

The configuration used is highly aggressive, and the resulting HTML may actually
be invalid, but should still function.

It will not be suitable for inclusion in other HTML documents, however.

## Dependencies

This package has the following runtime dependencies:

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

## 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-javascript-plugin
Description: A Shanzhai plugin which minifies the Javascript from the source store, writing the resulting Javascript to the Pug locals store.
Latest version: 0.0.14

# `@shanzhai/minify-javascript-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-javascript-plugin.svg)](https://www.npmjs.com/package/@shanzhai/minify-javascript-plugin) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minify-javascript-plugin.svg)](https://www.npmjs.com/package/@shanzhai/minify-javascript-plugin)

A Shanzhai plugin which minifies the Javascript from the source store, writing the resulting Javascript to the Pug locals 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-javascript-step
Description: A Shanzhai step which minifies a Javascript file.
Latest version: 0.0.15

# `@shanzhai/minify-javascript-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-javascript-step.svg)](https://www.npmjs.com/package/@shanzhai/minify-javascript-step) [![npm type definitions](https://img.shields.io/npm/types/@shanzhai/minify-javascript-step.svg)](https://www.npmjs.com/package/@shanzhai/minify-javascript-step)

A Shanzhai step which minifies a Javascript file.

## Usage

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

```typescript
new MinifyJavascriptStep(
  `A description of the operation being performed`,
  new AnInputOfUnminifiedJavascript(),
  new AnInputOfAnObjectOfGlobalConstants(),
  new AnOutputOfMinifiedJavascript()
);
```

## Configuration Notes

The configuration used is highly aggressive.

It assumes that no other script in the page needs any of top-level declarations,
and leaves only object property minification disabled (due to its high risk of
unexpected side effects).

## Dependencies

This package has the following runtime dependencies:

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

## 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)