digital form builder

XGov 数字表格生成器

贡献

欢迎提出问题和拉取请求。请先检查 CONTRIBUTING.md！

该存储库是一个单一存储库

• @xgovformbuilder/runner - Hapi 服务器，可以从 JSON 文件“运行”表单
• @xgovformbuilder/designer - 帮助表单构建的 React 应用程序
• @xgovformbuilder/model - 为数据模型和其他助手提供服务
• @xgovformbuilder/e2e - 端到端测试

这些存储库是从 DEFRA 的数字表单生成器中分叉出来的。

这是一个（接近）零安装的yarn 2 工作空间存储库。 .yarnrc.yml 允许我们调整纱线环境。请在 .yarn 中提交任何插件，但不要提交您的 .yarn/cache。 CI 将保存和恢复缓存。

工作区将处理包的符号链接，因此我们不必手动运行yarn link 。它还将处理在存储库之间共享的任何包的节点模块提升，从而减少安装时间。希望一切顺利™️。

另请参阅各个存储库自述文件以获取更多信息：

• 跑步者自述文件
• 设计师自述文件
• 模型自述文件
• e2e（冒烟测试）自述文件

设置

始终从根目录运行脚本。

1. 确保您使用的是节点 20 node --version 。
2. 确保您安装了yarn 1.22+。您不需要安装yarn 2.4+，yarn 将检测.yarn 中的yarn 2 二进制文件并使用它。
3. 如果使用设计器：
   • 请注意，设计者要求运行程序使用默认的NODE_ENV=development设置（请参阅 runner/config/development.json）运行，以便在设计期间启用表单的发布和预览。
4. 运行$ yarn命令以安装所有工作区中的所有依赖项。
5. 运行$ yarn build来构建所有工作区（这是必需的，因为依赖项可以相互依赖）。

如前所述，始终从根目录运行脚本。因为工作区没有脚本或包，您需要从其文件夹内部运行，并且通过在根目录中运行yarn 2 可以正确解析脚本/包。

要了解有关工作区的更多信息，请检查以下链接：

• Yarn 中的工作区
• 工作空间

我想要...

运行特定工作区的脚本

$ yarn [runner|designer|model] name-of-script

例如： yarn designer start或yarn runner add babel-core --dev

为每个工作区运行一个脚本

$ yarn workspaces foreach run name-of-script

监视并构建所有存储库中的更改

除非你有强大的处理器，否则我不会推荐它。

$ yarn watch

向所有工作区添加依赖项

$ yarn add packagename

创建一个新的工作区

1. 为工作区创建一个新目录并用纱线初始化它
   1. $ mkdir myNewLib
   2. $ cd myNewlib
   3. $ yarn init
2. 在根package.json中
   1. 将myNewLib添加到workspaces对象。

故障排除

如果您有任何问题，请提交问题或通过 gitter 发送消息。

错误：ENOENT：没有这样的文件或目录，scandir 'xxx/node_modules/node-sass/vendor'

/vendor不存在，因为它尚未构建或重建。您也可能会在core-js 、 fsevents 、 nodemailer等方面遇到此问题。 $ yarn rebuild来重建所有包$ yarn rebuild only node-sass只重建node-sass

CI

我们使用 GitHub 操作来运行我们的 CI 流程。在此处查看工作流程的可视化。

版本控制

版本号将根据提交消息和 SemVer (Major.Minor.Patch) 自动递增。合并时，在合并提交前添加以下内容：

• major:或breaking: - 例如， breaking: removing feature X 。这将增加主要版本 - 例如：1.1.0 到 2.0.0
• minor:或feature: - 例如， feature: new component 。这将增加次要版本 - 例如：1.1.0 到 1.2.0
• patch:或fix: - 例如， fix: url bug - 这将增加 PATCH 版本 - 例如：1.0.0 到 1.0.1（默认情况下也会发生这种情况）

开发环境

每当 PR 合并到 main 中时，就会触发开发工作流程，您可以在存储库的操作选项卡上监视它。

该工作流程包含两个并行运行的独立作业，一个用于 Runner，另一个用于 Designer 应用程序。

两项工作的工作原理如下：

1. 构建具有所有依赖项的 docker 映像。
2. 将镜像推送到 Heroku 容器注册表。
3. 发布最新图片。

最新版本将在这里运行：Runner / Designer。

烟雾测试

针对所有 PR 运行一套冒烟测试。有一个 Cron Job 对 Heroku 部署执行冒烟测试，并计划在每天午夜运行。

可以在此存储库中找到旧版冒烟测试套件。它们已被删除，以便该项目可以在节点 18 上运行。

未来几个月，冒烟测试将迁移至使用 cypress.io。