docs: Modern.js New Plugin Doc #6938
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 9add52c The changes in this PR will be included in the next version bump. This PR includes changesets to release 286 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for modernjs-byted ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
zllkjc
reviewed
Mar 18, 2025
There was a problem hiding this comment.
这部分我感觉不需要介绍插件的事情，就说配置就好了
在 modern.runtim.ts 中配置
balabala
在 modern.config.ts 中配置（废弃）
balabal，为什么废弃
| @@ -0,0 +1,629 @@ | |||
| # CLI 插件 API | |||
|
|
|||
| # Modern.js CLI 插件 API | |||
There was a problem hiding this comment.
另外下面运行时插件的是：插件 API
这里感觉也叫插件 API 就好了~
|
|
||
| `setup` 函数接收一个 `api` 对象，该对象提供了所有可用的 CLI 插件 API。 | ||
|
|
||
| ## API 参考 |
|
|
||
| 获取 Modern.js 应用的上下文信息。 | ||
|
|
||
| - **返回值:** `AppContext` 对象，包含以下字段： |
There was a problem hiding this comment.
感觉 internalSrcAlias、internalDirAlias、internalDirectory 可以不写在文档上
| 获取用户在 `modern.config.ts` 文件中定义的配置。 | ||
|
|
||
| - **返回值:** 用户定义的配置对象。 | ||
| - **示例:** |
|
|
||
| --- | ||
|
|
||
| #### `api.deploy` |
There was a problem hiding this comment.
这个钩子我担心会给用户造成额外的心智，因为框架内也有处理 build 产物的逻辑，用户需要了解框架内如何处理产物，不然容易出错。如果在框架处理前，可能出现某个文件被用户处理了，框架无法处理。反之在后，用户想处理某个文件，但是框架已经处理了，用户也不了解处理后的结构。
| @@ -0,0 +1,3 @@ | |||
| # 生命周期 | |||
|
|
|||
|  | |||
| }); | ||
| ``` | ||
|
|
||
| #### Server 插件 |
| }); | ||
| ``` | ||
|
|
||
| - **注意事项**: |
| @@ -0,0 +1,3 @@ | |||
| # 生命周期 | |||
|
|
|||
|  | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Related Links
Checklist
pnpm run change.