Skip to content

Commit 50e4dff

Browse files
committed
fix clj-kondo import instructions in README
Use the correct two-step workflow from the clj-kondo docs: --copy-configs --skip-lint (to copy configs) --dependencies --parallel (to warm the cache) The previous instruction used wrong flags and a literal "classpath" string instead of the actual classpath expansion.
1 parent 1209b1f commit 50e4dff

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -947,13 +947,24 @@ meta-merge). e.g. `{:colors ^:replace {...}}`)
947947

948948
Ornament ships clj-kondo hooks and configuration that validate `defstyled` forms — catching bad tag names, invalid syntax, and providing correct `def`-like analysis.
949949

950-
The hooks are bundled in the JAR under `clj-kondo.exports/`. To activate them in your project, run:
950+
The hooks are bundled in the JAR under `clj-kondo.exports/`. To activate them in your project:
951951

952-
```bash
953-
clj-kondo --copy-configs --dependencies --lint classpath
954-
```
952+
1. Ensure a `.clj-kondo` directory exists at your project root:
953+
```
954+
mkdir -p .clj-kondo
955+
```
956+
957+
2. Copy the configs from your dependencies:
958+
```
959+
clj-kondo --lint "$(clojure -Spath)" --copy-configs --skip-lint
960+
```
961+
962+
3. Warm the linting cache:
963+
```
964+
clj-kondo --lint "$(clojure -Spath)" --dependencies --parallel
965+
```
955966

956-
This copies the config and hook into your `.clj-kondo/` directory. After that, clj-kondo will automatically validate `defstyled` forms in your project.
967+
After that, clj-kondo will automatically validate `defstyled` forms in your project. Consider checking the copied configs into version control.
957968

958969
## Babashka compatibility
959970

0 commit comments

Comments
 (0)