插件开发学习记录——对他人项目的学习

不是程序员,自学过一点 Python 和 JS,没什么完整的项目开发经验,想要学习下怎么开发插件,同时记录分享出来。

首先,Obsidian 插件是使用 Typescript 语言开发的,应该先学习下 TS。我看的视频教程是:尚硅谷TypeScript教程(李立超老师TS新课)_哔哩哔哩 。这个教程的特点是:

  • 对于 TS 做基本介绍,没有过于发散深入,总长度10小时左右,太长就看不下去。
  • 讲解了相关开发工具链和开发环境搭建,前端开发工具链对于新手真是太复杂了。
  • 有练手项目,能够更好掌握。

然后,阅读官方的插件开发示例。

然后,选择一个比较简单的项目源码阅读学习,我选择的是 obsidian-activity-history插件 当前的 0.1.4 版本(新注册用户放不了更多链接,自己找吧)。阅读过程中把整个项目的源码用中文注释了一遍,顺便分享出来。下载

4 个赞
import { Plugin } from 'obsidian';
import { ActivityHistorySettingTab } from './settings'
import { addProject, removeProject, updateActivityAll } from './utils'
import { ActivityHistoryProcessor } from './block'
import { DEFAULT_SETTINGS } from './constants';
import type { ActivitySettings } from './types';

其它引用文件在目录里都有,唯独obsidian模块文件不在,能否介绍一下插件调试的方法。是不是只能放到.obsidian目录里,通过触发动作来调试。

Obsidian 库(模块)是直接安装在开发环境中的,如 npm install obsidian
据说所知,只能放在 .obsidian 插件目录中,触发运行调试

谢谢,好象是没有太好办法。只能新建一个专门调试用的ob库来做测试。