obsidian-launcher 3.0.1 → 3.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jesse Hines
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,136 @@
-# obsidian-launcher
+# Obsidian Launcher [![](https://img.shields.io/npm/v/obsidian-launcher)](https://www.npmjs.com/package/obsidian-launcher)
 
-TODO
+`obsidian-launcher` is a package for downloading and launching different versions of [Obsidian](https://obsidian.md) for testing Obsidian plugins. It can download and launch different versions of Obsidian, install plugins and themes into Obsidian vaults, and launch sandboxed Obsidian instances with isolated user configuration directories. You can use it as either a JavaScript package or as a command line interface.
+
+The primary use case for this package is to allow [wdio-obsidian-service](../wdio-obsidian-service/README.md) to automatically download Obsidian when testing plugins with WebdriverIO. However, it can also be used as a stand-alone package if you want to use the CLI to compare Obsidian versions during plugin development.
+
+## Example Usage
+You can run the CLI via `npx`, e.g.:
+```bash
+npx obsidian-launcher watch --version 1.8.10 --copy --plugin . test/vault
+```
+This will download and launch Obsidian 1.8.10 with a sandboxed configuration directory so you don't need to worry about it interfering with your system Obsidian installation. You can even launch multiple different versions of Obsidian side-by-side. See [below](#cli) for CLI docs.
+
+To use the JavaScript API, use the `ObsidianLauncher` class, e.g.:
+```js
+import ObsidianLauncher from "obsidian-launcher"
+const launcher = new ObsidianLauncher();
+const {proc} = await launcher.launch({
+    appVersion: "1.8.10",
+    vault: "path/to/my/vault",
+    copy: true, // open a copy of the vault in Obsidian
+    plugins: [
+        "path/to/my/plugin", // install a local plugin
+        {id: "dataview"}, // install a community plugin
+    ],
+})
+```
+
+## Obsidian App vs Installer Versions
+Obsidian Desktop is distributed in two parts, the "installer" which is the executable containing Electron, and the "app" which is a bundle of JavaScript containing the Obsidian code. Obsidian's self-update system only updates the app JS bundle, and not the base installer/Electron version. This makes Obsidian's auto-update fast as it only needs to download a few MiB of JS instead of all of Electron. But, it means different users with the same Obsidian app version may be running on different versions of Electron, which can cause subtle differences in plugin behavior. Most ObsidianLauncher methods take both an `appVersion` and an `installerVersion` parameter, allowing you to test the same Obsidian app version on different versions of Electron.
+
+`appVersion` can be set to one of:
+- a specific version string like "1.7.7"
+- "latest": run the latest non-beta Obsidian version
+- "latest-beta": run the latest beta Obsidian version (or latest if there is no current beta)
+    - To download Obsidian beta versions you'll need to have an Obsidian Insiders account
+- "earliest": run the `minAppVersion` set in your plugin's `manifest.json`
+
+`installerVersion` can be set to one of:
+- a specific version string like "1.7.7"
+- "latest": run the latest Obsidian installer compatible with `appVersion`
+- "earliest": run the oldest Obsidian installer compatible with `appVersion`
+
+### Platform Support
+`obsidian-launcher` works for Obsidian Desktop on Windows, Linux, and MacOS.
+
+Windows firewall will sometimes complain about NodeJS on launch, you can just cancel the popup it makes.
+
+## API Docs
+API docs for the package are available [here](https://jesse-r-s-hines.github.io/wdio-obsidian-service/obsidian-launcher/README.html).
+
+## CLI
+```bash
+npx obsidian-launcher [subcommand] ...
+```
+
+### Plugin and Theme format
+Several commands can take a list of plugins and themes to install. You can specify the `--plugin` and `--theme` arguments multiple times to install multiple plugins/themes. The format should be one of:
+- `<path>`: Path to a local plugin/theme to install
+- `repo:<github-repo>`: GitHub repo of the plugin/theme to install, e.g. `repo:SilentVoid13/Templater`
+- `id:<community-id>`: For plugins, id of a community plugin, e.g. `id:templater-obsidian`
+- `name:<community-name>`: For themes, name of a community theme, e.g. `name:Minimal`
+
+You can install a specific version of a plugin or theme with `-p id:myplugin@1.2.3`.
+
+### launch
+Download and launch Obsidian, opening the specified vault.
+
+The Obsidian instance will have a sandboxed configuration directory. You can use this command to compare plugin behavior on different versions of Obsidian without messing with your system installation of Obsidian.
+
+You can pass arguments through to the Obsidian executable using `--`:
+```bash
+npx obsidian-launcher launch ./vault -- --remote-debugging-port=9222
+```
+
+Arguments:
+- `vault`: Vault to open
+
+Options:
+- `-v, --version <version>`: Obsidian app version to run (default: "latest")
+- `-i, --installer <version>`: Obsidian installer version to run (default: "earliest")
+- `-p, --plugin <plugin>`: Plugin(s) to install
+- `-t, --theme <plugin>`: Theme(s) to install
+- `--copy`: Copy the vault first
+- `-c, --cache <cache>`: Directory to use as the download cache (default: OBSIDIAN_CACHE env var or ~/.obsidian-cache)
+
+### watch
+Downloads Obsidian and opens a vault, then watches for changes to plugins and themes.
+
+Takes the same arguments as the `launch` command but watches for changes to any local plugins or themes and updates the vault. Automatically installs `pjeby/hot-reload` so plugins will hot reload as they are updated.
+
+Arguments:
+- `vault`: Vault to open
+
+Options:
+- `-v, --version <version>`: Obsidian app version to run (default: "latest")
+- `-i, --installer <version>`: Obsidian installer version to run (default: "latest")
+- `-p, --plugin <plugin>`: Plugin(s) to install
+- `-t, --theme <plugin>`: Theme to install
+- `--copy`: Copy the vault first
+- `-c, --cache <cache>`: Directory to use as the download cache (default: OBSIDIAN_CACHE env var or ~/.obsidian-cache)
+
+### install
+Install plugins and themes into an Obsidian vault.
+
+Arguments:
+- `vault`: Vault to install into
+
+Options:
+- `-p, --plugin <plugin>`: Plugin(s) to install
+- `-t, --theme <plugin>`: Theme(s) to install.
+- `-c, --cache <cache>`: Directory to use as the download cache (default: OBSIDIAN_CACHE env var or ~/.obsidian-cache)
+
+### download
+Download Obsidian to the cache.
+
+Pre-download Obsidian to the cache. Pass asset to select what variant to download, which can be one of:
+- app: Download the desktop app JS bundle
+- installer: Download the desktop installer
+- desktop: Download both the desktop app bundle and installer (the default)
+- apk: Download the mobile app APK file
+
+Arguments:
+- `asset`: Obsidian asset to download (default: "desktop")
+
+Options:
+- `-v, --version <version>`: Obsidian version (default: "latest")
+- `-i, --installer <version>`: Obsidian installer version (default: "earliest")
+- `--platform <platform>`: Platform of the installer, one of linux, win32, darwin. (default: system platform)
+- `--arch <arch>`: Architecture of the installer, one of arm64, ia32, x64. (default: system arch)
+- `-c, --cache <cache>`: Directory to use as the download cache (default: OBSIDIAN_CACHE env var or ~/.obsidian-cache)
+
+## Obsidian CLI
+Obsidian has its [own CLI](https://obsidian.md/help/cli) which connects to the running Obsidian instance and lets you run commands against it. The Obsidian CLI will still work with Obsidian instances launched via obsidian-launcher as long as you only run one Obsidian instance at a time. With multiple instances, obsidian-launcher's sandboxing interferes with the Obsidian CLI connection.
+
+Note, the Obsidian CLI requires Obsidian app>=1.12.7 with installer>=1.12.7

package/dist/7z.cjs

@@ -0,0 +1,41 @@
+"use strict"; function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }require('./chunk-UMVJ7W6K.cjs');
+
+// src/7z.js
+var _path = require('path'); var _path2 = _interopRequireDefault(_path);
+var _7zwasm = require('7z-wasm'); var _7zwasm2 = _interopRequireDefault(_7zwasm);
+async function main() {
+  const sevenZip = await _7zwasm2.default.default({
+    // stdin: () => {},
+    stdout: (charCode) => {
+      if (charCode !== null) {
+        process.stdout.write(String.fromCharCode(charCode));
+      }
+    },
+    quit: (code) => {
+      if (code) {
+        process.exit(code);
+      }
+    }
+  });
+  const chmodOrig = sevenZip.FS.chmod.bind(sevenZip.FS);
+  sevenZip.FS.chmod = function(path2, mode, dontFollow) {
+    if (!mode) {
+      return;
+    }
+    chmodOrig(path2, mode, dontFollow);
+  };
+  const cwd = process.cwd();
+  const hostRoot = _path2.default.parse(cwd).root;
+  const hostDir = _path2.default.relative(hostRoot, cwd).split(_path2.default.sep).join("/");
+  const mountRoot = "/nodefs";
+  sevenZip.FS.mkdir(mountRoot);
+  sevenZip.FS.mount(sevenZip.NODEFS, { root: hostRoot }, mountRoot);
+  sevenZip.FS.chdir(mountRoot + "/" + hostDir);
+  var args = process.argv.slice(2);
+  sevenZip.callMain(args);
+}
+main().catch((e) => {
+  console.error(e);
+  process.exit(-1);
+});
+//# sourceMappingURL=7z.cjs.map

package/dist/7z.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/wdio-obsidian-service/wdio-obsidian-service/packages/obsidian-launcher/dist/7z.cjs","../src/7z.js"],"names":["path"],"mappings":"AAAA,6IAA6B;AAC7B;AACA;ACGA,wEAAiB;AACjB,iFAAqB;AAErB,MAAA,SAAe,IAAA,CAAA,EAAO;AAClB,EAAA,MAAM,SAAA,EAAW,MAAM,gBAAA,CAAS,OAAA,CAAQ;AAAA;AAAA,IAEpC,MAAA,EAAQ,CAAC,QAAA,EAAA,GAAa;AAClB,MAAA,GAAA,CAAI,SAAA,IAAa,IAAA,EAAM;AACnB,QAAA,OAAA,CAAQ,MAAA,CAAO,KAAA,CAAM,MAAA,CAAO,YAAA,CAAa,QAAQ,CAAC,CAAA;AAAA,MACtD;AAAA,IACJ,CAAA;AAAA,IACA,IAAA,EAAM,CAAC,IAAA,EAAA,GAAS;AACZ,MAAA,GAAA,CAAI,IAAA,EAAM;AACN,QAAA,OAAA,CAAQ,IAAA,CAAK,IAAI,CAAA;AAAA,MACrB;AAAA,IACJ;AAAA,EACJ,CAAC,CAAA;AAED,EAAA,MAAM,UAAA,EAAY,QAAA,CAAS,EAAA,CAAG,KAAA,CAAM,IAAA,CAAK,QAAA,CAAS,EAAE,CAAA;AACpD,EAAA,QAAA,CAAS,EAAA,CAAG,MAAA,EAAQ,QAAA,CAASA,KAAAA,EAAM,IAAA,EAAM,UAAA,EAAY;AACjD,IAAA,GAAA,CAAI,CAAC,IAAA,EAAM;AACP,MAAA,MAAA;AAAA,IACJ;AACA,IAAA,SAAA,CAAUA,KAAAA,EAAM,IAAA,EAAM,UAAU,CAAA;AAAA,EACpC,CAAA;AAEA,EAAA,MAAM,IAAA,EAAM,OAAA,CAAQ,GAAA,CAAI,CAAA;AACxB,EAAA,MAAM,SAAA,EAAW,cAAA,CAAK,KAAA,CAAM,GAAG,CAAA,CAAE,IAAA;AACjC,EAAA,MAAM,QAAA,EAAU,cAAA,CAAK,QAAA,CAAS,QAAA,EAAU,GAAG,CAAA,CAAE,KAAA,CAAM,cAAA,CAAK,GAAG,CAAA,CAAE,IAAA,CAAK,GAAG,CAAA;AACrE,EAAA,MAAM,UAAA,EAAY,SAAA;AAClB,EAAA,QAAA,CAAS,EAAA,CAAG,KAAA,CAAM,SAAS,CAAA;AAC3B,EAAA,QAAA,CAAS,EAAA,CAAG,KAAA,CAAM,QAAA,CAAS,MAAA,EAAQ,EAAE,IAAA,EAAM,SAAS,CAAA,EAAG,SAAS,CAAA;AAChE,EAAA,QAAA,CAAS,EAAA,CAAG,KAAA,CAAM,UAAA,EAAY,IAAA,EAAM,OAAO,CAAA;AAE3C,EAAA,IAAI,KAAA,EAAO,OAAA,CAAQ,IAAA,CAAK,KAAA,CAAM,CAAC,CAAA;AAC/B,EAAA,QAAA,CAAS,QAAA,CAAS,IAAI,CAAA;AAC1B;AAEA,IAAA,CAAK,CAAA,CAAE,KAAA,CAAM,CAAA,CAAA,EAAA,GAAK;AACd,EAAA,OAAA,CAAQ,KAAA,CAAM,CAAC,CAAA;AACf,EAAA,OAAA,CAAQ,IAAA,CAAK,CAAA,CAAE,CAAA;AACnB,CAAC,CAAA","file":"/home/runner/work/wdio-obsidian-service/wdio-obsidian-service/packages/obsidian-launcher/dist/7z.cjs","sourcesContent":[null,"/**\n * Script wrapper for 7z-wasm. 7z-wasm comes with it's own CLI, but getting the binary path can be flaky depending on\n * how wdio-obsidian-service is installed. This also lets us customize it a bit. This does need to be called as a\n * subprocess to avoid blocking the main thread.\n */\nimport path from \"path\";\nimport SevenZip from \"7z-wasm\"\n\nasync function main() {\n    const sevenZip = await SevenZip.default({\n        // stdin: () => {},\n        stdout: (charCode) => {\n            if (charCode !== null) {\n                process.stdout.write(String.fromCharCode(charCode));\n            }\n        },\n        quit: (code) => {\n            if (code) {\n                process.exit(code);\n            }\n        }\n    });\n    // HACK: The WASM 7-Zip sets file mode to 000 when extracting tar archives, making it impossible to extract sub-folders\n    const chmodOrig = sevenZip.FS.chmod.bind(sevenZip.FS);\n    sevenZip.FS.chmod = function(path, mode, dontFollow) {\n        if (!mode) {\n            return;\n        }\n        chmodOrig(path, mode, dontFollow);\n    };\n\n    const cwd = process.cwd();\n    const hostRoot = path.parse(cwd).root;\n    const hostDir = path.relative(hostRoot, cwd).split(path.sep).join(\"/\");\n    const mountRoot = \"/nodefs\";\n    sevenZip.FS.mkdir(mountRoot);\n    sevenZip.FS.mount(sevenZip.NODEFS, { root: hostRoot }, mountRoot);\n    sevenZip.FS.chdir(mountRoot + \"/\" + hostDir);\n\n    var args = process.argv.slice(2);\n    sevenZip.callMain(args);\n}\n\nmain().catch(e => {\n    console.error(e);\n    process.exit(-1);\n});\n"]}

package/dist/7z.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/7z.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/7z.js

@@ -0,0 +1,39 @@
+// src/7z.js
+import path from "path";
+import SevenZip from "7z-wasm";
+async function main() {
+  const sevenZip = await SevenZip.default({
+    // stdin: () => {},
+    stdout: (charCode) => {
+      if (charCode !== null) {
+        process.stdout.write(String.fromCharCode(charCode));
+      }
+    },
+    quit: (code) => {
+      if (code) {
+        process.exit(code);
+      }
+    }
+  });
+  const chmodOrig = sevenZip.FS.chmod.bind(sevenZip.FS);
+  sevenZip.FS.chmod = function(path2, mode, dontFollow) {
+    if (!mode) {
+      return;
+    }
+    chmodOrig(path2, mode, dontFollow);
+  };
+  const cwd = process.cwd();
+  const hostRoot = path.parse(cwd).root;
+  const hostDir = path.relative(hostRoot, cwd).split(path.sep).join("/");
+  const mountRoot = "/nodefs";
+  sevenZip.FS.mkdir(mountRoot);
+  sevenZip.FS.mount(sevenZip.NODEFS, { root: hostRoot }, mountRoot);
+  sevenZip.FS.chdir(mountRoot + "/" + hostDir);
+  var args = process.argv.slice(2);
+  sevenZip.callMain(args);
+}
+main().catch((e) => {
+  console.error(e);
+  process.exit(-1);
+});
+//# sourceMappingURL=7z.js.map

package/dist/7z.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/7z.js"],"sourcesContent":["/**\n * Script wrapper for 7z-wasm. 7z-wasm comes with it's own CLI, but getting the binary path can be flaky depending on\n * how wdio-obsidian-service is installed. This also lets us customize it a bit. This does need to be called as a\n * subprocess to avoid blocking the main thread.\n */\nimport path from \"path\";\nimport SevenZip from \"7z-wasm\"\n\nasync function main() {\n    const sevenZip = await SevenZip.default({\n        // stdin: () => {},\n        stdout: (charCode) => {\n            if (charCode !== null) {\n                process.stdout.write(String.fromCharCode(charCode));\n            }\n        },\n        quit: (code) => {\n            if (code) {\n                process.exit(code);\n            }\n        }\n    });\n    // HACK: The WASM 7-Zip sets file mode to 000 when extracting tar archives, making it impossible to extract sub-folders\n    const chmodOrig = sevenZip.FS.chmod.bind(sevenZip.FS);\n    sevenZip.FS.chmod = function(path, mode, dontFollow) {\n        if (!mode) {\n            return;\n        }\n        chmodOrig(path, mode, dontFollow);\n    };\n\n    const cwd = process.cwd();\n    const hostRoot = path.parse(cwd).root;\n    const hostDir = path.relative(hostRoot, cwd).split(path.sep).join(\"/\");\n    const mountRoot = \"/nodefs\";\n    sevenZip.FS.mkdir(mountRoot);\n    sevenZip.FS.mount(sevenZip.NODEFS, { root: hostRoot }, mountRoot);\n    sevenZip.FS.chdir(mountRoot + \"/\" + hostDir);\n\n    var args = process.argv.slice(2);\n    sevenZip.callMain(args);\n}\n\nmain().catch(e => {\n    console.error(e);\n    process.exit(-1);\n});\n"],"mappings":";AAKA,OAAO,UAAU;AACjB,OAAO,cAAc;AAErB,eAAe,OAAO;AAClB,QAAM,WAAW,MAAM,SAAS,QAAQ;AAAA;AAAA,IAEpC,QAAQ,CAAC,aAAa;AAClB,UAAI,aAAa,MAAM;AACnB,gBAAQ,OAAO,MAAM,OAAO,aAAa,QAAQ,CAAC;AAAA,MACtD;AAAA,IACJ;AAAA,IACA,MAAM,CAAC,SAAS;AACZ,UAAI,MAAM;AACN,gBAAQ,KAAK,IAAI;AAAA,MACrB;AAAA,IACJ;AAAA,EACJ,CAAC;AAED,QAAM,YAAY,SAAS,GAAG,MAAM,KAAK,SAAS,EAAE;AACpD,WAAS,GAAG,QAAQ,SAASA,OAAM,MAAM,YAAY;AACjD,QAAI,CAAC,MAAM;AACP;AAAA,IACJ;AACA,cAAUA,OAAM,MAAM,UAAU;AAAA,EACpC;AAEA,QAAM,MAAM,QAAQ,IAAI;AACxB,QAAM,WAAW,KAAK,MAAM,GAAG,EAAE;AACjC,QAAM,UAAU,KAAK,SAAS,UAAU,GAAG,EAAE,MAAM,KAAK,GAAG,EAAE,KAAK,GAAG;AACrE,QAAM,YAAY;AAClB,WAAS,GAAG,MAAM,SAAS;AAC3B,WAAS,GAAG,MAAM,SAAS,QAAQ,EAAE,MAAM,SAAS,GAAG,SAAS;AAChE,WAAS,GAAG,MAAM,YAAY,MAAM,OAAO;AAE3C,MAAI,OAAO,QAAQ,KAAK,MAAM,CAAC;AAC/B,WAAS,SAAS,IAAI;AAC1B;AAEA,KAAK,EAAE,MAAM,OAAK;AACd,UAAQ,MAAM,CAAC;AACf,UAAQ,KAAK,EAAE;AACnB,CAAC;","names":["path"]}