Adjust Vale rules to ignore links #753
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Tokesh <tokesh789@gmail.com>
Tokesh
requested review from
dblock,
harshavamsi,
sachetalva,
nhtruong,
Xtansia,
VachaShah and
aabeshov
as code owners
Changes AnalysisCommit SHA: 9b2b62d API ChangesSummaryNO CHANGES ReportThe full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/12516178491/artifacts/2365785178 API Coverage
|
Signed-off-by: Tokesh <tokesh789@gmail.com>
Signed-off-by: Tokesh <tokesh789@gmail.com>
dblock
requested changes
Dec 22, 2024
There was a problem hiding this comment.
- Add tests, make sure there's one with 1 link and 2 links to https://github.com/opensearch-project/opensearch-api-specification/tree/main/tools/tests/prepare-for-vale.
- Extract
line.replace(/\[([^\]]+)\]\([^)]+\)/g, '$1')into a method, similar toprune_vars, maybe something descriptive likeremove_links.
Signed-off-by: Tokesh <tokesh789@gmail.com>
dblock
requested changes
Dec 23, 2024
There was a problem hiding this comment.
One more place where the transformation needs to be applied, see below.
Iterate till unit tests and linter are green (this repo uses a slightly different convention that the default TS with variable_names).
Add an integration test to https://github.com/opensearch-project/opensearch-api-specification/blob/main/tools/tests/prepare-for-vale/fixtures.
Signed-off-by: Tokesh <tokesh789@gmail.com>
Signed-off-by: Tokesh <tokesh789@gmail.com>
Signed-off-by: Tokesh <tokesh789@gmail.com>
dblock
requested changes
Dec 23, 2024
Signed-off-by: Tokesh <tokesh789@gmail.com>
Signed-off-by: Tokesh <tokesh789@gmail.com>
dblock
approved these changes
Dec 27, 2024
nathaliellenaa
pushed a commit
to nathaliellenaa/opensearch-api-specification
that referenced
this pull request
Dec 31, 2024
* ignoring hyperlinks in descriptions for vale Signed-off-by: Tokesh <tokesh789@gmail.com> * hotfix linter Signed-off-by: Tokesh <tokesh789@gmail.com> * deleting not necessary sign to pass ci linter Signed-off-by: Tokesh <tokesh789@gmail.com> * added separate method and tests Signed-off-by: Tokesh <tokesh789@gmail.com> * added expect with contain Signed-off-by: Tokesh <tokesh789@gmail.com> * added tests and fixing code style Signed-off-by: Tokesh <tokesh789@gmail.com> * hotfix code style in keepdescriptions Signed-off-by: Tokesh <tokesh789@gmail.com> * chore: added spaces outside of regex match Signed-off-by: Tokesh <tokesh789@gmail.com> * chore: formatting code by linter Signed-off-by: Tokesh <tokesh789@gmail.com> --------- Signed-off-by: Tokesh <tokesh789@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated the
process_filemethod to remove markdown links, leaving only their text content. This ensures the tool processesdescriptionandx-deprecation-messagefields cleanly, aligning with Vale style-checking requirements.Issues Resolved
[#752]
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.