Google Git
Sign in
fuchsia / shac-project / shac / 99394d7bec91cb700a693b901c2807722db117ea
commit99394d7bec91cb700a693b901c2807722db117ea[log] [tgz]
authorOliver Newman <olivernewman@google.com>Thu Jul 20 17:51:44 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Jul 20 17:51:44 2023 +0000
tree0dd6e1d3e038216bdf648ad1362b10d5952c2ff7
parentea49ce43869935f17396dfd438c5fc6638851bd1 [diff]
[engine] Make message optional for formatter findings

Findings from checks will pretty much always specify the same message,
something like "File not formatted, please run `shac fmt`". Autogenerate
this message by default for formatting checks so check writers don't
need to write redundant messages.

This will also incentivize check writers to mark formatting checks as
`formatter=True`, otherwise they'll have to specify a message for every
finding.

Change-Id: I9b822d4177211d537cc539eacbcc109f4d14db6b
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/887575
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Reviewed-by: Marc-Antoine Ruel <maruel@google.com>
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
4 files changed
tree: 0dd6e1d3e038216bdf648ad1362b10d5952c2ff7
  1. .github/
  2. checks/
  3. doc/
  4. images/
  5. internal/
  6. scripts/
  7. vendor/
  8. .gitignore
  9. AUTHORS
  10. codecov.yml
  11. CONTRIBUTING.md
  12. go.mod
  13. go.sum
  14. LICENSE
  15. main.go
  16. OWNERS
  17. PATENTS
  18. README.md
  19. shac.star
  20. shac.textproto
README.md

shac

Shac (Scalable Hermetic Analysis and Checks) is a unified and ergonomic tool and framework for writing and running static analysis checks.

Shac checks are written in Starlark.

usage demonstration

Usage

go install go.fuchsia.dev/shac-project/shac@latest
shac check
shac doc shac.star | less

Documentation

Road map

Planned features/changes, in descending order by priority:

  • [x] Configuring files to exclude from shac analysis in shac.textproto
  • [x] Include unstaged files in analysis, including respecting unstaged shac.star files
  • [x] Automatic fix application with handling for conflicting suggestions
  • [ ] Provide a .shac cache directory that checks can write to
  • [ ] Mount checkout directory read-only
    • [x] By default
    • [ ] Unconditionally
  • [ ] Give checks access to the commit message via ctx.scm
  • [ ] Built-in formatting of Starlark files
  • [ ] Configurable “pass-throughs” - non-default environment variables and mounts that can optionally be passed through to the sandbox
  • [ ] Add glob arguments to ctx.scm.{all,affected}_files() functions for easier filtering
  • [ ] Filesystem sandboxing on MacOS
  • [ ] Windows sandboxing
  • [ ] Testing framework for checks

Contributing

⚠ The source of truth is at https://fuchsia.googlesource.com/shac-project/shac.git and uses Gerrit for code review.

See CONTRIBUTING.md to submit changes.