Add npm run lint task with vale linter
#155
Open
Conversation
This file contains hidden or 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
andreslucena
commented
Mar 6, 2024
| @@ -4,6 +4,7 @@ | |||
| "scripts": { | |||
| "prebuild": "./bin/playbook-changer.js", | |||
| "build": "antora antora-playbook.yml $@", | |||
| "lint": "vale --config vale.ini docs/en/modules/admin/", | |||
There was a problem hiding this comment.
@RCheesley I've added you as a reviewer. Let me know if the command that I'm adding in the task is similar to what you use locally or if you're using other flags/options.
There was a problem hiding this comment.
Hey there! I don't know much about npm lint, but I believe this would be limited only to the admin section of the docs which isn't really what you want, right?
You would normally use a GitHub Action to lint only the files that have been changed in the PR, and if you are working locally you either use the Vale plugin in your IDE or you run it at the CLI for the specific folder/file.
What is it that you're trying to achieve here? Maybe I missed that step.
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.
While reviewing #147 and #151 I wanted an easy way for checking the offenses and fixes. This PR adds the
npm run linttask to be consistent with other projects.