Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c5504b6999 | ||
| ac1fa01578 | |||
| 06f0d4bd60 | |||
| c87ad25d4d | |||
| a426e74684 | |||
| d730ead6ae | |||
| e09d5e5e2f | |||
| c31e7323b8 | |||
| e4117a3d28 | |||
| 87d27f2f4c | |||
| 06350d6c62 | |||
| ac37b6a6f5 | |||
| a135038b40 | |||
|
|
4be12fb6e6 | ||
| fb5d11dd6a |
7
LICENSE
Normal file
7
LICENSE
Normal file
@@ -0,0 +1,7 @@
|
||||
Copyright © 2026 Brendan Chen
|
||||
|
||||
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.
|
||||
63
README.md
63
README.md
@@ -1,13 +1,17 @@
|
||||
# Obsidian Jekyll Publish
|
||||
|
||||
An Obsidian plugin that publishes the active note as a Jekyll blog post via git. Images are copied alongside the post using one of two configurable strategies, and credentials are handled by your system git — nothing is stored inside Obsidian.
|
||||
An Obsidian plugin that publishes the active note as a Jekyll page via git.
|
||||
Images are copied alongside the post using one of two configurable strategies,
|
||||
and credentials are handled by your system git. Nothing is stored inside
|
||||
Obsidian.
|
||||
|
||||
## What it does
|
||||
|
||||
1. Opens a "Publish to Jekyll" modal for the currently active markdown file.
|
||||
2. Lets you confirm or adjust the slug, date, frontmatter, image strategy, and commit message.
|
||||
1. Opens a "Publish to Jekyll" modal for the currently active Markdown file.
|
||||
2. Lets you confirm or adjust the slug, date, frontmatter, image strategy, and
|
||||
commit message.
|
||||
3. Clones (or updates) your Jekyll site repository into a temporary directory.
|
||||
4. Writes the post as `_posts/<date>-<slug>.md` (or your configured path).
|
||||
4. Writes the note to your configured directory.
|
||||
5. Copies any embedded images according to the selected strategy.
|
||||
6. Commits and pushes to your configured remote and branch.
|
||||
|
||||
@@ -18,12 +22,13 @@ An Obsidian plugin that publishes the active note as a Jekyll blog post via git.
|
||||
```
|
||||
<your-vault>/.obsidian/plugins/jekyll-publish/
|
||||
```
|
||||
3. Reload Obsidian and enable **Jekyll Publish** under Settings → Community plugins.
|
||||
3. Reload Obsidian and enable **Jekyll Publish** under Settings → Community
|
||||
plugins.
|
||||
|
||||
## Settings
|
||||
|
||||
| Setting | Description | Default |
|
||||
|---|---|---|
|
||||
|-------------------------|-----------------------------------------------------|----------------------|
|
||||
| Remote URL | Git remote URL for your Jekyll site (HTTPS or SSH) | _(empty)_ |
|
||||
| Branch | Branch to push to | `main` |
|
||||
| Posts directory | Destination directory inside the repo | `_posts` |
|
||||
@@ -36,18 +41,35 @@ An Obsidian plugin that publishes the active note as a Jekyll blog post via git.
|
||||
|
||||
## Image strategies
|
||||
|
||||
**flat-slug** — all images for the post are copied flat into `<images-dir>/`. A single image is renamed to `<slug>.<ext>`; multiple images are renamed to `<slug>-1.<ext>`, `<slug>-2.<ext>`, … (the original Obsidian filename is discarded). Keeps the images directory shallow; suitable for sites with few images per post.
|
||||
**flat-slug** — all images for the post are copied flat into `<images-dir>/`. A
|
||||
single image is renamed to `<slug>.<ext>`; multiple images are renamed to
|
||||
`<slug>-1.<ext>`, `<slug>-2.<ext>`, etc.
|
||||
|
||||
**per-post-folder** — images are copied into `<images-dir>/<slug>/` preserving their original filenames. Keeps each post's images grouped together; suitable for posts with many images.
|
||||
**per-post-folder** — images are copied into `<images-dir>/<slug>/` preserving
|
||||
their original filenames.
|
||||
|
||||
## Credentials model
|
||||
|
||||
The plugin uses your **system git** binary for all remote operations and stores **no** passwords or tokens inside Obsidian or the plugin's data files. Authentication is delegated entirely to git's own credential handling, which works across platforms:
|
||||
The plugin uses your **system git** binary for all remote operations and stores
|
||||
**no** passwords or tokens inside Obsidian or the plugin's data files.
|
||||
Authentication is delegated entirely to git's own credential handling, which
|
||||
works across platforms:
|
||||
|
||||
- **HTTPS remotes** — git uses your configured credential helper: **Git Credential Manager** (bundled with Git for Windows), **osxkeychain** (macOS), or libsecret (Linux). The first push prompts you through that helper's own dialog and caches the result in your OS keychain. If no helper is configured, the publish fails fast with a clear message (the plugin sets `GIT_TERMINAL_PROMPT=0` so git never hangs waiting on a non-existent terminal).
|
||||
- **SSH remotes** — git uses your existing SSH agent / `~/.ssh` key configuration. Use an `ssh://` URL and make sure your key (or agent) is set up; no extra steps in the plugin.
|
||||
- **HTTPS remotes** — git uses your configured credential helper: **Git
|
||||
Credential Manager** (bundled with Git for Windows), **osxkeychain** (macOS),
|
||||
or libsecret (Linux). The first push prompts you through that helper's own
|
||||
dialog and caches the result in your OS keychain. If no helper is configured,
|
||||
the publish fails fast with a clear message (the plugin sets
|
||||
`GIT_TERMINAL_PROMPT=0` so git never hangs waiting on a non-existent
|
||||
terminal).
|
||||
- **SSH remotes** — git uses your existing SSH agent / `~/.ssh` key
|
||||
configuration. Use an `ssh://` URL and make sure your key (or agent) is set
|
||||
up; no extra steps in the plugin.
|
||||
|
||||
Commits are authored with the **Author name/email** from the plugin settings if set; otherwise git uses your machine's git identity (`user.name` / `user.email`). If neither is configured, git will refuse to commit — set an author in settings or configure a global git identity.
|
||||
Commits are authored with the **Author name/email** from the plugin settings if
|
||||
set; otherwise git uses your machine's git identity (`user.name` /
|
||||
`user.email`). If neither is configured, git will refuse to commit — set an
|
||||
author in settings or configure a global git identity.
|
||||
|
||||
## Development
|
||||
|
||||
@@ -70,11 +92,13 @@ npm run build
|
||||
npm test
|
||||
```
|
||||
|
||||
Runs the Vitest suite (frontmatter parsing, slug derivation, image path logic, git helpers, publish pipeline).
|
||||
Runs the Vitest suite (frontmatter parsing, slug derivation, image path logic,
|
||||
git helpers, publish pipeline).
|
||||
|
||||
### E2E tests
|
||||
|
||||
The E2E suite boots the real Obsidian binary in a headless X display and drives it via the Chrome DevTools Protocol.
|
||||
The E2E suite boots the real Obsidian binary in a headless X display and drives
|
||||
it via the Chrome DevTools Protocol.
|
||||
|
||||
**Prerequisites:**
|
||||
|
||||
@@ -87,9 +111,14 @@ npm run e2e
|
||||
```
|
||||
|
||||
The script:
|
||||
|
||||
1. Extracts the AppImage (once, cached).
|
||||
2. Provisions a throwaway vault at `.obsidian-e2e/` with the plugin installed.
|
||||
3. Launches Obsidian with `--remote-debugging-port` and connects Playwright over CDP.
|
||||
4. Runs the smoke spec: plugin loads, command `jekyll-publish:publish-current-note` is registered, opening a note and executing the command shows a modal with heading "Publish to Jekyll".
|
||||
3. Launches Obsidian with `--remote-debugging-port` and connects Playwright over
|
||||
CDP.
|
||||
4. Runs the smoke spec: plugin loads, command
|
||||
`jekyll-publish:publish-current-note` is registered, opening a note and
|
||||
executing the command shows a modal with heading "Publish to Jekyll".
|
||||
|
||||
The `.obsidian-e2e/` directory and Playwright `test-results/` are excluded from git.
|
||||
The `.obsidian-e2e/` directory and Playwright `test-results/` are excluded from
|
||||
git.
|
||||
|
||||
@@ -1083,7 +1083,7 @@ Co-Authored-By: Claude"
|
||||
- Create: `src/publish.ts`, `src/publish.test.ts`
|
||||
|
||||
**Interfaces:**
|
||||
- Consumes: `parseNote`, `Pair` (frontmatter); `findImageRefs`, `planImages`, `Strategy` (images); `buildPost`; `postFilename` (slug); `GitClient`, `GitFile` (git); `JekyllPublishSettings`.
|
||||
- Consumes: `parseNote`, `Pair` (frontmatter); `findImageRefs`, `planImages`, `Strategy` (images); `buildPost`; `pageFilename` (slug); `GitClient`, `GitFile` (git); `JekyllPublishSettings`.
|
||||
- Produces:
|
||||
- `interface PublishInput { noteText: string; frontmatterPairs: Pair[]; slug: string; date: string; strategy: Strategy; commitMessage: string }`
|
||||
- `interface ImageResolver { (linktext: string): Promise<Buffer | null> }`
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
{
|
||||
"id": "jekyll-publish",
|
||||
"name": "Jekyll Publish",
|
||||
"version": "0.1.1",
|
||||
"version": "0.2.0",
|
||||
"minAppVersion": "1.5.0",
|
||||
"description": "Publish the active note as a Jekyll post (with images) via git.",
|
||||
"author": "Claude",
|
||||
"description": "Publish the active note as a Jekyll post, with images, via git.",
|
||||
"author": "Brendan Chen",
|
||||
"isDesktopOnly": true
|
||||
}
|
||||
|
||||
27
package-lock.json
generated
27
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "obsidian-jekyll-publish",
|
||||
"version": "0.1.0",
|
||||
"version": "0.1.3",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "obsidian-jekyll-publish",
|
||||
"version": "0.1.0",
|
||||
"version": "0.1.3",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"js-yaml": "^4.1.0"
|
||||
@@ -1197,9 +1197,9 @@
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/js-yaml": {
|
||||
"version": "4.2.0",
|
||||
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz",
|
||||
"integrity": "sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==",
|
||||
"version": "4.3.1",
|
||||
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.3.1.tgz",
|
||||
"integrity": "sha512-CY6crGq313MX8GkwvB7tzgp99vjQxY1++5y10/BKN/GUfHqWaOGQMNZkBvqSzsZKWk/ijwHlWzzkLulsGHhjWQ==",
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
@@ -1210,6 +1210,7 @@
|
||||
"url": "https://github.com/sponsors/nodeca"
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"argparse": "^2.0.1"
|
||||
},
|
||||
@@ -1303,9 +1304,9 @@
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/nanoid": {
|
||||
"version": "3.3.13",
|
||||
"resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.13.tgz",
|
||||
"integrity": "sha512-sPdqC6ByMVVGvF1ynvvMo0/o+oD1VX7DaHhijt1bFgjvBkHBib4t49GoNDhf2NDta4oeUNlaGbSt5K7qjZ955Q==",
|
||||
"version": "3.3.18",
|
||||
"resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.18.tgz",
|
||||
"integrity": "sha512-DTg4MJbGMWkfi6VZFdNt2/caMbQy4Ou+Op/hJQvGEWcnVfoA1QA+xzRKAzw9jD6+GVOOeYr/mIcuDSdug6F6+w==",
|
||||
"dev": true,
|
||||
"funding": [
|
||||
{
|
||||
@@ -1313,6 +1314,7 @@
|
||||
"url": "https://github.com/sponsors/ai"
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"bin": {
|
||||
"nanoid": "bin/nanoid.cjs"
|
||||
},
|
||||
@@ -1469,9 +1471,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/postcss": {
|
||||
"version": "8.5.15",
|
||||
"resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.15.tgz",
|
||||
"integrity": "sha512-FfR8sjd4em2T6fb3I2MwAJU7HWVMr9zba+enmQeeWFfCbm+UOC/0X4DS8XtpUTMwWMGbjKYP7xjfNekzyGmB3A==",
|
||||
"version": "8.5.26",
|
||||
"resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.26.tgz",
|
||||
"integrity": "sha512-u82N74LFzG8ca+dD8puPnplTXoGH4fTPpVGuIbt36G3qvNlkvfD0lEAZSxaly3KX8TS/L1A1gsCEmvKmBcVbkQ==",
|
||||
"dev": true,
|
||||
"funding": [
|
||||
{
|
||||
@@ -1487,8 +1489,9 @@
|
||||
"url": "https://github.com/sponsors/ai"
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"nanoid": "^3.3.12",
|
||||
"nanoid": "^3.3.17",
|
||||
"picocolors": "^1.1.1",
|
||||
"source-map-js": "^1.2.1"
|
||||
},
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "obsidian-jekyll-publish",
|
||||
"version": "0.1.1",
|
||||
"version": "0.2.0",
|
||||
"description": "Publish the active Obsidian note as a Jekyll post (with images) via git.",
|
||||
"main": "dist/main.js",
|
||||
"type": "module",
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { App, Modal, Setting } from "obsidian";
|
||||
import { Pair, parseNote, resolveFrontmatter } from "./frontmatter";
|
||||
import { Pair, composeFrontmatter, docFrontmatterToPairs, parseNote } from "./frontmatter";
|
||||
import { Strategy } from "./images";
|
||||
import { JekyllPublishSettings } from "./settings";
|
||||
import { deriveDate, deriveSlug } from "./slug";
|
||||
@@ -7,7 +7,7 @@ import { deriveDate, deriveSlug } from "./slug";
|
||||
export interface ModalResult {
|
||||
frontmatterPairs: Pair[];
|
||||
slug: string;
|
||||
date: string;
|
||||
date?: string;
|
||||
strategy: Strategy;
|
||||
commitMessage: string;
|
||||
}
|
||||
@@ -15,35 +15,37 @@ export interface ModalResult {
|
||||
export class PublishModal extends Modal {
|
||||
private result: ModalResult;
|
||||
private mergeDoc = true;
|
||||
private custom: Pair[] = [];
|
||||
/** Editable rows = preset fields (seeded from settings) + custom additions. */
|
||||
private editableRows: Pair[];
|
||||
/** The note's own frontmatter, shown read-only when merge is on. */
|
||||
private readonly docPairs: Pair[];
|
||||
private fmEl!: HTMLElement;
|
||||
|
||||
constructor(
|
||||
app: App,
|
||||
private settings: JekyllPublishSettings,
|
||||
settings: JekyllPublishSettings,
|
||||
private noteText: string,
|
||||
private filename: string,
|
||||
filename: string,
|
||||
private onSubmit: (r: ModalResult) => void
|
||||
) {
|
||||
super(app);
|
||||
const { frontmatter } = parseNote(noteText);
|
||||
const title = typeof frontmatter.title === "string" ? frontmatter.title : "";
|
||||
this.docPairs = docFrontmatterToPairs(frontmatter);
|
||||
// Deep-copy the presets so editing/deleting rows here never mutates the
|
||||
// saved settings.
|
||||
this.editableRows = settings.presetFrontmatter.map((p) => ({ key: p.key, value: p.value }));
|
||||
this.result = {
|
||||
frontmatterPairs: [],
|
||||
slug: deriveSlug({ title, filename }),
|
||||
date: deriveDate({ frontmatterDate: frontmatter.date, now: new Date() }),
|
||||
date: deriveDate({ frontmatterDate: frontmatter.date }),
|
||||
strategy: settings.defaultImageStrategy,
|
||||
commitMessage: settings.commitMessageTemplate.replace("{{title}}", title || filename),
|
||||
};
|
||||
}
|
||||
|
||||
private recompute() {
|
||||
const { frontmatter } = parseNote(this.noteText);
|
||||
this.result.frontmatterPairs = resolveFrontmatter(
|
||||
this.settings.presetFrontmatter,
|
||||
frontmatter,
|
||||
this.custom,
|
||||
this.mergeDoc
|
||||
);
|
||||
this.result.frontmatterPairs = composeFrontmatter(this.docPairs, this.editableRows, this.mergeDoc);
|
||||
}
|
||||
|
||||
onOpen() {
|
||||
@@ -55,24 +57,32 @@ export class PublishModal extends Modal {
|
||||
t.setValue(this.result.slug).onChange((v) => (this.result.slug = v))
|
||||
);
|
||||
new Setting(contentEl).setName("Date").addText((t) =>
|
||||
t.setValue(this.result.date).onChange((v) => (this.result.date = v))
|
||||
);
|
||||
t.setValue(this.result.date ?? "").onChange((v) => (this.result.date = v))
|
||||
).setDesc("The date to prepend to the filename. Useful for blog posts.");
|
||||
|
||||
new Setting(contentEl).setName("Image strategy").addDropdown((d) =>
|
||||
d.addOption("flat-slug", "Flat, renamed to slug")
|
||||
.addOption("per-post-folder", "Per-post subfolder")
|
||||
.setValue(this.result.strategy)
|
||||
.onChange((v) => (this.result.strategy = v as Strategy))
|
||||
);
|
||||
new Setting(contentEl).setName("Merge document frontmatter").addToggle((t) =>
|
||||
t.setValue(this.mergeDoc).onChange((v) => { this.mergeDoc = v; this.renderFrontmatter(); })
|
||||
new Setting(contentEl)
|
||||
.setName("Merge document frontmatter")
|
||||
.setDesc("Include the note's own frontmatter (shown read-only below).")
|
||||
.addToggle((t) =>
|
||||
t.setValue(this.mergeDoc).onChange((v) => {
|
||||
this.mergeDoc = v;
|
||||
this.renderFrontmatter();
|
||||
})
|
||||
);
|
||||
|
||||
contentEl.createEl("h3", { text: "Frontmatter" });
|
||||
this.fmEl = contentEl.createDiv();
|
||||
this.renderFrontmatter();
|
||||
|
||||
new Setting(contentEl).addButton((b) =>
|
||||
b.setButtonText("Add property").onClick(() => {
|
||||
this.custom.push({ key: "", value: "" });
|
||||
this.editableRows = [...this.editableRows, { key: "", value: "" }];
|
||||
this.renderFrontmatter();
|
||||
})
|
||||
);
|
||||
@@ -88,25 +98,52 @@ export class PublishModal extends Modal {
|
||||
);
|
||||
}
|
||||
|
||||
private fmEl!: HTMLElement;
|
||||
private renderFrontmatter() {
|
||||
this.recompute();
|
||||
this.fmEl.empty();
|
||||
this.fmEl.createEl("h3", { text: "Frontmatter (resolved)" });
|
||||
for (const p of this.result.frontmatterPairs) {
|
||||
this.fmEl.createDiv({ cls: "jekyll-publish-row", text: `${p.key}: ${p.value}` });
|
||||
}
|
||||
if (this.custom.length) {
|
||||
this.fmEl.createEl("h4", { text: "Custom properties" });
|
||||
this.custom.forEach((row, i) => {
|
||||
const div = this.fmEl.createDiv({ cls: "jekyll-publish-row" });
|
||||
const k = div.createEl("input", { value: row.key, placeholder: "key" });
|
||||
const v = div.createEl("input", { value: row.value, placeholder: "value" });
|
||||
k.oninput = () => { this.custom[i].key = k.value; this.recompute(); };
|
||||
v.oninput = () => { this.custom[i].value = v.value; this.recompute(); };
|
||||
});
|
||||
|
||||
const editableKeys = new Set(
|
||||
this.editableRows.filter((r) => r.key.trim() !== "").map((r) => r.key)
|
||||
);
|
||||
|
||||
// Document fields (read-only) first — only those not overridden by an
|
||||
// editable row, so the modal never shows a key twice.
|
||||
if (this.mergeDoc) {
|
||||
const docRows = this.docPairs.filter((p) => !editableKeys.has(p.key));
|
||||
for (const p of docRows) {
|
||||
const row = this.fmEl.createDiv({ cls: "jekyll-publish-row" });
|
||||
const k = row.createEl("input", { cls: "jekyll-publish-doc", value: p.key });
|
||||
const v = row.createEl("input", { cls: "jekyll-publish-doc", value: p.value });
|
||||
k.disabled = true;
|
||||
v.disabled = true;
|
||||
k.title = "From the note's frontmatter (edit the note to change)";
|
||||
v.title = k.title;
|
||||
}
|
||||
}
|
||||
|
||||
onClose() { this.contentEl.empty(); }
|
||||
// Editable rows (presets + custom) — same style, all editable and deletable.
|
||||
this.editableRows.forEach((row, i) => {
|
||||
const div = this.fmEl.createDiv({ cls: "jekyll-publish-row" });
|
||||
const k = div.createEl("input", { value: row.key, placeholder: "key" });
|
||||
const v = div.createEl("input", { value: row.value, placeholder: "value" });
|
||||
k.oninput = () => {
|
||||
this.editableRows = this.editableRows.map((r, j) => (j === i ? { ...r, key: k.value } : r));
|
||||
this.recompute();
|
||||
};
|
||||
v.oninput = () => {
|
||||
this.editableRows = this.editableRows.map((r, j) => (j === i ? { ...r, value: v.value } : r));
|
||||
this.recompute();
|
||||
};
|
||||
const del = div.createEl("button", { cls: "jekyll-publish-del", text: "×" });
|
||||
del.setAttr("aria-label", "Delete property");
|
||||
del.onclick = () => {
|
||||
this.editableRows = this.editableRows.filter((_, j) => j !== i);
|
||||
this.renderFrontmatter();
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
onClose() {
|
||||
this.contentEl.empty();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,8 +16,8 @@ export class JekyllPublishSettingTab extends PluginSettingTab {
|
||||
.addText((t) => t.setValue(s.remoteUrl).onChange((v) => { s.remoteUrl = v; save(); }));
|
||||
new Setting(containerEl).setName("Branch")
|
||||
.addText((t) => t.setValue(s.branch).onChange((v) => { s.branch = v; save(); }));
|
||||
new Setting(containerEl).setName("Posts directory")
|
||||
.addText((t) => t.setValue(s.postsDir).onChange((v) => { s.postsDir = v; save(); }));
|
||||
new Setting(containerEl).setName("Page directory")
|
||||
.addText((t) => t.setValue(s.publishDir).onChange((v) => { s.publishDir = v; save(); }));
|
||||
new Setting(containerEl).setName("Images directory")
|
||||
.addText((t) => t.setValue(s.imagesDir).onChange((v) => { s.imagesDir = v; save(); }));
|
||||
new Setting(containerEl).setName("Default image strategy")
|
||||
@@ -27,9 +27,9 @@ export class JekyllPublishSettingTab extends PluginSettingTab {
|
||||
.onChange((v) => { s.defaultImageStrategy = v as typeof s.defaultImageStrategy; save(); }));
|
||||
new Setting(containerEl).setName("Commit message template").setDesc("{{title}} is substituted")
|
||||
.addText((t) => t.setValue(s.commitMessageTemplate).onChange((v) => { s.commitMessageTemplate = v; save(); }));
|
||||
new Setting(containerEl).setName("Author name (optional)")
|
||||
new Setting(containerEl).setName("Git author name (optional)")
|
||||
.addText((t) => t.setValue(s.authorName).onChange((v) => { s.authorName = v; save(); }));
|
||||
new Setting(containerEl).setName("Author email (optional)")
|
||||
new Setting(containerEl).setName("Git author email (optional)")
|
||||
.addText((t) => t.setValue(s.authorEmail).onChange((v) => { s.authorEmail = v; save(); }));
|
||||
|
||||
containerEl.createEl("h3", { text: "Preset frontmatter" });
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { describe, expect, test } from "vitest";
|
||||
import { parseNote, resolveFrontmatter, serializeFrontmatter } from "./frontmatter";
|
||||
import { composeFrontmatter, docFrontmatterToPairs, parseNote, serializeFrontmatter } from "./frontmatter";
|
||||
|
||||
describe("parseNote", () => {
|
||||
test("splits frontmatter and body, strips BOM", () => {
|
||||
@@ -12,27 +12,70 @@ describe("parseNote", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("resolveFrontmatter", () => {
|
||||
const presets = [{ key: "layout", value: "post" }, { key: "kind", value: "essay" }];
|
||||
test("presets only when mergeDoc is false", () => {
|
||||
expect(resolveFrontmatter(presets, { title: "X" }, [], false)).toEqual(presets);
|
||||
describe("docFrontmatterToPairs", () => {
|
||||
test("converts a record to ordered string pairs", () => {
|
||||
const pairs = docFrontmatterToPairs({
|
||||
title: "Hello",
|
||||
date: new Date("2026-02-06T00:00:00Z"),
|
||||
draft: true,
|
||||
});
|
||||
test("merge appends doc keys and doc overrides preset value", () => {
|
||||
const r = resolveFrontmatter(presets, { kind: "note", title: "X" }, [], true);
|
||||
expect(r).toEqual([
|
||||
{ key: "layout", value: "post" },
|
||||
{ key: "kind", value: "note" },
|
||||
{ key: "title", value: "X" },
|
||||
expect(pairs).toEqual([
|
||||
{ key: "title", value: "Hello" },
|
||||
{ key: "date", value: "2026-02-06" },
|
||||
{ key: "draft", value: "true" },
|
||||
]);
|
||||
});
|
||||
test("custom rows come last and override everything", () => {
|
||||
const r = resolveFrontmatter(presets, {}, [{ key: "layout", value: "page" }], false);
|
||||
expect(r[0]).toEqual({ key: "layout", value: "page" });
|
||||
expect(r).toHaveLength(2);
|
||||
test("empty record yields an empty array", () => {
|
||||
expect(docFrontmatterToPairs({})).toEqual([]);
|
||||
});
|
||||
test("date object is rendered as YYYY-MM-DD", () => {
|
||||
const r = resolveFrontmatter([], { date: new Date("2026-06-11T00:00:00Z") }, [], true);
|
||||
expect(r).toEqual([{ key: "date", value: "2026-06-11" }]);
|
||||
});
|
||||
|
||||
describe("composeFrontmatter", () => {
|
||||
const doc = [
|
||||
{ key: "title", value: "Hello" },
|
||||
{ key: "date", value: "2026-02-06" },
|
||||
];
|
||||
const editable = [
|
||||
{ key: "layout", value: "post" },
|
||||
{ key: "kind", value: "essay" },
|
||||
];
|
||||
|
||||
test("merge on: document fields first, then editable rows", () => {
|
||||
expect(composeFrontmatter(doc, editable, true)).toEqual([
|
||||
{ key: "title", value: "Hello" },
|
||||
{ key: "date", value: "2026-02-06" },
|
||||
{ key: "layout", value: "post" },
|
||||
{ key: "kind", value: "essay" },
|
||||
]);
|
||||
});
|
||||
test("merge off: only the editable rows", () => {
|
||||
expect(composeFrontmatter(doc, editable, false)).toEqual(editable);
|
||||
});
|
||||
test("an editable row overrides a document field with the same key (doc field dropped)", () => {
|
||||
const ed = [
|
||||
{ key: "title", value: "Override" },
|
||||
{ key: "layout", value: "post" },
|
||||
];
|
||||
expect(composeFrontmatter(doc, ed, true)).toEqual([
|
||||
{ key: "date", value: "2026-02-06" },
|
||||
{ key: "title", value: "Override" },
|
||||
{ key: "layout", value: "post" },
|
||||
]);
|
||||
});
|
||||
test("blank-key editable rows are skipped", () => {
|
||||
const ed = [
|
||||
{ key: "", value: "" },
|
||||
{ key: "layout", value: "post" },
|
||||
{ key: " ", value: "x" },
|
||||
];
|
||||
expect(composeFrontmatter([], ed, true)).toEqual([{ key: "layout", value: "post" }]);
|
||||
});
|
||||
test("duplicate editable keys: last value wins at first position", () => {
|
||||
const ed = [
|
||||
{ key: "tag", value: "a" },
|
||||
{ key: "tag", value: "b" },
|
||||
];
|
||||
expect(composeFrontmatter([], ed, false)).toEqual([{ key: "tag", value: "b" }]);
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
@@ -14,12 +14,26 @@ export function parseNote(text: string): { frontmatter: Record<string, unknown>;
|
||||
return { frontmatter, body: stripped.slice(m[0].length) };
|
||||
}
|
||||
|
||||
export function resolveFrontmatter(
|
||||
presets: Pair[],
|
||||
docFrontmatter: Record<string, unknown>,
|
||||
custom: Pair[],
|
||||
mergeDoc: boolean
|
||||
): Pair[] {
|
||||
/**
|
||||
* Convert a parsed note's frontmatter object into ordered, stringified pairs
|
||||
* suitable for display (read-only) and composition.
|
||||
*/
|
||||
export function docFrontmatterToPairs(docFrontmatter: Record<string, unknown>): Pair[] {
|
||||
return Object.entries(docFrontmatter).map(([key, v]) => ({ key, value: stringifyScalar(v) }));
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the final frontmatter for the post.
|
||||
*
|
||||
* Editable rows (the preset fields seeded from settings plus any custom rows
|
||||
* the user added) are authoritative: on a key collision they win over the
|
||||
* document's own merged fields, which appear first (and are shown read-only in
|
||||
* the modal). Blank-key rows are dropped; duplicate editable keys keep the last
|
||||
* value at the first position.
|
||||
*/
|
||||
export function composeFrontmatter(docPairs: Pair[], editableRows: Pair[], mergeDoc: boolean): Pair[] {
|
||||
const editable = editableRows.filter((r) => r.key.trim() !== "");
|
||||
const editableKeys = new Set(editable.map((r) => r.key));
|
||||
const out: Pair[] = [];
|
||||
const idx = new Map<string, number>();
|
||||
const put = (key: string, value: string) => {
|
||||
@@ -27,9 +41,8 @@ export function resolveFrontmatter(
|
||||
if (at !== undefined) out[at] = { key, value };
|
||||
else { idx.set(key, out.length); out.push({ key, value }); }
|
||||
};
|
||||
for (const p of presets) put(p.key, p.value);
|
||||
if (mergeDoc) for (const [k, v] of Object.entries(docFrontmatter)) put(k, stringifyScalar(v));
|
||||
for (const c of custom) put(c.key, c.value);
|
||||
if (mergeDoc) for (const p of docPairs) if (!editableKeys.has(p.key)) put(p.key, p.value);
|
||||
for (const r of editable) put(r.key, r.value);
|
||||
return out;
|
||||
}
|
||||
|
||||
|
||||
11
src/main.ts
11
src/main.ts
@@ -54,7 +54,16 @@ export default class JekyllPublishPlugin extends Plugin {
|
||||
{ noteText, ...r },
|
||||
this.settings,
|
||||
git,
|
||||
(linktext) => this.resolveImage(linktext)
|
||||
(linktext) => this.resolveImage(linktext),
|
||||
(event) => {
|
||||
if (event === 'beforeClone') {
|
||||
new Notice("Jekyll Publish: cloning");
|
||||
} else if (event === 'beforeWrite') {
|
||||
new Notice("Jekyll Publish: writing contents");
|
||||
} else if (event === 'beforePush') {
|
||||
new Notice("Jekyll Publish: pushing contents");
|
||||
}
|
||||
}
|
||||
);
|
||||
const warn = result.unresolved.length
|
||||
? ` (${result.unresolved.length} image(s) unresolved)`
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { expect, test, vi } from "vitest";
|
||||
import { expect, test, vi, vitest } from "vitest";
|
||||
import { publish } from "./publish";
|
||||
import { DEFAULT_SETTINGS } from "./settings";
|
||||
import type { GitClient, GitFile } from "./git";
|
||||
@@ -63,3 +63,27 @@ test("throws when remoteUrl is empty", async () => {
|
||||
),
|
||||
).rejects.toThrow(/remote/i);
|
||||
});
|
||||
|
||||
test("calls all the events", async () => {
|
||||
const { git } = fakeGit();
|
||||
const listener = vitest.fn();
|
||||
|
||||
await publish(
|
||||
{
|
||||
noteText: "---\nlayout: post\n---\n\n![[shot.png]]\nbody",
|
||||
frontmatterPairs: [{ key: "layout", value: "post" }],
|
||||
slug: "my-post",
|
||||
date: "2026-06-19",
|
||||
strategy: "flat-slug",
|
||||
commitMessage: "Publish: My Post",
|
||||
},
|
||||
{ ...DEFAULT_SETTINGS, remoteUrl: "ssh://x/y.git" },
|
||||
git,
|
||||
async () => Buffer.from([9]),
|
||||
listener
|
||||
);
|
||||
|
||||
expect(listener).toHaveBeenCalledWith('beforeClone');
|
||||
expect(listener).toHaveBeenCalledWith('beforeWrite');
|
||||
expect(listener).toHaveBeenCalledWith('beforePush');
|
||||
});
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { parseNote, Pair } from "./frontmatter";
|
||||
import { buildPost } from "./buildPost";
|
||||
import { postFilename } from "./slug";
|
||||
import { pageFilename } from "./slug";
|
||||
import { findImageRefs, planImages, Strategy } from "./images";
|
||||
import { GitClient, GitFile } from "./git";
|
||||
import { JekyllPublishSettings } from "./settings";
|
||||
@@ -9,12 +9,13 @@ export interface PublishInput {
|
||||
noteText: string;
|
||||
frontmatterPairs: Pair[];
|
||||
slug: string;
|
||||
date: string;
|
||||
date?: string;
|
||||
strategy: Strategy;
|
||||
commitMessage: string;
|
||||
}
|
||||
|
||||
export type ImageResolver = (linktext: string) => Promise<Buffer | null>;
|
||||
export type PublishEventsListener = (on: 'beforeClone' | 'beforeWrite' | 'beforePush') => void;
|
||||
|
||||
export interface PublishResult {
|
||||
postPath: string;
|
||||
@@ -26,7 +27,8 @@ export async function publish(
|
||||
input: PublishInput,
|
||||
settings: JekyllPublishSettings,
|
||||
git: GitClient,
|
||||
resolveImage: ImageResolver
|
||||
imageResolver: ImageResolver,
|
||||
onProgress?: PublishEventsListener
|
||||
): Promise<PublishResult> {
|
||||
if (!settings.remoteUrl.trim()) throw new Error("No git remote URL configured");
|
||||
|
||||
@@ -37,7 +39,7 @@ export async function publish(
|
||||
const unresolved: string[] = [];
|
||||
for (const ref of refs) {
|
||||
if (resolved.some((r) => r.linktext === ref.linktext)) continue;
|
||||
const data = await resolveImage(ref.linktext);
|
||||
const data = await imageResolver(ref.linktext);
|
||||
if (data) resolved.push({ linktext: ref.linktext, data });
|
||||
else unresolved.push(ref.linktext);
|
||||
}
|
||||
@@ -51,16 +53,19 @@ export async function publish(
|
||||
});
|
||||
|
||||
const postText = buildPost({ frontmatterPairs: input.frontmatterPairs, body: rewrittenBody });
|
||||
const postPath = `${settings.postsDir}/${postFilename({ date: input.date, slug: input.slug })}`;
|
||||
const notePath = `${settings.publishDir}/${pageFilename({ date: input.date, slug: input.slug })}`;
|
||||
|
||||
const files: GitFile[] = [{ repoPath: postPath, data: postText }];
|
||||
const files: GitFile[] = [{ repoPath: notePath, data: postText }];
|
||||
for (const item of plan) {
|
||||
const r = resolved.find((x) => x.linktext === item.linktext)!;
|
||||
files.push({ repoPath: item.repoPath, data: r.data });
|
||||
}
|
||||
|
||||
onProgress?.('beforeClone');
|
||||
await git.syncClone({ url: settings.remoteUrl, branch: settings.branch });
|
||||
onProgress?.('beforeWrite');
|
||||
await git.writeFiles(files);
|
||||
onProgress?.('beforePush');
|
||||
await git.commitAndPush({
|
||||
message: input.commitMessage,
|
||||
branch: settings.branch,
|
||||
@@ -68,5 +73,5 @@ export async function publish(
|
||||
authorEmail: settings.authorEmail || undefined,
|
||||
});
|
||||
|
||||
return { postPath, imageCount: plan.length, unresolved };
|
||||
return { postPath: notePath, imageCount: plan.length, unresolved };
|
||||
}
|
||||
|
||||
@@ -4,7 +4,7 @@ import { Pair } from "./frontmatter";
|
||||
export interface JekyllPublishSettings {
|
||||
remoteUrl: string;
|
||||
branch: string;
|
||||
postsDir: string;
|
||||
publishDir: string;
|
||||
imagesDir: string;
|
||||
defaultImageStrategy: Strategy;
|
||||
presetFrontmatter: Pair[];
|
||||
@@ -16,7 +16,7 @@ export interface JekyllPublishSettings {
|
||||
export const DEFAULT_SETTINGS: JekyllPublishSettings = {
|
||||
remoteUrl: "",
|
||||
branch: "main",
|
||||
postsDir: "_posts",
|
||||
publishDir: "_posts",
|
||||
imagesDir: "assets/img",
|
||||
defaultImageStrategy: "flat-slug",
|
||||
presetFrontmatter: [],
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { describe, expect, test } from "vitest";
|
||||
import { slugify, deriveSlug, deriveDate, postFilename } from "./slug";
|
||||
import { slugify, deriveSlug, deriveDate, pageFilename } from "./slug";
|
||||
|
||||
describe("slugify", () => {
|
||||
test("lowercases, drops apostrophes, hyphenates", () => {
|
||||
@@ -19,14 +19,18 @@ describe("deriveSlug", () => {
|
||||
describe("deriveDate", () => {
|
||||
const now = new Date("2026-06-19T12:00:00Z");
|
||||
test("uses frontmatter Date or string, else now", () => {
|
||||
expect(deriveDate({ frontmatterDate: new Date("2026-02-06T00:00:00Z"), now })).toBe("2026-02-06");
|
||||
expect(deriveDate({ frontmatterDate: "2026-02-18 09:00", now })).toBe("2026-02-18");
|
||||
expect(deriveDate({ now })).toBe("2026-06-19");
|
||||
expect(deriveDate({ frontmatterDate: new Date("2026-02-06T00:00:00Z"), })).toBe("2026-02-06");
|
||||
expect(deriveDate({ frontmatterDate: "2026-02-18 09:00" })).toBe("2026-02-18");
|
||||
expect(deriveDate({ frontmatterDate: "unparsable" })).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe("postFilename", () => {
|
||||
test("joins date and slug", () => {
|
||||
expect(postFilename({ date: "2026-06-19", slug: "hello" })).toBe("2026-06-19-hello.md");
|
||||
expect(pageFilename({ date: "2026-06-19", slug: "hello" })).toBe("2026-06-19-hello.md");
|
||||
});
|
||||
|
||||
test("renders correctly without date", () => {
|
||||
expect(pageFilename({ slug: "hello-without-date" })).toBe("hello-without-date.md");
|
||||
});
|
||||
});
|
||||
|
||||
@@ -12,11 +12,10 @@ export function deriveSlug(o: { title?: string; filename: string }): string {
|
||||
return slugify(base);
|
||||
}
|
||||
|
||||
export function deriveDate(o: { frontmatterDate?: unknown; now: Date }): string {
|
||||
export function deriveDate(o: { frontmatterDate?: unknown }): string | undefined {
|
||||
const d = o.frontmatterDate;
|
||||
if (d instanceof Date && !isNaN(d.getTime())) return fmt(d);
|
||||
if (typeof d === "string" && /^\d{4}-\d{2}-\d{2}/.test(d)) return d.slice(0, 10);
|
||||
return fmt(o.now);
|
||||
}
|
||||
|
||||
function fmt(d: Date): string {
|
||||
@@ -24,6 +23,9 @@ function fmt(d: Date): string {
|
||||
return `${d.getUTCFullYear()}-${p(d.getUTCMonth() + 1)}-${p(d.getUTCDate())}`;
|
||||
}
|
||||
|
||||
export function postFilename(o: { date: string; slug: string }): string {
|
||||
export function pageFilename(o: { date?: string; slug: string }): string {
|
||||
if (o.date) {
|
||||
return `${o.date}-${o.slug}.md`;
|
||||
}
|
||||
return `${o.slug}.md`;
|
||||
}
|
||||
|
||||
17
styles.css
17
styles.css
@@ -1,2 +1,17 @@
|
||||
.jekyll-publish-row { display: flex; gap: 8px; margin-bottom: 6px; }
|
||||
.jekyll-publish-row { display: flex; gap: 8px; margin-bottom: 6px; align-items: center; }
|
||||
.jekyll-publish-row input { flex: 1; }
|
||||
|
||||
/* Read-only document frontmatter fields shown when "Merge document
|
||||
frontmatter" is on — visually muted to signal they cannot be edited here. */
|
||||
.jekyll-publish-row input.jekyll-publish-doc {
|
||||
opacity: 0.65;
|
||||
cursor: not-allowed;
|
||||
}
|
||||
|
||||
/* Delete button on an editable property row. */
|
||||
.jekyll-publish-del {
|
||||
flex: 0 0 auto;
|
||||
width: 28px;
|
||||
padding: 0;
|
||||
line-height: 1;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user