Google Git
Sign in
fuchsia / shac-project / shac / f400ab78925858efc56cda3214b913049a6b999d
commitf400ab78925858efc56cda3214b913049a6b999d[log] [tgz]
authorOliver Newman <olivernewman@google.com>Wed Jul 19 14:46:41 2023 +0000
committerCQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Jul 19 14:46:41 2023 +0000
tree693edada3c2a8f24588ef32627a99ec2a3c8de55
parent6065391ce87eb00744a4277453453ec1cd702018 [diff]
[scm] Include untracked files in analysis

It's more user-friendly to consider untracked files in analysis so that
users can get feedback on new files without needing to stage them first.
It's especially important for `shac check` to run untracked `shac.star`
files, otherwise people get confusing "no shac.star files found" errors
when adding a shac.star file to a repo, until they `git add` it.

The existence of untracked files does not affect the choice of which
commit to use as the "upstream", to accomodate users who tend to keep
untracked files sitting around. It's okay to include those files in the
analysis, but the existence of those files shouldn't prevent other files
from being analyzed.

Change-Id: I1e5263150eddf79094b69cd2bb0e6a6fa88a0e0a
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/886295
Reviewed-by: Marc-Antoine Ruel <maruel@google.com>
Commit-Queue: Oliver Newman <olivernewman@google.com>
Fuchsia-Auto-Submit: Oliver Newman <olivernewman@google.com>
5 files changed
tree: 693edada3c2a8f24588ef32627a99ec2a3c8de55
  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
  • [ ] 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.