OrgCheck 项目使用教程

OrgCheck 项目使用教程

OrgCheck Org Check is an easy-to-install and easy-to-use Salesforce application in order to quickly analyze your org and its technical debt. 项目地址: https://gitcode.com/gh_mirrors/or/OrgCheck

1. 项目的目录结构及介绍

OrgCheck 项目的目录结构如下：

OrgCheck/
├── build/
├── config/
├── docs/
├── force-app/
│   └── main/
│       └── default/
├── orgs/
├── .eslintrc.json
├── .forceignore
├── .gitignore
├── .prettierignore
├── .prettierrc
├── CODEOWNERS
├── CODE_OF_CONDUCT.md
├── LICENSE.md
├── README.md
├── SECURITY.md
├── cumulusci.yml
├── package-lock.json
├── package.json
├── sfdx-project.json
└── yarn.lock

目录结构介绍

• build/: 构建生成的文件目录。
• config/: 项目配置文件目录。
• docs/: 项目文档目录。
• force-app/main/default/: Salesforce 应用的主要代码目录。
• orgs/: 组织相关文件目录。
• .eslintrc.json: ESLint 配置文件。
• .forceignore: Salesforce DX 忽略文件配置。
• .gitignore: Git 忽略文件配置。
• .prettierignore: Prettier 忽略文件配置。
• .prettierrc: Prettier 配置文件。
• CODEOWNERS: 代码所有者配置文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• LICENSE.md: 项目许可证文件。
• README.md: 项目介绍文件。
• SECURITY.md: 安全策略文件。
• cumulusci.yml: CumulusCI 配置文件。
• package-lock.json: npm 包锁定文件。
• package.json: npm 包配置文件。
• sfdx-project.json: Salesforce DX 项目配置文件。
• yarn.lock: Yarn 包锁定文件。

2. 项目的启动文件介绍

OrgCheck 项目的启动文件主要是 force-app/main/default/ 目录下的文件。这些文件包含了 Salesforce 应用的主要代码和配置。

主要启动文件

• force-app/main/default/classes/: Apex 类文件目录。
• force-app/main/default/pages/: Visualforce 页面文件目录。
• force-app/main/default/triggers/: Apex 触发器文件目录。

这些文件是 Salesforce 应用的核心部分，负责处理业务逻辑和用户界面。

3. 项目的配置文件介绍

OrgCheck 项目的配置文件主要集中在根目录和 config/ 目录下。

主要配置文件

• .eslintrc.json: ESLint 配置文件，用于代码风格检查。
• .forceignore: Salesforce DX 忽略文件配置，指定哪些文件在部署时被忽略。
• .gitignore: Git 忽略文件配置，指定哪些文件在版本控制中被忽略。
• .prettierignore: Prettier 忽略文件配置，指定哪些文件在代码格式化时被忽略。
• .prettierrc: Prettier 配置文件，用于代码格式化。
• cumulusci.yml: CumulusCI 配置文件，用于 Salesforce 项目的持续集成和部署。
• package.json: npm 包配置文件，定义项目依赖和脚本。
• sfdx-project.json: Salesforce DX 项目配置文件，定义 Salesforce 项目的结构和元数据。
• yarn.lock: Yarn 包锁定文件，确保项目依赖的一致性。

这些配置文件帮助开发者管理和维护项目的代码风格、依赖关系和部署流程。

OrgCheck Org Check is an easy-to-install and easy-to-use Salesforce application in order to quickly analyze your org and its technical debt. 项目地址: https://gitcode.com/gh_mirrors/or/OrgCheck