Yarus / Builder ·

Blazing fast, zero configuration node app and libs builder

Getting Started

Installing

For Builder itself installation is done by executing one command.

npm install --save-dev @yarus/builder

Dependending on your transpiling needs you need Babel with the requires presets/plugins. This is nothing extra to install typically as you might have these things in-place already. Example:

npm install --save-dev @babel/core @babel/plugin-external-helpers @babel/plugin-transform-runtime

Usage

Command Line Interface

Builder comes with a binary which can be called from within your scripts section in the package.json file.

"scripts": {
  "prepare": "preppy"
}

There is also some amount of parameters you can use if the auto detection of your library does not work out correctly.

• --root auto The root folder of your project
• --output auto Override output folder (and package.json entries)
• --watch false Keeps running and rebuilds on any change
• --no-sourcemap false Disables creation of a source map file during processing
• -v, --verbose false Verbose output mode
• -h, --help Get help
• --run Executes the generated binary after creation

Binary Output(s)

• src/cli/{cliname}/index.js
• src/cli/{cliname}.js
• src/cli/index.js
• src/cli.js

Environment Settings

Contributing

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to @yarus / Builder.

Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributors

This project exists thanks to all the people who contribute.

---

Made with ❤️ by Yaroslav Usenko.

It is free software, and may be redistributed under the MIT License detailed in the LICENSE.md file.