Google Git
Sign in
fuchsia / shac-project / shac / 9b6143b7486a35da6e90b4a0b46a55103ee032e4
commit9b6143b7486a35da6e90b4a0b46a55103ee032e4[log] [tgz]
authorOliver Newman <olivernewman@google.com>Mon Sep 11 18:39:59 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Sep 11 18:39:59 2023 +0000
tree0f2b556ab7f938859cd9d0ab7357aae20b89eae5
parent130473d3b96e23beb6ac42e2b5958efdcdb6d48d [diff]
[engine] Rename Options.Root to Options.Dir

For consistency with Ic9aef678e2cb518a81ff2f36f3bec6fda969675d, rename
the Root field to Dir, since shac now uses git to locate the root
directory, which may differ from (but will always be a parent of) the
directory specified by the Dir field.

Change-Id: I94e6a293691096fa0b52053342a7ea6bab97dcc5
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/914337
Reviewed-by: Marc-Antoine Ruel <maruel@google.com>
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
5 files changed
tree: 0f2b556ab7f938859cd9d0ab7357aae20b89eae5
  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.