Obsidian Advanced URI 项目教程

1. 项目目录结构及介绍

Obsidian Advanced URI 项目的目录结构如下：

obsidian-advanced-uri/
├── docs/
│   └── ...
├── src/
│   └── ...
├── .editorconfig
├── .gitignore
├── .prettierrc.json
├── CHANGELOG.md
├── LICENSE
├── README.md
├── esbuild.config.mjs
├── manifest.json
├── package-lock.json
├── package.json
└── tsconfig.json

目录结构介绍

• docs/: 包含项目的文档文件，如用户指南、API文档等。
• src/: 包含项目的源代码文件，通常是 TypeScript 或 JavaScript 文件。
• .editorconfig: 配置文件，用于统一代码编辑器的设置。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .prettierrc.json: Prettier 代码格式化工具的配置文件。
• CHANGELOG.md: 记录项目版本变更的日志文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文件，通常包含项目的基本信息、安装步骤和使用说明。
• esbuild.config.mjs: esbuild 构建工具的配置文件。
• manifest.json: 插件的清单文件，包含插件的基本信息和配置。
• package-lock.json: 锁定项目依赖包版本的文件。
• package.json: 项目的 npm 配置文件，包含项目的依赖、脚本等信息。
• tsconfig.json: TypeScript 编译器的配置文件。

2. 项目启动文件介绍

Obsidian Advanced URI 项目的启动文件主要是 src/ 目录下的源代码文件。这些文件通常是 TypeScript 或 JavaScript 文件，负责实现插件的核心功能。

主要启动文件

• src/main.ts: 这是插件的主入口文件，负责初始化插件并注册各种功能。
• src/utils.ts: 包含一些工具函数，用于辅助插件的实现。
• src/settings.ts: 处理插件的设置和配置。

3. 项目的配置文件介绍

Obsidian Advanced URI 项目的配置文件主要包括以下几个：

配置文件介绍

• .editorconfig: 用于统一代码编辑器的设置，确保不同开发者使用相同的代码风格。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录，避免将不必要的文件提交到版本库。
• .prettierrc.json: Prettier 代码格式化工具的配置文件，用于自动格式化代码。
• esbuild.config.mjs: esbuild 构建工具的配置文件，用于打包和优化项目代码。
• manifest.json: 插件的清单文件，包含插件的基本信息、版本号、作者等。
• package.json: 项目的 npm 配置文件，包含项目的依赖、脚本、版本号等信息。
• tsconfig.json: TypeScript 编译器的配置文件，用于配置 TypeScript 编译选项。

配置文件示例

package.json

{
  "name": "obsidian-advanced-uri",
  "version": "1.0.0",
  "description": "Advanced URI plugin for Obsidian",
  "main": "src/main.ts",
  "scripts": {
    "build": "esbuild src/main.ts --bundle --outfile=dist/main.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Vinzent03",
  "license": "MIT",
  "dependencies": {
    "obsidian": "^0.12.0"
  }
}

tsconfig.json

{
  "compilerOptions": {
    "target": "ES6",
    "module": "CommonJS",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"]
}

通过以上配置文件，开发者可以轻松管理和配置 Obsidian Advanced URI 插件的开发环境和构建流程。