es-fluent-cli 0.4.0

CLI for es-fluent FTL file generation
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

# es-fluent-cli

A command-line tool for managing Fluent translations in `es-fluent` projects.

## Installation

```sh
cargo install es-fluent-cli
```

## Usage

Run the tool from your project root or a sub-crate.

### Commands

#### `generate`

Scans your Rust source code for `#[derive(EsFluent)]` and related macros, and updates or creates your FTL files.

```sh
es-fluent generate
```

- **Default Behavior**: Adds new keys and updates existing ones. Preserves existing translations.
- **Options**:
  - `--mode aggressive`: Completely overwrites the file (WARNING: this deletes custom translations).

#### `watch`

Watches your `src/` directory for changes and automatically runs the generator. This is ideal for development.

```sh
es-fluent watch
```

#### `clean`

Removes orphan keys and groups—translations that are defined in your FTL file but no longer found in your Rust code.

```sh
es-fluent clean
```

> **Note**: This will remove comments associated with orphan keys, and even entire groups if they become empty.

## Configuration

The CLI relies on an `i18n.toml` file in your crate root:

```toml
assets_dir = "i18n"         # Directory for FTL files
fallback_language = "en"    # Default language
```