Skip to content
This repository was archived by the owner on Dec 9, 2024. It is now read-only.

Commit 7ad8ba7

Browse files
committed
feat: modify local development under the hood docs
to reflect the `tsx` refactoring
1 parent b442154 commit 7ad8ba7

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

docs/src/content/docs/core-concepts/local-development.mdx

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,14 @@ There are a couple of controls you can use during live local development.
108108
## How it works under the hood
109109

110110
- The CLI...
111-
1. creates a directory in your system's temp folder
112-
2. copies your project files to the temp folder
113-
3. watches for any changes in your project and copies the changes to the temp folder
114-
4. starts the TypeScript compiler in watch mode to compile the project to JS
115-
5. dynamically imports the CDK project file and searches for an exported variable which is of the type `cdk.App`
116-
6. searches the stacks to find Buttonize CDK resources
117-
7. extracts the Buttonize resources
118-
8. tries to fetch the stack metadata and resources from AWS, if the stack has been deployed
119-
9. puts everything together and waits for the local connection from [app.buttonize.io/live](https://app.buttonize.io/live)
111+
112+
1. uses [`tsx`](https://github.com/privatenumber/tsx?tab=readme-ov-file#nodejs-loader) ESM [module loader](https://nodejs.org/api/module.html#customization-hooks) to dynamically import your TypeScript CDK code
113+
2. watches for any changes in `.ts, .tsx, .json` files in your project
114+
3. searches in the `<entrypoint>` file for an exported variable of the type `cdk.App`
115+
4. extracts the Buttonize resources from stacks in the `cdk.App`
116+
5. tries to fetch the stack metadata and resources from AWS, if the stack has been deployed
117+
6. puts everything together and waits for the local connection from [app.buttonize.io/live](https://app.buttonize.io/live)
118+
120119
- Buttonize Live Local Development UI...
121120
1. tries to connect to the local dev server
122121
2. pulls the data and watches for any changes

0 commit comments

Comments
 (0)