@windypro-rourou/dsh-eda 0.1.4 → 0.1.6

package/skill/guide/i18n.md

@@ -1,57 +1,57 @@
-# Multi-language Support
-
-## Multi-language Configuration
-
-The extension supports multi-language configuration, you can create a `<IANA Language Tags>.json` file in the `./locales/` folder, you can create a `<IANA language tag>.json` file, which will be automatically associated with the corresponding language and called when appropriate.
-
-::: code-group
-
-```json [zh-Hans.json]
-{
-	"Enter": "确定",
-	"Cancel": "取消"
-}
-```
-
-```json [en.json]
-{
-	"Enter": "Enter",
-	"Cancel": "Cancel"
-}
-```
-
-:::
-
-If you need to get all the language labels supported by the current extension, you can call the [SYS_I18n.getAllSupportedLanguages()](../reference/pro-api.sys_i18n.getallsupportedlanguages) method, which will return an array of strings.
-
-::: warning
-
-Note that if your extension has two or more languages, it must include at least one of `en` or `zh-Hans` as a fallback language, otherwise you may encounter unexpected display errors.
-
-:::
-
-## Use of Multiple Languages within the Code
-
-To use a multilingual system to display different text in different language environments, use the [SYS_I18n.text()](../reference/pro-api.sys_i18n.text) method.
-
-[SYS_I18n.text()](../reference/pro-api.sys_i18n.text) method has a mandatory argument `tag`, which corresponds to the key name in the multilingual file, and the key value matched by that key name is the final displayed text.
-
-You can specify the `namespace` parameter as the `uuid` of other extensions to call the multilingual configuration of other extensions.
-
-Currently, EasyEDA Professional only supports a few languages by default, while the extension API supports a lot of additional languages, you can use the `language` parameter to adapt more languages for your extension, but you need to design your own logic and method to switch languages.
-
-When translating a language, it is very likely that we will encounter a situation where we need to embed parameters into the text, because the syntax of each language is different and the position of the parameters in the text of the language may vary greatly, you can use a placeholder in the `${1}` format to indicate the parameters that need to be embedded and pass the parameters into the `arg` of the [SYS_I18n.text()](../reference/pro-api.sys_i18n.text) method within `arg`, so that when the specified text is displayed, the corresponding argument will be embedded in the text at the specified location.
-
-::: tip
-
-Language priority: current display language > system default language > the first language in the dataset that contains the text tag > text label (tag)
-
-In addition to the above steps, you may need to know other [SYS_I18n](../reference/pro-api.sys_i18n) APIs to work more freely with multilingual content.
-
-:::
-
-## Translating Fields in extension.json
-
-If you need to translate fields in `extension.json`, create a `<IANA language tag>.json` file in the `./locales/extensionJson/` folder.
-
-Within that file, each `key` must be a `value` from `extension.json`, and each `value` in the translation file is the translated result.
+# Multi-language Support
+
+## Multi-language Configuration
+
+The extension supports multi-language configuration, you can create a `<IANA Language Tags>.json` file in the `./locales/` folder, you can create a `<IANA language tag>.json` file, which will be automatically associated with the corresponding language and called when appropriate.
+
+::: code-group
+
+```json [zh-Hans.json]
+{
+	"Enter": "确定",
+	"Cancel": "取消"
+}
+```
+
+```json [en.json]
+{
+	"Enter": "Enter",
+	"Cancel": "Cancel"
+}
+```
+
+:::
+
+If you need to get all the language labels supported by the current extension, you can call the [SYS_I18n.getAllSupportedLanguages()](../reference/pro-api.sys_i18n.getallsupportedlanguages) method, which will return an array of strings.
+
+::: warning
+
+Note that if your extension has two or more languages, it must include at least one of `en` or `zh-Hans` as a fallback language, otherwise you may encounter unexpected display errors.
+
+:::
+
+## Use of Multiple Languages within the Code
+
+To use a multilingual system to display different text in different language environments, use the [SYS_I18n.text()](../reference/pro-api.sys_i18n.text) method.
+
+[SYS_I18n.text()](../reference/pro-api.sys_i18n.text) method has a mandatory argument `tag`, which corresponds to the key name in the multilingual file, and the key value matched by that key name is the final displayed text.
+
+You can specify the `namespace` parameter as the `uuid` of other extensions to call the multilingual configuration of other extensions.
+
+Currently, EasyEDA Professional only supports a few languages by default, while the extension API supports a lot of additional languages, you can use the `language` parameter to adapt more languages for your extension, but you need to design your own logic and method to switch languages.
+
+When translating a language, it is very likely that we will encounter a situation where we need to embed parameters into the text, because the syntax of each language is different and the position of the parameters in the text of the language may vary greatly, you can use a placeholder in the `${1}` format to indicate the parameters that need to be embedded and pass the parameters into the `arg` of the [SYS_I18n.text()](../reference/pro-api.sys_i18n.text) method within `arg`, so that when the specified text is displayed, the corresponding argument will be embedded in the text at the specified location.
+
+::: tip
+
+Language priority: current display language > system default language > the first language in the dataset that contains the text tag > text label (tag)
+
+In addition to the above steps, you may need to know other [SYS_I18n](../reference/pro-api.sys_i18n) APIs to work more freely with multilingual content.
+
+:::
+
+## Translating Fields in extension.json
+
+If you need to translate fields in `extension.json`, create a `<IANA language tag>.json` file in the `./locales/extensionJson/` folder.
+
+Within that file, each `key` must be a `value` from `extension.json`, and each `value` in the translation file is the translated result.

package/skill/guide/index.md

@@ -1,7 +1,7 @@
-# What is Extension API?
-
-EasyEDA Professional Extension API (hereinafter referred to as "Extension API") is a set of JS API interfaces built on the front-end, which is used to develop various custom functions of EasyEDA Professional Editor. In short, the Extension API uses the basic syntax of JavaScript to write source code that highly encapsulates many EasyEDA Pro features and algorithms, together with a comprehensive [SDK](./ancillary-projects/pro-api-sdk), [type constraints](./ancillary-projects/pro-api-types), the development of custom extensions can be completed with very little effort, effectively reducing the mental burden on developers and designers.
-
-Next, you can go to the [How to Get Started](./how-to-start) section to learn how to install the environment from scratch and build your own EasyEDA Pro Edition extension.
-
-If you are an extension user, see the [Getting and Using Extensions](../user-guide/using-extension) section.
+# What is Extension API?
+
+EasyEDA Professional Extension API (hereinafter referred to as "Extension API") is a set of JS API interfaces built on the front-end, which is used to develop various custom functions of EasyEDA Professional Editor. In short, the Extension API uses the basic syntax of JavaScript to write source code that highly encapsulates many EasyEDA Pro features and algorithms, together with a comprehensive [SDK](./ancillary-projects/easyeda-api-sdk), [type constraints](./ancillary-projects/pro-api-types), the development of custom extensions can be completed with very little effort, effectively reducing the mental burden on developers and designers.
+
+Next, you can go to the [How to Get Started](./how-to-start) section to learn how to install the environment from scratch and build your own EasyEDA Pro Edition extension.
+
+If you are an extension user, see the [Getting and Using Extensions](../user-guide/using-extension) section.

package/skill/guide/inline-frame.md

@@ -1,20 +1,20 @@
-# Inline Frame Support
-
-In some application scenarios where extensions want to have fully customized windows that are not limited to the popups and controls provided by EasyEDA, we provide a way to build windows using inline frames.
-
-To use inline frames, you need to save all files in the extension's `/iframe/` directory and use [SYS_IFrame.openIFrame()](../reference/pro-api.sys_iframe.openiframe) method to load the specified `html` file as the content of the inline frame.
-
-```typescript
-// This example loads the index.html file in the /iframe/ directory with a window of 500px in height and width
-eda.sys_IFrame.openIFrame('/iframe/index.html', 500, 500);
-```
-
-::: tip
-Files can be loaded and indexed without being stored in the `/iframe/` directory, but it is recommended that the `/iframe/` directory be used as the storage directory for inline frame files for a more intuitive organization of the files.
-
-The URI referred to by the `htmlFileName` parameter starts at the root path of the extension package, you can use `/` or start directly with the `iframe/` folder name.
-:::
-
-The extension API will automatically read the specified `html` file and other files associated with it, but will not continue to recursively parse it, due to the limitations of our secure resource access rules.
-
-To open multiple IFrame windows within a single extension, specify an ID for each IFrame.
+# Inline Frame Support
+
+In some application scenarios where extensions want to have fully customized windows that are not limited to the popups and controls provided by EasyEDA, we provide a way to build windows using inline frames.
+
+To use inline frames, you need to save all files in the extension's `/iframe/` directory and use [SYS_IFrame.openIFrame()](../reference/pro-api.sys_iframe.openiframe) method to load the specified `html` file as the content of the inline frame.
+
+```typescript
+// This example loads the index.html file in the /iframe/ directory with a window of 500px in height and width
+eda.sys_IFrame.openIFrame('/iframe/index.html', 500, 500);
+```
+
+::: tip
+Files can be loaded and indexed without being stored in the `/iframe/` directory, but it is recommended that the `/iframe/` directory be used as the storage directory for inline frame files for a more intuitive organization of the files.
+
+The URI referred to by the `htmlFileName` parameter starts at the root path of the extension package, you can use `/` or start directly with the `iframe/` folder name.
+:::
+
+The extension API will automatically read the specified `html` file and other files associated with it, but will not continue to recursively parse it, due to the limitations of our secure resource access rules.
+
+To open multiple IFrame windows within a single extension, specify an ID for each IFrame.

package/skill/guide/invoke-apis.md

@@ -1,81 +1,81 @@
-# Invoking the Extension API
-
-## Invoke Method
-
-There are many classes under the EasyEDA Pro Extension API module, all **Classes**, **Enumerations**, **Interfaces**, **Type Aliases** are registered under the `EDA` base class by default and have been instantiated as [eda](../reference/pro-api.eda) object exists in the root scope of every extension runtime, and you can access it directly through the `eda` object.
-
-All extension's runtime get a separate `eda` object, which is not shared with other extensions. You can output this object on the console in [Debug Mode](#entering-debug-mode) within an extension (or in [Standalone Script](#debugging-with-standalone-scripting)) using the following code:
-
-```javascript
-console.log('[DEBUG] eda:', eda);
-```
-
-Standard extension API calls require the splice **eda** + **class instance object name** + **method name / variable name**. The object names corresponding to classes instantiated in the system are in the form of the first three letters of the underscore in lowercase, for example:
-
-| Class Name       | Class Instance Object Name |
-| ---------------- | -------------------------- |
-| SYS_I18n         | sys_I18n                   |
-| SYS_ToastMessage | sys_ToastMessage           |
-
-The following example calls the `text` method under the `SYS_I18n` class and the `showMessage` method under the `SYS_ToastMessage` class:
-
-```typescript {2}
-// Note that the `sys` in `sys_I18n` is lowercase because we need to use the object name when calling the
-eda.sys_ToastMessage.showMessage(eda.sys_I18n.text('Done'), ESYS_ToastMessageType.INFO);
-
-const t = eda.sys_I18n.text; // Assign `eda.sys_I18n.text` method to `t`
-eda.sys_ToastMessage.showMessage(t('Done'), ESYS_ToastMessageType.INFO); // This will give you exactly the same result as line 2
-```
-
-## Commissioning Methods
-
-### Entering Debug Mode
-
-You can add the `cll=debug` parameter within the URL of the EasyEDA Pro editor to enter debug mode:
-
-```diff
-- https://pro.easyeda.com/editor
-+ https://pro.easyeda.com/editor?cll=debug
-```
-
-Then press <kbd>F12</kbd> three times in quick succession to open the developer tools. Switch to the Console tab to output debugging information.
-
-::: tip
-
-If you are using the desktop client, you can press <kbd>F12</kbd> three times in quick succession to open the developer tools, then enter the following in the console:
-
-```javascript
-window.location.href = 'https://client/editor?cll=debug';
-```
-
-Then you can enter debug mode.
-
-:::
-
-### Debugging with Standalone Scripting
-
-When using the extension API interface, you need to compile the changes first and upload the compiled result to EasyEDA before you can see the result. If you have some logic that you want to split out for debugging, you can try using the standalone script feature.
-
-::: details EasyEDA Pro V2
-
-Entry: **Top Menu** -\> **Settings** -\> **Extensions** -\> **Standalone Script**
-
-![Standalone Script Window](/storage/images/en/api/guide/invoke-apis/invoke-apis_20250322_142403.jpg)
-
-:::
-
-::: details EasyEDA Pro V3
-
-Entry: **Top Menu** -\> **Advanced** -\> **Run Script**
-
-![Run Script Window](/storage/images/cn/api/guide/invoke-apis/invoke-apis_20260312_101848.png)
-
-You can use Script Manager to save standalone scripts and run them quickly:
-
-![Script Manager Window](/storage/images/cn/api/guide/invoke-apis/invoke-apis_20260312_102007.png)
-
-:::
-
-Standalone scripts get a unique, throw-away `eda` object each time they run, so you don't have to worry about contaminating the runtime environment with the results of previous runs. Note, however, that some of the extension API interfaces, such as `SYS_IFrame`, cannot be called from within a standalone script because they use features from extension packages or external interactions.
-
-The standalone script's save feature stores data in the browser's [LocalStorage](https://developer.mozilla.org/docs/Web/API/Window/localStorage) or [IndexedDB](https://developer.mozilla.org/docs/Web/API/IndexedDB_API), which is generally sustainable locally, but please note that this is always insecure, so please backup your own standalone scripts.
+# Invoking the Extension API
+
+## Invoke Method
+
+There are many classes under the EasyEDA Pro Extension API module, all **Classes**, **Enumerations**, **Interfaces**, **Type Aliases** are registered under the `EDA` base class by default and have been instantiated as [eda](../reference/pro-api.eda) object exists in the root scope of every extension runtime, and you can access it directly through the `eda` object.
+
+All extension's runtime get a separate `eda` object, which is not shared with other extensions. You can output this object on the console in [Debug Mode](#entering-debug-mode) within an extension (or in [Standalone Script](#debugging-with-standalone-scripting)) using the following code:
+
+```javascript
+console.log('[DEBUG] eda:', eda);
+```
+
+Standard extension API calls require the splice **eda** + **class instance object name** + **method name / variable name**. The object names corresponding to classes instantiated in the system are in the form of the first three letters of the underscore in lowercase, for example:
+
+| Class Name       | Class Instance Object Name |
+| ---------------- | -------------------------- |
+| SYS_I18n         | sys_I18n                   |
+| SYS_ToastMessage | sys_ToastMessage           |
+
+The following example calls the `text` method under the `SYS_I18n` class and the `showMessage` method under the `SYS_ToastMessage` class:
+
+```typescript {2}
+// Note that the `sys` in `sys_I18n` is lowercase because we need to use the object name when calling the
+eda.sys_ToastMessage.showMessage(eda.sys_I18n.text('Done'), ESYS_ToastMessageType.INFO);
+
+const t = eda.sys_I18n.text; // Assign `eda.sys_I18n.text` method to `t`
+eda.sys_ToastMessage.showMessage(t('Done'), ESYS_ToastMessageType.INFO); // This will give you exactly the same result as line 2
+```
+
+## Commissioning Methods
+
+### Entering Debug Mode
+
+You can add the `cll=debug` parameter within the URL of the EasyEDA Pro editor to enter debug mode:
+
+```diff
+- https://pro.easyeda.com/editor
++ https://pro.easyeda.com/editor?cll=debug
+```
+
+Then press <kbd>F12</kbd> three times in quick succession to open the developer tools. Switch to the Console tab to output debugging information.
+
+::: tip
+
+If you are using the desktop client, you can press <kbd>F12</kbd> three times in quick succession to open the developer tools, then enter the following in the console:
+
+```javascript
+window.location.href = 'https://client/editor?cll=debug';
+```
+
+Then you can enter debug mode.
+
+:::
+
+### Debugging with Standalone Scripting
+
+When using the extension API interface, you need to compile the changes first and upload the compiled result to EasyEDA before you can see the result. If you have some logic that you want to split out for debugging, you can try using the standalone script feature.
+
+::: details EasyEDA Pro V2
+
+Entry: **Top Menu** -\> **Settings** -\> **Extensions** -\> **Standalone Script**
+
+![Standalone Script Window](/storage/images/en/api/guide/invoke-apis/invoke-apis_20250322_142403.jpg)
+
+:::
+
+::: details EasyEDA Pro V3
+
+Entry: **Top Menu** -\> **Advanced** -\> **Run Script**
+
+![Run Script Window](/storage/images/cn/api/guide/invoke-apis/invoke-apis_20260312_101848.png)
+
+You can use Script Manager to save standalone scripts and run them quickly:
+
+![Script Manager Window](/storage/images/cn/api/guide/invoke-apis/invoke-apis_20260312_102007.png)
+
+:::
+
+Standalone scripts get a unique, throw-away `eda` object each time they run, so you don't have to worry about contaminating the runtime environment with the results of previous runs. Note, however, that some of the extension API interfaces, such as `SYS_IFrame`, cannot be called from within a standalone script because they use features from extension packages or external interactions.
+
+The standalone script's save feature stores data in the browser's [LocalStorage](https://developer.mozilla.org/docs/Web/API/Window/localStorage) or [IndexedDB](https://developer.mozilla.org/docs/Web/API/IndexedDB_API), which is generally sustainable locally, but please note that this is always insecure, so please backup your own standalone scripts.

package/skill/guide/stability.md

@@ -1,37 +1,37 @@
-# Interface Stabilization
-
-Our priority in maintaining the extension API is efficient abstraction and interface stability. It's important for users that extensions don't fail to work on a regular basis, and this is especially true and important considering that EasyEDA is currently a rapidly evolving product.
-
-On the other hand, we also want to strike the right balance between delivering new features quickly and maintaining backward compatibility, and here's how we intend to do that.
-
-## API Version Control
-
-Changes to the extension API will be identified as `major.minor.patch`. `major` indicates a major version, `minor` indicates a minor version, and `patch` indicates a fix.
-
-### Major Version
-
-::: info
-The EasyEDA Professional Edition Extension API has its own release version number, which is not equivalent to the EasyEDA version number. In general, major updates to the Extension API will follow the major or minor releases of EasyEDA.
-:::
-
-Changes to existing APIs that will be made available as major releases may have a noticeable impact on extensions and require the authors of extensions that utilize those APIs to update their code.
-
-This includes changes to the API itself (e.g., removing deprecated methods) or changes to API behavior.
-
-Extensions are not automatically upgraded to these versions, and in order to keep existing extensions working, the EasyEDA Professional API development team is committed to extending the lifecycle of deprecated methods as long as possible.
-
-### Minor Version
-
-New API interfaces and bug fixes will be provided as minor releases, and these new APIs will automatically be available to extensions as soon as they are run in the latest version of EasyEDA.
-
-If there are bugs in the API, we may, at our discretion, release bug fixes as a minor update, depending on whether we feel that certain extensions may break as a result of fixing the bugs. While any change in API behavior could theoretically make extensions work improperly, it would incur a lot of unnecessary additional overhead for extension authors and us to treat every bug fix as a major change.
-
-### Patch
-
-We release a fix update when we fix an urgent new issue, make a minimal change to the API, or even just change the content of the documentation.
-
-We may change the API's TypeScript type definition in the form of a break in the fix update. In the TypeScript world, Type and Script are two different things. As such, changes to Type do not affect existing code or cause breaks in released extensions, and having types that accurately represent the latest state of the API is more important than having perfect backward compatibility because types are easy to update. Typically, type changes only involve renaming certain types.
-
-## APIs for the Development Phase
-
-Development-stage APIs are APIs that are only available when the extension is set to a development version, which allows extension developers to try out new APIs and provide feedback to the EasyEDA Professional Extension API development team on whether the APIs are meeting usage requirements and/or working in any unexpected ways. APIs in development will be prominently identified within the documentation.
+# Interface Stabilization
+
+Our priority in maintaining the extension API is efficient abstraction and interface stability. It's important for users that extensions don't fail to work on a regular basis, and this is especially true and important considering that EasyEDA is currently a rapidly evolving product.
+
+On the other hand, we also want to strike the right balance between delivering new features quickly and maintaining backward compatibility, and here's how we intend to do that.
+
+## API Version Control
+
+Changes to the extension API will be identified as `major.minor.patch`. `major` indicates a major version, `minor` indicates a minor version, and `patch` indicates a fix.
+
+### Major Version
+
+::: info
+The EasyEDA Professional Edition Extension API has its own release version number, which is not equivalent to the EasyEDA version number. In general, major updates to the Extension API will follow the major or minor releases of EasyEDA.
+:::
+
+Changes to existing APIs that will be made available as major releases may have a noticeable impact on extensions and require the authors of extensions that utilize those APIs to update their code.
+
+This includes changes to the API itself (e.g., removing deprecated methods) or changes to API behavior.
+
+Extensions are not automatically upgraded to these versions, and in order to keep existing extensions working, the EasyEDA Professional API development team is committed to extending the lifecycle of deprecated methods as long as possible.
+
+### Minor Version
+
+New API interfaces and bug fixes will be provided as minor releases, and these new APIs will automatically be available to extensions as soon as they are run in the latest version of EasyEDA.
+
+If there are bugs in the API, we may, at our discretion, release bug fixes as a minor update, depending on whether we feel that certain extensions may break as a result of fixing the bugs. While any change in API behavior could theoretically make extensions work improperly, it would incur a lot of unnecessary additional overhead for extension authors and us to treat every bug fix as a major change.
+
+### Patch
+
+We release a fix update when we fix an urgent new issue, make a minimal change to the API, or even just change the content of the documentation.
+
+We may change the API's TypeScript type definition in the form of a break in the fix update. In the TypeScript world, Type and Script are two different things. As such, changes to Type do not affect existing code or cause breaks in released extensions, and having types that accurately represent the latest state of the API is more important than having perfect backward compatibility because types are easy to update. Typically, type changes only involve renaming certain types.
+
+## APIs for the Development Phase
+
+Development-stage APIs are APIs that are only available when the extension is set to a development version, which allows extension developers to try out new APIs and provide feedback to the EasyEDA Professional Extension API development team on whether the APIs are meeting usage requirements and/or working in any unexpected ways. APIs in development will be prominently identified within the documentation.