Skip to content

Commit

Permalink
add notice about vendoring when using linters (#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthiasWinzeler authored Jul 13, 2022
1 parent fedfb49 commit be06665
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ Again, the naming rule `#` joined with the fields name must be followed, so the

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.

> **Note**
>
> 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.
#### What's wrong with comments? Why not parse regular comments?

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

0 comments on commit be06665

Please sign in to comment.