technofab/docsonnet
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/docsonnet.git synced 2025-12-12 06:20:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

add notice about vendoring when using linters (#28)

Browse source
This commit is contained in:
Matthias Winzeler 2022-07-13 13:15:04 +02:00 • committed by GitHub
parent fedfb4920f
commit be066653f3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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: