Initial commit

RobTheFiveNine · RobTheFiveNine · commit dd9942d5831a · 2024-05-07T14:43:03.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{js,json,yml}]
+charset = utf-8
+indent_style = space
+indent_size = 2
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: [RobTheFiveNine]
diff --git a/.github/images/example.png b/.github/images/example.png
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,16 @@
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Swap the comments on the following lines if you wish to use zero-installs
+# In that case, don't forget to run `yarn config set enableGlobalCache false`!
+# Documentation here: https://yarnpkg.com/features/caching#zero-installs
+
+#!.yarn/cache
+.pnp.*
+
+# build fragments
+dist/
diff --git a/.yarn/releases/yarn-4.2.1.cjs b/.yarn/releases/yarn-4.2.1.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1 @@
+yarnPath: .yarn/releases/yarn-4.2.1.cjs
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# Obsidian GDScript Syntax Highlighting Plugin
+
+This plugin for Obsidian provides live syntax highlighting for GDScript (the language used in [Godot](https://godotengine.org/)).
+
+An example of the highlighting can be seen below:
+
+![](.github/images/example.png)
+
+## Setup (manual)
+The plugin is going to be submitted to the Obsidian team to hopefully be approved as a community plugin, but for now, if you wish to install the plugin manually.
+
+1. Navigate to the vault you wish to install it in using your file explorer
+2. Navigate into the `.obisidian` directory, and in there, go into the `plugins` directory
+3. Create a new folder in here named `gdscript-syntax-highlighting`
+4. Head over to the [Latest Release](https://github.com/RobTheFiveNine/obsidian-gdscript/releases/latest) and download the `main.js` and `manifest.json` files into the newly created folder.
+5. Open the settings window in Obsidian and enable the plugin in the `Community plugins` section
+
+## License
+This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
diff --git a/manifest.json b/manifest.json
@@ -0,0 +1,11 @@
+{
+    "author":"RobTheFiveNine",
+    "authorUrl": "https://github.com/RobTheFiveNine/obsidian-gdscript",
+    "description": "Adds live GDScript syntax highlighting to code blocks in the Obsidian editor.",
+    "fundingUrl": "https://github.com/sponsors/RobTheFiveNine",
+    "id": "gdscript-syntax-highlighting",
+    "isDesktopOnly": false,
+    "minAppVersion": "1.5.12",
+    "name": "GDScript Syntax Highlighting",
+    "version": "1.0.0"
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,29 @@
+{
+  "name": "obsidian-gdscript",
+  "description": "Adds live GDScript syntax highlighting to code blocks in the Obsidian editor.",
+  "main": "src/main.js",
+  "version": "1.0.0",
+  "author": "RobTheFiveNine",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RobTheFiveNine/obsidian-gdscript"
+  },
+  "license": "MPL-2.0",
+  "packageManager": "yarn@4.2.1",
+  "dependencies": {
+    "codemirror": "^6.0.1",
+    "obsidian": "1.5.7-1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.17.2",
+    "rollup-plugin-copy": "^3.5.0"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "clean": "rimraf dist"
+  }
+}
diff --git a/rollup.config.js b/rollup.config.js
@@ -0,0 +1,26 @@
+import {nodeResolve} from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import copy from 'rollup-plugin-copy';
+
+export default {
+  input: 'src/main.js',
+  output: {
+    dir: 'dist',
+    sourcemap: 'inline',
+    format: 'cjs',
+    exports: 'default'
+  },
+  external: ['obsidian'],
+  plugins: [
+    nodeResolve({browser: true}),
+    commonjs(),
+    copy({
+      targets: [
+        {
+          src: 'manifest.json',
+          dest: 'dist',
+        },
+      ],
+    }),
+  ]
+};
diff --git a/src/main.js b/src/main.js
@@ -0,0 +1,54 @@
+import { Plugin } from 'obsidian';
+
+
+export default class GdscriptSyntaxPlugin extends Plugin {
+    onload() {
+        var self = this;
+
+        // The defineSimpleMode function is not immediately available during
+        // onload, so continue to try and define the language until it is.
+        const setupInterval = setInterval(() => {
+            if (CodeMirror && CodeMirror.defineSimpleMode) {
+                CodeMirror.defineSimpleMode("gdscript", {
+                    start: [
+                        { regex: /\b0x[0-9a-f]+\b/i, token: "number" },
+                        { regex: /\b-?\d+\b/, token: "number" },
+                        { regex: /#.+/, token: 'comment' },
+                        { regex: /\s*(@onready|@export)\b/, token: 'keyword' },
+                        { regex: /\b(?:and|as|assert|break|breakpoint|const|continue|elif|else|enum|for|if|in|is|master|mastersync|match|not|null|or|pass|preload|puppet|puppetsync|remote|remotesync|return|self|setget|static|tool|var|while|yield)\b/, token: 'keyword' },
+                        { regex: /[()\[\]{},]/, token: "meta" },
+
+                        // The words following func, class_name and class should be highlighted as attributes,
+                        // so push onto the definition stack
+                        { regex: /\b(func|class_name|class|extends|signal)\b/, token: "keyword", push: "definition" },
+
+                        { regex: /@?(?:("|')(?:(?!\1)[^\n\\]|\\[\s\S])*\1(?!"|')|"""(?:[^\\]|\\[\s\S])*?""")/, token: "string" },
+                        { regex: /\$[\w\/]+\b/, token: 'variable' },
+                        { regex: /\:[\s]*$/, token: 'operator' },
+                        { regex: /\:[ ]*/, token: 'meta', push: 'var_type' },
+                        { regex: /\->[ ]*/, token: 'operator', push: 'definition' },
+                        { regex: /\+|\*|-|\/|:=|>|<|\^|&|\||%|~|=/, token: "operator" },
+                        { regex: /\b(?:false|true)\b/, token: 'number' },
+                        { regex: /\b[A-Z][A-Z_\d]*\b/, token: 'operator' },
+                    ],
+                    var_type: [
+                        { regex: /(\w+)/, token: 'attribute', pop: true },
+                    ],
+                    definition: [
+                        { regex: /(\w+)/, token: "attribute", pop: true }
+                    ]
+                })
+
+                self.app.workspace.iterateAllLeaves((leaf) => {
+                    leaf.rebuildView();
+                 });
+
+                 clearInterval(setupInterval);
+            }
+        }, 100);
+    }
+
+    onunload() {
+        delete CodeMirror.modes['gdscript'];
+    }
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+yarnPath: .yarn/releases/yarn-4.2.1.cjs`