haoide 项目使用教程

haoide 项目使用教程

haoide Stop upgrade, most of features were delivered in https://github.com/xjsender/haoide-vscode 项目地址: https://gitcode.com/gh_mirrors/ha/haoide

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

haoide/
├── config/
├── docs/
├── libs/
├── requests/
├── salesforce/
├── .gitignore
├── HISTORY.rst
├── MIT-LICENSE
├── README.md
├── aura.py
├── bulk.py
├── completions.py
├── context.py
├── db.py
├── document.py
├── events.py
├── lwc.py
├── main.py
├── messages.json
├── package.py
├── processor.py
├── progress.py
└── util.py

目录结构介绍

• config/: 存放项目的配置文件。
• docs/: 存放项目的文档文件。
• libs/: 存放项目依赖的库文件。
• requests/: 存放与请求相关的文件。
• salesforce/: 存放与 Salesforce 相关的文件。
• .gitignore: Git 忽略文件配置。
• HISTORY.rst: 项目历史记录文件。
• MIT-LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。
• aura.py: 与 Aura 组件相关的文件。
• bulk.py: 与批量操作相关的文件。
• completions.py: 自动补全相关的文件。
• context.py: 上下文相关的文件。
• db.py: 数据库相关的文件。
• document.py: 文档相关的文件。
• events.py: 事件相关的文件。
• lwc.py: 与 Lightning Web Component 相关的文件。
• main.py: 项目的主入口文件。
• messages.json: 消息配置文件。
• package.py: 包相关的文件。
• processor.py: 处理器相关的文件。
• progress.py: 进度相关的文件。
• util.py: 工具类文件。

2. 项目的启动文件介绍

项目的启动文件是 main.py。该文件是整个项目的入口，负责初始化项目并启动主要的业务逻辑。

main.py 文件内容概述

# main.py

def main():
    # 初始化项目配置
    initialize_config()
    
    # 启动主要业务逻辑
    start_business_logic()

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

项目的配置文件主要存放在 config/ 目录下。以下是一些主要的配置文件及其作用：

config/project.json

该文件用于配置项目的全局设置，包括 Salesforce 的登录信息、默认项目配置等。

{
    "projects": [
        {
            "pro-sublime": {
                "default": true,
                "login_url": "https://login.salesforce.com",
                "login_type": "REST",
                "subscribed_metadata_objects": [
                    "ApexClass",
                    "ApexComponent",
                    "ApexTrigger",
                    "AuraDefinitionBundle"
                ],
                "username": "apex.sublime@dev.com"
            }
        }
    ]
}

config/messages.json

该文件用于配置项目中的消息提示信息，包括错误提示、成功提示等。

{
    "error": {
        "invalid_login": "登录失败，请检查用户名和密码。"
    },
    "success": {
        "login_success": "登录成功！"
    }
}

通过以上配置文件，可以灵活地调整项目的运行环境和行为。

haoide Stop upgrade, most of features were delivered in https://github.com/xjsender/haoide-vscode 项目地址: https://gitcode.com/gh_mirrors/ha/haoide