Skip to content

Commit 7633183

Browse files
authored
Merge pull request #1 from iVariable/format-codeblocks
Proof of concept
2 parents 7f6a793 + c399f4c commit 7633183

File tree

8 files changed

+3383
-207
lines changed

8 files changed

+3383
-207
lines changed

README.md

Lines changed: 19 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,28 @@
1-
## Obsidian Sample Plugin
1+
## Obsidian Format Code plugin
22

3-
This is a sample plugin for Obsidian (https://obsidian.md).
3+
This is a plugin for [Obsidian](https://obsidian.md) that introduces
4+
custom commands to format code.
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-
- Changes the default font color to red using `styles.css`.
12-
- Adds a ribbon icon, which shows a Notice when clicked.
13-
- Adds a command "Open Sample Modal" which opens a Modal.
14-
- Adds a plugin setting tab to the settings page.
15-
- Registers a global click event and output 'click' to the console.
16-
- Registers a global interval which logs 'setInterval' to the console.
17-
18-
### First time developing plugins?
19-
20-
Quick starting guide for new plugin devs:
21-
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.
6+
Currently supports the following languages:
7+
- JSON
8+
- YAML
9+
- HTML
10+
- GraphQL
11+
- TypeScript
4812

4913
### How to use
5014

51-
- Clone this repo.
52-
- `npm i` or `yarn` to install dependencies
53-
- `npm run dev` to start compilation in watch mode.
54-
55-
### Manually installing the plugin
56-
57-
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
15+
![How to use](assets/obsidian-prettier-demo.gif)
5816

59-
### Improve code quality with eslint (optional)
60-
- [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.
61-
- To use eslint with this project, make sure to install eslint from terminal:
62-
- `npm install -g eslint`
63-
- To use eslint to analyze this project use this command:
64-
- `eslint main.ts`
65-
- eslint will then create a report with suggestions for code improvement by file and line number.
66-
- 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:
67-
- `eslint .\src\`
17+
### How to install
6818

19+
Until this plugin is not published in the Obsidian ecosystem you
20+
can install it using [How to develop](#how-to-develop) instructions
6921

70-
### API Documentation
22+
### How to develop
7123

72-
See https://github.com/obsidianmd/obsidian-api
24+
1. Clone the repository to `.obsidian/plugins/obsidian-format-code`
25+
2. `npm i`
26+
3. `npm run dev`
27+
4. Launch Obsidian
28+
5. Enable plugin in the Obsidian settings under "Community plugins" > "Installed plugins"" >"Format code"

assets/obsidian-prettier-demo.gif

584 KB
Loading

main.ts

Lines changed: 53 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,137 +1,62 @@
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'
1+
import {App, Editor, MarkdownView, Notice, Plugin} from 'obsidian';
2+
3+
const prettier = require("prettier");
4+
const plugins = [
5+
require("prettier/parser-babel"),
6+
require("prettier/parser-html"),
7+
require("prettier/parser-yaml"),
8+
require("prettier/parser-graphql"),
9+
require("prettier/parser-typescript")
10+
];
11+
12+
interface Formatter {
13+
name: string;
14+
parser: string;
1115
}
1216

13-
export default class MyPlugin extends Plugin {
14-
settings: MyPluginSettings;
15-
17+
export default class FormatCodePlugin extends Plugin {
1618
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');
19+
let supportedFormats: Formatter[] = [
20+
{
21+
name: "JSON",
22+
parser: "json"
23+
},
24+
{
25+
name: "YAML",
26+
parser: "yaml"
27+
},
28+
{
29+
name: "HTML",
30+
parser: "html"
31+
},
32+
{
33+
name: "GraphQL",
34+
parser: "graphql"
35+
},
36+
{
37+
name: "TypeScript",
38+
parser: "typescript"
4639
}
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();
40+
];
41+
42+
supportedFormats.forEach(x => {
43+
this.addCommand({
44+
id: 'format-prettier-' + x.name,
45+
name: x.name,
46+
editorCallback: (editor: Editor, view: MarkdownView) => {
47+
try {
48+
const formatted = prettier.format(editor.getSelection(), {
49+
semi: false,
50+
parser: x.parser,
51+
plugins: plugins
52+
});
53+
editor.replaceSelection(formatted);
54+
} catch (e) {
55+
console.log(e);
56+
new Notice("Format: " + e);
6057
}
61-
62-
// This command will only show up in Command Palette when the check function returns true
63-
return true;
6458
}
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);
59+
});
7560
});
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());
87-
}
88-
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-
containerEl.createEl('h2', {text: 'Settings for my awesome plugin.'});
124-
125-
new Setting(containerEl)
126-
.setName('Setting #1')
127-
.setDesc('It\'s a secret')
128-
.addText(text => text
129-
.setPlaceholder('Enter your secret')
130-
.setValue(this.plugin.settings.mySetting)
131-
.onChange(async (value) => {
132-
console.log('Secret: ' + value);
133-
this.plugin.settings.mySetting = value;
134-
await this.plugin.saveSettings();
135-
}));
13661
}
13762
}

manifest.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"id": "obsidian-sample-plugin",
3-
"name": "Sample Plugin",
4-
"version": "1.0.1",
2+
"id": "obsidian-format-code",
3+
"name": "Format code",
4+
"version": "0.0.1",
55
"minAppVersion": "0.12.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",
6+
"description": "This plugin introduces commands to format code (internally uses prettier)",
7+
"author": "Vladimir Savenkov",
8+
"authorUrl": "https://github.com/iVariable",
99
"isDesktopOnly": false
1010
}

0 commit comments

Comments
 (0)