QuickAdd 开源项目教程

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

QuickAdd 项目的目录结构如下：

quickadd/
├── .github/
│   └── workflows/
├── assets/
│   └── images/
├── docs/
│   ├── examples/
│   └── images/
├── src/
│   ├── choices/
│   ├── commands/
│   ├── manager/
│   ├── models/
│   ├── parsers/
│   ├── quickAddApi/
│   ├── settings/
│   ├── templates/
│   └── utils/
├── .gitignore
├── .npmrc
├── .prettierrc
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
└── webpack.config.js

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• assets/images/: 存放项目相关的图片资源。
• docs/examples/: 存放文档中的示例代码。
• docs/images/: 存放文档中的图片资源。
• src/: 项目的源代码目录，包含多个子目录和文件。
  • choices/: 包含选择相关的逻辑代码。
  • commands/: 包含命令相关的逻辑代码。
  • manager/: 包含管理器相关的逻辑代码。
  • models/: 包含数据模型相关的逻辑代码。
  • parsers/: 包含解析器相关的逻辑代码。
  • quickAddApi/: 包含 QuickAdd API 相关的逻辑代码。
  • settings/: 包含设置相关的逻辑代码。
  • templates/: 包含模板相关的逻辑代码。
  • utils/: 包含工具函数相关的逻辑代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmrc: npm 配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的 npm 配置文件，包含依赖和脚本。
• tsconfig.json: TypeScript 配置文件。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

QuickAdd 项目的启动文件是 src/main.ts。这个文件是项目的入口点，负责初始化插件并加载必要的模块。

import { App, Plugin } from 'obsidian';
import { QuickAddApi } from './quickAddApi/quickAddApi';
import { QuickAddSettingsTab } from './settings/SettingsTab';
import { QuickAddManager } from './manager/manager';

export default class QuickAdd extends Plugin {
    settings: QuickAddSettings;
    manager: QuickAddManager;

    async onload() {
        console.log('加载 QuickAdd 插件');

        this.settings = new QuickAddSettings();
        await this.loadSettings();

        this.manager = new QuickAddManager(this);
        await this.manager.loadChoices();

        this.addSettingTab(new QuickAddSettingsTab(this.app, this));

        this.addCommand({
            id: 'run-quickadd',
            name: 'Run QuickAdd',
            callback: () => {
                this.manager.run();
            }
        });
    }

    async loadSettings() {
        this.settings = Object.assign({}, this.settings, await this.loadData());
    }

    async saveSettings() {
        await this.saveData(this.settings);
    }
}

启动文件介绍

• src/main.ts: 项目的入口文件，负责初始化插件、加载设置、管理器和命令。
  • onload(): 插件加载时调用的方法，初始化设置和管理器，并添加设置选项卡和命令。
  • loadSettings(): 加载设置数据的方法。
  • saveSettings(): 保存设置数据的方法。

3. 项目的配置文件介绍

QuickAdd 项目的配置文件是 src/settings/Settings.ts。这个文件定义了插件的设置选项和默认值。

export interface QuickAddSettings {
    mySetting: string;
}

export const DEFAULT