Skip to content

2785 indent line comments #2786

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

Merged
merged 3 commits into from
Apr 15, 2025
Merged

Conversation

pbwolf
Copy link
Contributor

@pbwolf pbwolf commented Apr 15, 2025

What has changed?

cljfmt 0.13.1 added an option to indent ";;" comments as recommended by the Clojure Style Guide:

  • :indent-line-comments? - true if cljfmt should align whole-line ;; comments with the code. Defaults to false.

This pull request

  • updates cljfmt to 0.13.1
  • sets option :indent-line-comments? to true by default
  • does not update pez-cljfmt, which handles formatting when :align-associative? is true
  • adds a test to formatter_test.cljs

Fixes #2785

My Calva PR Checklist

I have:

  • Read How to Contribute.
  • Directed this pull request at the dev branch. (Or have specific reasons to target some other branch.)
  • Made sure I have changed the PR base branch, so that it is not published. (Sorry for the nagging.)
  • Made sure there is an issue registered with a clear problem statement that this PR addresses, (created the issue if it was not present).
    • Updated the [Unreleased] entry in CHANGELOG.md, linking the issue(s) that the PR is addressing.
  • Figured if anything about the fix warrants tests on Mac/Linux/Windows/Remote/Whatever, and either tested it there if so, or mentioned it in the PR.
  • Added to or updated docs in this branch, if appropriate
  • Tests
    • Tested the particular change
    • Figured if the change might have some side effects and tested those as well.
  • Formatted all JavaScript and TypeScript code that was changed. (use the prettier extension or run npm run prettier-format)
  • Confirmed that there are no linter warnings or errors (use the eslint extension, run npm run eslint before creating your PR, or run npm run eslint-watch to eslint as you go).

Ping @PEZ, @bpringe, @corasaurus-hex, @Cyrik

Copy link

netlify bot commented Apr 15, 2025

Deploy Preview for calva-docs ready!

Name Link
🔨 Latest commit 98826d4
🔍 Latest deploy log https://app.netlify.com/sites/calva-docs/deploys/67fdb0d73196a1000805a298
😎 Deploy Preview https://deploy-preview-2786--calva-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@PEZ PEZ merged commit a3739ed into BetterThanTomorrow:dev Apr 15, 2025
5 checks passed
@PEZ
Copy link
Collaborator

PEZ commented Apr 15, 2025

Thanks! I agree we should make it the default. Let's see if we get complaints about it.

For future PRs, consider adding a short slug to your feature branch name. It makes it easier to understand what a particular VSIX is about, since we include the branch name in the file name.

image

I love that the issue addressed is part of the branch name, so please keep doing that. In this case it would have been something like: 2785-indent-line-comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants