Google Git
Sign in
fuchsia / shac-project / shac / 6b36786cd6e56fcf9722ec020479b046172ebcc7
commit6b36786cd6e56fcf9722ec020479b046172ebcc7[log] [tgz]
authorOliver Newman <olivernewman@google.com>Wed Sep 06 17:30:17 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Sep 06 17:30:17 2023 +0000
tree1b01b7ab72e93b08703f4ae0b01a3b998483629e
parent0ae299aac566002ee4c07c78c7971bd7af8706d0 [diff]
[doc] Move `shac` object to the top of stdlib.md

The `shac` object is the entrypoint to registering checks, so it's the
first thing anyone starting to use SHAC must know about.

Change-Id: Iba852fd90c825908b352e71104dbc25880bd9348
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/911235
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Reviewed-by: Danny Rosen <dannyrosen@google.com>
2 files changed
tree: 1b01b7ab72e93b08703f4ae0b01a3b998483629e
  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.