docs(plugins): document PluginLocalizedMeta type name
This commit is contained in:
1 parent
8ceaa725e0
commit
acec2ba713
3 files changed
+4
-4
No files matched your search
@@ -2,5 +2,5 @@
|
||||
# side as of the last confirmed-consistent state. Both languages carry equal authority;
|
||||
# after editing either side, bring the other along and re-record with:
|
||||
# pnpm run verify-translation-pairing --write packages/util/package-manifest/README.md
|
||||
README.md: 1edb4f802a3ceb4981f3c66e59a66d50edce22b5
|
||||
README.zh.md: 81af9eeb1a6504c5b19aa73509f69697c1726c6c
|
||||
README.md: 86121432ba12329e111f2c796679ae019e403d7e
|
||||
README.zh.md: d4d9d8b5b7787ac9531918fb1f7084c7c8a7a8d1
|
||||
@@ -52,7 +52,7 @@ The following metadata fields are optional. Omitting them leaves the format vers
|
||||
| `dsh.manifestVersion` | Manifest format identifier; the declared format is `1`, independent of the npm package version and Session format version. |
|
||||
| `engines.dsh` | Author-declared compatible DSH versions as a SemVer range, including exact prerelease versions. This field sits beside `engines.node` and `engines.npm`; an engines object may omit `dsh`. |
|
||||
|
||||
`LocalizedText` carries literal text or a language map with a required English fallback. `PackageMeta` carries optional display title and description fields, or a metadata diagnostic, for installed plugins. [App boot](../../boot/app-boot/README.md) reads these values; this package only supplies their types.
|
||||
`LocalizedText` carries literal text or a language map with a required English fallback. `PluginLocalizedMeta` carries optional display title and description fields, or a metadata diagnostic, for installed plugins. [App boot](../../boot/app-boot/README.md) reads these values; this package only supplies their types.
|
||||
|
||||
Public composition declarations are defined in [`src/types.ts`](src/types.ts). Internal `configTrees`, `sessionFormatMigration`, and generated `moduleFallback` metadata remain owned by their image-packer, catalog, and launcher readers; the public types do not expose them.
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ const manifest: DshPackageManifest = {
|
||||
| `dsh.manifestVersion` | manifest(元数据清单)格式标识;声明的格式为 `1`,独立于 npm 包版本和 Session 格式版本。 |
|
||||
| `engines.dsh` | 作者声明的兼容 DSH 版本,使用 SemVer 范围,也可填写精确的预发布版本。此字段与 `engines.node`、`engines.npm` 并列;engines 对象可省略 `dsh`。 |
|
||||
|
||||
`LocalizedText` 携带字面文本或带必需英文回退值的语言映射。`PackageMeta` 携带已安装插件的可选展示标题与描述字段,或元信息诊断。[App boot](../../boot/app-boot/README.zh.md) 读取这些值;本包只提供其类型。
|
||||
`LocalizedText` 携带字面文本或带必需英文回退值的语言映射。`PluginLocalizedMeta` 携带已安装插件的可选展示标题与描述字段,或元信息诊断。[App boot](../../boot/app-boot/README.zh.md) 读取这些值;本包只提供其类型。
|
||||
|
||||
公共组合声明定义在 [`src/types.ts`](src/types.ts) 中。内部 `configTrees`、`sessionFormatMigration` 和生成的 `moduleFallback` 元数据分别由镜像打包器、目录生成器和启动器读取方拥有;公共类型不暴露这些字段。
|
||||
|
||||
|
||||
Reference in new issue
Block a user