Skip to content

Commit 4f8f238

Browse files
committed
Review
1 parent 8a2687f commit 4f8f238

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

  • content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/get-started.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -129,33 +129,33 @@ In the source code, you should see the following:
129129

130130
When you install the extension, you see a new menu item in Studio Pro.
131131

132-
### Understanding the Generated Files
132+
### Understanding Generated Files
133133

134-
The generator creates a project with the following structure. Some files are boilerplate that you can leave untouched, while others must be updated with your changes before you can build or debug.
134+
The generator creates a project with the following structure. Some files are standardized and can be left untouched, while others must be updated before you build or debug.
135135

136-
#### Configuration files
136+
#### Configuration Files
137137

138-
* **`package.json`** Project dependencies and scripts. Use `npm run build` to build once, or `npm run build:dev` to build and watch for changes. Only edit this if you need to add packages.
139-
* **`tsconfig.json`** TypeScript compiler settings.
140-
* **`build.helpers.mjs`** Shared esbuild utilities used by `build-extension.mjs`. You do not need to edit this file.
138+
* **`package.json`** Defines project dependencies and scripts. Use `npm run build` to build once, or `npm run build:dev` to build and watch for changes. Edit this file only when you need to add packages.
139+
* **`tsconfig.json`** Contains TypeScript compiler settings.
140+
* **`build.helpers.mjs`** Provides shared esbuild utilities used by `build-extension.mjs`. You do not need to edit this file.
141141

142-
#### Build and deployment
142+
#### Build and Deployment
143143

144-
* **`build-extension.mjs`** The build entry point that wires everything together using esbuild. It defines the output directory (`outDir`), the source entry points (`src/main/index.ts``main`, `src/ui/index.tsx``tab`), and supports a `--watch` flag for live rebuilding. Set `appDir` to the absolute path of your Mendix app folder so the built extension is copied there automatically after each build. All the paths can be given while setting the template through the questions on your terminal. If you update the name of an entrypoint or add a new one you should also update it in this file.
144+
* **`build-extension.mjs`** The build entry point that wires everything together using esbuild. It defines the output directory (`outDir`), the source entry points (`src/main/index.ts``main`, `src/ui/index.tsx``tab`), and supports a `--watch` flag for live rebuilding. Set `appDir` to the absolute path of your Mendix app folder so the built extension is automatically copied there after each build. You can provide all paths while setting up the template through the terminal prompts. If you update an entry point name or add a new one, update it in this file as well.
145145

146146
{{% alert color="info" %}}
147-
The `dist/` folder is generated by `npm run build` and is not present until you build for the first time. Never edit files inside `dist/` directly, as your changes will be overwritten on the next build.
147+
The `dist/` folder is generated by `npm run build` and does not exist until you build for the first time. Never edit files inside `dist/` directly, as your changes will be overwritten on the next build.
148148
{{% /alert %}}
149149

150-
#### Source files
150+
#### Source Files
151151

152-
* **`src/manifest.json`** Tells Studio Pro how to load your extension: which compiled JS files are the entry points (`main.js`, `tab.js`) and what permissions the extension requires. Update this file if you rename your entry point files. If you add an entry point or update its name here, you should also update it in the `build-extension.mjs`.
153-
* **`src/main/index.ts`** The extension's main logic, which runs inside Studio Pro. Gets the Studio Pro API via `getStudioProApi`, registers a menu item under **Extensions** in the top menu bar, and opens a tab that renders the UI component when clicked. This is the primary file you will edit. If you rename this file, update the corresponding entry point in `build-extension.mjs`.
154-
* **`src/ui/index.tsx`** The React component rendered inside the Studio Pro tab. In the template it renders a simple heading and paragraph adn you should replace it with your own UI. If you rename this file, update two places: the entry point in `build-extension.mjs`, and the `uiEntrypoint` value passed to `studioPro.ui.tabs.open(...)` in `src/main/index.ts`. You can delete this file entirely if you also remove both of those references.
152+
* **`src/manifest.json`** Tells Studio Pro how to load your extension, including which compiled JS files serve as entry points (`main.js`, `tab.js`) and what permissions the extension requires. Update this file if you rename your entry point files. If you add or rename an entry point here, also update it in `build-extension.mjs`.
153+
* **`src/main/index.ts`** Contains the extension's main logic, which runs inside Studio Pro. It retrieves the Studio Pro API via `getStudioProApi`, registers a menu item under **Extensions** in the top menu bar, and opens a tab that renders the UI component when clicked. This is the primary file you will edit. If you rename this file, update the corresponding entry point in `build-extension.mjs`.
154+
* **`src/ui/index.tsx`** The React component rendered inside the Studio Pro tab. In the template, it renders a simple heading and paragraph that you should replace with your own UI. If you rename this file, update the entry point in `build-extension.mjs` and the `uiEntrypoint` value passed to `studioPro.ui.tabs.open(...)` in `src/main/index.ts`. You can delete this file entirely if you also remove both of those references.
155155

156-
#### Other files
156+
#### Other Files
157157

158-
* **`.gitignore`** Excludes `node_modules/` and the compiled `dist/` output from source control. Leave as-is, or extend it if you have local configuration files that should not be committed.
158+
* **`.gitignore`** Excludes `node_modules/` and the compiled `dist/` output from source control. Leave as is, or extend it if you have local configuration files that should not be committed.
159159

160160
### Building, Installing, and Debugging the Extension
161161

0 commit comments

Comments
 (0)