# truffle-flattener

> Truffle Flattener concats solidity files developed under Truffle with all of their dependencies

Latest version **1.6.0** (published 2022-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install truffle-flattener
pnpm add truffle-flattener
yarn add truffle-flattener
bun add truffle-flattener
```

Provides the command `truffle-flattener`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.0 |
| Published | 2022-02-12 |
| First published | 2017-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 14.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 365 |
| Author | Nomic Labs SRL |
| Maintainers | alcuadrado |
| Keywords | ethereum, solidity, truffle, smart-contracts |

## Links

- npm: https://www.npmjs.com/package/truffle-flattener
- Repository: https://github.com/nomiclabs/truffle-flattener
- Issues: https://github.com/nomiclabs/truffle-flattener/issues
- npm.io page: https://npm.io/package/truffle-flattener

## Dependencies (5)

- [tsort](https://npm.io/package/tsort.md) 0.0.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4
- [find-up](https://npm.io/package/find-up.md) ^2.1.0
- [@solidity-parser/parser](https://npm.io/package/@solidity-parser/parser.md) ^0.14.1
- [@resolver-engine/imports-fs](https://npm.io/package/@resolver-engine/imports-fs.md) ^0.2.2

## 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.6.0 (latest) — 2022-02-12
- 1.5.0 — 2020-09-13
- 1.4.4 — 2020-05-02
- 1.4.3 — 2020-04-12
- 1.4.2 — 2019-08-29
- 1.4.1 — 2019-08-29
- 1.4.0 — 2019-06-18
- 1.3.0 — 2019-02-13
- 1.2.12 — 2019-01-31
- 1.2.11 — 2019-01-27
- 1.2.10 — 2018-11-22
- 1.2.9 — 2018-10-04
- 1.2.8 — 2018-09-08
- 1.2.7 — 2018-09-08
- 1.2.6 — 2018-08-06
- … 7 more at https://npm.io/package/truffle-flattener/versions

## README

# truffle-flattener

[![npm](https://img.shields.io/npm/v/truffle-flattener.svg)](https://www.npmjs.com/package/truffle-flattener)

Truffle Flattener concats solidity files from Truffle and Buidler projects 
with all of their dependencies.

This tool helps you to verify contracts developed with Truffle and Buidler 
on [Etherscan](https://etherscan.io), or debugging them on
[Remix](https://remix.ethereum.org), by merging your files and their
dependencies in the right order.

If you are still using Truffle, we recommend you try [Buidler](https://github.com/nomiclabs/buidler), 
our Ethereum development environment, which is much faster and flexible.

# Hardhat support

If you are using Hardhat, you don't need this project. Use `npx hardhat flatten` instead.

## Installation

`npm install truffle-flattener -g`

## Usage

Just install it with npm in your truffle project and run
`truffle-flattener <solidity-files>`.

## Limitations

Aliased imports (eg: `import {symbol1 as alias, symbol2} from "filename";`) are
not supported by `truffle-flattener`.

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