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: #1564 #1568

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

Conversation

aakash-a-dev
Copy link

@aakash-a-dev aakash-a-dev commented Nov 6, 2024

For feat: #1564

Description

  • Adjusted ESLint configurations for CI/CD processes to suppress non-critical warnings and streamline development.
  • Improved rule consistency and selectively disabled non-essential rules for cleaner CI/CD logs.

Key Adjustments

Suppress Irrelevant Warnings

  • "no-warning-comments": "off"
    Current: "no-warning-comments": "error"
    Change: Set to "off" to prevent TODO, FIXME, and other notes from triggering CI/CD errors.
    Reason: These comments are typically reminders and are not critical for CI/CD.

  • "no-debugger": 0 and "no-console": "off"
    Current: "no-debugger": 1
    Change: Set "no-debugger" to 0 and "no-console": "off" to avoid flagging debugging and console statements.
    Reason: Debug and console statements may be intentional for development and usually harmless in non-production branches.

Enable Soft Warnings Instead of Errors

  • "no-empty": 0
    Current: "no-empty": 1
    Change: Set "no-empty" to 0 to allow empty blocks where intentional.
    Reason: Empty blocks can occur during early development or debugging stages.

  • "no-unused-expressions": 0
    Current: "no-unused-expressions": 1
    Change: Set to 0 if unused expressions are placeholders or not crucial.
    Reason: Reduces noise from expressions commonly used in development.

Enable Consistent Warning Levels

  • "no-invalid-regexp": 2
    Current: "no-invalid-regexp": 1
    Change: Set to 2 for strict checking of regular expressions.
    Reason: Ensures invalid regexes, which can cause crashes, are consistently flagged as errors.

  • "no-fallthrough": 2
    Current: "no-fallthrough": 1
    Change: Set to 2 to ensure proper documentation of intentional fall-through in switch statements.
    Reason: Helps avoid unintended behavior, essential for a stable CLI.

Disable Non-Essential Rules Temporarily

  • "no-multiple-empty-lines": 0 and "padded-blocks": 0
    Current: Set to enforce spacing and padding.
    Change: Set to 0 to ignore multiple empty lines and padded blocks.
    Reason: These are stylistic and not essential for functionality-focused CI/CD checks.

Doc I referred : https://typescript-eslint.io/rules/


PS: I am new in understanding this code repo and workflow there are high chances of wrong understanding from my end, but I will improve as per the requirement.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@aakash-a-dev aakash-a-dev changed the title Feat #1564 Feat: #1564 Nov 6, 2024
@aakash-a-dev aakash-a-dev changed the title Feat: #1564 feat: #1564 Nov 6, 2024
Copy link

sonarcloud bot commented Nov 14, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: To Triage
Development

Successfully merging this pull request may close these issues.

2 participants