fix: enhance linting process to preserve existing files

[harshit078]

What/Why/How?

• redocly lint api1.yaml --generate-ignore-file updates only entries related to api1.yaml and its referenced files

Reference

• CLI lint command --generate-ignore-file option override previously generated ignore file #2652

Testing

Screenshots (optional)

Check yourself

• Code follows the contributing guide
• All new/updated code is covered by tests
• Core code changed? - Tested with other Redocly products (internal contributions only)
• New package installed? - Tested in different environments (browser/node)
• Documentation update has been considered

Security

• The security impact of the change has been considered
• Code follows company security practices and guidelines

[changeset-bot]

🦋 Changeset detected

Latest commit: c7cad69

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

This PR includes changesets to release 3 packages

Name	Type
@redocly/cli	Minor
@redocly/openapi-core	Minor
@redocly/respect-core	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

[tatomyr]

Thank you for your contribution, @harshit078!
Will this clean up other ignored entries related to that API file?
Could you add a test with ignored rules for two files, and then re-generate the entries only for one file, assuming that one of the problems in this file has been resolved, so when ignoring, it only adds entries that are relevant to the new version of the linted file.

Say, the starting ignore file:

ignore-bar.yaml:
  no-empty-servers:
    - '#/servers'
  operation-summary:
    - '#/paths/~1items/get/summary'
ignore-foo.yaml:
  no-empty-servers:
    - '#/servers'

Then you fix the operation-summary rule in ignore-bar.yaml and re-generate the ignore file only for it.
What you should get is this (the ignore entry for foo is preserved, and bar is updated):

ignore-bar.yaml:
  no-empty-servers:
    - '#/servers'
ignore-foo.yaml:
  no-empty-servers:
    - '#/servers'

[harshit078]

@tatomyr Yes, it will clean up entries for the linted API file but only for files that still have problems in current run. Got it, I'll add the test

[tatomyr]

Left a couple of suggestions for improvement. Could you also check if the corresponding docs need to be updated?

[tatomyr]

Please do consider updating the corresponding docs in docs/@v2/commands/lint.md.

[tatomyr]

This check seems incorrect. The ref should align with mappedDefinitionName from Config.saveIgnore. I believe it would be cleaner to move this and the following lines into a new cleanup method next to saveIgnore and use it here.

[tatomyr]

@harshit078, your tests are failing. Could you fix that?

[harshit078]

@tatomyr pushed a fix for the failing test. thanks !

[tatomyr]

LGTM.