cmsds-开口数据组件
这种repo作为CMS Open Data站点的上游常见反应库. 此库由 括号。 。 。 .
地方发展
为了地方发展,我们建议使用 npm 工作空间。 。 。 . 一旦您有工作空间目录, 请沿着您想要工作的 Open Data 下游站点在您的工作空间内安装此库 .
在此工程的根文件夹中, 运行 npm run watch 建立本地代码。 确保上游使用位于此 repo 的 package.json 中的相同版本编号 。 也在当地启动上游站点,它应该从这个Repo中装入本地代码作为依赖. Parcel 还提供热重建,同时 watch 正在运行.
故事书
该项目包括编写组成部分和编制文件的故事手册.
运行故事本
要在开发模式中启动故事本 :
npm run storybook
这将启动 Storybook 开发服务器, 通常在 http://localhost:6006。 。 。 .
构建故事书
要建立静态版本的"故事"供部署:
npm run build-storybook
已建成的故事本将输出到 storybook-static 目录.
写故事
应利用命名公约将故事与组成部分放在一起:
ComponentName.stories.jsx或者说ComponentName.stories.tsx
故事使用 CSF3( 组成故事格式 3) 格式 。 参见当前 src/components/ 示例目录.
故事书限制
该项目正在整合故事书。 一些组件和页面模板可能还没有故事,CMS.gov设计系统的某些图标或样式可能没有如"故事本"所想的那样显示.
库存
这个项目包括一个自动脚本,生成所有组件、模板、服务、钩子、上下文、公用事业和类型的综合清单.
生成清单
为生成清单报告:
npm run generate:inventory
这创造了 COMPONENTS_INVENTORY.md 在根目录中设置:
- 所有图书馆项目的完整列表
- 公共出口状况
- 故事书报道
- 单位测试覆盖率
- 质量计量和统计
清单通过预先承诺的钩子自动更新每个承诺.
详情见 脚本文档。 。 。 .
组成部分使用报告
这个项目包括一个脚本,可以在使用cmsds-open-data-组件作为分析组件使用情况的依赖的项目中运行.
在附属项目中运行
从一个有 @civicactions/cmsds-open-data-components 作为依附关系:
npx generate-usage-report
此生成 COMPONENT_USAGE_REPORT.md 显示 :
- 正在使用库中哪些组件
- 在项目中每个部件被导入的地方
- 统计摘要和分类细目
- GitHub 链接到组件源代码
生成样本报告(图书馆开发)
要在此寄存器中使用 Storybook 文件生成样本报告 :
npm run generate:usage-report
这创造了 SAMPLE_COMPONENT_USAGE_REPORT.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