Ballpoint

A CLI for formatting ink files

Also available in web app form

Get Started

Step 1 Install node.js

use nvm to install node

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
nvm install 18
nvm use 18

Step 2 Ballpoint

npm install -g @little-bonsai/ballpoint

Step 3 Run

ballpoint **/*.ink

Acknowledgements

This would not have been possible without the great work of

• ink
• inkjs

Contributing

Bug Reports and PRs are very welcome.

If filing a bug report, please include:

• your original ink code
• how it was formatted
• how it should be formatted
• any additional information

If opening a MR, please include:

• a description of the change
• at least 1 test showing the input and output

TODO

• [x] npm publish
• [x] repeated application test
• [x] tags
• [x] multiple tags
• [x] ref arguments
• [x] INCLUDE handling
• [x] web hosted
  • [x] basic hosting
  • [x] error reporting
• [x] comments
• [x] directives based approach
• [x] api?
• [x] multi-lined multi-conditioned choices
• [x] dynamic tags
• [ ] PR GetType overrides into inkjs
• [ ] PR Parser export into inkj
• [ ] sort INCLUDEs option
• [ ] make package available as importable lib
• [ ] look at integrating into inky