This commit is contained in:
Cleon 2022-11-23 00:31:32 +13:00
commit 7e9293653f
15 changed files with 4112 additions and 0 deletions

10
.editorconfig Normal file
View file

@ -0,0 +1,10 @@
# top-most EditorConfig file
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = tab
indent_size = 4
tab_width = 4

2
.eslintignore Normal file
View file

@ -0,0 +1,2 @@
npm node_modules
build

23
.eslintrc Normal file
View file

@ -0,0 +1,23 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"env": { "node": true },
"plugins": [
"@typescript-eslint"
],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended"
],
"parserOptions": {
"sourceType": "module"
},
"rules": {
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": ["error", { "args": "none" }],
"@typescript-eslint/ban-ts-comment": "off",
"no-prototype-builtins": "off",
"@typescript-eslint/no-empty-function": "off"
}
}

25
.gitignore vendored Normal file
View file

@ -0,0 +1,25 @@
# vscode
.vscode
# Intellij
*.iml
.idea
# npm
node_modules
# Don't include the compiled main.js file in the repo.
# They should be uploaded to GitHub releases instead.
main.js
# Exclude sourcemaps
*.map
# obsidian
data.json
# Exclude macOS Finder (System Explorer) View States
.DS_Store
# Test vault
test-vault

1
.npmrc Normal file
View file

@ -0,0 +1 @@
tag-version-prefix=""

73
README.md Normal file
View file

@ -0,0 +1,73 @@
# Obsidian Sample Plugin
This is a sample plugin for Obsidian (https://obsidian.md).
This project uses Typescript to provide type checking and documentation.
The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
This sample plugin demonstrates some of the basic functionality the plugin API can do.
- Changes the default font color to red using `styles.css`.
- Adds a ribbon icon, which shows a Notice when clicked.
- Adds a command "Open Sample Modal" which opens a Modal.
- Adds a plugin setting tab to the settings page.
- Registers a global click event and output 'click' to the console.
- Registers a global interval which logs 'setInterval' to the console.
## First time developing plugins?
Quick starting guide for new plugin devs:
- 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.
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
- Install NodeJS, then run `npm i` in the command line under your repo folder.
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
- Reload Obsidian to load the new version of your plugin.
- Enable plugin in settings window.
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
## Releasing new releases
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
- 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.
- 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
- 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.
- Publish the release.
> 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`.
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
## Adding your plugin to the community plugin list
- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
- Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo.
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
## How to use
- Clone this repo.
- `npm i` or `yarn` to install dependencies
- `npm run dev` to start compilation in watch mode.
## Manually installing the plugin
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
## Improve code quality with eslint (optional)
- [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.
- To use eslint with this project, make sure to install eslint from terminal:
- `npm install -g eslint`
- To use eslint to analyze this project use this command:
- `eslint main.ts`
- eslint will then create a report with suggestions for code improvement by file and line number.
- 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:
- `eslint .\src\`
## API Documentation
See https://github.com/obsidianmd/obsidian-api

54
esbuild.config.mjs Normal file
View file

@ -0,0 +1,54 @@
import esbuild from "esbuild";
import process from "process";
import builtins from 'builtin-modules'
import copyStaticFiles from 'esbuild-copy-static-files';
const banner =
`/*
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
if you want to view the source, please visit the github repository of this plugin
*/
`;
const prod = (process.argv[2] === 'production');
esbuild.build({
banner: {
js: banner,
},
entryPoints: ['main.ts'],
bundle: true,
external: [
'obsidian',
'electron',
'@codemirror/autocomplete',
'@codemirror/collab',
'@codemirror/commands',
'@codemirror/language',
'@codemirror/lint',
'@codemirror/search',
'@codemirror/state',
'@codemirror/view',
'@lezer/common',
'@lezer/highlight',
'@lezer/lr',
...builtins],
format: 'cjs',
watch: !prod,
target: 'es2018',
logLevel: "info",
sourcemap: prod ? false : 'inline',
treeShaking: true,
minify: prod,
outfile: prod ? './dist/main.js' : './test-vault/.obsidian/plugins/meld-build/main.js',
plugins:[
// copyStaticFiles({
// src: './src/styles.css',
// dest: prod ? './dist/styles.css' : './test-vault/.obsidian/plugins/meld-encrypt/styles.css',
// }),
copyStaticFiles({
src: './manifest.json',
dest: prod ? './dist/manifest.json' : './test-vault/.obsidian/plugins/meld-build/manifest.json',
}),
]
}).catch(() => process.exit(1));

242
main.ts Normal file
View file

@ -0,0 +1,242 @@
import { CachedMetadata, Editor, MarkdownView, Notice, Plugin, TFile } from 'obsidian';
// Remember to rename these classes and interfaces!
interface MyPluginSettings {
mySetting: string;
}
const DEFAULT_SETTINGS: MyPluginSettings = {
mySetting: 'default'
}
export default class MyPlugin extends Plugin {
settings: MyPluginSettings;
async onload() {
await this.loadSettings();
this.addCommand({
id: 'meld-build-run',
name: 'Run',
editorCallback: (editor: Editor, view: MarkdownView) => {
//editor.replaceSelection('Sample Editor Command');
const b = new Builder();
b.compile(editor, view.file);
b.run();
}
});
}
onunload() {
}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
}
async saveSettings() {
await this.saveData(this.settings);
}
}
class DataSet{
name: string;
columns: string[] = [];
rows: string[][] = [];
}
interface ICompiled{
name: string;
codeBlocks: string[];
data: DataSet[]
}
export class Builder{
private compiled : ICompiled;
compile(editor: Editor, file: TFile) {
const fileCache = app.metadataCache.getFileCache(file);
console.log({fileCache});
this.compiled = {
name: file.basename,
codeBlocks: fileCache ? this.fetchCodeBlocks(editor, fileCache) : [],
data: fileCache ? this.fetchData(editor, fileCache) : [],
};
}
private fetchData(editor: Editor, fileCache: CachedMetadata): DataSet[] {
const result: DataSet[] = [];
if (!fileCache.sections){
return result;
}
let headingIdx = -1;
let lastHeading = '';
for (let i = 0; i < fileCache.sections.length; i++) {
const section = fileCache.sections[i];
if (section.type == 'heading' ){
headingIdx++;
lastHeading = fileCache.headings?.at(headingIdx)?.heading ?? '?';
console.debug({lastHeading});
}
if (section.type == 'table' ){
const from = editor.offsetToPos(section.position.start.offset);
const to = editor.offsetToPos(section.position.end.offset);
const table = editor.getRange( from, to );
const data: DataSet = new DataSet();
data.name = lastHeading;
const tableLines = table.split('\n').map( e=>e.trim().slice(1,-1).trim());
console.debug(tableLines);
data.columns = tableLines.first()?.split('|').map( e=>e.trim()) ?? [];
for (let i = 1; i < tableLines.length; i++) {
const line = tableLines[i];
if (line.startsWith('---') ){
continue;
}
if (line.startsWith('|') && line.endsWith('|')){
continue;
}
const row = line.split('|').map( e=>e.trim());
data.rows.push(row);
}
result.push( data );
}
}
return result;
}
private fetchCodeBlocks(editor: Editor, cache: CachedMetadata): string[] {
const result: string[] = [];
cache.sections?.forEach(section => {
if (section.type != 'code'){
return;
}
const from = editor.offsetToPos(section.position.start.offset);
const to = editor.offsetToPos(section.position.end.offset);
const code = editor.getRange( from, to );
let lines = code.split('\n');
if (lines.length <= 2){
return;
}
if ( !['```js', '```javascript'].find( e=> e.startsWith( lines[0].toLowerCase() ) )){
return;
}
// remove first and last lines
lines = lines.slice(1,-1)
result.push(...lines);
});
return result;
}
private fetchHelperCode(): string{
// const result:unknown = {};
// result.log = (o) => console.log(o);
let result = `
const $={};
$.log = console.log;
`
;
// //Sum.. not needed
// result += `
// $.sum = function() {
// return [...arguments].reduce( (c,p) => parseFloat(c) + parseFloat(p), 0.0 )
// }
// `
// load data sets
result += `$.data = {\n`;
//${JSON.stringify(d)}
this.compiled.data.forEach(d => {
const dataSetName = JSON.stringify(d.name.toLowerCase().replace(' ', '_').trim());
result += ` ${dataSetName} : [\n`
for (let i = 0; i < d.rows.length; i++) {
const r = d.rows[i];
result += ' {';
for (let j = 0; j < d.columns.length; j++) {
const c = d.columns[j];
const valAsNum = parseFloat(r[j]);
const value = isNaN(valAsNum) ? JSON.stringify(r[j]) : valAsNum;
result += `'${c}':${value},`
}
result += '},\n';
}
result += ` ],\n`
});
result += `}\n`;
// return
return result;
}
run() {
console.debug(this.compiled);
const scopedCode = this.fetchHelperCode() + this.compiled.codeBlocks.join('\n');
console.log(scopedCode);
try{
eval(scopedCode);
}catch(e){
console.error(e);
new Notice(e);
}
}
}
// class SampleModal extends Modal {
// constructor(app: App) {
// super(app);
// }
// onOpen() {
// const {contentEl} = this;
// contentEl.setText('Woah!');
// }
// onClose() {
// const {contentEl} = this;
// contentEl.empty();
// }
// }
// class SampleSettingTab extends PluginSettingTab {
// plugin: MyPlugin;
// constructor(app: App, plugin: MyPlugin) {
// super(app, plugin);
// this.plugin = plugin;
// }
// display(): void {
// const {containerEl} = this;
// containerEl.empty();
// containerEl.createEl('h2', {text: 'Settings for my awesome plugin.'});
// new Setting(containerEl)
// .setName('Setting #1')
// .setDesc('It\'s a secret')
// .addText(text => text
// .setPlaceholder('Enter your secret')
// .setValue(this.plugin.settings.mySetting)
// .onChange(async (value) => {
// console.log('Secret: ' + value);
// this.plugin.settings.mySetting = value;
// await this.plugin.saveSettings();
// }));
// }
// }

10
manifest.json Normal file
View file

@ -0,0 +1,10 @@
{
"id": "meld-build",
"name": "Meld Builder",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "",
"author": "meld-cp",
"authorUrl": "https://github.com/meld-cp/",
"isDesktopOnly": false
}

3598
package-lock.json generated Normal file

File diff suppressed because it is too large Load diff

25
package.json Normal file
View file

@ -0,0 +1,25 @@
{
"name": "meld-build-obsidian-plugin",
"version": "1.0.0",
"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
"main": "main.js",
"scripts": {
"dev": "node esbuild.config.mjs",
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
"version": "node version-bump.mjs && git add manifest.json versions.json"
},
"keywords": [],
"author": "",
"license": "MIT",
"devDependencies": {
"@types/node": "^16.11.6",
"@typescript-eslint/eslint-plugin": "5.29.0",
"@typescript-eslint/parser": "5.29.0",
"builtin-modules": "3.3.0",
"esbuild": "0.14.47",
"esbuild-copy-static-files": "^0.1.0",
"obsidian": "latest",
"tslib": "2.4.0",
"typescript": "4.7.4"
}
}

8
styles.css Normal file
View file

@ -0,0 +1,8 @@
/*
This CSS file will be included with your plugin, and
available in the app when your plugin is enabled.
If your plugin does not need CSS, delete this file.
*/

24
tsconfig.json Normal file
View file

@ -0,0 +1,24 @@
{
"compilerOptions": {
"baseUrl": ".",
"inlineSourceMap": true,
"inlineSources": true,
"module": "ESNext",
"target": "ES6",
"allowJs": true,
"noImplicitAny": true,
"moduleResolution": "node",
"importHelpers": true,
"isolatedModules": true,
"strictNullChecks": true,
"lib": [
"DOM",
"ES5",
"ES6",
"ES7"
]
},
"include": [
"**/*.ts"
]
}

14
version-bump.mjs Normal file
View file

@ -0,0 +1,14 @@
import { readFileSync, writeFileSync } from "fs";
const targetVersion = process.env.npm_package_version;
// read minAppVersion from manifest.json and bump version to target version
let manifest = JSON.parse(readFileSync("manifest.json", "utf8"));
const { minAppVersion } = manifest;
manifest.version = targetVersion;
writeFileSync("manifest.json", JSON.stringify(manifest, null, "\t"));
// update versions.json with target version and minAppVersion from manifest.json
let versions = JSON.parse(readFileSync("versions.json", "utf8"));
versions[targetVersion] = minAppVersion;
writeFileSync("versions.json", JSON.stringify(versions, null, "\t"));

3
versions.json Normal file
View file

@ -0,0 +1,3 @@
{
"1.0.0": "0.15.0"
}