Merge pull request #25 from terrastruct/bernie/fix-readme

Update readme, add additional default PATHs

Author: Bernard Xie

README.md

@@ -4,8 +4,7 @@
     D2 Obsidian Plugin
   </h2>
 
-D2 is a modern diagram scripting language thats turns text to diagrams. The source code
-for D2, as well as install instructions and all other information, can be found at
+D2 is a modern diagram scripting language thats turns text to diagrams. The source code for D2, as well as install instructions and all other information, can be found at
 [https://github.com/terrastruct/d2](https://github.com/terrastruct/d2).
 
 [![ci](https://github.com/terrastruct/d2-obsidian/actions/workflows/ci.yml/badge.svg)](https://github.com/terrastruct/d2-obsidian/actions/workflows/ci.yml)
@@ -21,19 +20,16 @@ https://user-images.githubusercontent.com/6413609/205414613-5b2559f1-0645-4432-b
 
 Settings > Community plugins > Browse > Search for "D2"
 
-**important**: [D2](https://github.com/terrastruct/d2) must be installed for this plugin
-to work currently. We will later on introduce a remote API as an option, but currently
-this plugin calls your local installation of D2.
+**important**: [D2](https://github.com/terrastruct/d2) must be installed for this plugin to work currently. We will later on introduce a remote API as an option, but currently this plugin calls your local installation of D2.
 
 ## Configurations
 
 - `Layout engine`: D2 supports multiple layout engines, which can significantly affect the look of your diagram.
 - `Theme ID`: For a list of available themes, visit the [D2 repository](https://github.com/terrastruct/d2/tree/master/d2themes).
-- `Debounce`: Number of milliseconds to wait after a change has made to refresh the
-  diagram (min 100).
-- `Path`: Customize the path to `d2` (optional). We check common places D2 might be
-  installed, along with your system path. However, your OS or setup may require you to
-  input your path to `d2` manually.
+- `Pad`: Number of pixels padded around the rendered diagram.
+- `Sketch mode`: Render the diagram to look like it was sketched by hand.
+- `Debounce`: Number of milliseconds to wait after a change has made to refresh the diagram (min 100).
+- `Path`: Customize the path to `d2` (optional). We check common places D2 might be installed, along with your system path. However, your OS or setup may require you to input your path to `d2` manually. To do so, type `where d2` into your terminal, and copy everything in the path up until `/d2` and paste it into this configuration.
 
 ## Usage
 
@@ -52,14 +48,13 @@ Hello -> World
 
 ## FAQ
 
+- I have D2 installed but I'm running into `D2 Compilation Error: d2: command not found`
+  - The Obsidian plugin may not be able to locate your D2 installation. Get the path to the D2 installation by executing `where d2` in the command line, then copy that path minus the executable itself into the `Path` plugin setting (so if the path is `/usr/local/bin/d2`, then you want to copy `/usr/local/bin`).
 - I have a question or need help.
   - The best way to get help is to ask on [D2 Discord](https://discord.gg/NF6X8K4eDq).
 - I'd like to contribute.
-  - We welcome contributions! Please pick one from an existing Issue, or open one if none
-    exists.
+  - We welcome contributions! Please pick one from an existing Issue, or open one if none exists.
 - I have a feature request, proposal, or bug report.
-  - Please open up a Github Issue. If it's D2-specific, please open it in the [D2
-    repository](https://github.com/terrastruct/d2). If it's specific to this plugin,
-    please open it here.
+  - Please open up a Github Issue. If it's D2-specific, please open it in the [D2 repository](https://github.com/terrastruct/d2). If it's specific to this plugin, please open it here.
 - I have a private inquiry.
   - Please reach out at [hi@d2lang.com](hi@d2lang.com).

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "d2-obsidian",
   "name": "D2",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "minAppVersion": "0.15.0",
   "description": "The official D2 plugin for Obsidian. D2 is a modern diagram scripting language that turns text to diagrams.",
   "author": "Terrastruct",

src/processor.ts

@@ -2,6 +2,7 @@ import { MarkdownPostProcessorContext, ButtonComponent } from "obsidian";
 import { exec, execSync } from "child_process";
 import { delimiter } from "path";
 import debounce from "lodash.debounce";
+import os from "os";
 
 import D2Plugin from "./main";
 
@@ -124,7 +125,15 @@ export class D2Processor {
   };
 
   async generatePreview(source: string, signal: AbortSignal): Promise<string> {
-    const pathArray = [process.env.PATH, "/opt/homebrew/bin"];
+    const pathArray = [process.env.PATH, "/opt/homebrew/bin", "/usr/local/bin"];
+
+    // platform will be win32 even on 64 bit windows
+    if (os.platform() === "win32") {
+      pathArray.push(`C:\Program Files\D2`);
+    } else {
+      pathArray.push(`${process.env.HOME}/.local/bin`);
+    }
+
     let GOPATH = "";
     try {
       GOPATH = execSync("go env GOPATH", {
@@ -143,6 +152,7 @@ export class D2Processor {
     if (this.plugin.settings.d2Path) {
       pathArray.push(this.plugin.settings.d2Path);
     }
+
     const options: any = {
       ...process.env,
       env: {

versions.json

@@ -1,4 +1,5 @@
 {
+  "1.1.1": "0.15.0",
   "1.1.0": "0.15.0",
   "1.0.1": "0.15.0",
   "1.0.0": "0.15.0"