Google Git
Sign in
fuchsia / shac-project / shac / 8e7f250456d15d150c4bba78f184ba169bbdae05
commit8e7f250456d15d150c4bba78f184ba169bbdae05[log] [tgz]
authorOliver Newman <olivernewman@google.com>Tue Aug 08 23:05:17 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Aug 08 23:05:17 2023 +0000
tree3d403ae221b9ff814605c208aa1a2a3919d1dd64
parent349fbb863c794b7dda10fbea14568c9c5dd759aa [diff]
[engine] Add ctx.platform.arch

... and rename `ctx.os.name` to `ctx.platform.os` so the OS and arch
values are grouped together. There are no downstream users of
`ctx.os.name` yet, so it's safe to rename.

Change-Id: If6c47eaed0301203ba8d90759ef10921622db8e9
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/897161
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>
12 files changed
tree: 3d403ae221b9ff814605c208aa1a2a3919d1dd64
  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.