-
Notifications
You must be signed in to change notification settings - Fork 5
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
Writing Style Linter: Update vale and prevent binary from being published #366
Conversation
This pull request is being automatically deployed with ZEIT Now (learn more). 🔍 Inspect: https://zeit.co/commercetools/commercetools-docs-kit/q40pzveya |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You also need to update the version for the bin
That's also what I meant here: #341 (comment)
To avoid this situations where we forget to update both versions. |
OK, you beat me to try it now. I've just pushed a wrapper that is actually preserving all console interaction and coloring etc by not using the fat That did the job, so here we go. We could remove shelljs in the other script, too - I didn't do it here because I don't remember why it was introduced from the beginning. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks 💯
@nkuehn I pushed a commit to reuse the common logic between the bin scripts. Please have a look |
const configParamPosition = params.findIndex((p) => p === '--config'); | ||
if ( | ||
params[configParamPosition + 1] && | ||
params[configParamPosition + 1].startsWith('-') | ||
) { | ||
params = params.filter((p) => p !== '--config'); | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I understand, this is not necessary anymore, as for VSCode we can use the "config" option of the plugin and use the vale-bin
binary.
Also to prevent the ignore rules for the binaries to accidentally ignore that folder, too.
change locations using that folder
- document how to configure vscode - improve wording and chapter order
4600a73
to
3c7a971
Compare
@emmenko since you moved the binary to the root folder the ignore rule was a bit dangerous to also cover the I overhauled the README to explain the VSCode usage and some other things. |
Perfect, thanks! |
This fixes the notorious issue that the wrong vale binary was executed on linux hosts, e.g. CI. I updated
.gitignore
when changing the binary naming convention but oversaw.npmignore
.Since this requires a new package version anyways, I am updating the vale version to a recent bugfix in the same step.