README
¶
crie.
universal meta-linter using containerized execution
Features
crie is for teams that want one reproducible command to format, lint, and find coverage gaps across every language in a repository, without installing every tool locally.
- No more config chaos - one simple setup for all your tools
- Quality checks that just work, right out of the box
- Container-based isolation for consistent tool execution
- Container runtime flexibility - supports both Docker and Podman
- Drop in and get coding - minimal setup required
- Catch every blind spot with full coverage detection
Install
brew install tyhal/tap/crie
or from source:
GOFLAGS='-tags=exclude_graphdriver_btrfs,containers_image_openpgp' \
CGO=0 \
go install github.com/tyhal/crie/cmd/crie@latest
Deps
Usage
The suggested way to start running crie is to run chk at the top of your project and add --continue to see every error in the project (this will not change any code)
crie chk --continue
Documentation
See the documentation for installation, configuration, and usage guides.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
crie
command
Package main is the main entrypoint for the crie CLI.
|
Package main is the main entrypoint for the crie CLI. |
|
docgen
command
Package main generates CLI reference documentation for crie.
|
Package main generates CLI reference documentation for crie. |
|
internal
|
|
|
config/language
Package language contains configuration structures and helpers for language definitions.
|
Package language contains configuration structures and helpers for language definitions. |
|
filelist
Package filelist provides utilities to build file lists from directories.
|
Package filelist provides utilities to build file lists from directories. |
|
runner
Package runner contains the logic to run the linters
|
Package runner contains the logic to run the linters |
|
pkg
|
|
|
cli
Package cli allows a CLI tool to be linted from the host or in a container
|
Package cli allows a CLI tool to be linted from the host or in a container |
|
cli/executor
Package executor allows for a CLI tool to be executed in different contexts
|
Package executor allows for a CLI tool to be executed in different contexts |
|
dockfmt
Package dockfmt provides a linter that uses the github.com/reteps/dockerfmt library to format dockerfiles
|
Package dockfmt provides a linter that uses the github.com/reteps/dockerfmt library to format dockerfiles |
|
linter
Package linter provides a simple interface for linting, allowing for custom implementations
|
Package linter provides a simple interface for linting, allowing for custom implementations |
|
noop
Package noop provides a linter that does nothing, useful for testing and as a template implementation of linter.Linter
|
Package noop provides a linter that does nothing, useful for testing and as a template implementation of linter.Linter |
|
shfmt
Package shfmt is a linter for shell scripts using mvdan.cc/sh
|
Package shfmt is a linter for shell scripts using mvdan.cc/sh |
|
verify
|
|
|
lang/go/src
command
Package main is a dummy package for testing
|
Package main is a dummy package for testing |
Click to show internal directories.
Click to hide internal directories.