Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add npm run lint task with vale linter #155

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

andreslucena
Copy link
Member

While reviewing #147 and #151 I wanted an easy way for checking the offenses and fixes. This PR adds the npm run lint task to be consistent with other projects.

@@ -4,6 +4,7 @@
"scripts": {
"prebuild": "./bin/playbook-changer.js",
"build": "antora antora-playbook.yml $@",
"lint": "vale --config vale.ini docs/en/modules/admin/",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants