Google Git
Sign in
fuchsia / shac-project / shac / 655d899e0db0ec5d9d85604bdd32abf736822476
commit655d899e0db0ec5d9d85604bdd32abf736822476[log] [tgz]
authorOliver Newman <olivernewman@google.com>Thu Jul 20 16:17:26 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Jul 20 16:17:26 2023 +0000
treed9fb059d117fff3df9ea424084d210a9cb55364e
parent89d15c8efe973e24620884e6718b3d6ef5500a07 [diff]
[engine] Add `stdin` arg to `ctx.os.exec()`

For getting suggested replacements for formatters, it's useful for the
formatter to be able to write the formatted code to stdout. Some
formatters, such as Black, will only write formatted results to stdout
if the input is passed via stdin.

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

  • [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.