# @nomiclabs/buidler-solpp

> Buidler plugin for solpp

Latest version **1.3.3** (published 2020-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nomiclabs/buidler-solpp
pnpm add @nomiclabs/buidler-solpp
yarn add @nomiclabs/buidler-solpp
bun add @nomiclabs/buidler-solpp
```

## Health

**Score 40/100 (D)** — status: abandoned.

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

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.3.3 |
| Published | 2020-05-10 |
| First published | 2019-04-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 12.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8521 |
| Author | Nomic Labs LLC |
| Maintainers | alcuadrado, fzeoli |
| Keywords | ethereum, smart-contracts, buidler, buidler-plugin, solidity, solidity-preprocessor, solpp |

## Links

- npm: https://www.npmjs.com/package/@nomiclabs/buidler-solpp
- Repository: https://github.com/nomiclabs/buidler
- Homepage: https://github.com/nomiclabs/buidler/tree/master/packages/buidler-solpp
- Issues: https://github.com/nomiclabs/buidler/issues
- npm.io page: https://npm.io/package/@nomiclabs/buidler-solpp

## Dependencies (2)

- [solpp](https://npm.io/package/solpp.md) ^0.10.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.3.3 (latest) — 2020-05-10
- 1.3.3-rc.0 (rc) — 2020-05-05
- 1.3.2 — 2020-05-02
- 1.3.1 — 2020-04-28
- 1.3.0 — 2020-04-18
- 1.3.0-rc.1 — 2020-04-10
- 1.3.0-rc.0 — 2020-04-06
- 1.2.0 — 2020-02-27
- 1.2.0-rc.4 — 2020-02-24
- 1.2.0-rc.3 — 2020-02-23
- 1.2.0-rc.2 — 2020-02-23
- 1.2.0-rc.1 — 2020-02-22
- 1.2.0-rc.0 — 2020-02-21
- 1.1.3-rc.0 — 2020-02-13
- 1.1.1 — 2020-01-26
- … 15 more at https://npm.io/package/@nomiclabs/buidler-solpp/versions

## README

[![npm](https://img.shields.io/npm/v/@nomiclabs/buidler-solpp.svg)](https://www.npmjs.com/package/@nomiclabs/buidler-solpp)
[![buidler](https://buidler.dev/buidler-plugin-badge.svg?1)](https://buidler.dev)

# buidler-solpp

[Buidler](http://getbuidler.com) plugin for integration with the [solpp preprocessor](https://github.com/merklejerk/solpp).

## What

This plugin hooks into the compilation pipeline and runs the solpp preprocessor.

## Installation

```bash
npm install --save-dev @nomiclabs/buidler-solpp
```

And add the following statement to your `buidler.config.js`:

```js
usePlugin("@nomiclabs/buidler-solpp");
```

## Environment extensions

This plugin does not extend the environment.

## Usage

There are no additional steps you need to take for this plugin to work.

Install it, run `npx buidler compile` and solc will compile the solpp generated contracts, which will be in `cache/solpp-generated-contracts`.

## Configuration

This plugin can by configured by setting a `solpp` entry in `buidler.config.js`. Its options are:

- `defs`: is an object where each property is the symbol's name and its value is the actual definition. Definitions can be numbers, string, expressions, lists, or functions. For more detail about symbols you can check [solpp README](https://github.com/merklejerk/solpp).
- `cwd: string`: directory where the contracts are located, it will be used for flattening purposes, by default it will be the project's source directory.
- `collapseEmptyLines: boolean`: delete empty lines, false by default.
- `noPreprocessor: boolean`: disable preprocessor, false by default.
- `noFlatten: boolean`: won't flatten contracts, true by default.
- `tolerant: boolean`: ignore if an imported contract file is missing when flattening, false by default.

## TypeScript support

You need to add this to your `tsconfig.json`'s `files` array: `"node_modules/@nomiclabs/buidler-solpp/src/type-extensions.d.ts"`

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