Document that go tool is not supported (#3)

wasilibs · Jan 10, 2025 · ceebaad · ceebaad
1 parent 16dff11
commit ceebaad
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/.golangci.yml b/.golangci.yml
@@ -27,7 +27,7 @@ linters-settings:
     sections:
       - standard
       - default
-      - prefix(github.com/wasilibs/go-prettier)
+      - prefix(github.com/wasilibs/go-shellcheck)
   gosec:
     config:
       G306: "0644"

diff --git a/README.md b/README.md
@@ -21,6 +21,9 @@ To avoid installation entirely, it can be convenient to use `go run`
 $ go run github.com/wasilibs/go-shellcheck/cmd/shellcheck@latest *.sh
 ```
 
+_Due to [potential build breakage](https://github.com/golang/go/issues/71192) unrelated to this project,
+`go tool` is not supported._
+
 Note that due to the sandboxing of the filesystem when using Wasm, currently only files that descend
 from the current directory when executing the tool are accessible to it, i.e., `../sql/my.sh` or
 `/separate/root/my.sh` will not be found.