rust-workspaced 0.0.0

Generate .gitignore files from a declarative TOML specification.
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

<!--
SPDX-FileCopyrightText: Elio Severo Junior <elioseverojunior@gmail.com>

SPDX-License-Identifier: MIT OR Apache-2.0
-->

# rust-workspaced

[![crates.io](https://img.shields.io/crates/v/rust-workspaced.svg)](https://crates.io/crates/rust-workspaced)
[![docs.rs](https://docs.rs/rust-workspaced/badge.svg)](https://docs.rs/rust-workspaced)
[![license: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](#licence)

Generate `.gitignore` files from a declarative TOML specification.

## Status

**This crate is a name reservation.** Version `0.0.0` claims the name on
crates.io; it contains no working API and nothing useful to depend on yet.

Please do not add it as a dependency. The version will move off `0.0.0` when
there is something real to ship, and this README will say so.

## Why

A `.gitignore` is an append-only pile of patterns. Entries accumulate, nobody
remembers which tool needed `**/.cargo-vet` or whether `/target` is still load
bearing, and the same block gets copy-pasted between repositories where it
slowly drifts out of sync.

`rust-workspaced` treats the file as generated output. Patterns live in TOML with the
reasoning attached, grouped into named sections, and the `.gitignore` is
rendered from that — so the source of truth is reviewable and the output is
reproducible.

## How it works

Describe the sections and rules in `rust-workspaced.toml`:

```toml
version = 1

[[gitignore.section]]
level = 3
name = "Rust"
note = "Cargo Ignores"

[[gitignore.section.rule]]
ignore = ["/target"]

[[gitignore.section.rule]]
note = "Cargo Package"
ignore = ["**/dist"]

[[gitignore.section.rule]]
note = "Cargo Vet"
ignore = ["**/.cargo-vet"]
```

Which renders to `.gitignore`:

```gitignore
### Rust
# Cargo Ignores
/target

# Cargo Package
**/dist

# Cargo Vet
**/.cargo-vet
```

A section's `name` becomes a heading at the given `level`, each `note` becomes
the comment introducing its rule, and `ignore` carries the patterns themselves.
Every entry keeps the note explaining why it is there.

## Licence

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
  <https://www.apache.org/licenses/LICENSE-2.0>)
- MIT License ([LICENSE-MIT](LICENSE-MIT) or
  <https://opensource.org/licenses/MIT>)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 licence, shall be
dual licensed as above, without any additional terms or conditions.