5 Commits
Author SHA1 Message Date
Ignacio Ballesteros 8d842f2a80 feat: warn when Better Notes is not installed
CI / build (push) Successful in 23s
Release / build (push) Successful in 1m18s
Release / update-rolling-release (push) Successful in 8s
Release / publish-release (push) Successful in 8s
Add isBetterNotesInstalled() helper and surface a warning notification
on startup plus clear errors during export stating Better Notes is a
requirement. Bump version to 1.0.3.
2026-09-29 17:55:36 +02:00
Ignacio Ballesteros 2366db009b chore: release v1.0.2
CI / build (push) Successful in 16s
Release / build (push) Successful in 1m49s
Release / update-rolling-release (push) Successful in 9s
Release / publish-release (push) Successful in 10s
2026-09-29 17:35:27 +02:00
Ignacio Ballesteros 8393cca8dd feat: add Zotero 10 support
CI / build (push) Successful in 21s
Bump strict_max_version to 10.0.* and esbuild target to firefox140
(Zotero 9/10 Firefox 140 ESR base). Update docs accordingly.
2026-09-29 17:34:28 +02:00
Ignacio Ballesteros 15e55ee126 chore: bump version to 1.0.1 for update test
CI / build (push) Successful in 21s
Release / build (push) Successful in 38s
Release / update-rolling-release (push) Successful in 7s
Release / publish-release (push) Successful in 7s
2026-02-17 23:56:10 +01:00
Ignacio Ballesteros 52efde64c0 fix: mark rolling 'release' as pre-release so v1.0.0 shows as latest
CI / build (push) Successful in 21s
Release / build (push) Successful in 26s
Release / update-rolling-release (push) Successful in 6s
Release / publish-release (push) Successful in 6s
2026-02-17 23:52:51 +01:00
12 changed files with 42 additions and 19 deletions
+3 -3
View File
@@ -94,11 +94,11 @@ jobs:
-H "Authorization: token ${GITEA_TOKEN}" -H "Authorization: token ${GITEA_TOKEN}"
done done
# Update the release body to reflect the current version # Update the release body and ensure it stays marked as pre-release
curl -s -X PATCH "${API_URL}/repos/${REPO}/releases/${RELEASE_ID}" \ curl -s -X PATCH "${API_URL}/repos/${REPO}/releases/${RELEASE_ID}" \
-H "Authorization: token ${GITEA_TOKEN}" \ -H "Authorization: token ${GITEA_TOKEN}" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d "{\"body\": \"Rolling release — always points to the latest update manifest (currently v${VERSION}). Do not delete.\"}" -d "{\"body\": \"Rolling release — always points to the latest update manifest (currently v${VERSION}). Do not delete.\", \"prerelease\": true}"
else else
# Create the rolling release for the first time # Create the rolling release for the first time
@@ -118,7 +118,7 @@ jobs:
\"name\": \"Update Manifest (rolling)\", \"name\": \"Update Manifest (rolling)\",
\"body\": \"Rolling release — always points to the latest update manifest (currently v${VERSION}). Do not delete.\", \"body\": \"Rolling release — always points to the latest update manifest (currently v${VERSION}). Do not delete.\",
\"draft\": false, \"draft\": false,
\"prerelease\": false \"prerelease\": true
}") }")
RELEASE_ID=$(echo "${RELEASE}" | jq -r '.id') RELEASE_ID=$(echo "${RELEASE}" | jq -r '.id')
+1 -1
View File
@@ -25,7 +25,7 @@ npm run release # Bump version, commit, tag, and build
This project does not currently have automated tests. To test manually: This project does not currently have automated tests. To test manually:
1. Run `npm run build` to create the XPI 1. Run `npm run build` to create the XPI
2. Install the XPI in Zotero 7 2. Install the XPI in Zotero 7–10
3. Test export functionality manually via Tools menu 3. Test export functionality manually via Tools menu
--- ---
+3 -3
View File
@@ -12,7 +12,7 @@ Export PDF and EPUB annotations from Zotero to Org-mode files for use with Emacs
## Requirements ## Requirements
- **[Zotero](https://www.zotero.org/) 7.0+** - **[Zotero](https://www.zotero.org/) 7.0+ (through 10.x)**
- **[Better Notes](https://github.com/windingwind/zotero-better-notes)** plugin — must be installed before this plugin - **[Better Notes](https://github.com/windingwind/zotero-better-notes)** plugin — must be installed before this plugin
- **[Pandoc](https://pandoc.org/)** — for Markdown to Org conversion - **[Pandoc](https://pandoc.org/)** — for Markdown to Org conversion
@@ -89,7 +89,7 @@ src/
├── exporter.ts # Attachment detection, sync checking, batch export ├── exporter.ts # Attachment detection, sync checking, batch export
├── converter.ts # Markdown → Org via pandoc, file I/O ├── converter.ts # Markdown → Org via pandoc, file I/O
├── notifier.ts # Zotero event handlers (sync finish, tab close) ├── notifier.ts # Zotero event handlers (sync finish, tab close)
└── menu.ts # Menu registration (Zotero 7 + 8 compatible) └── menu.ts # Menu registration (Zotero 7 + 8/10 compatible)
addon/ # Static plugin files copied verbatim into the XPI addon/ # Static plugin files copied verbatim into the XPI
├── manifest.json ├── manifest.json
@@ -170,7 +170,7 @@ The dev server (`npm start`) watches for changes in `src/` and `addon/`, rebuild
There are no automated tests. To test manually: There are no automated tests. To test manually:
1. `npm run build` to produce the XPI 1. `npm run build` to produce the XPI
2. Install the XPI in a Zotero 7 instance via **Tools → Add-ons → Install Add-on From File...** 2. Install the XPI in a Zotero 7–10 instance via **Tools → Add-ons → Install Add-on From File...**
3. Exercise the export functionality manually via the Tools menu and right-click context menu 3. Exercise the export functionality manually via the Tools menu and right-click context menu
### Releasing ### Releasing
+2 -2
View File
@@ -1,7 +1,7 @@
{ {
"manifest_version": 2, "manifest_version": 2,
"name": "Zotero Org Export Annotations", "name": "Zotero Org Export Annotations",
"version": "1.0.0", "version": "1.0.1",
"description": "Export Zotero PDF/EPUB annotations to Org-mode files for Emacs, org-roam, and citar", "description": "Export Zotero PDF/EPUB annotations to Org-mode files for Emacs, org-roam, and citar",
"author": "Ignacio", "author": "Ignacio",
"homepage_url": "https://gitea.bueso.eu/ignacio.ballesteros/zotero-notes-export-org", "homepage_url": "https://gitea.bueso.eu/ignacio.ballesteros/zotero-notes-export-org",
@@ -14,7 +14,7 @@
"id": "org-export-annotations@zotero.org", "id": "org-export-annotations@zotero.org",
"update_url": "https://gitea.bueso.eu/ignacio.ballesteros/zotero-notes-export-org/releases/download/release/update.json", "update_url": "https://gitea.bueso.eu/ignacio.ballesteros/zotero-notes-export-org/releases/download/release/update.json",
"strict_min_version": "7.0", "strict_min_version": "7.0",
"strict_max_version": "8.*" "strict_max_version": "10.0.*"
} }
} }
} }
+2 -2
View File
@@ -1,12 +1,12 @@
{ {
"name": "zotero-org-export-annotations", "name": "zotero-org-export-annotations",
"version": "1.0.0", "version": "1.0.3",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "zotero-org-export-annotations", "name": "zotero-org-export-annotations",
"version": "1.0.0", "version": "1.0.3",
"license": "GPL-3.0-or-later", "license": "GPL-3.0-or-later",
"devDependencies": { "devDependencies": {
"@types/node": "^20.11.0", "@types/node": "^20.11.0",
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "zotero-org-export-annotations", "name": "zotero-org-export-annotations",
"version": "1.0.0", "version": "1.0.3",
"description": "Export Zotero PDF/EPUB annotations to Org-mode files for Emacs integration", "description": "Export Zotero PDF/EPUB annotations to Org-mode files for Emacs integration",
"config": { "config": {
"addonName": "Zotero Org Export Annotations", "addonName": "Zotero Org Export Annotations",
+4
View File
@@ -31,6 +31,10 @@ export class OrgExportAnnotationsAddon {
this.log(`Initialized version ${this.version}`); this.log(`Initialized version ${this.version}`);
} }
isBetterNotesInstalled(): boolean {
return Boolean(Zotero.BetterNotes?.api?.convert?.note2md);
}
log(message: string, ...args: unknown[]): void { log(message: string, ...args: unknown[]): void {
if (this.data.env === "development" || this.prefs?.debug) { if (this.data.env === "development" || this.prefs?.debug) {
Zotero.debug(`[OrgExportAnnotations] ${message}`, false); Zotero.debug(`[OrgExportAnnotations] ${message}`, false);
+12 -4
View File
@@ -12,14 +12,22 @@ export interface Hooks {
onMenuExportSelected(): Promise<void>; onMenuExportSelected(): Promise<void>;
} }
function showNotification(message: string): void { function showNotification(message: string, headline = "Org Export"): void {
const pw = new Zotero.ProgressWindow({ closeOnClick: true }); const pw = new Zotero.ProgressWindow({ closeOnClick: true });
pw.changeHeadline("Org Export"); pw.changeHeadline(headline);
pw.addDescription(message); pw.addDescription(message);
pw.show(); pw.show();
pw.startCloseTimer(4000); pw.startCloseTimer(4000);
} }
function warnBetterNotesRequired(addon: OrgExportAnnotationsAddon): void {
const message =
"Better Notes plugin is required for Org export.\n" +
"Please install it from: https://github.com/windingwind/zotero-better-notes";
addon.warn(message);
showNotification(message, "Org Export - Missing Requirement");
}
export function createHooks(addon: OrgExportAnnotationsAddon): Hooks { export function createHooks(addon: OrgExportAnnotationsAddon): Hooks {
let notifierIDs: string[] = []; let notifierIDs: string[] = [];
@@ -35,8 +43,8 @@ export function createHooks(addon: OrgExportAnnotationsAddon): Hooks {
Zotero.uiReadyPromise, Zotero.uiReadyPromise,
]); ]);
if (!Zotero.BetterNotes) { if (!addon.isBetterNotesInstalled()) {
addon.warn("Better Notes plugin not found - some features may not work"); warnBetterNotesRequired(addon);
} }
Zotero.PreferencePanes.register({ Zotero.PreferencePanes.register({
+1
View File
@@ -9,6 +9,7 @@ Zotero.OrgExportAnnotations = {
log: addon.log.bind(addon), log: addon.log.bind(addon),
error: addon.error.bind(addon), error: addon.error.bind(addon),
warn: addon.warn.bind(addon), warn: addon.warn.bind(addon),
isBetterNotesInstalled: addon.isBetterNotesInstalled.bind(addon),
get id() { get id() {
return addon.id; return addon.id;
}, },
+7
View File
@@ -9,6 +9,13 @@ export async function convertToOrg(
const mdPath = PathUtils.join(notesPath, `${citationKey}.md`); const mdPath = PathUtils.join(notesPath, `${citationKey}.md`);
try { try {
if (!Zotero.OrgExportAnnotations.isBetterNotesInstalled()) {
throw new Error(
"Better Notes plugin is required for Org export. " +
"Please install it from: https://github.com/windingwind/zotero-better-notes"
);
}
const mdContent = await Zotero.BetterNotes!.api.convert.note2md(note, notesPath); const mdContent = await Zotero.BetterNotes!.api.convert.note2md(note, notesPath);
await Zotero.File.putContentsAsync(mdPath, mdContent); await Zotero.File.putContentsAsync(mdPath, mdContent);
+5 -2
View File
@@ -143,8 +143,11 @@ export class OrgExporter {
throw new Error("Notes path is not configured"); throw new Error("Notes path is not configured");
} }
if (!Zotero.BetterNotes?.api?.convert?.note2md) { if (!Zotero.OrgExportAnnotations.isBetterNotesInstalled()) {
throw new Error("Better Notes plugin is required but not found"); throw new Error(
"Better Notes plugin is required for Org export. " +
"Please install it from: https://github.com/windingwind/zotero-better-notes"
);
} }
await this.prefs.ensureNotesDirectory(); await this.prefs.ensureNotesDirectory();
+1 -1
View File
@@ -18,7 +18,7 @@ export default defineConfig({
{ {
entryPoints: ["src/index.ts"], entryPoints: ["src/index.ts"],
bundle: true, bundle: true,
target: "firefox128", target: "firefox140",
outfile: ".scaffold/build/addon/content/scripts/index.js", outfile: ".scaffold/build/addon/content/scripts/index.js",
}, },
], ],