Apex Unified Logging 项目教程

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

Apex Unified Logging 项目的目录结构如下：

apex-unified-logging/
├── config/
│   └── force-app/
│       └── main/
│           └── default/
├── scripts/
│   ├── .eslintignore
│   ├── .forceignore
│   ├── .gitignore
│   ├── pmdCache
│   └── prettierrc
├── LICENSE
├── README.md
├── ruleset.xml
└── sfdx-project.json

目录介绍

• config/: 包含 Salesforce 项目的配置文件。
  • force-app/: Salesforce DX 项目的主要目录。
    • main/: 包含默认的 Salesforce 配置和代码。
      • default/: 默认的 Salesforce 配置和代码文件。
• scripts/: 包含项目的脚本文件。
  • .eslintignore: ESLint 忽略文件。
  • .forceignore: Salesforce DX 忽略文件。
  • .gitignore: Git 忽略文件。
  • pmdCache: PMD 缓存文件。
  • prettierrc: Prettier 配置文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• ruleset.xml: PMD 规则集文件。
• sfdx-project.json: Salesforce DX 项目配置文件。

2、项目的启动文件介绍

Apex Unified Logging 项目的启动文件主要是 sfdx-project.json，它包含了 Salesforce DX 项目的配置信息。

sfdx-project.json

{
  "packageDirectories": [
    {
      "path": "force-app",
      "default": true
    }
  ],
  "namespace": "",
  "sfdcLoginUrl": "https://login.salesforce.com",
  "sourceApiVersion": "50.0"
}

配置项介绍

• packageDirectories: 定义了项目的目录结构，force-app 是默认的目录。
• namespace: 项目的命名空间，当前为空。
• sfdcLoginUrl: Salesforce 登录 URL。
• sourceApiVersion: 源代码的 API 版本。

3、项目的配置文件介绍

Apex Unified Logging 项目的配置文件主要包括以下几个：

.forceignore

# Ignore the metadata types and folders
package.xml
**/aura/**
**/lwc/**

.gitignore

# Ignore the metadata types and folders
.sfdx/
.sfdx-temp/
**/bin/
**/obj/
**/node_modules/
**/dist/
**/coverage/

prettierrc

{
  "trailingComma": "all",
  "tabWidth": 2,
  "semi": true,
  "singleQuote": true
}

ruleset.xml

<?xml version="1.0"?>
<ruleset name="Custom Ruleset"
    xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
  <description>
    Custom ruleset for Apex Unified Logging
  </description>
</ruleset>

配置文件介绍

• .forceignore: 定义了 Salesforce DX 项目中需要忽略的文件和目录。
• .gitignore: 定义了 Git 版本控制系统中需要忽略的文件和目录。
• prettierrc: 定义了代码格式化工具 Prettier 的配置。
• ruleset.xml: 定义了代码质量工具 PMD 的规则集。

以上是 Apex Unified Logging 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。