Hercules
Hercules is a tool for easily managing all of Remark's TypeScript projects, specifically inter-project dependencies.
Installation
Hercules can be installed like so:
npm i -g @remark/hercules
hercules
should now be accessible via the command line.
Commands
Hercules commands can be run from anywhere inside of the Remark monorepo. Attempting to run outside of the repo will not work, as Hercules needs access to its configuration file (i.e., C:/Projects/hercules.json
).
help
hercules -h
Displays the Hercules help menu.
ls
hercules ls
Lists all of the packages in the repository.
bootstrap
hercules bootstrap
Bootstraps all of the packages in the current repository.
What this entails:
- Runs
npm install
to install all external dependencies from the packages. - Runs
npm prepublish
for each package, which can be used to run compilation steps, etc. - Creates symlinks for all internal dependencies.