Skip to content

Allow exclusions to be array of strings #129

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

tyler-mastery
Copy link

@tyler-mastery tyler-mastery commented Mar 12, 2025

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?
Currently, exclusions are defined as a long comma-separated string. Since JSON does not support multi-line strings, this makes the configuration difficult to read, maintain, and validate with linting tools.

To improve readability and maintainability, we should allow exclusions to be specified as an array of strings. This will enable proper linting, formatting, and make large exclusion lists much easier to work with.

Example — Current (hard to read):

{
  "exclusions": "error1, error2, error3, error4, error5, error6, another, thisIsGettingLong, okThisIsReallyTooLong, iHateThisExtremelyLongString"
}

Example — Proposed (clean and readable):

{
  "exclusions": [
    "error1",
    "error2",
    "error3",
    "error4",
    "error5",
    "error6"
  ]
}

This approach makes the configuration more maintainable and aligns with best practices for managing lists in JSON.

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Configuration related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Which package are you modifying?

  • @koliveira15/nx-sonarqube
  • docs-site

What is the current behavior?

Only string for exclusions

Closes #

What is the new behavior?

Allows array of strings for exclusions

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@tyler-mastery tyler-mastery changed the title Add exclusions array Allow exclusions to be array of strings Mar 12, 2025
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.

1 participant