# @plateui/toolkit

> Tooling set for functionary applications

Latest version **0.2.2** (published 2021-05-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @plateui/toolkit
pnpm add @plateui/toolkit
yarn add @plateui/toolkit
bun add @plateui/toolkit
```

Provides the command `functionary-toolkit`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2021-05-14 |
| First published | 2021-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 14.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Wraft Inc |
| Maintainers | muneef |
| Keywords | build, test, tools |

## Links

- npm: https://www.npmjs.com/package/@plateui/toolkit
- Repository: https://github.com/wraft/plateui
- Homepage: https://github.com/wraft/plateui/packages/toolkit
- Issues: https://github.com/wraft/plateui/issues
- npm.io page: https://npm.io/package/@plateui/toolkit

## Dependencies (1)

- [yargs](https://npm.io/package/yargs.md) ^16.2.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2021-05-14
- 0.2.1 — 2021-04-30

## README

# `@plateui/toolkit`

Tooling set for functionary applications

## Usage

Install as a dependency

```bash
# if you use yarn
yarn add -D @plateui/toolkit
# or if you use npm
npm i --save-dev @plateui/toolkit
```

### CLI

A binary executable can be invoked as an npm script: `plateui-toolkit`.

#### create-dotenv-file

Create a local `.env` file based on an example file

`plateui-toolkit create-dotenv-file --example .env.example`

### Exports

This package also provides some centralised default configurations for e.g. webpack and babel.

```js
// webpack.config.babel.js
import { getWebpack4Configuration } from '@plateui/toolkit';

export default getWebpack4Configuration(
  'production', // or 'development'
  {
    buildFolder: path.resolve(__dirname, 'build'), // generated build folder
    htmlTemplate: path.resolve(__dirname, 'public/index.html'), // entry point for HtmlWebpackPlugin
  },
  {
    // any custom configuration that will be merged using webpack-merge
  },
);
```

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