Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Rename "format" to "output format" #494

Open
chris48s opened this issue Aug 19, 2024 · 0 comments
Open

Rename "format" to "output format" #494

chris48s opened this issue Aug 19, 2024 · 0 comments
Labels
breaking changes that need to be made in a major release

Comments

@chris48s
Copy link
Owner

I'd like to bring this into line with the terminology in the plugin system.

I think the way I will do this is:

  • In a minor release, add an --output-format command line flag and an outputFormat key in the config file
  • Make them do the same thing as --format and format
  • Mark --format and format deprecated in the changelog
  • Mark format deprecated in the JSON schema
  • Mark --format as deprecated using yargs
  • Log a deprecation warning to the console if either of those things are used

Then in the next major, actually remove format and --format

@chris48s chris48s added the breaking changes that need to be made in a major release label Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking changes that need to be made in a major release
Projects
None yet
Development

No branches or pull requests

1 participant