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

Move all our CLI file formatters to the format dir #13296

Merged
merged 2 commits into from Jul 20, 2021

Conversation

skullydazed
Copy link
Member

@skullydazed skullydazed commented Jun 22, 2021

Description

We have several commands for formatting files, but the naming convention is all over the place. This consolidates them into a nice structured qmk format-<type> command. The old names will continue to work for at least 1 or 2 more develop cycles, but they throw a warning.

Types of Changes

  • Core
  • Enhancement/optimization
  • Documentation

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@skullydazed skullydazed requested a review from a team June 22, 2021 05:57
@github-actions github-actions bot added cli qmk cli command python labels Jun 22, 2021
Copy link
Member

@Erovia Erovia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just minor suggestions, otherwise looks good.

lib/python/qmk/cli/cformat.py Outdated Show resolved Hide resolved
lib/python/qmk/cli/fileformat.py Outdated Show resolved Hide resolved
@Erovia Erovia requested a review from a team July 20, 2021 18:32
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
@skullydazed skullydazed merged commit 4ab8734 into develop Jul 20, 2021
Erovia added a commit to Erovia/qmk_firmware that referenced this pull request Jul 23, 2021
PR qmk#13296 changed the name of the `cformat` and `pyformat` commands to
`format-c` and `format-py` respectively. This PR updates the documentation
and some parts of the CLI to use the new names.
Also add documentation for the new `format-text` subcommand, introduced
in the same PR.
Erovia added a commit that referenced this pull request Jul 23, 2021
PR #13296 changed the name of the `cformat` and `pyformat` commands to
`format-c` and `format-py` respectively. This PR updates the documentation
and some parts of the CLI to use the new names.
Also add documentation for the new `format-text` subcommand, introduced
in the same PR.
@fauxpark fauxpark deleted the refactor_formatters branch August 3, 2021 10:15
nhongooi pushed a commit to nhongooi/qmk_firmware that referenced this pull request Dec 5, 2021
* move all our file formatters to the format dir

* Apply suggestions from code review

Co-authored-by: Erovia <Erovia@users.noreply.github.com>

Co-authored-by: Erovia <Erovia@users.noreply.github.com>
nhongooi pushed a commit to nhongooi/qmk_firmware that referenced this pull request Dec 5, 2021
PR qmk#13296 changed the name of the `cformat` and `pyformat` commands to
`format-c` and `format-py` respectively. This PR updates the documentation
and some parts of the CLI to use the new names.
Also add documentation for the new `format-text` subcommand, introduced
in the same PR.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli qmk cli command python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants