From 1bd58533106da9e07d01547ca9f5c2023f80c3f5 Mon Sep 17 00:00:00 2001
From: overlookmotel <theoverlookmotel@gmail.com>
Date: Mon, 19 Aug 2024 22:43:47 +0200
Subject: [PATCH] docs(transformer): updated README re: order of methods
 (#4993)

Add to `oxc_transformer` README note about order methods laid out in
files.

The idea is that you can read code for a transformer from top to bottom,
and the logic flows in this direction.
---
 crates/oxc_transformer/README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/crates/oxc_transformer/README.md b/crates/oxc_transformer/README.md
index 183f95b22..eb51c0717 100644
--- a/crates/oxc_transformer/README.md
+++ b/crates/oxc_transformer/README.md
@@ -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 {