joplin-plugin-ridgeline 0.2.7 → 0.2.9

package/README.md

@@ -19,7 +19,7 @@ Ridgeline draws a compact stack of thin bars down the edge of your note — one
 ## Features
 
 - **Compact level-encoded minimap.** One thin bar per heading; the bar length encodes the heading level (H1 longest … H6 shortest), so the note's structure reads at a glance from a sliver of edge space.
-- **Live current-section tracking.** The bar for the section at the top of the viewport is brightened and thickened and follows your scrolling in real time, centred in its slot so it never looks like it dropped toward a neighbour.
+- **Live current-section tracking.** The bar for the section at the top of the viewport is brightened and thickened and follows your scrolling in real time.
 - **Hover-intent table of contents.** Let the pointer rest on the bars (a short dwell, so a mouse merely crossing the strip never pops it open) and the stack expands into a full clickable outline, indented by level, with the current heading highlighted. Click a bar or a row to jump.
 - **Editor and viewer, in step.** The strip is drawn in both the raw Markdown editor and the rendered note viewer, and a jump from either pane moves both.
 - **Overlay or reserve.** Draw the strip over the text, or reserve a thin margin so it never overlaps a word — set independently for the editor and the viewer.
@@ -36,7 +36,7 @@ To install the file by hand instead, download `io.github.pmslava.ridgeline.jpl`
 
 ## Settings
 
-All settings live under **Settings → Ridgeline** and apply live.
+All settings live under **Settings → Ridgeline**. Every one applies live, with the single exception of *Show the toolbar toggle button*, which takes effect only after restarting Joplin (see the note in the table).
 
 | Setting | Default | What it does |
 | --- | --- | --- |
@@ -46,6 +46,7 @@ All settings live under **Settings → Ridgeline** and apply live.
 | **Maximum heading depth** | H1–H6 | The deepest heading level shown. Headings deeper than this are dropped from the minimap and the outline. |
 | **Show minimap** | On | Master switch for the strip in both panes. Toggle without disabling the plugin (see the command below). |
 | **Hide minimap when the note has no headings** | On | On a heading-less note, hide the strip and drop its reserved margin so the text uses the full width. |
+| **Show the toolbar toggle button** | On | Show the `fa-stream` note-toolbar button that toggles the minimap. **Takes effect only after restarting Joplin** — the plugin API cannot remove a toolbar button once created. The **Tools → Ridgeline** menu entry and `Ctrl+Alt+M` keep working regardless. |
 | **Hover open delay (ms)** | 300 | How long the pointer must rest on the bars before the outline opens (100–1000 ms). Higher = a quick trip across the strip never opens it. |
 
 ### Commands and shortcuts
@@ -56,59 +57,22 @@ All settings live under **Settings → Ridgeline** and apply live.
 | **Ridgeline: Toggle strip side (left/right)** | `Ctrl+Alt+R` | — |
 | **Ridgeline: Toggle hide-when-empty** | `Ctrl+Alt+H` | — |
 
-All three are also in the **Tools** menu, and each flips the matching setting so both panes update live.
+All three also sit together in the **Tools → Ridgeline** submenu, listed there under the same full
+names as above (Joplin labels a plugin menu entry from its command, so the `Ridgeline:` prefix is
+repeated inside the submenu). Each flips the matching setting, so both panes update live.
 
 ## Development
 
 ```
+git clone https://github.com/pmslava/joplin-plugin-ridgeline
+cd joplin-plugin-ridgeline
 npm install
 npm run dist
 ```
 
 `npm run dist` builds the publishable plugin to `publish/io.github.pmslava.ridgeline.jpl`.
 
-### End-to-end tests
-
-The E2E suite drives a real Joplin desktop (Electron) build with the plugin loaded, under a virtual display. It needs Xvfb and the Playwright Chromium host dependencies installed.
-
-First fetch the Joplin AppImage the tests run against (downloaded once, then cached under `.e2e-cache/`):
-
-```
-npm run setup:e2e
-```
-
-The version is pinned in `scripts/setup-e2e.sh` and overridable — it must be at least the manifest's `app_min_version`:
-
-```
-JOPLIN_E2E_VERSION=3.7.6 npm run setup:e2e
-```
-
-`npm run test:e2e` runs the whole suite in one process (it wraps `playwright test` in `xvfb-run`). The suite launches Joplin many times serially, so on a laptop it is more comfortable to run it in **four shards**, each in the foreground:
-
-```
-npm run dist
-npm run setup:e2e
-xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test --shard=1/4
-xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test --shard=2/4
-xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test --shard=3/4
-xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test --shard=4/4
-```
-
-The `-screen 0 1920x1080x24` server args give the virtual display enough room for the split-pane layouts the specs assert against.
-
-### Regenerating the screenshots
-
-The README/manifest screenshots are produced by a separate, opt-in spec that captures (rather than asserts) against a throwaway profile forced to Joplin's dark theme:
-
-```
-npm run dist
-npm run setup:e2e
-SHOWCASE=1 xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test e2e/showcase.spec.ts
-```
-
-It writes the PNGs into `docs/images/`. Its content is fictional ("Acme Rocket Skates") — it never touches your real Joplin profile.
-
-See [PUBLISHING.md](PUBLISHING.md) for the release flow.
+For the end-to-end test suite, regenerating the showcase screenshots, and a tour of the repository layout, see [DEVELOPMENT.md](DEVELOPMENT.md). See [PUBLISHING.md](PUBLISHING.md) for the release flow.
 
 ## Credits
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "joplin-plugin-ridgeline",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "description": "Ridgeline: a hover-expanding minimap outline for the Joplin editor and viewer.",
   "homepage": "https://github.com/pmslava/joplin-plugin-ridgeline",
   "repository": {
     "type": "git",
-    "url": "https://github.com/pmslava/joplin-plugin-ridgeline"
+    "url": "git+https://github.com/pmslava/joplin-plugin-ridgeline.git"
   },
   "publishConfig": {
     "access": "public"
@@ -14,6 +14,7 @@
     "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
     "prepare": "npm run dist",
     "updateVersion": "webpack --env joplin-plugin-config=updateVersion",
+    "test:sandbox-proxy": "node scripts/audit-sandbox-proxy.js",
     "setup:e2e": "bash scripts/setup-e2e.sh",
     "test:e2e": "npm run dist && npm run setup:e2e && xvfb-run -a --server-args=\"-screen 0 1920x1080x24\" playwright test"
   },

package/publish/io.github.pmslava.ridgeline.json

@@ -2,7 +2,7 @@
 	"manifest_version": 1,
 	"id": "io.github.pmslava.ridgeline",
 	"app_min_version": "3.3",
-	"version": "0.2.7",
+	"version": "0.2.9",
 	"name": "Ridgeline",
 	"description": "A hover-expanding minimap outline for the Markdown editor and viewer: a compact stack of level-encoded bars that tracks the current section and expands into a full clickable table of contents on hover. Theme-aware, live settings, multi-window.",
 	"author": "pmslava",
@@ -35,6 +35,6 @@
 			"label": "In a split view the strip tracks the current section in both the editor and the rendered viewer at once"
 		}
 	],
-	"_publish_hash": "sha256:6722f2995489bd3c423fcb9b195fc204dd4ea6deb97030b1b4086d916644d425",
-	"_publish_commit": "main:1a2533deb0a421ecdf6bd7dfa213eff1108f4782"
+	"_publish_hash": "sha256:94c99c33811c762fdb6f5da95cb5eda6ad564639c826f049e4fb2a67287105a7",
+	"_publish_commit": "master:995548433273a55fc086383e2e08d81c3f4e3659"
 }