Skip to content

various: expand formatting#688

Open
faukah wants to merge 4 commits into
masterfrom
faukah/push-kxwoqlnmpqqy
Open

various: expand formatting#688
faukah wants to merge 4 commits into
masterfrom
faukah/push-kxwoqlnmpqqy

Conversation

@faukah

@faukah faukah commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Sanity Checking

  • I have read and understood the contribution guidelines
  • I have updated the changelog as per my changes
  • I have tested, and self-reviewed my code
  • Style and consistency
    • I ran nix fmt to format my Nix code
    • I ran cargo fmt to format my Rust code
    • I have added appropriate documentation to new code
    • My changes are consistent with the rest of the codebase
  • Correctness
    • I ran cargo clippy and fixed any new linter warnings.
  • If new changes are particularly complex:
    • My code includes comments in particularly complex areas to explain the
      logic
    • I have documented the motive for those changes in the PR body or commit
      description.
  • Tested on platform(s):
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin

Add a 👍 reaction to pull requests you find important.

@coderabbitai

coderabbitai Bot commented Jun 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 80ffaa48-b7cf-4031-84d0-a58976f98a0d

📥 Commits

Reviewing files that changed from the base of the PR and between dfc85da and ed992c0.

📒 Files selected for processing (8)
  • .github/ISSUE_TEMPLATE/bug.yml
  • .github/workflows/changelog.yaml
  • .github/workflows/cleanup.yaml
  • CHANGELOG.md
  • Justfile
  • docs/README.md
  • flake.nix
  • shell.nix
💤 Files with no reviewable changes (1)
  • .github/workflows/changelog.yaml
✅ Files skipped from review due to trivial changes (4)
  • .github/workflows/cleanup.yaml
  • shell.nix
  • docs/README.md
  • .github/ISSUE_TEMPLATE/bug.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • flake.nix

📝 Walkthrough

Walkthrough

Adds deno and taplo as project formatters: flake.nix extends its formatter wrapper to run taplo fmt for TOML and deno fmt for Markdown, shell.nix adds deno to nativeBuildInputs, and Justfile gains deno-check/deno-fmt recipes wired into the existing check and fix targets. The remaining file changes are formatting-only normalizations across CHANGELOG.md, docs/README.md, .github/ISSUE_TEMPLATE/bug.yml, and .github/workflows/.

Changes

Deno/TOML Formatter Integration and Applied Cleanups

Layer / File(s) Summary
Deno/TOML formatter wiring in flake, shell, and Justfile
flake.nix, shell.nix, Justfile
flake.nix extends the formatter wrapper to invoke taplo fmt for TOML files and deno fmt for Markdown, adding both tools to runtimeInputs. shell.nix adds deno to nativeBuildInputs. Justfile adds deno-check (deno fmt --check) and deno-fmt (deno fmt .) recipes and includes them in the check and fix dependency lists.
Formatting normalization across docs and config
CHANGELOG.md, docs/README.md, .github/ISSUE_TEMPLATE/bug.yml, .github/workflows/changelog.yaml, .github/workflows/cleanup.yaml
Line-wrapping, indentation, and quote-style normalization applied with no semantic changes: CHANGELOG entries reflowed, README nh search table and NH_FILE/NH_ATTRP paragraph rewrapped, bug template YAML whitespace and indentation adjusted, cleanup workflow date value re-quoted with double quotes, and changelog workflow trailing blank line removed.

Possibly related PRs

  • nix-community/nh#633: Updates CI to invoke just check/just fix, which directly exercises the deno-check and deno-fmt targets added to those recipes in this PR.
  • nix-community/nh#597: Introduces and standardizes the just check/just fix recipes that this PR extends with Deno formatting steps.

Suggested reviewers

  • NotAShelf
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description lacks substantive information about the changes; it contains only the template boilerplate without any explanation of the formatting expansion or motivation. Add a clear description explaining what formatting tools were added (Deno, TOML), which files were modified, and the motivation for these changes.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'various: expand formatting' directly reflects the main changes across multiple files to add and expand formatting tooling support (Deno formatting, TOML formatting, Markdown formatting).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@faukah faukah added the allow-no-changelog Doesen't need a CHANGELOG.md entry. label Jun 14, 2026
Comment thread shell.nix
Comment on lines +23 to +24
# Markdown formatting
deno

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm not a big fan of using a js runtime for formatting, but as discussed with @NotAShelf, there are no other good Markdown formatters we're both happy with.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@flake.nix`:
- Around line 58-59: The comment states "Format Nix with Alejandra" but the
actual command on the following line invokes nixfmt, which is a different
formatter. Update the comment to accurately reflect the tool being used in the
fd command. Change the comment to state "Format Nix with nixfmt" to match the
nixfmt command that is actually being executed.
- Around line 64-65: The Markdown formatter in flake.nix excludes docs/API.md
using the `-E docs/API.md` flag in the fd command, but this file does not exist
in the repository and the Justfile's deno-fmt recipe does not apply this same
exclusion. Remove the `-E docs/API.md` exclusion from the fd command unless this
file is planned to be generated or managed externally, in which case add a
comment explaining the purpose of the exclusion.

In `@Justfile`:
- Line 4: Update CONTRIBUTING.md at lines 91-100 to document the Deno formatting
step that is now included in the check and fix tasks. The `check` recipe in
Justfile includes `deno-check` and the `fix` recipe includes `deno-fmt`, but the
current documentation only lists cargo-based tools. Add documentation for the
`deno fmt` step to the task descriptions so users are aware that Deno formatting
checks are part of the check and fix process.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 647c6f90-b05a-4fef-8ad6-82edcaf6e651

📥 Commits

Reviewing files that changed from the base of the PR and between 4735d06 and dfc85da.

📒 Files selected for processing (8)
  • .github/ISSUE_TEMPLATE/bug.yml
  • .github/workflows/changelog.yaml
  • .github/workflows/cleanup.yaml
  • CHANGELOG.md
  • Justfile
  • docs/README.md
  • flake.nix
  • shell.nix
💤 Files with no reviewable changes (1)
  • .github/workflows/changelog.yaml

Comment thread flake.nix Outdated
Comment thread flake.nix Outdated
Comment thread Justfile
@faukah faukah force-pushed the faukah/push-kxwoqlnmpqqy branch from dfc85da to ed992c0 Compare June 14, 2026 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

allow-no-changelog Doesen't need a CHANGELOG.md entry.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant