yact 2.6.1

Yet Another Commit Transformer: a tool for formatting staged files with minimal disturbance to developer workflow.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

# Configuration file

The configuration file consists an optional version requirement on yact itself
followed by formatting configuration items.

An example version requirement can be found below:

```toml
requires_yact_version = ">=2.0.0, <3.0.0"
```

Each item specifies a glob specifying what files to format and a set of
transformers to apply to them:

```toml
[[items]]
glob = "**/*example/*glob*.extension"
transformers = []
```

## Builtin transformers

### Trailing whitespace trimmer

```toml
transformers = [{ Builtin = "TrailingWhitespace" }]
```

## External transformers

If specific configuration is desired, configure with a `.rustfmt.toml` file.
More than likely the edition at least will need to be configured in this way.

### Rustfmt

```toml
transformers = [{ External = "Rustfmt" }]
```

### Gofmt

```toml
transformers = [{ External = "Gofmt" }]
```

### Clang format

If specific configuration is desired, configure with a `.clang-format` file.

```toml
transformers = [{ External = "ClangFormat" }]
```

### Deno fmt

```toml
transformers = [{ External = "DenoFmt" }]
```

### Prettier

```toml
transformers = [{ External = { Prettier = { package_json_directory = "web/projects/example/", package_manager_type = "Bun" }}}]
```

| Key                    | Required / Optional | Description                                                                                                                 |
| ---------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| package_json_directory | optional            | Directory containing package.json, if different from repository root                                                        |
| package_manager_type   | optional            | Package manager to use to run workspace version of `prettier`; if not provided, searches for `prettier` on the system path. |

### Ruff lint

Configurable Ruff linter autofixes.

```toml
transformers = [{ External = { RuffLint = { behavior = "", venv_path = ".venv", unsafe_fixes = true }}}]
```

| Key          | Required / Optional | Description                                                                                                                          |
| ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| behavior     | required            | "CheckOnly", "CheckAndFix", or "FixOnly"                                                                                             |
| venv_path    | optional            | Directory of virtual environment to use to run workspace version of `ruff`; if not provided, searches for `ruff` on the system path. |
| unsafe_fixes | optional            | Use `ruff`'s unsafe fixes option. Defaults to false                                                                                  |

### Ruff format

The configuration for `ruff` allows specifying a `venv_path` which allows
running the virtual environment's installed version of `ruff`.

```toml
transformers = [{ External = { RuffFormat = { venv_path = ".venv" }}}]
```

| Key       | Required / Optional | Description                                                                                                                          |
| --------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| venv_path | optional            | Directory of virtual environment to use to run workspace version of `ruff`; if not provided, searches for `ruff` on the system path. |

### System formatter

A generic transformer that can be used to configure any formatter not already
supported.

```toml
transformers = [{ External = { System = { command = "bash", env = {}, args = ["-c", "csharpier format"] }}}]
```

| Key     | Required / Optional | Description                                   |
| ------- | ------------------- | --------------------------------------------- |
| command | required            | Command to run                                |
| env     | required            | Environment variables to run the command with |
| args    | required            | Command line arguments for the command        |