Compare commits
18 Commits
67a76fed6e
...
1e9f5c5949
| Author | SHA1 | Date | |
|---|---|---|---|
1e9f5c5949
|
|||
|
7f84bc2e88
|
|||
|
44b9ea287a
|
|||
|
0fd5107ea4
|
|||
|
4ffca11431
|
|||
|
46ba087b94
|
|||
|
4e6f1cfa2b
|
|||
|
7cd98ab8d2
|
|||
|
5fdc9bb9da
|
|||
|
3ef2c3f109
|
|||
|
b1e39b1722
|
|||
|
52cb6f1264
|
|||
|
eae61404fc
|
|||
|
5cfb245535
|
|||
|
45213601c0
|
|||
|
e0d4bdb678
|
|||
|
04330a39fa
|
|||
|
8e23c8602a
|
5
.gitignore
vendored
5
.gitignore
vendored
|
|
@ -10,3 +10,8 @@ repl-result-*
|
|||
|
||||
# devshell
|
||||
/.data
|
||||
|
||||
# docs
|
||||
node_modules
|
||||
docs/.vitepress/cache
|
||||
docs/.vitepress/dist
|
||||
12
cache/cache.go
vendored
12
cache/cache.go
vendored
|
|
@ -11,6 +11,8 @@ import (
|
|||
"runtime"
|
||||
"time"
|
||||
|
||||
"git.numtide.com/numtide/treefmt/stats"
|
||||
|
||||
"git.numtide.com/numtide/treefmt/format"
|
||||
"git.numtide.com/numtide/treefmt/walk"
|
||||
|
||||
|
|
@ -33,9 +35,10 @@ type Entry struct {
|
|||
}
|
||||
|
||||
var (
|
||||
db *bolt.DB
|
||||
db *bolt.DB
|
||||
logger *log.Logger
|
||||
|
||||
ReadBatchSize = 1024 * runtime.NumCPU()
|
||||
logger *log.Logger
|
||||
)
|
||||
|
||||
// Open creates an instance of bolt.DB for a given treeRoot path.
|
||||
|
|
@ -234,11 +237,14 @@ func ChangeSet(ctx context.Context, walker walk.Walker, pathsCh chan<- string) e
|
|||
|
||||
changedOrNew := cached == nil || !(cached.Modified == info.ModTime() && cached.Size == info.Size())
|
||||
|
||||
stats.Add(stats.Traversed, 1)
|
||||
if !changedOrNew {
|
||||
// no change
|
||||
return nil
|
||||
}
|
||||
|
||||
stats.Add(stats.Emitted, 1)
|
||||
|
||||
// pass on the path
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
|
|
@ -293,6 +299,8 @@ func Update(treeRoot string, paths []string) (int, error) {
|
|||
continue
|
||||
}
|
||||
|
||||
stats.Add(stats.Formatted, 1)
|
||||
|
||||
entry := Entry{
|
||||
Size: pathInfo.Size(),
|
||||
Modified: pathInfo.ModTime(),
|
||||
|
|
|
|||
|
|
@ -14,9 +14,9 @@ import (
|
|||
"sort"
|
||||
"strings"
|
||||
"syscall"
|
||||
"time"
|
||||
|
||||
"git.numtide.com/numtide/treefmt/format"
|
||||
"git.numtide.com/numtide/treefmt/stats"
|
||||
"github.com/gobwas/glob"
|
||||
|
||||
"git.numtide.com/numtide/treefmt/cache"
|
||||
|
|
@ -32,7 +32,6 @@ const (
|
|||
)
|
||||
|
||||
var (
|
||||
start time.Time
|
||||
globalExcludes []glob.Glob
|
||||
formatters map[string]*format.Formatter
|
||||
pipelines map[string]*format.Pipeline
|
||||
|
|
@ -43,7 +42,7 @@ var (
|
|||
)
|
||||
|
||||
func (f *Format) Run() (err error) {
|
||||
start = time.Now()
|
||||
stats.Init()
|
||||
|
||||
Cli.Configure()
|
||||
|
||||
|
|
@ -196,6 +195,8 @@ func walkFilesystem(ctx context.Context) func() error {
|
|||
default:
|
||||
// ignore symlinks and directories
|
||||
if !(info.IsDir() || info.Mode()&os.ModeSymlink == os.ModeSymlink) {
|
||||
stats.Add(stats.Traversed, 1)
|
||||
stats.Add(stats.Emitted, 1)
|
||||
pathsCh <- path
|
||||
}
|
||||
return nil
|
||||
|
|
@ -257,7 +258,7 @@ func updateCache(ctx context.Context) func() error {
|
|||
return ErrFailOnChange
|
||||
}
|
||||
|
||||
fmt.Printf("%v files changed in %v\n", changes, time.Now().Sub(start))
|
||||
stats.Print()
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
|
@ -322,12 +323,17 @@ func applyFormatters(ctx context.Context) func() error {
|
|||
}()
|
||||
|
||||
for path := range pathsCh {
|
||||
var matched bool
|
||||
for key, pipeline := range pipelines {
|
||||
if !pipeline.Wants(path) {
|
||||
continue
|
||||
}
|
||||
matched = true
|
||||
tryApply(key, path)
|
||||
}
|
||||
if matched {
|
||||
stats.Add(stats.Matched, 1)
|
||||
}
|
||||
}
|
||||
|
||||
// flush any partial batches which remain
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@ package cli
|
|||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path"
|
||||
|
|
@ -68,19 +67,19 @@ func TestSpecifyingFormatters(t *testing.T) {
|
|||
|
||||
out, err := cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "3 files changed")
|
||||
assertFormatted(t, as, out, 3)
|
||||
|
||||
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir, "--formatters", "elm,nix")
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "2 files changed")
|
||||
assertFormatted(t, as, out, 2)
|
||||
|
||||
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir, "--formatters", "ruby,nix")
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "2 files changed")
|
||||
assertFormatted(t, as, out, 2)
|
||||
|
||||
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir, "--formatters", "nix")
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "1 files changed")
|
||||
assertFormatted(t, as, out, 1)
|
||||
|
||||
// test bad names
|
||||
|
||||
|
|
@ -110,7 +109,7 @@ func TestIncludesAndExcludes(t *testing.T) {
|
|||
test.WriteConfig(t, configPath, cfg)
|
||||
out, err := cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 31))
|
||||
assertFormatted(t, as, out, 31)
|
||||
|
||||
// globally exclude nix files
|
||||
cfg.Global.Excludes = []string{"*.nix"}
|
||||
|
|
@ -118,7 +117,7 @@ func TestIncludesAndExcludes(t *testing.T) {
|
|||
test.WriteConfig(t, configPath, cfg)
|
||||
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 30))
|
||||
assertFormatted(t, as, out, 30)
|
||||
|
||||
// add haskell files to the global exclude
|
||||
cfg.Global.Excludes = []string{"*.nix", "*.hs"}
|
||||
|
|
@ -126,7 +125,7 @@ func TestIncludesAndExcludes(t *testing.T) {
|
|||
test.WriteConfig(t, configPath, cfg)
|
||||
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 24))
|
||||
assertFormatted(t, as, out, 24)
|
||||
|
||||
echo := cfg.Formatters["echo"]
|
||||
|
||||
|
|
@ -136,7 +135,7 @@ func TestIncludesAndExcludes(t *testing.T) {
|
|||
test.WriteConfig(t, configPath, cfg)
|
||||
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 22))
|
||||
assertFormatted(t, as, out, 22)
|
||||
|
||||
// remove go files from the echo formatter
|
||||
echo.Excludes = []string{"*.py", "*.go"}
|
||||
|
|
@ -144,7 +143,7 @@ func TestIncludesAndExcludes(t *testing.T) {
|
|||
test.WriteConfig(t, configPath, cfg)
|
||||
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 21))
|
||||
assertFormatted(t, as, out, 21)
|
||||
|
||||
// adjust the includes for echo to only include elm files
|
||||
echo.Includes = []string{"*.elm"}
|
||||
|
|
@ -152,7 +151,7 @@ func TestIncludesAndExcludes(t *testing.T) {
|
|||
test.WriteConfig(t, configPath, cfg)
|
||||
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 1))
|
||||
assertFormatted(t, as, out, 1)
|
||||
|
||||
// add js files to echo formatter
|
||||
echo.Includes = []string{"*.elm", "*.js"}
|
||||
|
|
@ -160,7 +159,7 @@ func TestIncludesAndExcludes(t *testing.T) {
|
|||
test.WriteConfig(t, configPath, cfg)
|
||||
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 2))
|
||||
assertFormatted(t, as, out, 2)
|
||||
}
|
||||
|
||||
func TestCache(t *testing.T) {
|
||||
|
|
@ -182,34 +181,34 @@ func TestCache(t *testing.T) {
|
|||
test.WriteConfig(t, configPath, cfg)
|
||||
out, err := cmd(t, "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 31))
|
||||
assertFormatted(t, as, out, 31)
|
||||
|
||||
out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "0 files changed")
|
||||
assertFormatted(t, as, out, 0)
|
||||
|
||||
// clear cache
|
||||
out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir, "-c")
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 31))
|
||||
assertFormatted(t, as, out, 31)
|
||||
|
||||
out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "0 files changed")
|
||||
assertFormatted(t, as, out, 0)
|
||||
|
||||
// clear cache
|
||||
out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir, "-c")
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 31))
|
||||
assertFormatted(t, as, out, 31)
|
||||
|
||||
out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "0 files changed")
|
||||
assertFormatted(t, as, out, 0)
|
||||
|
||||
// no cache
|
||||
out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir, "--no-cache")
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 31))
|
||||
assertStats(t, as, out, 31, 31, 31, 0)
|
||||
}
|
||||
|
||||
func TestChangeWorkingDirectory(t *testing.T) {
|
||||
|
|
@ -243,7 +242,7 @@ func TestChangeWorkingDirectory(t *testing.T) {
|
|||
// this should fail if the working directory hasn't been changed first
|
||||
out, err := cmd(t, "-C", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 31))
|
||||
assertFormatted(t, as, out, 31)
|
||||
}
|
||||
|
||||
func TestFailOnChange(t *testing.T) {
|
||||
|
|
@ -307,31 +306,31 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
|
|||
args := []string{"--config-file", configPath, "--tree-root", tempDir}
|
||||
out, err := cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 3))
|
||||
assertFormatted(t, as, out, 3)
|
||||
|
||||
// tweak mod time of elm formatter
|
||||
as.NoError(test.RecreateSymlink(t, binPath+"/"+"elm-format"))
|
||||
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 3))
|
||||
assertFormatted(t, as, out, 3)
|
||||
|
||||
// check cache is working
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "0 files changed")
|
||||
assertFormatted(t, as, out, 0)
|
||||
|
||||
// tweak mod time of python formatter
|
||||
as.NoError(test.RecreateSymlink(t, binPath+"/"+"black"))
|
||||
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 3))
|
||||
assertFormatted(t, as, out, 3)
|
||||
|
||||
// check cache is working
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "0 files changed")
|
||||
assertFormatted(t, as, out, 0)
|
||||
|
||||
// add go formatter
|
||||
cfg.Formatters["go"] = &config2.Formatter{
|
||||
|
|
@ -343,12 +342,12 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
|
|||
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 4))
|
||||
assertFormatted(t, as, out, 4)
|
||||
|
||||
// check cache is working
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "0 files changed")
|
||||
assertFormatted(t, as, out, 0)
|
||||
|
||||
// remove python formatter
|
||||
delete(cfg.Formatters, "python")
|
||||
|
|
@ -356,12 +355,12 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
|
|||
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 2))
|
||||
assertFormatted(t, as, out, 2)
|
||||
|
||||
// check cache is working
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "0 files changed")
|
||||
assertFormatted(t, as, out, 0)
|
||||
|
||||
// remove elm formatter
|
||||
delete(cfg.Formatters, "elm")
|
||||
|
|
@ -369,12 +368,12 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
|
|||
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 1))
|
||||
assertFormatted(t, as, out, 1)
|
||||
|
||||
// check cache is working
|
||||
out, err = cmd(t, args...)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), "0 files changed")
|
||||
assertFormatted(t, as, out, 0)
|
||||
}
|
||||
|
||||
func TestGitWorktree(t *testing.T) {
|
||||
|
|
@ -408,10 +407,10 @@ func TestGitWorktree(t *testing.T) {
|
|||
wt, err := repo.Worktree()
|
||||
as.NoError(err, "failed to get git worktree")
|
||||
|
||||
run := func(changed int) {
|
||||
run := func(formatted int) {
|
||||
out, err := cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", changed))
|
||||
assertFormatted(t, as, out, formatted)
|
||||
}
|
||||
|
||||
// run before adding anything to the worktree
|
||||
|
|
@ -429,7 +428,7 @@ func TestGitWorktree(t *testing.T) {
|
|||
// walk with filesystem instead of git
|
||||
out, err := cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir, "--walk", "filesystem")
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 59))
|
||||
assertFormatted(t, as, out, 59)
|
||||
}
|
||||
|
||||
func TestPathsArg(t *testing.T) {
|
||||
|
|
@ -464,12 +463,12 @@ func TestPathsArg(t *testing.T) {
|
|||
// without any path args
|
||||
out, err := cmd(t, "-C", tempDir)
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 31))
|
||||
assertFormatted(t, as, out, 31)
|
||||
|
||||
// specify some explicit paths
|
||||
out, err = cmd(t, "-C", tempDir, "-c", "elm/elm.json", "haskell/Nested/Foo.hs")
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 2))
|
||||
assertFormatted(t, as, out, 2)
|
||||
|
||||
// specify a bad path
|
||||
out, err = cmd(t, "-C", tempDir, "-c", "elm/elm.json", "haskell/Nested/Bar.hs")
|
||||
|
|
@ -529,7 +528,7 @@ go/main.go
|
|||
|
||||
out, err := cmd(t, "-C", tempDir, "--stdin")
|
||||
as.NoError(err)
|
||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 3))
|
||||
assertFormatted(t, as, out, 3)
|
||||
}
|
||||
|
||||
func TestDeterministicOrderingInPipeline(t *testing.T) {
|
||||
|
|
|
|||
|
|
@ -69,3 +69,16 @@ func cmd(t *testing.T, args ...string) ([]byte, error) {
|
|||
|
||||
return out, nil
|
||||
}
|
||||
|
||||
func assertStats(t *testing.T, as *require.Assertions, output []byte, traversed int32, emitted int32, matched int32, formatted int32) {
|
||||
t.Helper()
|
||||
as.Contains(string(output), fmt.Sprintf("traversed %d files", traversed))
|
||||
as.Contains(string(output), fmt.Sprintf("emitted %d files", emitted))
|
||||
as.Contains(string(output), fmt.Sprintf("matched %d files", matched))
|
||||
as.Contains(string(output), fmt.Sprintf("formatted %d files", formatted))
|
||||
}
|
||||
|
||||
func assertFormatted(t *testing.T, as *require.Assertions, output []byte, count int) {
|
||||
t.Helper()
|
||||
as.Contains(string(output), fmt.Sprintf("formatted %d files", count))
|
||||
}
|
||||
|
|
|
|||
35
docs/.vitepress/config.mts
Normal file
35
docs/.vitepress/config.mts
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
import { defineConfig } from 'vitepress'
|
||||
|
||||
// https://vitepress.dev/reference/site-config
|
||||
export default defineConfig({
|
||||
title: "Treefmt",
|
||||
description: "one CLI to format your repo",
|
||||
themeConfig: {
|
||||
|
||||
logo: '/logo.svg',
|
||||
|
||||
// https://vitepress.dev/reference/default-theme-config
|
||||
nav: [
|
||||
{ text: 'Home', link: '/' },
|
||||
{ text: 'Quick Start', link: '/quick-start' }
|
||||
],
|
||||
|
||||
sidebar: [
|
||||
{ text: 'Quick Start', link: '/quick-start' },
|
||||
{ text: 'Overview', link: '/overview' },
|
||||
{ text: 'Usage', link: '/usage' },
|
||||
{ text: 'Formatter Spec', link: '/formatter-spec' },
|
||||
{ text: 'Contributing', link: '/contributing' },
|
||||
{ text: 'FAQ', link: '/faq' },
|
||||
],
|
||||
|
||||
socialLinks: [
|
||||
{ icon: 'github', link: 'https://git.numtide.com/numtide/treefmt' }
|
||||
],
|
||||
|
||||
footer: {
|
||||
message: 'Released under the <a href="https://git.numtide.com/numtide/treefmt/src/branch/main/LICENSE.md">MIT License</a>.',
|
||||
copyright: "Copyright © 2024-present Treefmt Contributors"
|
||||
}
|
||||
}
|
||||
})
|
||||
17
docs/.vitepress/theme/index.ts
Normal file
17
docs/.vitepress/theme/index.ts
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
// https://vitepress.dev/guide/custom-theme
|
||||
import { h } from "vue";
|
||||
import type { Theme } from "vitepress";
|
||||
import DefaultTheme from "vitepress/theme";
|
||||
import "./style.css";
|
||||
|
||||
export default {
|
||||
extends: DefaultTheme,
|
||||
Layout: () => {
|
||||
return h(DefaultTheme.Layout, null, {
|
||||
// https://vitepress.dev/guide/extending-default-theme#layout-slots
|
||||
});
|
||||
},
|
||||
enhanceApp({ app, router, siteData }) {
|
||||
// ...
|
||||
},
|
||||
} satisfies Theme;
|
||||
146
docs/.vitepress/theme/style.css
Normal file
146
docs/.vitepress/theme/style.css
Normal file
|
|
@ -0,0 +1,146 @@
|
|||
/**
|
||||
* Customize default theme styling by overriding CSS variables:
|
||||
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
|
||||
*/
|
||||
|
||||
/**
|
||||
* Colors
|
||||
*
|
||||
* Each colors have exact same color scale system with 3 levels of solid
|
||||
* colors with different brightness, and 1 soft color.
|
||||
*
|
||||
* - `XXX-1`: The most solid color used mainly for colored text. It must
|
||||
* satisfy the contrast ratio against when used on top of `XXX-soft`.
|
||||
*
|
||||
* - `XXX-2`: The color used mainly for hover state of the button.
|
||||
*
|
||||
* - `XXX-3`: The color for solid background, such as bg color of the button.
|
||||
* It must satisfy the contrast ratio with pure white (#ffffff) text on
|
||||
* top of it.
|
||||
*
|
||||
* - `XXX-soft`: The color used for subtle background such as custom container
|
||||
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
|
||||
* on top of it.
|
||||
*
|
||||
* The soft color must be semi transparent alpha channel. This is crucial
|
||||
* because it allows adding multiple "soft" colors on top of each other
|
||||
* to create a accent, such as when having inline code block inside
|
||||
* custom containers.
|
||||
*
|
||||
* - `default`: The color used purely for subtle indication without any
|
||||
* special meanings attched to it such as bg color for menu hover state.
|
||||
*
|
||||
* - `brand`: Used for primary brand colors, such as link text, button with
|
||||
* brand theme, etc.
|
||||
*
|
||||
* - `tip`: Used to indicate useful information. The default theme uses the
|
||||
* brand color for this by default.
|
||||
*
|
||||
* - `warning`: Used to indicate warning to the users. Used in custom
|
||||
* container, badges, etc.
|
||||
*
|
||||
* - `danger`: Used to show error, or dangerous message to the users. Used
|
||||
* in custom container, badges, etc.
|
||||
* -------------------------------------------------------------------------- */
|
||||
|
||||
:root {
|
||||
--vp-c-treefmt-orange-1: #f79433;
|
||||
--vp-c-treefmt-orange-2: #f6861a;
|
||||
--vp-c-treefmt-orange-3: #dd6d00;
|
||||
--vp-c-treefmt-orange-soft: rgba(245, 121, 0, 0.14);
|
||||
|
||||
--vp-c-treefmt-green-1: #9de05c;
|
||||
--vp-c-treefmt-green-2: #8fdb45;
|
||||
--vp-c-treefmt-green-3: #73d216;
|
||||
--vp-c-treefmt-green-soft: rgba(115, 210, 22, 0.14);
|
||||
|
||||
--vp-c-treefmt-gray-1: #6d6e6a;
|
||||
--vp-c-treefmt-gray-2: #888a85;
|
||||
--vp-c-treefmt-gray-3: #a0a19d;
|
||||
--vp-c-treefmt-gray-soft: rgba(136, 138, 133, 0.14);
|
||||
|
||||
--vp-c-default-1: var(--vp-c-treefmt-gray-1);
|
||||
--vp-c-default-2: var(--vp-c-treefmt-gray-2);
|
||||
--vp-c-default-3: var(--vp-c-treefmt-gray-3);
|
||||
--vp-c-default-soft: var(--vp-c-treefmt-gray-soft);
|
||||
|
||||
--vp-c-brand-1: var(--vp-c-treefmt-orange-1);
|
||||
--vp-c-brand-2: var(--vp-c-treefmt-orange-2);
|
||||
--vp-c-brand-3: var(--vp-c-treefmt-orange-3);
|
||||
--vp-c-brand-soft: var(--vp-c-treefmt-orange-soft);
|
||||
|
||||
--vp-c-tip-1: var(--vp-c-brand-1);
|
||||
--vp-c-tip-2: var(--vp-c-brand-2);
|
||||
--vp-c-tip-3: var(--vp-c-brand-3);
|
||||
--vp-c-tip-soft: var(--vp-c-brand-soft);
|
||||
|
||||
--vp-c-warning-1: var(--vp-c-yellow-1);
|
||||
--vp-c-warning-2: var(--vp-c-yellow-2);
|
||||
--vp-c-warning-3: var(--vp-c-yellow-3);
|
||||
--vp-c-warning-soft: var(--vp-c-yellow-soft);
|
||||
|
||||
--vp-c-danger-1: var(--vp-c-red-1);
|
||||
--vp-c-danger-2: var(--vp-c-red-2);
|
||||
--vp-c-danger-3: var(--vp-c-red-3);
|
||||
--vp-c-danger-soft: var(--vp-c-red-soft);
|
||||
}
|
||||
|
||||
/**
|
||||
* Component: Button
|
||||
* -------------------------------------------------------------------------- */
|
||||
|
||||
:root {
|
||||
--vp-button-brand-border: transparent;
|
||||
--vp-button-brand-text: var(--vp-c-white);
|
||||
--vp-button-brand-bg: var(--vp-c-brand-3);
|
||||
--vp-button-brand-hover-border: transparent;
|
||||
--vp-button-brand-hover-text: var(--vp-c-white);
|
||||
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
|
||||
--vp-button-brand-active-border: transparent;
|
||||
--vp-button-brand-active-text: var(--vp-c-white);
|
||||
--vp-button-brand-active-bg: var(--vp-c-brand-1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Component: Home
|
||||
* -------------------------------------------------------------------------- */
|
||||
|
||||
:root {
|
||||
--vp-home-hero-image-background-image: linear-gradient(
|
||||
-45deg,
|
||||
var(--vp-c-treefmt-orange-3) 50%,
|
||||
var(--vp-c-treefmt-green-1) 50%
|
||||
);
|
||||
--vp-home-hero-image-filter: blur(44px);
|
||||
}
|
||||
|
||||
@media (min-width: 640px) {
|
||||
:root {
|
||||
--vp-home-hero-image-filter: blur(56px);
|
||||
}
|
||||
}
|
||||
|
||||
@media (min-width: 960px) {
|
||||
:root {
|
||||
--vp-home-hero-image-filter: blur(68px);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Component: Custom Block
|
||||
* -------------------------------------------------------------------------- */
|
||||
|
||||
:root {
|
||||
--vp-custom-block-tip-border: transparent;
|
||||
--vp-custom-block-tip-text: var(--vp-c-text-1);
|
||||
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
|
||||
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
|
||||
}
|
||||
|
||||
/**
|
||||
* Component: Algolia
|
||||
* -------------------------------------------------------------------------- */
|
||||
|
||||
.DocSearch {
|
||||
--docsearch-primary-color: var(--vp-c-brand-1) !important;
|
||||
}
|
||||
145
docs/contributing.md
Normal file
145
docs/contributing.md
Normal file
|
|
@ -0,0 +1,145 @@
|
|||
---
|
||||
outline: deep
|
||||
---
|
||||
|
||||
# Contribution guidelines
|
||||
|
||||
This file contains instructions that will help you make a contribution.
|
||||
|
||||
## Licensing
|
||||
|
||||
The treefmt binaries and this user guide are licensed under the [MIT license](https://numtide.github.io/treefmt/LICENSE.html).
|
||||
|
||||
## Before you contribute
|
||||
|
||||
Here you can take a look at the [existing issues](https://github.com/numtide/treefmt/issues). Feel free to contribute, but make sure you have a [GitHub account](https://github.com/join) first :) .
|
||||
|
||||
If you're new to open source, please read GitHub's guide on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). It's a quick read, and it's a great way to introduce yourself to how things work behind the scenes in open-source projects.
|
||||
|
||||
Before sending a pull request, make sure that you've read all the guidelines. If you don't understand something, please [state your question clearly in an issue](https://github.com/numtide/treefmt/issues/new) or ask the community on the [treefmt matrix server](https://matrix.to/#/#treefmt:numtide.com).
|
||||
|
||||
## Creating an issue
|
||||
|
||||
If you need to create an issue, make sure to clearly describe it, including:
|
||||
|
||||
- The steps to reproduce it if it's a bug
|
||||
- The version of treefmt used
|
||||
- The database driver and version
|
||||
- The database version
|
||||
|
||||
The cache database is stored in a toml file the ~/.cache/treefmt directory.
|
||||
|
||||
## Making changes
|
||||
|
||||
If you want to introduce changes to the project, please follow these steps:
|
||||
|
||||
- Fork the repository on GitHub
|
||||
- Create a branch on your fork. Don't commit directly to main
|
||||
- Add the necessary tests for your changes
|
||||
- Run treefmt in the source directory before you commit your changes
|
||||
- Push your changes to the branch in your repository fork
|
||||
- Submit a pull request to the original repository
|
||||
|
||||
Make sure you based your commits on logical and atomic units!
|
||||
|
||||
## Examples of git history
|
||||
|
||||
Git history that we want to have:
|
||||
|
||||
Git history that we are trying to avoid:
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Git history that we want to have</summary>
|
||||
|
||||
```
|
||||
|
||||
* e3ed88b (HEAD -> contribution-guide, upstream/main, origin/main, origin/HEAD, main) Merge pull request #470 from zimbatm/fix_lru_cache
|
||||
|
||||
|\
|
||||
|
||||
| * 1ab7d9f Use rayon for multithreading command
|
||||
|
||||
|/
|
||||
|
||||
* e9c5bb4 Merge pull request #468 from zimbatm/multithread
|
||||
|
||||
|\
|
||||
|
||||
| * de2d6cf Add lint property for Formatter struct
|
||||
|
||||
| * cd2ed17 Fix impl on Formatter get_command() function
|
||||
|
||||
|/
|
||||
|
||||
* 028c344 Merge pull request #465 from rayon/0.15.0-release
|
||||
|
||||
|\
|
||||
|
||||
| * 7b619d6 0.15.0 release
|
||||
|
||||
|/
|
||||
|
||||
* acdf7df Merge pull request #463 from zimbatm/support-multi-part-namespaces
|
||||
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Git history that we are <b>trying</b> to avoid:</summary>
|
||||
|
||||
```
|
||||
|
||||
* 4c8aca8 Merge pull request #120 from zimbatm/add-rayon
|
||||
|
||||
|\
|
||||
|
||||
| * fc2b449 use rayon for engine now
|
||||
|
||||
| * 2304683 add rayon config
|
||||
|
||||
| * 5285bd3 bump base image to F30
|
||||
|
||||
* | 4d0fbe2 Merge pull request #114 from rizary/create_method_create_release
|
||||
|
||||
|\ \
|
||||
|
||||
| * | 36a9396 test changed
|
||||
|
||||
| * | 22f681d method create release for github created
|
||||
|
||||
* | | 2ef4ea1 Merge pull request #119 from rizary/config.rs
|
||||
|
||||
|\ \ \
|
||||
|
||||
| |/ /
|
||||
|
||||
|/| |
|
||||
|
||||
| * | 5f1b8f0 unused functions removed
|
||||
|
||||
* | | a93c361 Merge pull request #117 from zimbatm/add-getreleases-to-abstract
|
||||
|
||||
|\ \ \
|
||||
|
||||
| |/ /
|
||||
|
||||
|/| |
|
||||
|
||||
| * | 0a97236 add get_releses for Cargo
|
||||
|
||||
| * | 55e4c57 add get_releases/get_release into engine.rs
|
||||
|
||||
|/ /
|
||||
|
||||
* | badeddd Merge pull request #101 from zimbatm/extreme-cachin
|
||||
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
Additionally, it's always good to work on improving documentation and adding examples.
|
||||
|
||||
Thank you for considering contributing to `treefmt`.
|
||||
19
docs/faq.md
Normal file
19
docs/faq.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# FAQ
|
||||
|
||||
## How does treefmt function?
|
||||
|
||||
`Treefmt` traverses all your project's folders, maps files to specific code formatters, and formats the code accordingly. Other tools also traverse the filesystem, but not necessarily starting from the root of the project.
|
||||
|
||||
Contrary to other formatters, `treefmt` doesn't preview the changes before writing them to a file. If you want to view the changes, you can always check the diff in your version control (we assume that your project is checked into a version control system). You can also rely on version control if errors were introduced into your code as a result of disruptions in the formatter's work.
|
||||
|
||||
## How is the cache organized?
|
||||
|
||||
At this moment, the cache is represented by a flat TOML file where file paths are mapped to `mtimes`. The file is located in:
|
||||
|
||||
```
|
||||
~/.cache/treefmt/<hash-of-the-treefmt.toml-path>.toml
|
||||
```
|
||||
|
||||
However, we are planning to move the hash file to the destination project's root directory.
|
||||
|
||||
At the end of each tool run, the cache file gets overwritten with the last formatting time entries. In this way, we can can compare the last change time of the file to the last formatting time, and figure out which files need re-formatting.
|
||||
55
docs/formatter-spec.md
Normal file
55
docs/formatter-spec.md
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
outline: deep
|
||||
---
|
||||
|
||||
# Formatter Specification
|
||||
|
||||
In order to keep the design of `treefmt` simple, we support only formatters which adhere to a certain standard. This document outlines this standard. If the formatter you would like to use doesn't comply with the rules, it's often possible to create a wrapper script that transforms the usage to match the specification.
|
||||
|
||||
In this design, we rely on `treefmt` to do the tree traversal, and only invoke
|
||||
the code formatter on the selected files.
|
||||
|
||||
## Rules
|
||||
|
||||
In order for the formatter to comply to this spec, it MUST follow the
|
||||
following rules:
|
||||
|
||||
### 1. Files passed as arguments
|
||||
|
||||
In order to be integrated to `treefmt`'s workflow, the formatter's CLI must adhere to the following specification:
|
||||
|
||||
```
|
||||
<command> [options] [...<files>]
|
||||
```
|
||||
|
||||
Where:
|
||||
|
||||
- `<command>` is the name of the formatting tool.
|
||||
- `[options]` is any number of flags and options that the formatter accepts.
|
||||
- `[...<files>]` is one or more files given to the formatter for processing.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
$ rustfmt --edition 2018 src/main.rs src/lib.rs
|
||||
```
|
||||
|
||||
It SHOULD processes only the specified files. Files that are not passed SHOULD never be formatted.
|
||||
|
||||
### 2. Write to changed files
|
||||
|
||||
Whenever there is a change to the code formatting, the code formatter MUST
|
||||
write to the changes back to the original location.
|
||||
|
||||
If there is no changes to the original file, the formatter MUST NOT write to
|
||||
the original location.
|
||||
|
||||
### 3. Idempotent
|
||||
|
||||
The code formatter SHOULD be indempotent. Meaning that it produces stable
|
||||
outputs.
|
||||
|
||||
### 4. Reliable
|
||||
|
||||
We expect the formatter to be reliable and not break the semantic of the
|
||||
formatted files.
|
||||
143
docs/formatters.md
Normal file
143
docs/formatters.md
Normal file
|
|
@ -0,0 +1,143 @@
|
|||
# A list of known formatters
|
||||
|
||||
Here is a list of all the formatters we tested. Feel free to send a PR to add
|
||||
other ones!
|
||||
|
||||
## [prettier](https://prettier.io/)
|
||||
|
||||
An opinionated code formatter that supports many languages.
|
||||
|
||||
```toml
|
||||
command = "prettier"
|
||||
options = ["--write"]
|
||||
includes = [
|
||||
"*.css",
|
||||
"*.html",
|
||||
"*.js",
|
||||
"*.json",
|
||||
"*.jsx",
|
||||
"*.md",
|
||||
"*.mdx",
|
||||
"*.scss",
|
||||
"*.ts",
|
||||
"*.yaml",
|
||||
]
|
||||
```
|
||||
|
||||
## [Black](https://github.com/psf/black)
|
||||
|
||||
A python formatter.
|
||||
|
||||
```toml
|
||||
command = "black"
|
||||
includes = ["*.py"]
|
||||
```
|
||||
|
||||
## [clang-format](https://clang.llvm.org/docs/ClangFormat.html)
|
||||
|
||||
A tool to format C/C++/Java/JavaScript/Objective-C/Protobuf/C# code.
|
||||
|
||||
```toml
|
||||
command = "clang-format"
|
||||
options = [ "-i" ]
|
||||
includes = [ "*.c", "*.cpp", "*.cc", "*.h", "*.hpp" ]
|
||||
```
|
||||
|
||||
Note: This example focuses on C/C++ but can be modified to use with other languages.
|
||||
|
||||
## Elm
|
||||
|
||||
```toml
|
||||
command = "elm-format"
|
||||
options = ["--yes"]
|
||||
includes = ["*.elm"]
|
||||
```
|
||||
|
||||
## Go
|
||||
|
||||
```toml
|
||||
command = "gofmt"
|
||||
options = ["-w"]
|
||||
includes = ["*.go"]
|
||||
```
|
||||
|
||||
## [Ormolu](https://github.com/tweag/ormolu)
|
||||
|
||||
Haskell formatter. Make sure to use ormolu 0.1.4.0+ as older versions don't
|
||||
adhere to the spec.
|
||||
|
||||
```toml
|
||||
command = "ormolu"
|
||||
options = [
|
||||
"--ghc-opt", "-XBangPatterns",
|
||||
"--ghc-opt", "-XPatternSynonyms",
|
||||
"--ghc-opt", "-XTypeApplications",
|
||||
"--mode", "inplace",
|
||||
"--check-idempotence",
|
||||
]
|
||||
includes = ["*.hs"]
|
||||
```
|
||||
|
||||
## [stylish-haskell](https://github.com/jaspervdj/stylish-haskell)
|
||||
|
||||
Another Haskell formatter.
|
||||
|
||||
```toml
|
||||
command = "stylish-haskell"
|
||||
options = [ "--inplace" ]
|
||||
includes = [ "*.hs" ]
|
||||
```
|
||||
|
||||
## [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)
|
||||
|
||||
Nix code formatter.
|
||||
|
||||
```toml
|
||||
command = "nixpkgs-fmt"
|
||||
includes = ["*.nix"]
|
||||
```
|
||||
|
||||
## rustfmt
|
||||
|
||||
```toml
|
||||
command = "rustfmt"
|
||||
options = ["--edition", "2018"]
|
||||
includes = ["*.rs"]
|
||||
```
|
||||
|
||||
## [rufo](https://github.com/ruby-formatter/rufo)
|
||||
|
||||
Rufo is an opinionated ruby formatter. By default it exits with status 3 on
|
||||
file change so we have to pass the `-x` option.
|
||||
|
||||
```toml
|
||||
command = "rufo"
|
||||
options = ["-x"]
|
||||
includes = ["*.rb"]
|
||||
```
|
||||
|
||||
## cargo fmt
|
||||
|
||||
`cargo fmt` is not supported as it doesn't follow the spec. It doesn't allow
|
||||
to pass arbitrary files to be formatted, which treefmt relies on. Use `rustfmt`
|
||||
instead (which is what `cargo fmt` uses under the hood).
|
||||
|
||||
## [shfmt](https://github.com/mvdan/sh)
|
||||
|
||||
A shell code formatter.
|
||||
|
||||
```toml
|
||||
command = "shfmt"
|
||||
options = [
|
||||
"-i",
|
||||
"2", # indent 2
|
||||
"-s", # simplify the code
|
||||
"-w", # write back to the file
|
||||
]
|
||||
includes = ["*.sh"]
|
||||
```
|
||||
|
||||
## terraform
|
||||
|
||||
terraform fmt only supports formatting one file at the time. See
|
||||
https://github.com/hashicorp/terraform/pull/28191
|
||||
18
docs/index.md
Normal file
18
docs/index.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
# https://vitepress.dev/reference/default-theme-home-page
|
||||
layout: home
|
||||
|
||||
hero:
|
||||
name: "Treefmt"
|
||||
text: "One CLI to format your repo"
|
||||
image:
|
||||
src: /fmt.gif
|
||||
alt: Treefmt
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Quick Start
|
||||
link: /quick-start
|
||||
- theme: alt
|
||||
text: More Info
|
||||
link: /overview
|
||||
---
|
||||
65
docs/installation.md
Normal file
65
docs/installation.md
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
---
|
||||
outline: deep
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
There are two options to install `treefmt`: by downloading the latest binary, or by compiling and building the tool from source.
|
||||
|
||||
## Installing with a binary file
|
||||
|
||||
You can find the list of the latest binaries [here](https://github.com/numtide/treefmt/releases).
|
||||
|
||||
## Building from source
|
||||
|
||||
There are several ways to build `treefmt` from source. Your choice will depend on whether you're a [nix](https://github.com/NixOS/nix) user.
|
||||
|
||||
### Non-Nix User
|
||||
|
||||
To try the project without building it, run:
|
||||
|
||||
```
|
||||
$ cargo run -- --help
|
||||
```
|
||||
|
||||
The command will output the manual. You can run the tool in this manner with any other flag or option to format your project.
|
||||
|
||||
To build a binary, you need to have rust installed. You can install it with [rustup](https://rustup.rs/). Now, if you want to build the project, switch to the project root folder and run:
|
||||
|
||||
```
|
||||
$ cargo build
|
||||
```
|
||||
|
||||
After the successful execution of the cargo build command, you will find the `treefmt` binary in the target folder.
|
||||
|
||||
### Nix User
|
||||
|
||||
[Nix](https://github.com/NixOS/nix) is a package manager foundational for NixOS. You can use it in NixOS and in any other OS equally.
|
||||
|
||||
If you're using both `treefmt` and `nix`, you can go for [`treefmt-nix`](https://github.com/numtide/treefmt-nix), a special tool that makes installation and configuration of `treefmt` with `nix` easier.
|
||||
|
||||
**Non-flake user**
|
||||
|
||||
Here you also have two options: you can install `treefmt` with plain nix-build , or with nix-shell.
|
||||
|
||||
To build the package with nix-build, just run:
|
||||
|
||||
```
|
||||
$ nix-build -A treefmt
|
||||
```
|
||||
|
||||
**Nix-flake user**
|
||||
|
||||
If you want to use this repository with flakes, please enable the flakes feature first. To run the project with flakes without building it, you can execute the following command in the root folder:
|
||||
|
||||
```
|
||||
$ nix run . -- --help
|
||||
```
|
||||
|
||||
To build the project, run the following command in the root folder:
|
||||
|
||||
```
|
||||
$ nix build
|
||||
```
|
||||
|
||||
The `treefmt` binary will be available in the result folder.
|
||||
75
docs/overview.md
Normal file
75
docs/overview.md
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
# About the project
|
||||
|
||||
`treefmt` is a formatting tool that saves you time: it provides developers with a universal way to trigger all
|
||||
formatters needed for the project in one place.
|
||||
|
||||
## Background
|
||||
|
||||
Typically, each project has its own code standards enforced by the project's owner. Any code contributions must match
|
||||
that given standard, i.e. be formatted in a specific manner.
|
||||
|
||||
At first glance, the task of code formatting may seem trivial: the formatter can be automatically triggered when you
|
||||
save a file in your IDE. Indeed, formatting doesn't take much effort if you're working on a single project long term:
|
||||
setting up the formatters in your IDE won't take much of your time, and then you're ready to go.
|
||||
|
||||
Contrary to that, if you're working on multiple projects at the same time, you may have to update your formatter
|
||||
configs in the IDE each time you switch between the projects. This is because formatter settings aren't
|
||||
project-specific --- they are set up globally for all projects.
|
||||
|
||||
Alternatively, you can trigger formatters manually, one-by-one or in a script. Actually, for bigger projects, it's
|
||||
common to have a script that runs over your project's directories and calls formatters consequently. But it takes time
|
||||
to iterate through all the files.
|
||||
|
||||
All the solutions take up a significant amount of time which a developer could spend doing the actual work. They also
|
||||
require you to remember which formatters and options are used by each project you are working on.
|
||||
|
||||
`treefmt` solves these issues.
|
||||
|
||||
## Why treefmt?
|
||||
|
||||
`treefmt`'s configuration is project-specific, so you don't need to re-configure formatters each time you switch
|
||||
between projects, like you have to when working with formatters in the IDE.
|
||||
|
||||
Contrary to calling formatters from the command line, there's no need to remember all the specific formatters required
|
||||
for each project. Once you set up the config, you can run the tool in any of your project's folders without any
|
||||
additional flags or options.
|
||||
|
||||
Typically, formatters have different ways to say there was a specific error. With `treefmt`, you get a standardized
|
||||
output which is easier to understand than the variegated outputs of different formatters, so it takes less time to
|
||||
grasp what's wrong.
|
||||
|
||||
In addition, `treefmt` works faster than the custom script solution because the changed files are cached and the
|
||||
formatters run only against them. Moreover, formatters are run in parallel, which makes the tool even faster.
|
||||
|
||||
The difference may not be significant for smaller projects, but it gets quite visible as the project grows. For
|
||||
instance, take the caching optimization.
|
||||
|
||||
It takes 22 seconds to traverse a project of 40,559 files and no changes without caching:
|
||||
|
||||
```
|
||||
traversed 40559 files
|
||||
emitted 40559 files for processing
|
||||
matched 33712 files to formatters
|
||||
formatted 33712 files in 22.270884528s
|
||||
```
|
||||
|
||||
...while it takes **270 milliseconds** to traverse the same project with caching:
|
||||
|
||||
```
|
||||
traversed 40559 files
|
||||
emitted 6847 files for processing
|
||||
matched 0 files to formatters
|
||||
formatted 0 files in 270.53513ms
|
||||
```
|
||||
|
||||
The tool can be invoked manually or integrated into your CI. There's currently no integration with IDEs, but the feature is coming soon.
|
||||
|
||||
## What we still need help with
|
||||
|
||||
- **IDE integration:** Most of developers are used to formatting a file upon save in the IDE. So far, you can't use `treefmt` for this purpose, but we're working on it 😀
|
||||
- **Pre-commit hook:** It's good to have your code checked for adherence to the project's standards before commit. `treefmt` pre-commit hook won't let you commit if you have formatting issues.
|
||||
|
||||
As a next step, learn how to [install] and [use] `treefmt`.
|
||||
|
||||
[install]: installation.md
|
||||
[use]: usage.md
|
||||
1629
docs/package-lock.json
generated
Normal file
1629
docs/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
13
docs/package.json
Normal file
13
docs/package.json
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
{
|
||||
"name": "treefmt-docs",
|
||||
"version": "0.0.1",
|
||||
"devDependencies": {
|
||||
"vitepress": "^1.1.4"
|
||||
},
|
||||
"scripts": {
|
||||
"vitepress": "vitepress",
|
||||
"dev": "vitepress dev",
|
||||
"build": "vitepress build",
|
||||
"preview": "vitepress preview"
|
||||
}
|
||||
}
|
||||
BIN
docs/public/fmt.gif
Normal file
BIN
docs/public/fmt.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
194
docs/public/logo.svg
Normal file
194
docs/public/logo.svg
Normal file
|
|
@ -0,0 +1,194 @@
|
|||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://creativecommons.org/ns#"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
inkscape:export-ydpi="512"
|
||||
inkscape:export-xdpi="512"
|
||||
inkscape:export-filename="/home/basile/dev/treefmt.png"
|
||||
sodipodi:docname="treefmt.svg"
|
||||
inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
|
||||
id="svg16"
|
||||
version="1.1"
|
||||
viewBox="0 0 12.7 12.7"
|
||||
height="48"
|
||||
width="48">
|
||||
<defs
|
||||
id="defs10">
|
||||
<inkscape:path-effect
|
||||
hide_knots="false"
|
||||
only_selected="false"
|
||||
apply_with_radius="true"
|
||||
apply_no_radius="true"
|
||||
use_knot_distance="true"
|
||||
flexible="false"
|
||||
chamfer_steps="1"
|
||||
radius="0.5"
|
||||
mode="F"
|
||||
method="auto"
|
||||
unit="px"
|
||||
satellites_param="F,0,0,1,0,0.13229167,0,1 @ F,0,0,1,0,0.13229167,0,1 @ F,0,0,1,0,0.13229167,0,1 @ F,0,0,1,0,0.13229167,0,1"
|
||||
lpeversion="1"
|
||||
is_visible="true"
|
||||
id="path-effect1012"
|
||||
effect="fillet_chamfer" />
|
||||
<inkscape:path-effect
|
||||
hide_knots="false"
|
||||
only_selected="false"
|
||||
apply_with_radius="true"
|
||||
apply_no_radius="true"
|
||||
use_knot_distance="true"
|
||||
flexible="false"
|
||||
chamfer_steps="1"
|
||||
radius="0.5"
|
||||
mode="F"
|
||||
method="auto"
|
||||
unit="px"
|
||||
satellites_param="F,0,0,1,0,0.13229167,0,1 @ F,0,0,1,0,0.13229167,0,1 @ F,0,0,1,0,0.13229167,0,1 @ F,0,0,1,0,0.13229167,0,1"
|
||||
lpeversion="1"
|
||||
is_visible="true"
|
||||
id="path-effect1010"
|
||||
effect="fillet_chamfer" />
|
||||
<inkscape:path-effect
|
||||
hide_knots="false"
|
||||
only_selected="false"
|
||||
apply_with_radius="true"
|
||||
apply_no_radius="true"
|
||||
use_knot_distance="true"
|
||||
flexible="false"
|
||||
chamfer_steps="1"
|
||||
radius="0.5"
|
||||
mode="F"
|
||||
method="auto"
|
||||
unit="px"
|
||||
satellites_param="F,0,0,1,0,0.13229167,0,1 @ F,0,0,1,0,0.13229167,0,1 @ F,0,0,1,0,0.13229167,0,1 @ F,0,0,1,0,0.13229167,0,1"
|
||||
lpeversion="1"
|
||||
is_visible="true"
|
||||
id="path-effect989"
|
||||
effect="fillet_chamfer" />
|
||||
</defs>
|
||||
<sodipodi:namedview
|
||||
inkscape:window-maximized="1"
|
||||
inkscape:window-y="340"
|
||||
inkscape:window-x="1440"
|
||||
inkscape:window-height="1373"
|
||||
inkscape:window-width="2560"
|
||||
units="px"
|
||||
showgrid="false"
|
||||
inkscape:document-rotation="0"
|
||||
inkscape:current-layer="layer1"
|
||||
inkscape:document-units="mm"
|
||||
inkscape:cy="29.374509"
|
||||
inkscape:cx="-10.431476"
|
||||
inkscape:zoom="11.2"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:pageopacity="0.0"
|
||||
borderopacity="1.0"
|
||||
bordercolor="#666666"
|
||||
pagecolor="#ffffff"
|
||||
id="base">
|
||||
<inkscape:grid
|
||||
dotted="false"
|
||||
id="grid902"
|
||||
type="xygrid" />
|
||||
</sodipodi:namedview>
|
||||
<metadata
|
||||
id="metadata13">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
<dc:title></dc:title>
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<g
|
||||
id="layer1"
|
||||
inkscape:groupmode="layer"
|
||||
inkscape:label="Layer 1">
|
||||
<path
|
||||
d="m 6.3370673,12.637056 c -0.5007028,0 -5.1699157,-2.6957712 -5.42026711,-3.1293926 C 0.66644877,9.074042 0.66644862,3.6824995 0.91680002,3.2488781 1.1671514,2.8152568 5.8363641,0.11948539 6.337067,0.11948538 c 0.5007028,-2e-8 5.169916,2.69577112 5.420267,3.12939252 0.250351,0.4336213 0.250352,5.8251638 0,6.2587852 -0.250351,0.4336214 -4.9195639,3.1293929 -5.4202667,3.1293929 z"
|
||||
inkscape:randomized="0"
|
||||
inkscape:rounded="0.08"
|
||||
inkscape:flatsided="true"
|
||||
sodipodi:arg2="2.0943951"
|
||||
sodipodi:arg1="1.5707963"
|
||||
sodipodi:r2="5.4202676"
|
||||
sodipodi:r1="6.2587852"
|
||||
sodipodi:cy="6.3782705"
|
||||
sodipodi:cx="6.3370669"
|
||||
sodipodi:sides="6"
|
||||
id="path20"
|
||||
style="fill:#729fcf;stroke-width:0.0142755"
|
||||
sodipodi:type="star" />
|
||||
<path
|
||||
sodipodi:type="star"
|
||||
style="fill:#888a85;stroke-width:0.0128537"
|
||||
id="path20-3"
|
||||
sodipodi:sides="6"
|
||||
sodipodi:cx="6.3652418"
|
||||
sodipodi:cy="6.3777179"
|
||||
sodipodi:r1="5.6354737"
|
||||
sodipodi:r2="4.8804641"
|
||||
sodipodi:arg1="1.5707963"
|
||||
sodipodi:arg2="2.0943951"
|
||||
inkscape:flatsided="true"
|
||||
inkscape:rounded="0.08"
|
||||
inkscape:randomized="0"
|
||||
d="m 6.3652422,12.013192 c -0.4508379,0 -4.6550446,-2.4273 -4.8804635,-2.817737 -0.225419,-0.3904371 -0.2254191,-5.2450367 -2e-7,-5.6354738 0.225419,-0.390437 4.4296255,-2.81773694 4.8804634,-2.81773696 0.4508379,-1e-8 4.6550441,2.42729966 4.8804631,2.81773676 0.225419,0.390437 0.225419,5.2450366 0,5.6354737 -0.225418,0.3904371 -4.4296249,2.8177373 -4.8804628,2.8177373 z" />
|
||||
<path
|
||||
sodipodi:type="rect"
|
||||
d="m 4.6302084,3.8364582 5.0270831,0 A 0.13229167,0.13229167 45 0 1 9.7895832,3.9687499 V 4.4979165 A 0.13229167,0.13229167 135 0 1 9.6572915,4.6302082 l -5.0270831,0 A 0.13229167,0.13229167 45 0 1 4.4979167,4.4979165 V 3.9687499 A 0.13229167,0.13229167 135 0 1 4.6302084,3.8364582 Z"
|
||||
inkscape:path-effect="#path-effect989"
|
||||
y="3.8364582"
|
||||
x="4.4979167"
|
||||
height="0.79374999"
|
||||
width="5.2916665"
|
||||
id="rect898"
|
||||
style="fill:#f57900;stroke-width:0.0121433" />
|
||||
<circle
|
||||
r="0.66145831"
|
||||
style="fill:#73d216;stroke-width:0.0221209"
|
||||
id="path860-3"
|
||||
cx="2.778125"
|
||||
cy="4.2333331" />
|
||||
<circle
|
||||
cy="6.4822917"
|
||||
cx="4.6302085"
|
||||
id="path860-3-5"
|
||||
style="fill:#73d216;stroke-width:0.0221209"
|
||||
r="0.66145831" />
|
||||
<circle
|
||||
r="0.66145831"
|
||||
style="fill:#73d216;stroke-width:0.0221209"
|
||||
id="path860-3-5-6"
|
||||
cx="4.6302085"
|
||||
cy="8.9958334" />
|
||||
<path
|
||||
sodipodi:type="rect"
|
||||
d="M 6.4822916,6.0854168 H 9.6572915 A 0.13229167,0.13229167 45 0 1 9.7895832,6.2177085 V 6.7468751 A 0.13229167,0.13229167 135 0 1 9.6572915,6.8791668 H 6.4822916 A 0.13229167,0.13229167 45 0 1 6.3499999,6.7468751 V 6.2177085 A 0.13229167,0.13229167 135 0 1 6.4822916,6.0854168 Z"
|
||||
inkscape:path-effect="#path-effect1010"
|
||||
style="fill:#f57900;stroke-width:0.00979024"
|
||||
id="rect898-2"
|
||||
width="3.4395833"
|
||||
height="0.79374999"
|
||||
x="6.3499999"
|
||||
y="6.0854168" />
|
||||
<path
|
||||
sodipodi:type="rect"
|
||||
d="m 6.4822916,8.598959 3.1749999,0 A 0.13229167,0.13229167 45 0 1 9.7895832,8.7312506 V 9.2604173 A 0.13229167,0.13229167 135 0 1 9.6572915,9.392709 l -3.1749999,0 A 0.13229167,0.13229167 45 0 1 6.3499999,9.2604173 V 8.7312506 A 0.13229167,0.13229167 135 0 1 6.4822916,8.598959 Z"
|
||||
inkscape:path-effect="#path-effect1012"
|
||||
y="8.598959"
|
||||
x="6.3499999"
|
||||
height="0.79374999"
|
||||
width="3.4395833"
|
||||
id="rect898-2-9"
|
||||
style="fill:#f57900;stroke-width:0.00979024" />
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 7.0 KiB |
18
docs/quick-start.md
Normal file
18
docs/quick-start.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
outline: none
|
||||
---
|
||||
|
||||
# Quick start
|
||||
|
||||
To run `treefmt` in your project, please follow these steps:
|
||||
|
||||
1. [Install] `treefmt`.
|
||||
2. Install any formatters you wish to use with `treefmt`.
|
||||
3. Run `treefmt --init` to generate a basic configuration file `treefmt.toml`.
|
||||
4. Edit the configuration, adding formatters as desired. See [here] for more info on how to configure a formatter.
|
||||
5. Run `treefmt` with the needed flags and options. You can check the supported options by executing `treefmt --help`.
|
||||
|
||||
In the following sections we will guide you through installing and configuring `treefmt` in detail.
|
||||
|
||||
[install]: installation.md
|
||||
[here]: formatter-spec.md
|
||||
115
docs/usage.md
Normal file
115
docs/usage.md
Normal file
|
|
@ -0,0 +1,115 @@
|
|||
# Usage
|
||||
|
||||
You can run treefmt by executing:
|
||||
|
||||
`$ treefmt`
|
||||
|
||||
or, if it's not in your `$PATH`:
|
||||
|
||||
`$ ./treefmt`
|
||||
|
||||
Treefmt has the following specification:
|
||||
|
||||
```
|
||||
treefmt [FLAGS] [OPTIONS] [--] [paths]...
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
`--allow-missing-formatter`
|
||||
|
||||
> Do not exit with an error if some of the configured formatters are missing.
|
||||
|
||||
`--clear-cache`
|
||||
|
||||
> Reset the evaluation cache. Invalidation should happen automatically if the formatting tool has been updated, or if the files to format have changed. If cache wasn't properly invalidated, you can use this flag to clear the cache.
|
||||
|
||||
`--fail-on-change`
|
||||
|
||||
> Exit with error if some files require re-formatting. This is useful for your CI if you want to detect if the contributed code was forgotten to be formatted.
|
||||
|
||||
`-h, --help`
|
||||
|
||||
> Prints available flags and options
|
||||
|
||||
`--init`
|
||||
|
||||
> Creates a new config file `treefmt.toml`.
|
||||
|
||||
`--no-cache`
|
||||
|
||||
> Tells `treefmt` to ignore the evaluation cache entirely. With this flag, you can avoid cache invalidation issues, if any. Typically, the machine that is running treefmt in the CI is starting with a fresh environment each time, so any calculated cache is lost. The `--no-cache` flag eliminates unnecessary work in the CI.
|
||||
|
||||
`-q, --quiet`
|
||||
|
||||
> Don't print output to stderr.
|
||||
|
||||
`--stdin`
|
||||
|
||||
> Format the content passed in stdin.
|
||||
|
||||
`-V, --version`
|
||||
|
||||
> Print version information.
|
||||
|
||||
`-v, --verbose`
|
||||
|
||||
> Change the log verbosity. Log verbosity is based off the number of 'v' used. With one `-v`, your logs will display `[INFO]` and `[ERROR]` messages, while `-vv` will also show `[DEBUG]` messages.
|
||||
|
||||
`--config-file <config-file>`
|
||||
|
||||
> Run with the specified config file which is not in the project tree.
|
||||
|
||||
`-f, --formatters <formatters>...`
|
||||
|
||||
> Only apply selected formatters. Defaults to all formatters.
|
||||
|
||||
`-H, --hidden`
|
||||
|
||||
> Also traverse hidden files (files that start with a .). This behaviour can be overridden with the `--no-hidden` flag.
|
||||
|
||||
`--no-hidden`
|
||||
|
||||
> Override the `--hidden` flag. Don't traverse hidden files.
|
||||
|
||||
`--tree-root <tree-root>`
|
||||
|
||||
> Set the path to the tree root directory where treefmt will look for the files to format. Defaults to the folder holding the `treefmt.toml` file. It’s mostly useful in combination with `--config-file` to specify the project root which won’t coincide with the directory holding `treefmt.toml`.
|
||||
|
||||
`-C <work-dir>`
|
||||
|
||||
> Run as if `treefmt` was started in `<work-dir>` instead of the current working directory (default: `.`). Equivalent to `cd <work dir>; treefmt`.
|
||||
|
||||
## Arguments
|
||||
|
||||
`<paths>...`
|
||||
|
||||
> Paths to format. Defaults to formatting the whole tree
|
||||
|
||||
## CI integration
|
||||
|
||||
Typically, you would use treefmt in the CI with the `--fail-on-change` and `--no-cache flags`. Find the explanations above.
|
||||
|
||||
You can you set a `treefmt` job in the GitHub pipeline for Ubuntu with nix-shell like this:
|
||||
|
||||
```
|
||||
name: treefmt
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: main
|
||||
jobs:
|
||||
formatter:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- uses: cachix/install-nix-action@v12
|
||||
with:
|
||||
nix_path: nixpkgs=channel:nixos-unstable
|
||||
- uses: cachix/cachix-action@v10
|
||||
with:
|
||||
name: nix-community
|
||||
authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
|
||||
- name: treefmt
|
||||
run: nix-shell --run "treefmt --fail-on-change --no-cache"
|
||||
```
|
||||
24
docs/vhs/fmt.tape
Normal file
24
docs/vhs/fmt.tape
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
Require nix
|
||||
|
||||
Set Shell zsh
|
||||
Set FontSize 12
|
||||
|
||||
Set Theme "Catppuccin Mocha"
|
||||
|
||||
Set Width 360
|
||||
Set Height 260
|
||||
Set Padding 20
|
||||
|
||||
Type "nix fmt -- --no-cache"
|
||||
Sleep 1s
|
||||
Enter
|
||||
|
||||
Sleep 3s
|
||||
Enter
|
||||
Enter
|
||||
Sleep 1s
|
||||
|
||||
Type "nix fmt"
|
||||
Enter
|
||||
|
||||
Sleep 5s
|
||||
42
flake.lock
42
flake.lock
|
|
@ -8,11 +8,11 @@
|
|||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1705332421,
|
||||
"narHash": "sha256-USpGLPme1IuqG78JNqSaRabilwkCyHmVWY0M9vYyqEA=",
|
||||
"lastModified": 1713532798,
|
||||
"narHash": "sha256-wtBhsdMJA3Wa32Wtm1eeo84GejtI43pMrFrmwLXrsEc=",
|
||||
"owner": "numtide",
|
||||
"repo": "devshell",
|
||||
"rev": "83cb93d6d063ad290beee669f4badf9914cc16ec",
|
||||
"rev": "12e914740a25ea1891ec619bb53cf5e6ca922e40",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
@ -26,11 +26,11 @@
|
|||
"nixpkgs-lib": "nixpkgs-lib"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1706830856,
|
||||
"narHash": "sha256-a0NYyp+h9hlb7ddVz4LUn1vT/PLwqfrWYcHMvFB1xYg=",
|
||||
"lastModified": 1712014858,
|
||||
"narHash": "sha256-sB4SWl2lX95bExY2gMFG5HIzvva5AVMJd4Igm+GpZNw=",
|
||||
"owner": "hercules-ci",
|
||||
"repo": "flake-parts",
|
||||
"rev": "b253292d9c0a5ead9bc98c4e9a26c6312e27d69f",
|
||||
"rev": "9126214d0a59633752a136528f5f3b9aa8565b7d",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
@ -41,11 +41,11 @@
|
|||
},
|
||||
"flake-root": {
|
||||
"locked": {
|
||||
"lastModified": 1692742795,
|
||||
"narHash": "sha256-f+Y0YhVCIJ06LemO+3Xx00lIcqQxSKJHXT/yk1RTKxw=",
|
||||
"lastModified": 1713493429,
|
||||
"narHash": "sha256-ztz8JQkI08tjKnsTpfLqzWoKFQF4JGu2LRz8bkdnYUk=",
|
||||
"owner": "srid",
|
||||
"repo": "flake-root",
|
||||
"rev": "d9a70d9c7a5fd7f3258ccf48da9335e9b47c3937",
|
||||
"rev": "bc748b93b86ee76e2032eecda33440ceb2532fcd",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
@ -98,11 +98,11 @@
|
|||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1705314449,
|
||||
"narHash": "sha256-yfQQ67dLejP0FLK76LKHbkzcQqNIrux6MFe32MMFGNQ=",
|
||||
"lastModified": 1710154385,
|
||||
"narHash": "sha256-4c3zQ2YY4BZOufaBJB4v9VBBeN2dH7iVdoJw8SDNCfI=",
|
||||
"owner": "nix-community",
|
||||
"repo": "gomod2nix",
|
||||
"rev": "30e3c3a9ec4ac8453282ca7f67fca9e1da12c3e6",
|
||||
"rev": "872b63ddd28f318489c929d25f1f0a3c6039c971",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
@ -113,11 +113,11 @@
|
|||
},
|
||||
"nix-filter": {
|
||||
"locked": {
|
||||
"lastModified": 1705332318,
|
||||
"narHash": "sha256-kcw1yFeJe9N4PjQji9ZeX47jg0p9A0DuU4djKvg1a7I=",
|
||||
"lastModified": 1710156097,
|
||||
"narHash": "sha256-1Wvk8UP7PXdf8bCCaEoMnOT1qe5/Duqgj+rL8sRQsSM=",
|
||||
"owner": "numtide",
|
||||
"repo": "nix-filter",
|
||||
"rev": "3449dc925982ad46246cfc36469baf66e1b64f17",
|
||||
"rev": "3342559a24e85fc164b295c3444e8a139924675b",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
@ -128,11 +128,11 @@
|
|||
},
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1707689078,
|
||||
"narHash": "sha256-UUGmRa84ZJHpGZ1WZEBEUOzaPOWG8LZ0yPg1pdDF/yM=",
|
||||
"lastModified": 1714253743,
|
||||
"narHash": "sha256-mdTQw2XlariysyScCv2tTE45QSU9v/ezLcHJ22f0Nxc=",
|
||||
"owner": "nixos",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "f9d39fb9aff0efee4a3d5f4a6d7c17701d38a1d8",
|
||||
"rev": "58a1abdbae3217ca6b702f03d3b35125d88a2994",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
@ -145,11 +145,11 @@
|
|||
"nixpkgs-lib": {
|
||||
"locked": {
|
||||
"dir": "lib",
|
||||
"lastModified": 1706550542,
|
||||
"narHash": "sha256-UcsnCG6wx++23yeER4Hg18CXWbgNpqNXcHIo5/1Y+hc=",
|
||||
"lastModified": 1711703276,
|
||||
"narHash": "sha256-iMUFArF0WCatKK6RzfUJknjem0H9m4KgorO/p3Dopkk=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "97b17f32362e475016f942bbdfda4a4a72a8a652",
|
||||
"rev": "d8fe5e6c92d0d190646fb9f1056741a229980089",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
inputs.flake-root.flakeModule
|
||||
./checks.nix
|
||||
./devshell.nix
|
||||
./docs.nix
|
||||
./nixpkgs.nix
|
||||
./packages.nix
|
||||
./treefmt.nix
|
||||
|
|
|
|||
72
nix/docs.nix
Normal file
72
nix/docs.nix
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
_: {
|
||||
perSystem = {
|
||||
pkgs,
|
||||
self',
|
||||
...
|
||||
}: {
|
||||
packages.docs = pkgs.buildNpmPackage {
|
||||
pname = "treefmt-docs";
|
||||
inherit (self'.packages.default) version;
|
||||
|
||||
src = ../docs;
|
||||
npmDepsHash = "sha256-J9qTWueOcSBq7qRec6YdTuWI2VlVQ0q6AynDLovf6s0=";
|
||||
|
||||
# we have to use a custom build phase because vitepress is doing something funky with the ttty
|
||||
buildPhase = ''
|
||||
cat | npm run build 2>&1 | cat
|
||||
'';
|
||||
|
||||
installPhase = ''
|
||||
runHook preInstall
|
||||
cp -rv .vitepress/dist/ $out
|
||||
runHook postInstall
|
||||
'';
|
||||
};
|
||||
|
||||
devshells.default = {
|
||||
packages = [
|
||||
pkgs.nodejs
|
||||
];
|
||||
|
||||
commands = let
|
||||
category = "docs";
|
||||
in [
|
||||
{
|
||||
inherit category;
|
||||
name = "docs:dev";
|
||||
help = "serve docs for local development";
|
||||
command = "cd $PRJ_ROOT/docs && npm run dev";
|
||||
}
|
||||
{
|
||||
inherit category;
|
||||
name = "docs:build";
|
||||
help = "create a production build of docs";
|
||||
command = "cd $PRJ_ROOT/docs && npm run build";
|
||||
}
|
||||
{
|
||||
inherit category;
|
||||
name = "docs:preview";
|
||||
help = "preview a production build of docs";
|
||||
command = "cd $PRJ_ROOT/docs && npm run preview";
|
||||
}
|
||||
{
|
||||
inherit category;
|
||||
package = pkgs.vhs;
|
||||
help = "generate terminal gifs";
|
||||
}
|
||||
{
|
||||
category = "docs";
|
||||
help = "regenerate gifs for docs";
|
||||
name = "gifs";
|
||||
command = ''
|
||||
set -xeuo pipefail
|
||||
|
||||
for tape in $PRJ_ROOT/docs/vhs/*; do
|
||||
vhs $tape -o "$PRJ_ROOT/docs/public/$(basename $tape .tape).gif"
|
||||
done
|
||||
'';
|
||||
}
|
||||
];
|
||||
};
|
||||
};
|
||||
}
|
||||
|
|
@ -25,6 +25,7 @@
|
|||
root = ../.;
|
||||
exclude = [
|
||||
"nix"
|
||||
"docs"
|
||||
];
|
||||
};
|
||||
|
||||
|
|
|
|||
65
stats/stats.go
Normal file
65
stats/stats.go
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
package stats
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
)
|
||||
|
||||
type Type int
|
||||
|
||||
const (
|
||||
Traversed Type = iota
|
||||
Emitted
|
||||
Matched
|
||||
Formatted
|
||||
)
|
||||
|
||||
var (
|
||||
counters map[Type]*atomic.Int32
|
||||
start time.Time
|
||||
)
|
||||
|
||||
func Init() {
|
||||
// record start time
|
||||
start = time.Now()
|
||||
|
||||
// init counters
|
||||
counters = make(map[Type]*atomic.Int32)
|
||||
counters[Traversed] = &atomic.Int32{}
|
||||
counters[Emitted] = &atomic.Int32{}
|
||||
counters[Matched] = &atomic.Int32{}
|
||||
counters[Formatted] = &atomic.Int32{}
|
||||
}
|
||||
|
||||
func Add(t Type, delta int32) int32 {
|
||||
return counters[t].Add(delta)
|
||||
}
|
||||
|
||||
func Value(t Type) int32 {
|
||||
return counters[t].Load()
|
||||
}
|
||||
|
||||
func Elapsed() time.Duration {
|
||||
return time.Now().Sub(start)
|
||||
}
|
||||
|
||||
func Print() {
|
||||
components := []string{
|
||||
"traversed %d files",
|
||||
"emitted %d files for processing",
|
||||
"matched %d files to formatters",
|
||||
"formatted %d files in %v",
|
||||
"",
|
||||
}
|
||||
|
||||
fmt.Printf(
|
||||
strings.Join(components, "\n"),
|
||||
Value(Traversed),
|
||||
Value(Emitted),
|
||||
Value(Matched),
|
||||
Value(Formatted),
|
||||
Elapsed(),
|
||||
)
|
||||
}
|
||||
Reference in New Issue
Block a user