docs: Documenting support for --parallelism flag in hcl fmt

[yhakbar]

Description

Documents support for --parallelism in hcl fmt.

TODOs

Read the Gruntwork contribution guidelines.

• I authored this code entirely myself
• I am submitting code based on open source software (e.g. MIT, MPL-2.0, Apache)]
• I am adding or upgrading a dependency or adapted code and confirm it has a compatible open source license
• Update the docs.
• Run the relevant tests successfully, including pre-commit checks.
• Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Added / Removed / Updated [X].

Migration Guide

Summary by CodeRabbit

• Documentation

  • Updated hcl fmt command documentation with improved flag organization for better usability

• New Features

  • Added parallelism configuration option for hcl fmt command to control concurrent execution

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
terragrunt-docs	Ready	Preview	Comment	Oct 27, 2025 9:19pm

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation for the hcl fmt command is updated to reorder the hcl-fmt-filter flag position and introduce a new parallelism flag to the flags list.

Changes

Cohort / File(s)	Change Summary
HCL fmt documentation docs-starlight/src/data/commands/hcl/fmt.mdx	Relocated hcl-fmt-filter flag in flags list; added new parallelism flag for configurable parameter support

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• docs: Documenting support for --filter in hcl commands #5010: Modifies hcl fmt documentation and the hcl-fmt-filter flag; directly related to this flag reordering.
• feat: Adding support for --parallelism to hcl fmt #5020: Adds --parallelism flag to hcl fmt command; directly related to the parallelism flag addition in this PR.

Suggested reviewers

• denis256
• levkohimins

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The PR description follows the required template structure with all major sections present (Description, TODOs, Release Notes, Migration Guide), but contains significant incomplete elements. The description section still has the placeholder "Fixes #000." instead of referencing an actual issue, the Release Notes section retains the template placeholder text "Added / Removed / Updated [X]." without being filled in, and the main description content is minimal. While the template structure is correct, the incomplete key sections and placeholder text indicate the description is not ready for merge.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "docs: Documenting support for --parallelism flag in hcl fmt" is clear and specific, accurately reflecting the main change documented in the raw summary: adding documentation for a new parallelism flag parameter in the hcl fmt command. The title uses conventional documentation prefix ("docs:") and directly addresses what was changed without being vague or generic. The title is concise and would be meaningful to someone scanning the commit history.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/documenting-parallel-flag-on-hcl-fmt

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 07af685 and 1919059.

📒 Files selected for processing (1)

• docs-starlight/src/data/commands/hcl/fmt.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs-starlight/**/*.md*

⚙️ CodeRabbit configuration file

Review the documentation for clarity, grammar, and spelling. Make sure that the documentation is easy to understand and follow. There is currently a migration underway from the Jekyll based documentation in docs to the Starlight + Astro based documentation in docs-starlight. Make sure that the docs-starlight documentation is accurate and up-to-date with the docs documentation, and that any difference between them results in an improvement in the docs-starlight documentation.

Files:

• docs-starlight/src/data/commands/hcl/fmt.mdx

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build-and-test

🔇 Additional comments (1)

docs-starlight/src/data/commands/hcl/fmt.mdx (1)

14-30: Verify parallelism flag documentation and placement.

The parallelism flag is added to the flags list but its placement between hcl-fmt-stdin and queue-exclude-dir breaks the grouping pattern (hcl-fmt-* flags, then queue-* flags). Additionally, ensure that a flag definition file for parallelism exists and documents the flag's behavior, scope (global vs. command-specific), and usage.

Consider confirming:

1. Whether parallelism is a global flag that applies to multiple commands (in which case it might belong in a shared globals section, not command-specific flags)
2. Whether a corresponding parallelism.mdx or similar flag definition file exists in the documentation
3. Whether the flag placement should be reordered to maintain the existing grouping pattern

---

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