Repository navigation
Publish the styles as the @devexpress/vale-styles npm package - #11
Merged
Merged
Conversation
skudnoff
approved these changes
Oct 29, 2026
skudnoff
approved these changes
Nov 3, 2026
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
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.
Documentation repos use these styles by copying the
vale/folder. That gives them no version to pin and no way to tell whether new rules will break their Vale check. This PR publishes the styles to GitHub Packages as@devexpress/vale-stylesso that consumers can pin a version and upgrade when they choose. The rules and thevale/folder are unchanged. The only addition undervale/is a new test sample.Changes
package.json: adds the package@devexpress/vale-styles@1.0.0, which publishes tohttps://npm.pkg.github.com.filesships onlydist/andTHIRD_PARTY_NOTICES.md.build,prepackandtestscripts callvale-style-package-publisher, from the internal@devexpress/vale-style-package-publisherpackage (pinned to1.0.0). This keeps custom build code out of this public repo.dist/DevExpress/is a Vale package:styles/, plus.vale.iniwithout itsStylesPathline.dist/templates/holdsjunit.tmplandrdjsonl.tmpl. Consumers setPackages = node_modules/@devexpress/vale-styles/dist/DevExpressand runvale sync.@vvago/valeis pinned exactly to3.25.1indevDependencies. It is also declared as an optional peer dependency (~3.25.1), so npm checks the version for consumers who install Vale from npm, and consumers who don't are not given a second binary.allowScriptsapproves the wrapper's postinstall, which downloads the Vale binary..github/workflows/ci.yml: runsnpm testwith a read-only token on pull requests and on pushes tomain.npm testbuildsdist/and syncs it into a temporary consumer project. It fails if any of the following happens:Vale exits with code 2.
The merged config lacks
DX,MicrosoftorVocab = DX.clean.mdhas alerts.A fixture's own rule never fires.
The
npm packfile list changes..github/workflows/release.yml: runs onvX.Y.Ztags.testjob runsnpm ciandnpm testwith a read-only token.publishjob (contents: write,packages: write) runsnpm ci --ignore-scripts, thencheck-release,npm publishandgh release create.mainand must not be lower thanlatest.vX.Y.Z-rc.Ntag on any commit publishes under thenextdist-tag as a GitHub prerelease.CHANGELOG.md: adds the version policy (major = new alerts are possible on unchanged text, minor = additions only, patch = false-positive fixes and message changes) and the1.0.0entry. The release workflow uses the version's section as the release notes and fails if that section is missing.vale/vale/tests/clean.md: a sample that must produce zero alerts..gitignore: ignoresnode_modules/anddist/.Worth a careful look
publishjob runs no third-party code alongside the write token.--ignore-scriptsmeans the Vale binary is never downloaded, and the only tool that runs is the dependency-free publisher. Every checkout usespersist-credentials: false.npm cireads@devexpress/vale-style-package-publisherwithGITHUB_TOKEN. This only works while that package lists this repo under Manage Actions access.npm cinow needs a GitHub Packages token withread:packages. Your user-level npm config must also map@devexpresstohttps://npm.pkg.github.com, because the repo has no.npmrc.v1.0.0on the merge commit, which publishes the package.Testing
CI runs
npm teston this PR.