Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twelvelabs/stylist
Manage all your code quality tools with a single executable
https://github.com/twelvelabs/stylist
cli code-quality formatter golang linter
Last synced: 6 days ago
JSON representation
Manage all your code quality tools with a single executable
- Host: GitHub
- URL: https://github.com/twelvelabs/stylist
- Owner: twelvelabs
- Created: 2023-02-19T06:47:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-20T22:07:43.000Z (24 days ago)
- Last Synced: 2024-10-21T01:54:58.061Z (24 days ago)
- Topics: cli, code-quality, formatter, golang, linter
- Language: Go
- Homepage:
- Size: 286 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Stylist
[](https://github.com/twelvelabs/stylist/actions/workflows/build.yml)
[](https://codecov.io/gh/twelvelabs/stylist)
Stylist aggregates all your code quality tools into a single, fast,
and easy to use executable. You define the tools your project uses
in `.stylist.yml`:
```yml
---
# A "processor" is a code quality tool (linter, scanner, formatter, etc...)
processors:
############################################################
# Stylist comes with presets for many common tools...
############################################################
- preset: cspell
includes:
- "**/*"
excludes:
- "problem-file1.txt"
- "problem-file2.txt"
- preset: gofmt
includes:
- "**/*.go"
- preset: golangci-lint
includes:
- "**/*.go"
excludes:
- "gen/*"
- preset: markdownlint
includes:
- "**/*.md"
############################################################
# ... or you can provide custom configuration.
############################################################
- name: custom-tool
includes:
- "**/*.{ext1,ext2,ext3}"
# Processors define check and/or fix commands
# (check commands report issues, fix commands correct them).
# See the documentation for more detail.
check:
command: "custom-tool lint --output=sarif"
input: variadic
output: stdout
format: sarif
fix:
command: "custom-tool lint --auto-fix --output=sarif"
input: variadic
output: stdout
format: sarif
```
Then run stylist's `check` and `fix` commands:
```shell
$ stylist check
[cspell] main.go:8:16 Unknown word 'someFunc' (spelling)
[golangci-lint] main.go:8:16 Error return value of `someFunc` is not checked (errcheck)
[markdownlint] README.md:1:9 Trailing punctuation in heading [Punctuation: ':'] (MD026)
[markdownlint] README.md:3:81 Line length [Expected: 80; Actual: 153] (MD013)
$ stylist fix
[markdownlint] README.md
```
## Installation
### Using [Homebrew](https://brew.sh/)
```bash
brew install twelvelabs/tap/stylist
```
### Pre-built binary
Download a pre-built binary from the
[Releases](https://github.com/twelvelabs/stylist/releases) page.
### From source
```bash
go install "github.com/twelvelabs/stylist@latest"
# or a specific version tag
tag=$(gh release view --json tagName --jq .tagName)
go install "github.com/twelvelabs/stylist@${tag}"
```