Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(transformer): updated README re: order of methods #4993

Merged
merged 1 commit into from
Aug 19, 2024
Merged

docs(transformer): updated README re: order of methods #4993

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions crates/oxc_transformer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,26 @@ comment, so we can return to it later.
* Entry points of transform should be implemented as `impl Traverse for MyTransform`.
* Those methods have to be called `enter_*` and `exit_*`.
* Parent transform will only interface with child transform via these entry points.
* Those entry points go at top of the file.
* Only other method exposed externally should be `new`. That should be at top of the file.
* Entry points go directly below `new` method definition.
* Internal methods implemented lower down in an `impl MyTransform` block.
* Internal methods named descriptively - `add_id_to_function` not `transform_function`.

i.e. File is laid out so logic flows from top of file to bottom.

e.g.:

```rs
struct FunctionRenamer;
struct FunctionRenamer {
prefix: String,
}

// Initialization
impl FunctionRenamer {
pub fn new(prefix: String) -> Self {
Self { prefix }
}
}

// Entry points
impl<'a> Traverse<'a> for FunctionRenamer {
Expand Down