Skip to content

Commit da49342

Browse files
committed
init
1 parent c06bcf9 commit da49342

File tree

6 files changed

+21
-241
lines changed

6 files changed

+21
-241
lines changed

README.md

Lines changed: 4 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,6 @@
1-
# Obsidian Sample Plugin
1+
# Lazy Cursor - Obsidian Plugin
22

3-
This is a sample plugin for Obsidian (https://obsidian.md).
3+
This is a tiny plugin for [Obsidian](https://obsidian.md) that initially hides the cursor when opening a note. The cursor will reappear when you click somewhere in the note.
4+
I created this plugin to prevent Obsidian from rendering the first line of a note in raw markdown when using Live Preview.
45

5-
This project uses Typescript to provide type checking and documentation.
6-
The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
7-
8-
**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
9-
10-
This sample plugin demonstrates some of the basic functionality the plugin API can do.
11-
- Adds a ribbon icon, which shows a Notice when clicked.
12-
- Adds a command "Open Sample Modal" which opens a Modal.
13-
- Adds a plugin setting tab to the settings page.
14-
- Registers a global click event and output 'click' to the console.
15-
- Registers a global interval which logs 'setInterval' to the console.
16-
17-
## First time developing plugins?
18-
19-
Quick starting guide for new plugin devs:
20-
21-
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
22-
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
23-
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
24-
- Install NodeJS, then run `npm i` in the command line under your repo folder.
25-
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
26-
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
27-
- Reload Obsidian to load the new version of your plugin.
28-
- Enable plugin in settings window.
29-
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
30-
31-
## Releasing new releases
32-
33-
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
34-
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
35-
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
36-
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
37-
- Publish the release.
38-
39-
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
40-
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
41-
42-
## Adding your plugin to the community plugin list
43-
44-
- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
45-
- Publish an initial version.
46-
- Make sure you have a `README.md` file in the root of your repo.
47-
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
48-
49-
## How to use
50-
51-
- Clone this repo.
52-
- Make sure your NodeJS is at least v16 (`node --version`).
53-
- `npm i` or `yarn` to install dependencies.
54-
- `npm run dev` to start compilation in watch mode.
55-
56-
## Manually installing the plugin
57-
58-
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
59-
60-
## Improve code quality with eslint (optional)
61-
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
62-
- To use eslint with this project, make sure to install eslint from terminal:
63-
- `npm install -g eslint`
64-
- To use eslint to analyze this project use this command:
65-
- `eslint main.ts`
66-
- eslint will then create a report with suggestions for code improvement by file and line number.
67-
- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
68-
- `eslint .\src\`
69-
70-
## Funding URL
71-
72-
You can include funding URLs where people who use your plugin can financially support it.
73-
74-
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
75-
76-
```json
77-
{
78-
"fundingUrl": "https://buymeacoffee.com"
79-
}
80-
```
81-
82-
If you have multiple URLs, you can also do:
83-
84-
```json
85-
{
86-
"fundingUrl": {
87-
"Buy Me a Coffee": "https://buymeacoffee.com",
88-
"GitHub Sponsor": "https://github.com/sponsors",
89-
"Patreon": "https://www.patreon.com/"
90-
}
91-
}
92-
```
93-
94-
## API Documentation
95-
96-
See https://github.com/obsidianmd/obsidian-api
6+
> It basically just runs `editor.blur();` when opening a file. This means the cursor might flicker shortly when opening a file.

bun.lockb

30.9 KB
Binary file not shown.

main.ts

Lines changed: 8 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,134 +1,13 @@
1-
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
2-
3-
// Remember to rename these classes and interfaces!
4-
5-
interface MyPluginSettings {
6-
mySetting: string;
7-
}
8-
9-
const DEFAULT_SETTINGS: MyPluginSettings = {
10-
mySetting: 'default'
11-
}
12-
13-
export default class MyPlugin extends Plugin {
14-
settings: MyPluginSettings;
1+
import { Plugin } from "obsidian";
152

3+
export default class LazyCursor extends Plugin {
164
async onload() {
17-
await this.loadSettings();
18-
19-
// This creates an icon in the left ribbon.
20-
const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
21-
// Called when the user clicks the icon.
22-
new Notice('This is a notice!');
23-
});
24-
// Perform additional things with the ribbon
25-
ribbonIconEl.addClass('my-plugin-ribbon-class');
26-
27-
// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
28-
const statusBarItemEl = this.addStatusBarItem();
29-
statusBarItemEl.setText('Status Bar Text');
30-
31-
// This adds a simple command that can be triggered anywhere
32-
this.addCommand({
33-
id: 'open-sample-modal-simple',
34-
name: 'Open sample modal (simple)',
35-
callback: () => {
36-
new SampleModal(this.app).open();
37-
}
38-
});
39-
// This adds an editor command that can perform some operation on the current editor instance
40-
this.addCommand({
41-
id: 'sample-editor-command',
42-
name: 'Sample editor command',
43-
editorCallback: (editor: Editor, view: MarkdownView) => {
44-
console.log(editor.getSelection());
45-
editor.replaceSelection('Sample Editor Command');
46-
}
47-
});
48-
// This adds a complex command that can check whether the current state of the app allows execution of the command
49-
this.addCommand({
50-
id: 'open-sample-modal-complex',
51-
name: 'Open sample modal (complex)',
52-
checkCallback: (checking: boolean) => {
53-
// Conditions to check
54-
const markdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
55-
if (markdownView) {
56-
// If checking is true, we're simply "checking" if the command can be run.
57-
// If checking is false, then we want to actually perform the operation.
58-
if (!checking) {
59-
new SampleModal(this.app).open();
60-
}
61-
62-
// This command will only show up in Command Palette when the check function returns true
63-
return true;
64-
}
65-
}
66-
});
67-
68-
// This adds a settings tab so the user can configure various aspects of the plugin
69-
this.addSettingTab(new SampleSettingTab(this.app, this));
70-
71-
// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
72-
// Using this function will automatically remove the event listener when this plugin is disabled.
73-
this.registerDomEvent(document, 'click', (evt: MouseEvent) => {
74-
console.log('click', evt);
75-
});
76-
77-
// When registering intervals, this function will automatically clear the interval when the plugin is disabled.
78-
this.registerInterval(window.setInterval(() => console.log('setInterval'), 5 * 60 * 1000));
79-
}
80-
81-
onunload() {
82-
83-
}
84-
85-
async loadSettings() {
86-
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
5+
this.registerEvent(
6+
this.app.workspace.on("file-open", () => {
7+
this.app.workspace.activeEditor?.editor?.blur();
8+
})
9+
);
8710
}
8811

89-
async saveSettings() {
90-
await this.saveData(this.settings);
91-
}
92-
}
93-
94-
class SampleModal extends Modal {
95-
constructor(app: App) {
96-
super(app);
97-
}
98-
99-
onOpen() {
100-
const {contentEl} = this;
101-
contentEl.setText('Woah!');
102-
}
103-
104-
onClose() {
105-
const {contentEl} = this;
106-
contentEl.empty();
107-
}
108-
}
109-
110-
class SampleSettingTab extends PluginSettingTab {
111-
plugin: MyPlugin;
112-
113-
constructor(app: App, plugin: MyPlugin) {
114-
super(app, plugin);
115-
this.plugin = plugin;
116-
}
117-
118-
display(): void {
119-
const {containerEl} = this;
120-
121-
containerEl.empty();
122-
123-
new Setting(containerEl)
124-
.setName('Setting #1')
125-
.setDesc('It\'s a secret')
126-
.addText(text => text
127-
.setPlaceholder('Enter your secret')
128-
.setValue(this.plugin.settings.mySetting)
129-
.onChange(async (value) => {
130-
this.plugin.settings.mySetting = value;
131-
await this.plugin.saveSettings();
132-
}));
133-
}
12+
onunload() {}
13413
}

manifest.json

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
{
2-
"id": "sample-plugin",
3-
"name": "Sample Plugin",
2+
"id": "lazy-cursor",
3+
"name": "Lazy Cursor",
44
"version": "1.0.0",
55
"minAppVersion": "0.15.0",
6-
"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.",
7-
"author": "Obsidian",
8-
"authorUrl": "https://obsidian.md",
9-
"fundingUrl": "https://obsidian.md/pricing",
10-
"isDesktopOnly": false
6+
"description": "Hides the cursor when opening a note until you click in the editor.",
7+
"author": "Timo Bechtel",
8+
"authorUrl": "https://github.com/TimoBechtel",
9+
"isDesktopOnly": true
1110
}

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
2-
"name": "obsidian-sample-plugin",
2+
"name": "obsidian-lazy-cursor",
33
"version": "1.0.0",
4-
"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
4+
"description": "Obsidian plugin that initially hides the cursor when opening a note",
55
"main": "main.js",
66
"scripts": {
77
"dev": "node esbuild.config.mjs",
88
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
99
"version": "node version-bump.mjs && git add manifest.json versions.json"
1010
},
1111
"keywords": [],
12-
"author": "",
12+
"author": "Timo Bechtel",
1313
"license": "MIT",
1414
"devDependencies": {
1515
"@types/node": "^16.11.6",

styles.css

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)