SFDX-Git-Delta 项目使用教程

SFDX-Git-Delta 项目使用教程

sfdx-git-delta Generate the sfdx content in source format from two git commits 项目地址: https://gitcode.com/gh_mirrors/sf/sfdx-git-delta

1. 项目目录结构及介绍

SFDX-Git-Delta 是一个 Salesforce 开源项目，用于生成增量 Salesforce 部署的清单和内容。以下是项目的目录结构及各部分功能的简要介绍：

.
├── .github/                        # GitHub 相关配置文件
├── .husky/                         # Husky 配置文件，用于 Git 钩子
├── __mocks__/                      # 模拟测试相关文件
├── __tests__/                      # 单元测试相关文件
├── bin/                            # 执行脚本
├── docs/                           # 文档目录
├── img/                            # 图片资源
├── messages/                       # 国际化消息文件
├── src/                            # 源代码目录
├── tooling/                        # 工具相关代码
├── .codeclimate.yml                # Code Climate 配置文件
├── .gitignore                      # Git 忽略文件
├── .lintstagedrc                   # Lint-staged 配置文件
├── .ls-lint.yml                    # Lint-staged 配置文件
├── .mega-linter.yml                # Mega-Linter 配置文件
├── .mocharc.json                   # Mocha 配置文件
├── .nycrc                          # NYC 配置文件
├── .prettierignore                 # Prettier 忽略文件
├── .prettierrc.json                # Prettier 配置文件
├── .trivyignore                    # Trivy 忽略文件
├── .validate-branch-namerc.json    # 校验分支名称配置文件
├── CHANGELOG.md                    # 更新日志
├── CODE_OF_CONDUCT.md              # 行为准则
├── CONTRIBUTING.md                 # 贡献指南
├── LICENSE.md                      # 许可证信息
├── PUBLISHING.md                   # 发布指南
├── README.md                       # 项目说明文件
├── SECURITY.md                     # 安全指南
├── biome.json                      # Biome 配置文件
├── commitlint.config.js            # CommitLint 配置文件
├── jest.config.js                  # Jest 配置文件
├── knip.config.ts                  # Knip 配置文件
├── lychee.toml                     # Lychee 配置文件
├── package-lock.json               # 包锁文件
├── package.json                    # 包文件
├── stryker.conf.mjs                # Stryker 配置文件
├── tsconfig.json                   # TypeScript 配置文件

2. 项目的启动文件介绍

项目的启动主要是通过 Salesforce CLI 插件 sf sgd source delta 来实现的。以下是启动文件的主要部分：

• bin/: 包含执行脚本，例如启动 CLI 插件的脚本。
• src/: 源代码目录，包含插件的主要逻辑。

要使用该插件，您需要首先通过 Salesforce CLI 安装它：

sf plugins install sfdx-git-delta

安装完成后，您可以使用以下命令来生成增量包：

sf sgd source delta -f <from-commit> -t <to-commit> -o <output-dir>

其中 <from-commit> 和 <to-commit> 是 Git 提交的 SHA 值，用于指定生成差分的范围，而 <output-dir> 是输出目录。

3. 项目的配置文件介绍

项目中有多个配置文件，用于不同工具和功能的设置。以下是一些重要的配置文件：

• .gitignore: 指定 Git 应该忽略的文件和目录。
• .prettierrc.json: Prettier 的配置文件，用于代码格式化。
• .trivyignore: Trivy 的忽略文件，用于忽略特定的安全扫描项。
• stryker.conf.mjs: Stryker 的配置文件，用于设置突变测试。

确保在开始项目之前，根据项目的具体需求对这些配置文件进行适当的修改和配置。

sfdx-git-delta Generate the sfdx content in source format from two git commits 项目地址: https://gitcode.com/gh_mirrors/sf/sfdx-git-delta