Add natural language linting #335
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
dshevtsov
added
enhancement
jhadobe
requested changes
Jul 12, 2024
keharper
reviewed
Jul 12, 2024
Co-authored-by: Jared Hoover <[email protected]> Co-authored-by: Kevin Harper <[email protected]>
|
Closing the PR because there is no consensus on the final list of terminology that should be enforced by the linter. |
|
Reopening per request from the project owner |
dshevtsov
commented
Jul 24, 2024
src/_includes/graphql/payment-methods/paypal-express-checkout-workflow.md
Outdated
Show resolved
Hide resolved
src/_includes/graphql/payment-methods/paypal-express-checkout-workflow.md
Outdated
Show resolved
Hide resolved
src/pages/rest/tutorials/bundle-product/create-bundle-product.md
Outdated
Show resolved
Hide resolved
keharper
approved these changes
Jul 24, 2024
|
@jhadobe please update your review since it's blocking the PR merging. |
jhadobe
approved these changes
Jul 24, 2024
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.
Purpose of this pull request
This pull request (PR) changes the PR testing workflow by enabling textlint which is a natural language linter. By default, the linter only verifies terminology. The level of severity is set to warning so that it would not fail the entire GitHub check. The code base was checked with the linter and edited with the tool's local option for auto-fixing.
Also, the single job in the GitHub workflow
validateis separated into two for clarity and flexibility:lintandtest_and_build.To view the textlint warnings, open the check's log: lint - Lint Code Base - NATURAL_LANGUAGE (example).
To run the linting locally:
npx textlint .To run auto-fixing locally:
npx textlint --fix .