sf-afmt 0.7.0

An Salesforce Apex lang formatter
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

# Technical Parts

## Parser

[Tree-sitter apex parser](https://github.com/aheber/tree-sitter-sfapex) is depended.

### Update parser version

Check `dep/update_parser_version.sh`. Steps can be also done manually as:

1. have `tree-sitter` and `node-js` installed locally
2. Download the parser repo to `dep/` folder, go to its path
3. Run `tree-sitter gen ./apex/grammar.js` to generate `./src`
4. Copy `parser.c` and `tree-sitter` sub folder into `/dep` to replace
5. Remove the parser repo downloaded in #2

## Test

Afmt is heavily guarded by test scripts in `tests` folder

### Assert testing

`cargo test --test test --  --show-output`

### Battle testing

Download the lists of Apex repo and format them.

`sh tests/battle_test/download.sh`
`sh tests/battle_test/format.sh`

# Extra Info (might outdated)

## 📦 Installation

### Prerequisites

- [Rust](https://www.rust-lang.org/tools/install) must be installed.

### Steps

1. Clone the repository:
   ```bash
   git clone https://github.com/xixiaofinland/afmt.git
   cd afmt
   ```

2. Build the project:
   ```bash
   cargo build --release
   ```

## 🚀 Running the Formatter

### Get help:
```bash
./target/release/afmt --help
```

### Format a file:
```bash
./target/release/afmt --file path/to/your_apex_file.cls
```

### Run with enabled backtrace:
```bash
RUST_BACKTRACE=1 ./target/release/afmt --file path/to/your_apex_file.cls
```
<br>