Skip to content
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

feat: Adding strict lint #3348

Merged
merged 2 commits into from
Aug 22, 2024
Merged

feat: Adding strict lint #3348

merged 2 commits into from
Aug 22, 2024

Conversation

yhakbar
Copy link
Collaborator

@yhakbar yhakbar commented Aug 16, 2024

Description

Adds strict linting for pull requests. This ensures that new code being introduced adheres to improved code quality standards.

The two lints being added here are for style and complexity. The current codebase violates these rules basically everywhere, so it's not feasible to enable these lints for everything.

Instead, we'll enable these lints for all new code being introduced or edited in pull requests, which should help us gradually improve the code quality over time.

I think if we're OK with introducing this, we should selectively ignore rules when they are too strict for a given file or require too much refactoring.

For a sense of the kinds of things we would change, you can take a look at this in-draft PR that I closed because it was unreasonably large:

#3347

TODOs

Read the Gruntwork contribution guidelines.

  • Update the docs.
  • Run the relevant tests successfully, including pre-commit checks.
  • Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
  • Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Added strict lint rules.

Copy link

sonarcloud bot commented Aug 16, 2024

@yhakbar yhakbar merged commit 98fcd4f into master Aug 22, 2024
4 checks passed
@yhakbar yhakbar deleted the feat/adding-strict-lint branch August 22, 2024 14:54
akrantz01 pushed a commit to akrantz01/homelab that referenced this pull request Aug 28, 2024
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
|
[gruntwork-io/terragrunt](https://github.com/gruntwork-io/terragrunt)
| minor | `v0.66.9` -> `v0.67.0` |
|
[gruntwork-io/terragrunt](https://github.com/gruntwork-io/terragrunt)
| minor | `0.66.9` -> `0.67.0` |

---

### Release Notes

<details>
<summary>gruntwork-io/terragrunt (gruntwork-io/terragrunt)</summary>

###
[`v0.67.0`](https://github.com/gruntwork-io/terragrunt/releases/tag/v0.67.0)

[Compare
Source](https://github.com/gruntwork-io/terragrunt/compare/v0.66.9...v0.67.0)

#### Updated CLI args, config attributes and blocks

- `--terragrunt-forward-tf-stdout`
([docs](https://terragrunt.gruntwork.io/docs/reference/cli-options/#terragrunt-forward-tf-stdout))
- `--terragrunt-disable-log-formatting`
([docs](https://terragrunt.gruntwork.io/docs/reference/cli-options/#terragrunt-disable-log-formatting))

#### Breaking Changes

-
[--terragrunt-include-module-prefix](https://terragrunt.gruntwork.io/docs/reference/cli-options/#terragrunt-include-module-prefix)
flag is deprecated, use
[--terragrunt-forward-tf-stdout](https://terragrunt.gruntwork.io/docs/reference/cli-options/#terragrunt-forward-tf-stdout)
instead

#### What's Changed

- feat: Adding `wsl` lint by
[@&#8203;yhakbar](https://github.com/yhakbar) in
[gruntwork-io/terragrunt#3351
- feat: Engine documentation update by
[@&#8203;denis256](https://github.com/denis256) in
[gruntwork-io/terragrunt#3355
- feat: Adding strict lint by
[@&#8203;yhakbar](https://github.com/yhakbar) in
[gruntwork-io/terragrunt#3348
- feat: Split out unessential jobs by
[@&#8203;yhakbar](https://github.com/yhakbar) in
[gruntwork-io/terragrunt#3357
- feat: Adding `thelpher` and `wastedassign` lints by
[@&#8203;yhakbar](https://github.com/yhakbar) in
[gruntwork-io/terragrunt#3352
- fix: Updating docs 'Reading from other HCL files' by
[@&#8203;riccalioliojr](https://github.com/riccalioliojr) in
[gruntwork-io/terragrunt#3361
- feat: Log improvements by
[@&#8203;levkohimins](https://github.com/levkohimins) in
[gruntwork-io/terragrunt#3338

Old Terragrunt log:

![old-logs](https://github.com/user-attachments/assets/3cd5b8b1-ffe9-4002-a288-6ab333b6c174)

New Terragrunt log:

![new-logs](https://github.com/user-attachments/assets/0d30fd20-0360-47e2-9f5e-1db9f62d22d6)

#### New Contributors

- [@&#8203;riccalioliojr](https://github.com/riccalioliojr) made their
first contribution in
[gruntwork-io/terragrunt#3361

**Full Changelog**:
gruntwork-io/terragrunt@v0.66.9...v0.67.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/akrantz01/homelab).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4yNi4xIiwidXBkYXRlZEluVmVyIjoiMzguNTYuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
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.

3 participants