feat: add new feature to supress the warnings #1805

AayushSaini101 · 2025-06-16T14:43:49Z

Resolves: #1564

Add a new flag to the validate command, --suppressWarnings, which is used to suppress warnings in the asyncapi document during validation, and --supressAllWarnings to remove all warnings
The documentation has been updated with proper usage.
New test cases has been added to verify the changes

changeset-bot · 2025-06-16T14:43:54Z

🦋 Changeset detected

Latest commit: e0c358d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@asyncapi/cli	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2025-06-16T14:44:10Z

Changeset has been generated for this PR as part of auto-changeset workflow.

Please review the changeset before merging the PR.

---
'@asyncapi/cli': minor
---

feat: add new feature to supress the warnings

- ab94c15: Add a new flag that is --x-suppress-warnings to supress the warning in the validate command
- 55819cd: Allow to pass multiple warnings to supress and add check to verify the warning is correct or not
- 885fc71: Update src/core/parser.ts

Co-authored-by: Souvik De <souvikde.ns@gmail.com>
- 16b22de: Update src/core/flags/validate.flags.ts

Co-authored-by: Souvik De <souvikde.ns@gmail.com>
- de1caad: Add another flag to supressallwarnings and update test case

If you are a maintainer or the author of the PR, you can change the changeset by clicking here

Tip

If you don't want auto-changeset to run on this PR, you can add the label skip-changeset to the PR or remove the changeset and change PR title to something other than fix: or feat:.

AayushSaini101 · 2025-06-16T14:44:11Z

/u

sonarqubecloud · 2025-06-16T14:44:57Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2025-06-16T14:48:41Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

…n the validate command

AayushSaini101 · 2025-06-16T15:16:18Z

/u

…e warning is correct or not

Souvikns

Everything else is fine, but I think it would be nice to have support for reading a file, like ignore file for warnings and errors.

Also how would someone know the ids for the warning, do you have any documentation for that.

src/core/parser.ts

src/core/flags/validate.flags.ts

Co-authored-by: Souvik De <souvikde.ns@gmail.com>

AayushSaini101 · 2025-06-18T07:02:23Z

Everything else is fine, but I think it would be nice to have support for reading a file, like ignore file for warnings and errors.

Also how would someone know the ids for the warning, do you have any documentation for that.

Make sense, we can allow file support as well, but we need to consider only warning statements, because errors must be resolved, and we don't have any documentions for this as well

src/commands/validate.ts

src/core/parser.ts

fmvilas · 2025-06-19T15:53:53Z

docs/usage.md

@@ -815,10 +815,15 @@ FLAGS
      --proxyPort=<value>            Port number number for the proxyHost.
      --score                        Compute the score of the AsyncAPI document. Scoring is based on whether the
                                     document has description, license, server and/or channels.
+      --x-suppress-warnings=<value>  One or more warning codes to suppress from diagnostics output. Can be passed


What's the reasoning for that x- here? 🤔 Wouldn't it be better to just make it suppress-warnings or no-warnings?

That said, I'd even go further and add no-linting so it removes the warnings and the recommendations but leaves the errors.

yes, need to remove x- here also thanks for idea regarding the supress all warning, we also dicussed in the recent metting as well with @Shurtu-gal i am current implementing it thanks

sonarqubecloud · 2025-06-19T17:08:35Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

AayushSaini101 · 2025-06-19T17:10:33Z

SupressingWarnings:

SupressingAllWarnings:

ifinvalid key is passed:

@Shurtu-gal @Souvikns

Souvikns

LGTM 🚀

AayushSaini101 · 2025-06-21T04:11:17Z

/rtm

aeworxet · 2025-06-23T02:34:08Z

@asyncapi/bounty_team

AayushSaini101 requested review from Souvikns, Amzani, Shurtu-gal and asyncapi-bot-eve as code owners June 16, 2025 14:43

github-project-automation bot added this to CLI - Kanban Jun 16, 2025

github-project-automation bot moved this to To Triage in CLI - Kanban Jun 16, 2025

asyncapi-bot pushed a commit to AayushSaini101/cli that referenced this pull request Jun 16, 2025

chore: add changeset for PR asyncapi#1805

f577ba6

asyncapi-bot pushed a commit to AayushSaini101/cli that referenced this pull request Jun 16, 2025

chore: add changeset for PR asyncapi#1805

af56d69

asyncapi-bot pushed a commit to AayushSaini101/cli that referenced this pull request Jun 16, 2025

chore: add changeset for PR asyncapi#1805

ab7bc76

AayushSaini101 force-pushed the 1564 branch from ab7bc76 to 226a85a Compare June 16, 2025 15:02

asyncapi-bot pushed a commit to AayushSaini101/cli that referenced this pull request Jun 16, 2025

chore: add changeset for PR asyncapi#1805

7802750

Add a new flag that is --x-suppress-warnings to supress the warning i…

ab94c15

…n the validate command

AayushSaini101 force-pushed the 1564 branch from 7802750 to ab94c15 Compare June 16, 2025 15:04

chore: add changeset for PR asyncapi#1805

9c84023

Merge branch 'master' into 1564

07136d3

AayushSaini101 changed the title ~~feat: add new flag for the supress warning~~ feat: add new feature to supress the warnings Jun 16, 2025

chore: add changeset for PR asyncapi#1805

4a97e31

asyncapi-bot pushed a commit to AayushSaini101/cli that referenced this pull request Jun 17, 2025

chore: add changeset for PR asyncapi#1805

56f5cff

AayushSaini101 force-pushed the 1564 branch from 56f5cff to 916da51 Compare June 17, 2025 07:06

asyncapi-bot pushed a commit to AayushSaini101/cli that referenced this pull request Jun 17, 2025

chore: add changeset for PR asyncapi#1805

89346c5

AayushSaini101 force-pushed the 1564 branch from 89346c5 to 89ad68a Compare June 17, 2025 07:09

asyncapi-bot pushed a commit to AayushSaini101/cli that referenced this pull request Jun 17, 2025

chore: add changeset for PR asyncapi#1805

cc554d2

Allow to pass multiple warnings to supress and add check to verify th…

55819cd

…e warning is correct or not

AayushSaini101 force-pushed the 1564 branch from cc554d2 to 55819cd Compare June 17, 2025 07:51

Souvikns requested changes Jun 18, 2025

View reviewed changes

src/core/parser.ts Outdated Show resolved Hide resolved

src/core/flags/validate.flags.ts Outdated Show resolved Hide resolved

github-project-automation bot moved this from To Triage to Backlog in CLI - Kanban Jun 18, 2025

AayushSaini101 and others added 3 commits June 18, 2025 12:29

Update src/core/parser.ts

885fc71

Co-authored-by: Souvik De <souvikde.ns@gmail.com>

Update src/core/flags/validate.flags.ts

16b22de

Co-authored-by: Souvik De <souvikde.ns@gmail.com>

chore: add changeset for PR asyncapi#1805

8e85e10

Shurtu-gal requested changes Jun 18, 2025

View reviewed changes

src/commands/validate.ts Show resolved Hide resolved

src/core/parser.ts Show resolved Hide resolved

fmvilas requested changes Jun 19, 2025

View reviewed changes

AayushSaini101 and others added 2 commits June 19, 2025 22:37

Add another flag to supressallwarnings and update test case

de1caad

chore: add changeset for PR asyncapi#1805

e0c358d

AayushSaini101 requested a review from Souvikns June 19, 2025 17:16

Souvikns approved these changes Jun 20, 2025

View reviewed changes

AayushSaini101 requested review from fmvilas and Shurtu-gal June 20, 2025 11:46

fmvilas approved these changes Jun 20, 2025

View reviewed changes

Shurtu-gal approved these changes Jun 21, 2025

View reviewed changes

asyncapi-bot added the ready-to-merge label Jun 21, 2025

asyncapi-bot merged commit 0754d1d into asyncapi:master Jun 21, 2025
26 checks passed

github-project-automation bot moved this from Backlog to Done in CLI - Kanban Jun 21, 2025

AayushSaini101 pushed a commit to AayushSaini101/cli that referenced this pull request Jun 21, 2025

chore: add changeset for PR asyncapi#1805

d02d31f

AayushSaini101 pushed a commit to AayushSaini101/cli that referenced this pull request Jun 21, 2025

chore: add changeset for PR asyncapi#1805

1c6be9b

AayushSaini101 pushed a commit to AayushSaini101/cli that referenced this pull request Jun 21, 2025

chore: add changeset for PR asyncapi#1805

95a17c6

AayushSaini101 pushed a commit to AayushSaini101/cli that referenced this pull request Jun 21, 2025

chore: add changeset for PR asyncapi#1805

b7cfefc

asyncapi-bot added the bounty AsyncAPI Bounty program related label label Jun 23, 2025

aeworxet added this to Bounty Program Jun 23, 2025

aeworxet moved this to Completed in Bounty Program Jun 23, 2025

Uh oh!

feat: add new feature to supress the warnings #1805

feat: add new feature to supress the warnings #1805

Uh oh!

Conversation

AayushSaini101 commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changeset has been generated for this PR as part of auto-changeset workflow.

Uh oh!

AayushSaini101 commented Jun 16, 2025

Uh oh!

sonarqubecloud bot commented Jun 16, 2025

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Jun 16, 2025

Quality Gate passed

Uh oh!

AayushSaini101 commented Jun 16, 2025

Uh oh!

Souvikns left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AayushSaini101 commented Jun 18, 2025

Uh oh!

Uh oh!

Uh oh!

fmvilas Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

AayushSaini101 Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jun 19, 2025

Quality Gate passed

Uh oh!

AayushSaini101 commented Jun 19, 2025

Uh oh!

Souvikns left a comment

Choose a reason for hiding this comment

Uh oh!

AayushSaini101 commented Jun 21, 2025

Uh oh!

Uh oh!

aeworxet commented Jun 23, 2025

Uh oh!

Uh oh!

AayushSaini101 commented Jun 16, 2025 •

edited

Loading

changeset-bot bot commented Jun 16, 2025 •

edited

Loading

github-actions bot commented Jun 16, 2025 •

edited

Loading