Google Git
Sign in
fuchsia / shac-project / shac / b1cf61a127ebbca65a1bfba4e986a4af3a6affb0
commitb1cf61a127ebbca65a1bfba4e986a4af3a6affb0[log] [tgz]
authorOliver Newman <olivernewman@google.com>Mon Jul 17 15:10:14 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Jul 17 15:10:14 2023 +0000
treed97ab74ae065521f35e5fdd12208ae68b3bd4d14
parent58a9bb92f28d29d01971e4f97a6ff0f6be192a5c [diff]
[reporting] Add multi-reporter

There are cases in which we want multiple reporters to run at a time,
e.g. when uploading to ResultDB we still want to emit to stdout. This
provides a nicer way of doing that versus having the ResultDB reporter
wrap a basic reporter.

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

  • [ ] Automatic fix application with handling for conflicting suggestions
  • [ ] Configuring files to exclude from shac analysis in shac.textproto
  • [ ] Include unstaged files in analysis, including respecting unstaged shac.star files
  • [ ] Provide a .shac cache directory that checks can write to
  • [ ] Mount checkout directory read-only
  • [ ] 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

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.