b-ryu / climp Goto Github PK

Can't have too many tests.

🚧 TODO

Primary features

• Support infinite positional args
• Support no-args case
• Support aliases
  • Support catch-all function for transforming command names
• Preprocessing/optimizations
• Support default types

Secondary features/backlog

• Built-in/generated --help function
• Greater configurability in general
• Improved errors
  • Pass in useful info in error object
  • More specialized error types
  • More extensive type errors
• More specific/useful TS types
• Config/arg validators
• Error-handling config

Project items

• Tests
• Flesh out docs
• Publish
• Publish script
• Set up GH actions for automated testing

• Add keywords

Publish on npm so I can easily dogfood this in other projects

The way I'm doing it right now (manually versioning, tagging and yarn publishing) is highly bucktee and error-prone.

I should write a script or something to smooth out the process a little bit.

Ideally we'd want some way of telling consumers if the command function they pass into the config is incompatible with the types defined in the rest of the config, if possible.