Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Remove all controllable short options for CLI #15

Closed
neocotic opened this issue Nov 1, 2017 · 1 comment
Closed

Remove all controllable short options for CLI #15

neocotic opened this issue Nov 1, 2017 · 1 comment

Comments

@neocotic
Copy link
Owner

neocotic commented Nov 1, 2017

Currently, the following options are supported by the CLI:

-V, --version              output the version number
--no-color                 disables color output
-b, --base-url <url>       specify base URL to use for all relative URLs in SVG
-f, --filename <filename>  specify filename the for PNG output when processing STDIN
--height <value>           specify height for PNG
--scale <value>            specify scale to apply to dimensions [1]
--width <value>            specify width for PNG
-h, --help                 output usage information

To be future-proof and avoid confusion when adding more options (see #14), we should remove all short options within our control. This includes the following:

  • -b
  • -f

These will still be accessible via their long options (i.e. --base-url and --filename respectively), however, the short options will no longer work.

Obviously, this will be a breaking change.

@neocotic
Copy link
Owner Author

neocotic commented Nov 3, 2017

This change has been implemented in 81eed21 and will be included in the 0.3.0 release.

@neocotic neocotic closed this as completed Nov 3, 2017
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

1 participant