fix: ensure emacs users can easily format in the editor#2470
Open
fix: ensure emacs users can easily format in the editor#2470
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds Emacs editor support for automatic code formatting using clang-format. It introduces a repository-tracked .dir-locals.el file that configures key bindings for clang-format commands in C++ mode, making it easier for Emacs users to format code consistently with the project's .clang-format configuration.
Changes:
- Added
.dir-locals.elwith clang-format key bindings (C-c ifor region,C-c ufor buffer) in c++-mode - Modified
.gitignoreto track.dir-locals.eland ignore.dir-locals-2.elfor personal customizations
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .gitignore | Updated to track .dir-locals.el and ignore .dir-locals-2.el (contains typo) |
| .dir-locals.el | New Emacs configuration file with clang-format key bindings and package loading logic |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
wdconinc
temporarily deployed
to
github-pages
GitHub Actions
Inactive
Contributor
wdconinc
force-pushed
the
emacs-clang-format
branch
from
6bd8e59 to
8ba6ff8
Compare
wdconinc
temporarily deployed
to
github-pages
GitHub Actions
Inactive
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Briefly, what does this PR introduce?
This PR adds a local emacs configuration and key binding for clang-format. The key bindings
C-c i(clang-format-region) andC-c u(clang-format-buffer) are defined.When first starting up emacs on a C++ file inside this repository, this configuration will as you to accept this configuration with
!(and you won't be asked again).You will need to have the
clang-formatemacs package installed (in addition to the commandclang-formatprovided by a system package).The
clang-formatemacs package is on the MELPA package archive, which you will need to enable in your configuration if it isn't already.This PR removes
.dir-locals.elfrom.gitignore(and adds.dir-locals-2.el), and this PR may therefore overwrite local.dir-locals.elfiles (after warning about this). The standard approach is for.dir-locals.elto be tracked in git, and for personal additions that are not tracked to be added to.dir-locals-2.el.What kind of change does this PR introduce?
Please check if this PR fulfills the following:
Does this PR introduce breaking changes? What changes might users need to make to their code?
No.
Does this PR change default behavior?
No.