chore: stricter tsconfig and README.md edit

.ncurc.json

@@ -0,0 +1,4 @@
+{
+	"upgrade": true,
+	"reject": ["@types/node"]
+}

README.md

@@ -29,6 +29,20 @@ I personally prefer to self-host PostgreSQL on an offshore server to protect my
 
 I did not try the managed providers that I listed above, but they are from reputable companies and provide way more storage and compute power than you will ever need to host the data generated by this plugin.
 
+### Where is my data stored?
+
+The data produced by `postgresql-obsidian` is made available to you under the `obsidian` database schema.
+
+You can use PostgreSQL views to extract and format the information that you need.
+
+### Why should I send my data to a PostgreSQL database?
+
+Sending the metadata of your notes to a PostgreSQL database will allow you to explore it with other tools, such as [Grafana](https://github.com/grafana/grafana/blob/main/README.md).
+
+Here is a screenshot of the Grafana dashboard I made to monitor my personal health:
+
+![Grafana dashboard of clouedoc's health, made using the data produced by the postgresql-obsidian plugin. It features charts of an ok-ish lifestyle.](./assets/grafana-dashboard.png)
+
 ## Contributing
 
 Contributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any contributions you make are **greatly appreciated**!

package.json

@@ -7,6 +7,7 @@
 		"dev": "node esbuild.config.mjs",
 		"build": "tsc && node esbuild.config.mjs production",
 		"version": "node version-bump.mjs && git add manifest.json versions.json",
+		"ncu": "npx npm-check-updates",
 		"lint": "eslint ./src"
 	},
 	"keywords": [
@@ -20,19 +21,19 @@
 	"author": "clouedoc",
 	"license": "MIT",
 	"devDependencies": {
-		"@rushstack/eslint-config": "^2.6.0",
+		"@rushstack/eslint-config": "^2.6.1",
 		"@types/node": "^16.11.6",
 		"@types/pg": "^8.6.5",
-		"@typescript-eslint/eslint-plugin": "^5.2.0",
-		"@typescript-eslint/parser": "^5.2.0",
-		"builtin-modules": "^3.2.0",
-		"esbuild": "0.13.12",
-		"eslint": "^8.17.0",
-		"obsidian": "latest",
-		"obsidian-dataview": "^0.5.34",
+		"@typescript-eslint/eslint-plugin": "^5.29.0",
+		"@typescript-eslint/parser": "^5.29.0",
+		"builtin-modules": "^3.3.0",
+		"esbuild": "0.14.47",
+		"eslint": "^8.18.0",
+		"obsidian": "^0.15.2",
+		"obsidian-dataview": "^0.5.36",
 		"pg": "^8.7.3",
 		"pg-native": "^3.0.0",
-		"tslib": "2.3.1",
-		"typescript": "^4.7.3"
+		"tslib": "2.4.0",
+		"typescript": "^4.7.4"
 	}
 }

src/classes/postgresql-plugin.ts

@@ -6,7 +6,8 @@ import { DataviewApi, getAPI } from "obsidian-dataview";
 import { Client } from "pg";
 
 export class PostgreSQLPlugin extends Plugin {
-	public settings: IPostgresPluginSettings;
+	// the settings are defined in `onload`. We can assert that they are defined
+	public settings!: IPostgresPluginSettings;
 	protected db: Client | undefined;
 
 	public async onload(): Promise<void> {
@@ -18,10 +19,15 @@ export class PostgreSQLPlugin extends Plugin {
 			id: "postgresql-upload-current-file",
 			name: "PostgreSQL: upload current file information",
 			callback: async () => {
-				const dv: DataviewApi = getAPI();
+				const dv: DataviewApi | undefined = getAPI();
+				if (!dv) {
+					// eslint-disable-next-line no-new
+					new Notice("The Dataview API is not available");
+					return;
+				}
 				const db: Client = await this.getDatabaseClient();
 
-				const filepath: string =
+				const filepath: string | undefined =
 					this.app.workspace.getActiveFile()?.path;
 
 				if (!filepath) {
@@ -30,7 +36,14 @@ export class PostgreSQLPlugin extends Plugin {
 					return;
 				}
 
-				const dataviewData: Record<string, unknown> = dv.page(filepath);
+				const dataviewData: Record<string, unknown> | undefined =
+					dv.page(filepath);
+
+				if (!dataviewData) {
+					// eslint-disable-next-line no-new
+					new Notice("Failed to fetch the dataview data");
+					return;
+				}
 
 				delete dataviewData.file;
 				delete dataviewData.position;
@@ -48,7 +61,7 @@ export class PostgreSQLPlugin extends Plugin {
 					);
 				} catch (err) {
 					// eslint-disable-next-line no-new
-					new Notice("PostgreSQL error: " + err.message);
+					new Notice("PostgreSQL error: " + (err as Error).message);
 					throw err;
 				}
 
@@ -83,7 +96,9 @@ export class PostgreSQLPlugin extends Plugin {
 			new Notice("Connected to PostgreSQL");
 		} catch (err) {
 			// eslint-disable-next-line no-new
-			new Notice("PostgreSQL connection error: " + err.message);
+			new Notice(
+				"PostgreSQL connection error: " + (err as Error).message
+			);
 			throw err;
 		}
 

tsconfig.json

@@ -12,7 +12,9 @@
 		"isolatedModules": true,
 		"skipLibCheck": true,
 		"noEmit": true,
-		"lib": ["DOM", "ES5", "ES6", "ES7"]
+		"lib": ["DOM", "ES5", "ES6", "ES7"],
+		"strict": true,
+		"strictNullChecks": true
 	},
 	"include": ["**/*.ts"]
 }