Skip to content

chore: Expanding lll coverage to queue - #5867

Merged
yhakbar merged 1 commit into
mainfrom
chore/expanding-lll-coverage-to-queue
Apr 29, 2026
Merged

chore: Expanding lll coverage to queue#5867
yhakbar merged 1 commit into
mainfrom
chore/expanding-lll-coverage-to-queue

Conversation

@yhakbar

@yhakbar yhakbar commented Apr 10, 2026

Copy link
Copy Markdown
Collaborator

Description

Addressed lll findings in queue.

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)

Updated lll linter coverage to include queue.

Summary by CodeRabbit

  • Chores

    • Updated linter configuration for path exclusions.
  • Style

    • Reformatted comments and test assertions for improved readability.

Note: This release contains internal code quality improvements with no user-facing changes.

@coderabbitai

coderabbitai Bot commented Apr 10, 2026

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

The PR updates linter configuration to exclude internal/queue/ paths from the lll linter, and reformats comments and test assertions in the queue module for improved readability. All changes are cosmetic with no logic modifications.

Changes

Cohort / File(s) Summary
Linter Configuration
.golangci.yml
Updated lll linter path-except regex to exclude internal/queue/ paths from line length checks.
Queue Module Formatting
internal/queue/queue.go, internal/queue/queue_test.go
Rewrapped comment documentation and test assertion arguments across multiple lines for readability without altering logic or behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: expanding the lll linter configuration to include the queue package by adding internal/queue/ to exclusions.
Description check ✅ Passed The description covers the main change (addressing lll findings in queue), includes checked TODOs, and provides release notes as required by the template.
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.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/expanding-lll-coverage-to-queue

Review rate limit: 3/5 reviews remaining, refill in 12 minutes and 48 seconds.

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

@vercel

vercel Bot commented Apr 10, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
terragrunt-docs Ready Ready Preview, Comment Apr 29, 2026 5:20pm

Request Review

@yhakbar
yhakbar force-pushed the chore/expanding-lll-coverage-to-tflint branch from b595fe0 to 0d7d132 Compare April 24, 2026 18:28
@yhakbar
yhakbar force-pushed the chore/expanding-lll-coverage-to-queue branch from 4cdda42 to 294825f Compare April 24, 2026 18:28
@yhakbar
yhakbar marked this pull request as ready for review April 24, 2026 18:29
@yhakbar
yhakbar requested a review from denis256 as a code owner April 24, 2026 18:29
denis256
denis256 previously approved these changes Apr 29, 2026
@yhakbar
yhakbar force-pushed the chore/expanding-lll-coverage-to-tflint branch from 0d7d132 to 2451cb4 Compare April 29, 2026 17:08
Base automatically changed from chore/expanding-lll-coverage-to-tflint to main April 29, 2026 17:18
@yhakbar
yhakbar dismissed denis256’s stale review April 29, 2026 17:18

The base branch was changed.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
.golangci.yml (1)

115-117: Consider refactoring the path-except regex for maintainability.

The path-except regex on line 117 is extremely long and contains many directory patterns in a single expression, which can be challenging to maintain. Consider splitting this into multiple exclusion rules or using a more structured format (e.g., a list of path patterns).

💡 Example refactor approach

While golangci-lint v2 doesn't directly support arrays for path-except, you could potentially split this into multiple linter exclusion rules for better readability:

      - linters:
          - lll
-       path-except: '^(internal/awshelper/|internal/cas/|...)'
+       path-except: '^(internal/awshelper/|internal/cas/|internal/cli/commands/(backend/(delete|migrate)|catalog/tui/command|exec|find|help|list|stack)/)'
+     - linters:
+         - lll
+       path-except: '^(internal/cloner/|internal/configbridge/|internal/engine/|internal/errorconfig/)'

However, this is a low-priority enhancement and doesn't need to block this PR.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.golangci.yml around lines 115 - 117, The long single path-except regex in
.golangci.yml (the path-except entry) is hard to maintain; split it into
multiple, smaller exclusions by creating separate linter entries or multiple
path-except rules that each match a subset of directories (e.g., group by
internal/* subsystems like internal/runner, internal/stacks, internal/tf,
pkg/log, etc.), or convert to several anchored regexes with clearer names so
each pattern is shorter and easier to edit; update the linter configuration to
apply these multiple exclusions in place of the single giant regex.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.golangci.yml:
- Around line 115-117: The long single path-except regex in .golangci.yml (the
path-except entry) is hard to maintain; split it into multiple, smaller
exclusions by creating separate linter entries or multiple path-except rules
that each match a subset of directories (e.g., group by internal/* subsystems
like internal/runner, internal/stacks, internal/tf, pkg/log, etc.), or convert
to several anchored regexes with clearer names so each pattern is shorter and
easier to edit; update the linter configuration to apply these multiple
exclusions in place of the single giant regex.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8bcd4234-b568-4086-b432-17c9a0da1d83

📥 Commits

Reviewing files that changed from the base of the PR and between d27064f and d2956f7.

📒 Files selected for processing (3)
  • .golangci.yml
  • internal/queue/queue.go
  • internal/queue/queue_test.go

@yhakbar
yhakbar merged commit 3fc8669 into main Apr 29, 2026
53 checks passed
@yhakbar
yhakbar deleted the chore/expanding-lll-coverage-to-queue branch April 29, 2026 18:41
Rahul-Kumar-prog pushed a commit to Rahul-Kumar-prog/terragrunt that referenced this pull request May 10, 2026
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