# @civicactions/cmsds-open-data-components 中文文档

规范地址：https://npmcn.com/package/%40civicactions/cmsds-open-data-components/

版本：4\.7\.1
npm 元数据更新时间：2026-11-07T12:27:30.992Z
中文译文更新时间：2026-11-09T22:48:36.033Z
软件包许可：GPL-3\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40civicactions/cmsds-open-data-components
原文对照：https://npmcn.com/package/%40civicactions/cmsds-open-data-components/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.1 MB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：17 个
- peer 依赖：react ^19\.2\.7，react-dom ^19\.2\.7，@cmsgov/design-system ^18\.0\.1
- 首次发布：2020-12-15T17:31:28.186Z
- 最新版本发布：2026-11-07T12:27:30.796Z
- 近 30 天下载量：1952（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：601（近 12 个月 160 个）

## 中文简介

使用 CMS 设计系统的开放数据目录前端组件

## 安装

```sh
npm install @civicactions/cmsds-open-data-components
```

也可以使用：`pnpm add @civicactions/cmsds-open-data-components`、`yarn add @civicactions/cmsds-open-data-components`、`bun add @civicactions/cmsds-open-data-components`

## README

# cmsds-开口数据组件

这种repo作为CMS Open Data站点的上游常见反应库. 此库由 [括号](https://parceljs.org/)。 。 。 .

## 地方发展

为了地方发展,我们建议使用 [npm 工作空间](https://docs.npmjs.com/cli/v7/using-npm/workspaces)。 。 。 . 一旦您有工作空间目录, 请沿着您想要工作的 Open Data 下游站点在您的工作空间内安装此库 .

在此工程的根文件夹中, 运行 `npm run watch` 建立本地代码。 确保上游使用位于此 repo 的 package.json 中的相同版本编号 。 也在当地启动上游站点,它应该从这个Repo中装入本地代码作为依赖. Parcel 还提供热重建,同时 `watch` 正在运行.

## 故事书

该项目包括编写组成部分和编制文件的故事手册.

### 运行故事本

要在开发模式中启动故事本 :

```bash
npm run storybook
```

这将启动 Storybook 开发服务器, 通常在 `http://localhost:6006`。 。 。 .

### 构建故事书

要建立静态版本的"故事"供部署:

```bash
npm run build-storybook
```

已建成的故事本将输出到 `storybook-static` 目录.

### 写故事

应利用命名公约将故事与组成部分放在一起:

-   `ComponentName.stories.jsx` 或者说 `ComponentName.stories.tsx`

故事使用 CSF3( 组成故事格式 3) 格式 。 参见当前 `src/components/` 示例目录.

### 故事书限制

该项目正在整合故事书。 一些组件和页面模板可能还没有故事,CMS.gov设计系统的某些图标或样式可能没有如"故事本"所想的那样显示.

## 库存

这个项目包括一个自动脚本,生成所有组件、模板、服务、钩子、上下文、公用事业和类型的综合清单.

### 生成清单

为生成清单报告:

```bash
npm run generate:inventory
```

这创造了 `COMPONENTS_INVENTORY.md` 在根目录中设置:

-   所有图书馆项目的完整列表
-   公共出口状况
-   故事书报道
-   单位测试覆盖率
-   质量计量和统计

清单通过预先承诺的钩子自动更新每个承诺.

详情见 [脚本文档](https://npmcn.com/package/%40civicactions/cmsds-open-data-components/scripts/README.md)。 。 。 .

## 组成部分使用报告

这个项目包括一个脚本,可以在使用cmsds-open-data-组件作为分析组件使用情况的依赖的项目中运行.

### 在附属项目中运行

从一个有 `@civicactions/cmsds-open-data-components` 作为依附关系:

```bash
npx generate-usage-report
```

此生成 `COMPONENT_USAGE_REPORT.md` 显示 :

-   正在使用库中哪些组件
-   在项目中每个部件被导入的地方
-   统计摘要和分类细目
-   GitHub 链接到组件源代码

### 生成样本报告(图书馆开发)

要在此寄存器中使用 Storybook 文件生成样本报告 :

```bash
npm run generate:usage-report
```

这创造了 `SAMPLE_COMPONENT_USAGE_REPORT.md` 显示报告格式.

详情见 [脚本文档](https://npmcn.com/package/%40civicactions/cmsds-open-data-components/scripts/README.md)。 。 。 .

## 出版新版本

### 清除缓存和先前的构建

在运行一个建筑之前,建议清理出旧的建筑和缓存文件来避免发布一个陈旧的建筑.

运行 `rm -rf dist/` 删除上一个构建  
运行 `rm -rf .parcel-cache/` 以清除包裹 构建缓存

### 创建新发行

运行 `npm run build` 在出版到 npm 之前创建库的制作版本.  
运行 `npm publish` 发布到 npm

### 创建 Alpha/ 测试发布

在创建用于测试目的的alpha发布器或任何其他发布器时,在发布命令中添加标记. 这将防止测试释放作为国家预防机制的最新释放出现.

运行后 `npm run build`, (中文(简体) ),  
运行 `npm publish --tag <tag name>` 示例( npm 发布 -- tag "alpha" )

## 测试

测试时可以使用: `npm run test`

## 常见问题

### @civicactions/cmsds-open-data-components 是什么？

使用 CMS 设计系统的开放数据目录前端组件

### 如何安装 @civicactions/cmsds-open-data-components？

在项目目录运行 npm install @civicactions/cmsds-open-data-components，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.2\.7）、react-dom（^19\.2\.7）、@cmsgov/design-system（^18\.0\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 generate-usage-report，可以用 npx generate-usage-report 直接运行。

### @civicactions/cmsds-open-data-components 支持 TypeScript 吗？

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

### @civicactions/cmsds-open-data-components 支持 ESM 还是 CommonJS？

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

### @civicactions/cmsds-open-data-components 可以商用吗？

@civicactions/cmsds-open-data-components 使用 GPL-3\.0 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以 GPL-3\.0 兼容许可开源，并附带专利与反锁定条款。仅内部使用不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @civicactions/cmsds-open-data-components 的下载量有多少？

根据 npm 官方下载统计，@civicactions/cmsds-open-data-components 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,952 次，日均约 65 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @civicactions/cmsds-open-data-components 还在维护吗？

最新版本 4\.7\.1 发布于 2026/11/07（2 天前）；至今共发布 601 个版本，其中过去 12 个月发布了 160 个；首次发布于 2020/12/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。