Maintenance

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,14 +3,15 @@ name: Bug report
 about: Create a report to help us improve
 title: "[BUG]"
 labels: bug
-assignees: ''
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -22,10 +23,10 @@ A clear and concise description of what you expected to happen.
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. MacOS]
- - Obsidian Version: [e.g. 0.12.3]
- - Plugin Version: [e.g. 0.1.0]
+**Environment (please complete the following information):**
+ - OS: [e.g. Desktop, iOS, Android]
+ - Obsidian Version: [e.g. 1.1.16]
+ - Plugin Version: [e.g. 1.1.1]
 
 **Additional context**
 Add any other context about the problem here.

.github/workflows/build.yml

@@ -1,16 +1,36 @@
 name: Build
 
 on:
-  pull_request:
   push:
-    branches: "**"
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  release:
+    types:
+      - created
 
 env:
   OBSIDIAN_VERSION: "1.1.16"
   OBSIDIAN_FLATPAK_COMMIT: f885ddeab17171e10486bce93b83e84494614cf654e8c70a237f5294b05b4c55
 
 jobs:
-  build-linux:
+  lint:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install dependencies
+        run: npm ci
+      - name: Lint
+        run: |
+          npm run lint
+  test-on-linux:
     runs-on: ubuntu-22.04
     steps:
       - name: Install Obsidian
@@ -28,17 +48,14 @@ jobs:
           node-version: 18
       - name: Install dependencies
         run: npm ci
-      - name: Lint
-        run: |
-          npm run lint
       - name: Test
         run: |
           npm run build-with-tests
           Xvfb -ac :0 -screen 0 1280x1024x16 &
           export DISPLAY=:0
           export $(dbus-launch)
           npm test
-  build-osx:
+  test-on-osx:
     runs-on: macos-12
     steps:
       - name: Install Obsidian
@@ -55,10 +72,49 @@ jobs:
           node-version: 18
       - name: Install dependencies
         run: npm ci
-      - name: Lint
-        run: |
-          npm run lint
       - name: Test
         run: |
           npm run build-with-tests
           npm test
+  release:
+    if: ${{ github.event_name == 'release' }}
+    runs-on: ubuntu-22.04
+    needs: [lint, test-on-linux, test-on-osx]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Upload main.js
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ github.event.release.upload_url }}
+          asset_path: main.js
+          asset_name: main.js
+          asset_content_type: text/javascript
+      - name: Upload manifest.json
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ github.event.release.upload_url }}
+          asset_path: manifest.json
+          asset_name: manifest.json
+          asset_content_type: application/json
+      - name: Upload styles.css
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ github.event.release.upload_url }}
+          asset_path: styles.css
+          asset_name: styles.css
+          asset_content_type: text/css

jest.config.json

@@ -1,9 +1,15 @@
 {
   "clearMocks": true,
+  "transform": {
+    "\\.ts$": "babel-jest",
+    "\\.spec\\.md$": "./jest/md-spec-transformer.js"
+  },
+  "testRegex": ["/__tests__/.*\\.ts$", "\\.spec\\.md$"],
+  "moduleFileExtensions": ["js", "ts", "md"],
   "globalSetup": "./jest/global-setup.js",
   "globalTeardown": "./jest/global-teardown.js",
   "setupFilesAfterEnv": ["./jest/obsidian-expect.js"],
-  "testEnvironment": "node",
+  "testEnvironment": "./jest/obsidian-environment.js",
   "maxConcurrency": 1,
   "maxWorkers": 1
 }

jest/global-setup.js

@@ -177,26 +177,40 @@ module.exports = async () => {
     debug(`Obsidian exited with code ${code}`);
   });
 
+  debug("Waiting for Obsidian WebSocket connection");
   const obsidianWs = await new Promise((resolve) => {
     wss.once("connection", (ws) => {
-      resolve(ws);
+      debug("Waiting for Obsidian ready message");
+      ws.once("message", (msg) => {
+        if (msg.toString() === "ready") {
+          resolve(ws);
+        }
+      });
     });
   });
+  debug("Obsidian WebSocket ready");
 
   const callbacks = new Map();
 
   obsidianWs.on("message", (message) => {
     const { id, data, error } = JSON.parse(message);
+    debug(`Response from Obsidian ${id}`);
     const cb = callbacks.get(id);
     if (cb) {
       callbacks.delete(id);
       cb(error, data);
+    } else {
+      debug(`Callback not found for ${id}`);
+      process.exit(1);
     }
   });
 
+  debug("Waiting for test environment connection");
   wss.on("connection", (ws) => {
+    debug("Test environment connected");
     ws.on("message", (message) => {
       const { id, type, data } = JSON.parse(message);
+      debug(`Request to Obsidian ${type} ${id}`);
       callbacks.set(id, (error, data) => {
         ws.send(JSON.stringify({ id, error, data }));
       });