cletter 0.1.0

Locale-correct business correspondence: composes cgreet, cfarewell and cink with locale tables for opening, subject, resolution and orthography
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

# cletter

Locale-correct business correspondence, composed from focused units. No
models, no I/O: same input always yields the same output.

`cletter` is the front door: it re-exports [`cgreet`](https://github.com/corbet-labs/cgreet)
(salutations), [`cfarewell`](https://github.com/corbet-labs/cfarewell)
(valedictions) and [`cink`](https://github.com/corbet-labs/cink) (signature
images), and adds what only makes sense together — locale resolution,
openings, subjects, orthography, and advisories:

```rust
use cletter::{closing, opening, resolve_locale, salutation, subject};

assert_eq!(resolve_locale(Some("de"), Some("Zürich, Zug")), "de-CH");
assert_eq!(
    salutation("de-CH", "Frau Dr. Müller"),
    "Sehr geehrte Frau Dr. Müller",
);
assert_eq!(closing("de-CH", None), "Freundliche Grüsse");
assert_eq!(opening("en-US", Some("Jane Doe"), None), "Dear Jane Doe,");
assert_eq!(
    subject("de-CH", Some("Leiterin Kommunikation"), None),
    "Bewerbung als Leiterin Kommunikation",
);
```

One locale per document (BCP 47). Unknown locales fall back through the
base language to English. Explicit overrides always win — user choice is
never degraded, the tables only supply defaults.

## Use

Rust:

```toml
[dependencies]
cletter = "0.1"
```

TypeScript (zero dependencies, runs in browsers, edge runtimes, and Node):

```sh
npm install @corbet-labs/cletter
```

Run `cargo test`, `cargo fmt --check`, and
`cargo clippy --all-targets -- -D warnings` before pushing.

## Contract for ports

Behavior is defined by data: `tables/locales.json` (openings, subjects,
orthography, region mapping) and `tables/countries.json` (location to
country resolution), documented in `tables/README.md`.
`tests/vectors/*.json` is the executable conformance suite every language
port runs. The Typst module in `typst/` derives from the same tables. A
port is done when every vector passes.

## License

FSL-1.1-ALv2; see `LICENSES/FSL-1.1-ALv2.txt`. Each published version
becomes available under Apache-2.0 two years after publication.