@webeferen/buildable

Buildable

Link your local repositories and dependencies quickly, without any additional knowledge.

• Installation
• Usage
  • Help & Version
  • Run Script
  • Dependency Graph
  • Execution Order
• Contributing
• License

Installation

Buildable is made to work with each of installation type such as local, global and npx.

Local scope

npm install --save-dev @webeferen/buildable

Global scope

npm install --global @webeferen/buildable

It can be also used via npx

npx @webeferen/buildable [command]

Usage

buildable [command] (...options)

Help

This command prints out useful information such as available commands and options.

buildable help

Prints out currently used version of the package

buildable --version

Run Script

This command runs specified command for each project inside directory.

buildable run (r) "script name" (...options)

Dependency Graph

This command generates dependency graph with every dependency inside workspace (linking them with correct versions). Graph only shows relations between local dependencies.

buildable dependency-graph (dg) (...options)

Execution Order

This command generates execution order in which projects should be run to avoid build order issues. It only takes into consideration local dependencies.

buildable execution-order (eo) (...options)

Available options

• --listeners (-l) List of comma separated texts when achieve next process can be run (regex check)
• --only (-o) List of comma separated projects that will only be run (with their dependencies)
• --exclude (-e) List of comma separated packages which should be excluded
• --path (-p) Relative path to the directory containing workspace (if any)
• --config (-c) Relative path to the configuration file
• --reload (-r) List of comma separated packages which can be manually reloaded

Possible issues

There were some cases where buildable was not able to kill child process by itself. If that happens, this command might help to clean the ports up:

kill -9 $(lsof -ti:[port])

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT