swc-project/swc
1
1
Fork 0
mirror of https://github.com/swc-project/swc.git synced 2024-12-26 23:27:56 +03:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

doc(es/minifier): Add contributing section

Browse Source
This commit is contained in:
강동윤 (Donny) 2024-07-13 17:05:24 +09:00
parent bb196044ee
commit e22f3ba9ad
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
crates/swc_ecma_minifier/README.md
View File

@ -18,3 +18,19 @@ From mac os x, run
``` ```
./scripts/instrument/all.sh path/to/input/dir ./scripts/instrument/all.sh path/to/input/dir
``` ```
# Contributing
## Testing
Please prefer execution tests over unit tests. Execution tests are more useful because there's no chance of human error while reviewing.
### Execution tests
You can add a test to [`./tests/exec.rs`](https://github.com/swc-project/swc/blob/main/crates/swc_ecma_minifier/tests/exec.rs)
You can run `./scripts/exec.sh` from `./crates/swc_ecma_minifier` to run execution tests of SWC minifier. `exec.sh` runs the cargo test with `--features debug`, and it makes the cargo test print lots of debug logging. You can search for `"change"`, and you can know the code responsible the optimization. The minifier has `report_change!` macro, and it prints the location of the relevant code.
### Fixture tests
You can add a test to [`./tests/fixture`](https://github.com/swc-project/swc/blob/main/crates/swc_ecma_minifier/tests/fixture/). You can select any directory, but please prefer to use the `issues` directory. You can run `./scripts/test.sh` from `./crates/swc_ecma_minifier` to run fixture tests. You can run it like `./scripts/test.sh foo` to run test cases only with `foo` in the file path. If you want to get location of change, you can do `./scripts/test.sh foo --features debug`.