Google Git
Sign in
fuchsia / shac-project / shac / a809cc033723c140961848298875f404c3195cf0
commita809cc033723c140961848298875f404c3195cf0[log] [tgz]
authorOliver Newman <olivernewman@google.com>Fri Sep 01 22:20:06 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Sep 01 22:20:06 2023 +0000
treeb943da92f1864ddeffcaf62acc2082f59089a404
parentc2131be7aa1b27bf81525d33174e09d67bf814c0 [diff]
[cli] Add --quiet flag to fix and fmt commands

Fuchsia's `fx format-code` command should not print any output on
success, so for it to be able to run `shac fmt`, there must be a way to
disable non-error output for `shac fmt`.

This should eventually apply to the `check` command as well for
consistency, but for now it's only needed on `fix` and `fmt`, and it was
easiest to do it this way because the output of `fix` and `fmt` comes
from a different codepath than that of `check`.

Change-Id: I6a1f895863523ed3e8ac3d0258f4ff2b07493c32
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/911236
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
Reviewed-by: Anthony Fandrianto <atyfto@google.com>
Commit-Queue: Auto-Submit <auto-submit@fuchsia-infra.iam.gserviceaccount.com>
5 files changed
tree: b943da92f1864ddeffcaf62acc2082f59089a404
  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.