Update eslint and connect with prettier

.eslintignore

@@ -1,2 +1,7 @@
 npm node_modules
-build
+build
+main.js
+
+jest.config.js
+
+.eslintrc.js

.eslintrc

@@ -1,20 +1,37 @@
 {
 	"root": true,
+	"ignorePatterns": [
+		"**.js"
+	],
 	"parser": "@typescript-eslint/parser",
-	"plugins": ["@typescript-eslint"],
+	"plugins": [
+		"@typescript-eslint",
+		"prettier"
+	],
 	"extends": [
 		"eslint:recommended",
 		"plugin:@typescript-eslint/eslint-recommended",
 		"plugin:@typescript-eslint/recommended"
 	],
 	"parserOptions": {
-		"sourceType": "module"
+		"sourceType": "module",
+		"project": "./tsconfig.json"
 	},
 	"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"
+		"prettier/prettier": "error",
+		"@typescript-eslint/ban-ts-comment": "warn",
+		"@typescript-eslint/no-unused-vars": [
+			"error",
+			{
+				"argsIgnorePattern": "^_",
+				"varsIgnorePattern": "^_",
+				"caughtErrorsIgnorePattern": "^_"
+			}
+		],
+		"@typescript-eslint/no-explicit-any": [
+			"warn"
+		],
+		// allow prettier to use SmartTabs
+		"no-mixed-spaces-and-tabs": "off"
 	}
-}
+}

.github/workflows/actions.yml

@@ -1,17 +1,33 @@
 name: GitHub Actions
-run-name: Unit testing ${{ github.actor }} changes
-on: [push]
+run-name: PR "${{ github.event.pull_request.title }}" CI Checks
+on:
+  push:
+  pull_request:
+   types: [opened, synchronize]
 jobs:
-    "run-unit-tests":
-        name: "Run unit tests"
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v3
-            - name: "Use node version"
-              uses: actions/setup-node@v3
-              with:
-                  node-version-file: .nvmrc
-            - name: "Install dependencies"
-              run: npm install
-            - name: Run tests
-              run: npm run test
+  "run-unit-tests":
+    name: "Run unit tests"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: "Use node version"
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc
+      - name: "Install dependencies"
+        run: npm install
+      - name: Run tests
+        run: npm run test
+  "lint":
+    name: "Checking for linting errors"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: "Use node version"
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc
+      - name: "Install dependencies"
+        run: npm install
+      - name: Checking linter
+        run: npm run lint

.nvmrc

@@ -1 +1 @@
-16.11
+20.6.0

.prettierrc.json

@@ -6,7 +6,7 @@
 	"useTabs": true,
 	"overrides": [
 		{
-			"files": ".prettierrc",
+			"files": [".prettierrc", ".eslintrc"],
 			"options": { "parser": "json" }
 		}
 	]

README.md

@@ -89,3 +89,13 @@ This plugin is developed in my free time. If you've found it useful, it would ma
 Note that you in no way have to feel any pressure to do this. The plugin is completely free, and will remain free in the unforeseeable future.
 
 [<img style="float:left" src="https://cdn.ko-fi.com/cdn/kofi3.png?v=3" width="200">](https://ko-fi.com/oleeskild)
+
+## Local development
+
+1. Clone this repository into `.obsidian` of your vault (it is recommended to use a test-vault instead of your own!)
+2. (for best compatability, use node version manager and run `nvm install && nvm use`)
+3. Install dependencies with `npm install`
+4. Run with `npm run dev`
+5. You should now be able to enable the plugin in obsidian
+
+Note: this repository uses prettier and eslint to enforce code formatting and style. It is recommended to install these to your IDE for automatic formatting and error highlighting.

main.ts

@@ -65,10 +65,10 @@ const DEFAULT_SETTINGS: DigitalGardenSettings = {
 };
 
 export default class DigitalGarden extends Plugin {
-	settings: DigitalGardenSettings;
-	appVersion: string;
+	settings!: DigitalGardenSettings;
+	appVersion!: string;
 
-	publishModal: PublishModal;
+	publishModal!: PublishModal;
 
 	async onload() {
 		this.appVersion = this.manifest.version;
@@ -114,8 +114,8 @@ export default class DigitalGarden extends Plugin {
 				const activeFile = this.app.workspace.getActiveFile();
 				const event = this.app.metadataCache.on(
 					"changed",
-					async (file, data, cache) => {
-						if (file.path === activeFile.path) {
+					async (file, _data, _cache) => {
+						if (file.path === activeFile?.path) {
 							const successfullyPublished =
 								await this.publishSingleNote();
 							if (successfullyPublished) {
@@ -338,10 +338,15 @@ export default class DigitalGarden extends Plugin {
 		}
 	}
 	async addPublishFlag() {
+		const activeFile = this.app.workspace.getActiveFile();
+		if (activeFile === null) {
+			new Notice("No active file!");
+			return;
+		}
 		const engine = new ObsidianFrontMatterEngine(
 			this.app.vault,
 			this.app.metadataCache,
-			this.app.workspace.getActiveFile(),
+			activeFile,
 		);
 		engine.set("dg-publish", true).apply();
 	}