Add cljs-patrol docstring checks to CI - #14
Merged
Merged
Conversation
Wire cljs-patrol (v0.0.17) into the pipeline as an npm run patrol step, scoped to the docstrings group over src/main with --fail-on all. The script caches the jar locally (gitignored) and CI runs it with the JDK already on the runner. Fix the two docstring-summary violations it reported: user-event/type and user-event/keyboard now open with a self-contained first-line summary sentence, per the bbatsov Clojure style guide.
Replace the curl-the-release-jar npm script with a deps.edn :patrol alias that pins cljs-patrol as a git dependency (v0.0.17, tag + sha) and runs cljs-patrol.core. npm run patrol now calls clojure -M:patrol, so the version is managed in deps.edn and resolved/cached by tools.deps rather than fetched as a prebuilt jar. CI installs the Clojure CLI via setup-clojure; ignore the .cpcache directory it produces.
Drop --only docstrings from the :patrol alias so the full rule set (re-frame, Spade, typography, a11y, docstrings) runs against src/main with --fail-on all. The whole codebase already passes every rule.
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
1 participant
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.
Adds cljs-patrol static analysis to the pipeline.
npm run patrolstep (afterlint) runs cljs-patrol v0.0.17 scoped to thedocstringsgroup oversrc/mainwith--fail-on all. The other rule groups (re-frame, Spade, a11y) don't apply to this library and all report 0.cljs-patrol.jar(gitignored); CI runs it with the JDK already set up on the runner — no extra action needed.:docstring-summaryviolations it flagged:user-event/typeanduser-event/keyboardnow open with a self-contained first-line summary sentence (bbatsov Clojure style guide).Locally
npm run patrol→0 blocking, 0 warnings. fmt/lint/test all green.