Skip to content

Commit be06665

Browse files
add notice about vendoring when using linters (#28)
1 parent fedfb49 commit be06665

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ Again, the naming rule `#` joined with the fields name must be followed, so the
8181

8282
No! The `docsonnet` binary comes included with it, and during normal Jsonnet use the docsonnet keys will never be accessed, so your Jsonnet runs just fine without.
8383

84+
> **Note**
85+
>
86+
> Linters like [jsonnet-lint](https://pkg.go.dev/github.com/google/go-jsonnet/linter) or `tk lint` require the imports to be resolvable, so you should add `doc-util` to `vendor/` when using these linters.
87+
8488
#### What's wrong with comments? Why not parse regular comments?
8589

8690
I had some attempts on this, especially because it feels more natural. However, the language properties of Jsonnet make this quite challenging:

0 commit comments

Comments
 (0)