@truffle/box
@truffle/box
npm i @truffle/box
@truffle/box

@truffle/box

A tool for developing smart contracts. Crafted with the finest cacaos.

by trufflesuite

2.1.58 (see all)License:MITTypeScript:Built-In
npm i @truffle/box
Readme

@truffle/box

Truffle Box management functionality.

Handles behavior for unboxing a new project from a predefined Truffle Box.

Usage

const TruffleBox = require("@truffle/box");

// `@truffle/box` prompts when unboxing into non-empty directories & before potential overwrites
// a `force` option can be passed to force unboxing. default is false
const unboxOptions = { force: false };

// .unbox() validates & unboxes truffle box repos
// pass the current working directory as directory to unbox into
TruffleBox.unbox("https://github.com/trufflesuite/truffle-init-default", process.cwd(), unboxOptions);

// or specify relative path to unbox into (path must already exist)
TruffleBox.unbox("https://github.com/trufflesuite/truffle-init-default", "some/relativePath", unboxOptions);

Box Configuration

Truffle Boxes are configured via a required truffle-box.json file in the box repo's root directory.

This box configuration file specifies an object containing the following properties:

  • ignore

    A list of relative paths to files that should be removed upon box unpack. Useful to remove box READMEs or other artifacts that pertain to box but not the set-up Truffle project.

    Example:

    "ignore": [
      "README.md",
      ".gitignore"
    ]
    
  • commands

    An object mapping supported behaviors for project to invoked command strings.

    truffle unbox prints commands to screen upon unboxing for documentation purposes.

    Example:

    "commands": {
      "compile": "truffle compile",
      "migrate": "truffle migrate",
      "test": "truffle test"
    }
    
  • hooks

    An object to specify commands to run at particular steps in the unbox process. Maps strings identifying individual hooks to command strings.

    Example:

    "hooks": {
      "post-unpack": "npm install"
    }
    

Available Unbox Hooks

  • post-unpack

    If provided, runs command after box files are fetched and cleaned up for a new project.

    Commonly useful to install dependencies, e.g.

Downloads/wk

812

GitHub Stars

13.5K

LAST COMMIT

7mos ago

MAINTAINERS

14

CONTRIBUTORS

258

OPEN ISSUES

488

OPEN PRs

26
VersionTagPublished
2.1.58
latest
6d ago
2.1.58-hardhat-error.0
hardhat-error
1mo ago
2.1.53-typescript-migrations.0
typescript-migrations
2mos ago
2.1.50-alpha.2
signTypedData_v4
3mos ago
No alternatives found
No tutorials found
Add a tutorial

Rate & Review

100
No reviews found
Be the first to rate