Obsidian Local REST API 项目教程

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

obsidian-local-rest-api/
├── docs/
│   └── ...
├── mocks/
│   └── ...
├── src/
│   ├── commands/
│   ├── periodic_notes/
│   ├── rest_api/
│   └── utils/
├── .editorconfig
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .npmrc
├── .tool-versions
├── LICENSE
├── README.md
├── esbuild.config.mjs
├── jest.config.js
├── main.d.ts
├── manifest.json
├── package-lock.json
├── package.json
├── styles.css
├── tsconfig.json
├── tsconfig.test.json
├── version-bump.mjs
└── versions.json

目录结构介绍

• docs/: 包含项目的文档文件。
• mocks/: 包含用于测试的模拟数据。
• src/: 项目的源代码目录，包含以下子目录：
  • commands/: 包含与命令相关的代码。
  • periodic_notes/: 包含与周期性笔记相关的代码。
  • rest_api/: 包含与REST API相关的代码。
  • utils/: 包含通用工具函数。
• .editorconfig: 编辑器配置文件。
• .eslintignore: ESLint忽略文件。
• .eslintrc: ESLint配置文件。
• .gitignore: Git忽略文件。
• .npmrc: npm配置文件。
• .tool-versions: 工具版本配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• esbuild.config.mjs: esbuild配置文件。
• jest.config.js: Jest测试配置文件。
• main.d.ts: TypeScript声明文件。
• manifest.json: 插件清单文件。
• package-lock.json: npm锁定文件。
• package.json: npm包配置文件。
• styles.css: 样式文件。
• tsconfig.json: TypeScript配置文件。
• tsconfig.test.json: 测试用TypeScript配置文件。
• version-bump.mjs: 版本更新脚本。
• versions.json: 版本信息文件。

2. 项目的启动文件介绍

项目的启动文件主要是 main.d.ts 和 manifest.json。

main.d.ts

这是一个TypeScript声明文件，定义了项目的主要接口和类型。它确保了TypeScript编译器能够正确识别和处理项目中的类型。

manifest.json

这是Obsidian插件的清单文件，包含了插件的基本信息和配置。启动插件时，Obsidian会读取这个文件来加载插件。

3. 项目的配置文件介绍

.editorconfig

这个文件定义了项目的编辑器配置，确保不同开发者使用不同编辑器时，代码风格保持一致。

.eslintignore

这个文件列出了ESLint应该忽略的文件和目录。

.eslintrc

这个文件是ESLint的配置文件，定义了代码检查规则。

.gitignore

这个文件列出了Git应该忽略的文件和目录，避免将不必要的文件提交到版本控制中。

.npmrc

这个文件是npm的配置文件，定义了npm的行为和设置。

.tool-versions

这个文件定义了项目使用的工具版本，通常用于版本管理工具如asdf。

esbuild.config.mjs

这是esbuild的配置文件，定义了如何打包和构建项目。

jest.config.js

这是Jest测试框架的配置文件，定义了测试的运行方式和规则。

tsconfig.json

这是TypeScript的配置文件，定义了TypeScript编译器的设置。

tsconfig.test.json

这是用于测试的TypeScript配置文件，通常包含与测试相关的特定设置。

version-bump.mjs

这是一个脚本文件，用于自动更新项目的版本号。

versions.json

这个文件记录了项目的版本信息，通常用于版本管理和发布。