@communities-webruntime/metadata-schema

中文文档
1.66.8发布于 2021/12/02MITTypeScriptES Module近 30 天下载 2965

闪电网络运行时间的 UI 元数据图谱

中文使用文档
文档目录4 节
  1. 概览
  2. 使用量
  3. 定义
  4. 捐款

UI 元数据Schema

使用一个统一的计划来模拟你在JSON的UI形状.

此工程目前仅用于 @communities-webruntime 及其相应的验证人.

概览

元数据-schema为 LWR 项目验证不同类型JSON元数据的形状.

目前得到支持的计划包括:

  • base (单位:千美元)犬科元数据(中文(简体) )
  • communities (单位:千美元)申报元数据(中文(简体) )

元数据类型包括:

  • branding
  • routes
  • theme
  • view

使用量

对照计划进行验证,导入 MetadataValidator数字 :

import MetadataValidator from '@communities-webruntime/metadata-schema';

const schema = 'communities';   // name of the schema to validate against
const metadataType = 'routes';  // name of the metadata type
const data = ...;
new MetadataValidator(schema).validate(data, metadataType);

例如,见 元数据验证.ts。 。 。 .

定义

名称说明
视图一个屏幕上的景色。 也被称为 页次。 。 。 .
构成部分一个可重复使用的可堆叠的UI碎片. 这是对技术不可知的,即这可能是LWC组件或可再使用的HTML组件.
地区观点中可能包含一个或多个组成部分的部分
产品一块存储颜色或字体等视觉信息的数据. 这通常是一个键: 值对
路线路由包含关于 URL 方案的元数据, 或任何位置指定符
主题一个主题是一个复杂类型,它包含关于应用程序更高水平视觉的元数据
主题Layout主题布局只是视图的另一个名称

关于元数据的更详细记录,见 社区解剖 LWR 模板。 。 。 .

捐款

  1. 编辑 仅限 受你变化影响的计划 要知道任何定义的改变都会影响所有计划. 确保您不会通过查看文件来破坏他人 /config 文件夹,并验证您的计划变化的影响.
  2. 进一步确保您不会通过进行所有测试来打破别人.
  3. 添加您更改的测试, 以确保其他人不会打断您 .

版本与发布记录

@communities-webruntime/metadata-schema 共发布 359 个版本,首次发布于 2020/01/23;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.66.8latest2021/12/024 年前
1.66.3-236.12021/12/024 年前
1.66.72021/12/014 年前
1.66.62021/11/274 年前
1.66.52021/11/244 年前
1.66.3-236.02021/11/244 年前

其他发布通道:summer20 → 0.29.13-226.1,winter21 → 0.33.24-228.1,spring21 → 0.42.6-230.3,summer21 → 0.49.6-232.2,winter22 → 0.61.2-234.9,canary → 1.61.5-alpha.1720。

关于 @communities-webruntime/metadata-schema 的常见问题

@communities-webruntime/metadata-schema 是什么?

闪电网络运行时间的 UI 元数据图谱

如何安装 @communities-webruntime/metadata-schema?

在项目目录运行 npm install @communities-webruntime/metadata-schema,或使用 pnpm add / yarn add / bun add。

@communities-webruntime/metadata-schema 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@communities-webruntime/metadata-schema 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@communities-webruntime/metadata-schema 可以商用吗?

@communities-webruntime/metadata-schema 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@communities-webruntime/metadata-schema 的下载量有多少?

根据 npm 官方下载统计,@communities-webruntime/metadata-schema 在 2026/10/11 – 2026/11/09 这 30 天内被下载 2,965 次,日均约 99 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@communities-webruntime/metadata-schema 还在维护吗?

最新版本 1.66.8 发布于 2021/12/02(4 年前);至今共发布 359 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/01/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。