Google Git
Sign in
fuchsia / shac-project / shac / d8b74dd9c45ec820653561de30ad5a5ba457e7fd
commitd8b74dd9c45ec820653561de30ad5a5ba457e7fd[log] [tgz]
authorOliver Newman <olivernewman@google.com>Fri Sep 01 15:22:24 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Sep 01 15:22:24 2023 +0000
tree63df7b2289dbb8f6195bc47dcdd5edd9b034753c
parente41b94339422e81f5f3df023ac768e90a6129d97 [diff]
[engine] Force-include cmdline files in scm

If files are specified on the command line, make sure to include those
files in the scm's "all files", not just "affected files", because
"affected files" should always be a subset of "all files".

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