zotero-plugin 1.2.0 → 1.2.3

package/README.md

@@ -28,6 +28,21 @@ add `#<number>` to the commit message.
 
 Release new versions by issuing `npm version <major|minor|patch>`.
 
+# Allowing your user to send debug information
+
+In your plugin, add `import { DebugLog } from 'zotero-plugin/debug-log'` to your startup file, then
+after `Zotero.Schema.updateSchemaPromise` clears, call
+
+```
+DebugLog.register('your plugin name', ['extensions.zotero.<your plugin extension root>.'])
+```
+
+the array is a list of either full names of preferences you want to know about, or a name ending in `.` which means "all keys directly under this".
+
+The Help menu will now have an entry "send debug log to file.io"; when your user selects that, the error log and the selected settings will be sent to file.io; if any items are selected, when that is clicked, a copy of those items will be included in RDF format.
+
+The user will get an ID that looks like `C3WvhYgA8RDM-2XZGASLV`; the first part is the file.io ID, so you would go to `https://file.io/C3WvhYgA8RDM` to retrieve the download; the zipfile you get there will be `2XZGASLV.zip`.
+
 # Starting Zotero with your plugin loaded
 
 Note is is *much* adviced to create a separate Zotero profile for testing!
@@ -38,7 +53,7 @@ Create a file called `zotero-plugin.ini` with the following contents:
 
 ```
 [profile]
-name = <your test profile name>
+name = <your test profile name> # optional. when not present, the profile picker will popup, where you can select the test profile
 path = <your test profile absolute path>
 
 [zotero]
@@ -61,7 +76,7 @@ and add this script to your package.json:
   "start": "zotero-start"
 ```
 
-then when you execute `npm start`, zotero will start up with the latest build of your plugin installed.
+then when you execute `npm start`, zotero will start up with the latest build of your plugin installed, and the given preferences set.
 
 **DO CREATE A BACKUP OF YOUR ZOTERO DATA *AND* YOUR ZOTERO PROFILE BEFORE USING THIS THE FIRST TIME**
 

package/bin/branches.js

@@ -5,10 +5,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 process.on('unhandledRejection', up => { throw up; });
 require("dotenv/config");
-const path = (0, tslib_1.__importStar)(require("path"));
+const path = tslib_1.__importStar(require("path"));
 const rest_1 = require("@octokit/rest");
 const octokit = new rest_1.Octokit({ auth: `token ${process.env.GITHUB_TOKEN}` });
-const root_1 = (0, tslib_1.__importDefault)(require("../root"));
+const root_1 = tslib_1.__importDefault(require("../root"));
 const pkg = require(path.join(root_1.default, 'package.json'));
 const [, owner, repo] = pkg.repository.url.match(/:\/\/github.com\/([^/]+)\/([^.]+)\.git$/);
 async function main() {

package/bin/link.js

@@ -3,9 +3,9 @@
 /* eslint-disable @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/restrict-template-expressions, @typescript-eslint/no-unsafe-call */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const fs = (0, tslib_1.__importStar)(require("fs"));
-const path = (0, tslib_1.__importStar)(require("path"));
-const root_1 = (0, tslib_1.__importDefault)(require("../root"));
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const root_1 = tslib_1.__importDefault(require("../root"));
 const pkg = Object.assign({}, require(path.join(root_1.default, 'package.json')));
 if (!pkg.id)
     pkg.id = `${pkg.name.replace(/^zotero-/, '')}@${pkg.author.email.replace(/.*@/, '')}`.toLowerCase();

package/bin/release.js

@@ -5,16 +5,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 process.on('unhandledRejection', up => { throw up; });
 require("dotenv/config");
-const path = (0, tslib_1.__importStar)(require("path"));
-const moment_1 = (0, tslib_1.__importDefault)(require("moment"));
-const fs = (0, tslib_1.__importStar)(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const moment_1 = tslib_1.__importDefault(require("moment"));
+const fs = tslib_1.__importStar(require("fs"));
 const rest_1 = require("@octokit/rest");
 const octokit = new rest_1.Octokit({ auth: `token ${process.env.GITHUB_TOKEN}` });
 const continuous_integration_1 = require("../continuous-integration");
-const root_1 = (0, tslib_1.__importDefault)(require("../root"));
+const root_1 = tslib_1.__importDefault(require("../root"));
 const pkg = require(path.join(root_1.default, 'package.json'));
 const [, owner, repo] = pkg.repository.url.match(/:\/\/github.com\/([^/]+)\/([^.]+)\.git$/);
-const version_1 = (0, tslib_1.__importDefault)(require("../version"));
+const version_1 = tslib_1.__importDefault(require("../version"));
 const xpi = `${pkg.name}-${version_1.default}.xpi`;
 const PRERELEASE = false;
 // eslint-disable-next-line no-magic-numbers

package/bin/start.py

@@ -140,30 +140,25 @@ for plugin_id in ET.parse(os.path.join(config.plugin.source, 'install.rdf')).get
   plugin_path = os.path.join(config.profile.path, 'extensions', plugin_id.text)
 with open(plugin_path, 'w') as f:
   sources = config.plugin.source
-  if sources[-1] != '/': sources += '/'
+  if sources[-1] not in '/\\': sources += os.sep
 
   if config.windows:
     sources = sources.replace('\\', '\\\\').replace('/', '\\\\')
 
   print('Writing addon source path to proxy file')
-  print('Source path: ' + sources)
-  print('Proxy file path: ' + plugin_path)
+  print('Source path:', sources)
+  print('Proxy file path:', plugin_path)
 
   print(sources, file=f)
 
-cmd = [
-  p for p in
-    [
-      config.zotero.path,
-      '-purgecaches',
-      '-P', config.profile.name,
-      '-ZoteroDebug' if config.windows else '-ZoteroDebugText',
-      '-jsconsole',
-      '-datadir', 'profile',
-      config.zotero.log and '>',
-      config.zotero.log,
-      '&',
-    ]
-  if p is not None
-]
+cmd = filter(None, [
+  config.zotero.path,
+  '-purgecaches',
+  '-P', config.profile.name,
+  '-ZoteroDebug' if config.windows else '-ZoteroDebugText',
+  '-jsconsole',
+  '-datadir', 'profile',
+  config.zotero.log and '>', config.zotero.log,
+  '&',
+])
 system(subprocess.list2cmdline(cmd))

package/bin/zipup.js

@@ -3,11 +3,11 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const fs = (0, tslib_1.__importStar)(require("fs"));
-const path = (0, tslib_1.__importStar)(require("path"));
-const archiver = (0, tslib_1.__importStar)(require("archiver"));
-const root_1 = (0, tslib_1.__importDefault)(require("../root"));
-const version_1 = (0, tslib_1.__importDefault)(require("../version"));
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const archiver = tslib_1.__importStar(require("archiver"));
+const root_1 = tslib_1.__importDefault(require("../root"));
+const version_1 = tslib_1.__importDefault(require("../version"));
 const [, , source, target] = process.argv;
 const xpi = path.join(root_1.default, 'xpi', `${target}-${version_1.default}.xpi`);
 console.log(`creating ${xpi}`); // eslint-disable-line no-console

package/continuous-integration.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContinuousIntegration = void 0;
 const tslib_1 = require("tslib");
-const child_process = (0, tslib_1.__importStar)(require("child_process"));
+const child_process = tslib_1.__importStar(require("child_process"));
 class ContinuousIntegrationSingleton {
     constructor() {
         this.service = '';

package/copy-assets.js

@@ -2,10 +2,10 @@
 /* eslint-disable no-console, @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const fs = (0, tslib_1.__importStar)(require("fs"));
-const glob = (0, tslib_1.__importStar)(require("glob"));
-const path = (0, tslib_1.__importStar)(require("path"));
-const root_1 = (0, tslib_1.__importDefault)(require("./root"));
+const fs = tslib_1.__importStar(require("fs"));
+const glob = tslib_1.__importStar(require("glob"));
+const path = tslib_1.__importStar(require("path"));
+const root_1 = tslib_1.__importDefault(require("./root"));
 function include(file, sources) {
     if (fs.lstatSync(file).isDirectory())
         return false;

package/debug-log.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DebugLog = void 0;
 const tslib_1 = require("tslib");
-const jszip_1 = (0, tslib_1.__importDefault)(require("jszip"));
+const jszip_1 = tslib_1.__importDefault(require("jszip"));
 class DebugLogSender {
     constructor() {
         this.enabled = false;
@@ -78,18 +78,22 @@ class DebugLogSender {
     }
     preferences(plugin) {
         const prefs = {};
+        const names = [];
         for (const pref of this.plugins[plugin] || []) {
             if (pref.endsWith('.')) {
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
                 const childkeys = Services.prefs.getBranch(pref).getChildList('', {});
                 for (const key of childkeys) {
-                    prefs[pref + key] = Zotero.Prefs.get(pref + key, true);
+                    names.push(pref + key);
                 }
             }
             else {
-                prefs[pref] = Zotero.Prefs.get(pref, true);
+                names.push(pref);
             }
         }
+        for (const pref of names.sort()) {
+            prefs[pref] = Zotero.Prefs.get(pref, true);
+        }
         return prefs;
     }
     async post(url, data) {

package/loader/peggy.js

@@ -1,7 +1,7 @@
 "use strict";
 /* eslint-disable prefer-arrow/prefer-arrow-functions, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call */
 const tslib_1 = require("tslib");
-const peggy = (0, tslib_1.__importStar)(require("peggy"));
+const peggy = tslib_1.__importStar(require("peggy"));
 module.exports = function loader(source) {
     return peggy.generate(source, {
         output: 'source',

package/loader/wrap.js

@@ -1,8 +1,8 @@
 "use strict";
 /* eslint-disable no-console, prefer-template, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/restrict-template-expressions */
 const tslib_1 = require("tslib");
-const path = (0, tslib_1.__importStar)(require("path"));
-const root_1 = (0, tslib_1.__importDefault)(require("../root"));
+const path = tslib_1.__importStar(require("path"));
+const root_1 = tslib_1.__importDefault(require("../root"));
 const pkg = Object.assign({}, require(path.join(root_1.default, 'package.json')));
 module.exports = function loader(source) {
     // this.cacheable()

package/make-dirs.js

@@ -2,10 +2,10 @@
 /* eslint-disable no-console, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const rimraf = (0, tslib_1.__importStar)(require("rimraf"));
-const fs = (0, tslib_1.__importStar)(require("fs"));
-const path = (0, tslib_1.__importStar)(require("path"));
-const root_1 = (0, tslib_1.__importDefault)(require("./root"));
+const rimraf = tslib_1.__importStar(require("rimraf"));
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const root_1 = tslib_1.__importDefault(require("./root"));
 console.log('make build dirs');
 for (const dir of [path.join(root_1.default, 'build'), path.join(root_1.default, 'gen'), path.join(root_1.default, 'xpi')]) {
     rimraf.sync(dir);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin",
-  "version": "1.2.0",
+  "version": "1.2.3",
   "description": "Zotero plugin builder",
   "homepage": "https://github.com/retorquere/zotero-plugin/wiki",
   "bin": {
@@ -29,10 +29,10 @@
   "dependencies": {
     "@octokit/rest": "^18.12.0",
     "@rgrove/parse-xml": "^3.0.0",
-    "@types/node": "^17.0.17",
-    "@typescript-eslint/eslint-plugin": "^5.11.0",
-    "@typescript-eslint/parser": "^5.11.0",
-    "@xmldom/xmldom": "^0.8.0",
+    "@types/node": "^17.0.21",
+    "@typescript-eslint/eslint-plugin": "^5.13.0",
+    "@typescript-eslint/parser": "^5.13.0",
+    "@xmldom/xmldom": "^0.8.1",
     "ajv": "^8.10.0",
     "ajv-keywords": "^5.1.0",
     "archiver": "^5.3.0",
@@ -40,7 +40,7 @@
     "current-git-branch": "^1.1.0",
     "dotenv": "^16.0.0",
     "ejs": "^3.1.6",
-    "eslint": "^8.9.0",
+    "eslint": "^8.10.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "glob": "^7.2.0",
@@ -55,9 +55,9 @@
     "shell-quote": "^1.7.3",
     "shelljs": "^0.8.5",
     "string-to-arraybuffer": "^1.0.2",
-    "ts-node": "^10.5.0",
+    "ts-node": "^10.6.0",
     "tslib": "^2.3.1",
-    "typescript": "^4.5.5",
+    "typescript": "^4.6.2",
     "uri-templates": "^0.2.0",
     "xml-parser": "^1.2.1",
     "xpath": "^0.0.32"

package/rdf.js

@@ -2,14 +2,14 @@
 /* eslint-disable no-console, @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/restrict-template-expressions */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const fs = (0, tslib_1.__importStar)(require("fs"));
-const path = (0, tslib_1.__importStar)(require("path"));
-const glob = (0, tslib_1.__importStar)(require("glob"));
-const pug = (0, tslib_1.__importStar)(require("pug"));
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const glob = tslib_1.__importStar(require("glob"));
+const pug = tslib_1.__importStar(require("pug"));
 const PropertiesReader = require("properties-reader");
 const uriTemplate = require("uri-templates");
-const root_1 = (0, tslib_1.__importDefault)(require("./root"));
-const version_1 = (0, tslib_1.__importDefault)(require("./version"));
+const root_1 = tslib_1.__importDefault(require("./root"));
+const version_1 = tslib_1.__importDefault(require("./version"));
 const pkg = Object.assign({}, require(path.join(root_1.default, 'package.json')));
 if (!pkg.id)
     pkg.id = `${pkg.name.replace(/^zotero-/, '')}@${pkg.author.email.replace(/.*@/, '')}`.toLowerCase();

package/version.js

@@ -2,10 +2,10 @@
 /* eslint-disable no-console */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const path = (0, tslib_1.__importStar)(require("path"));
-const os = (0, tslib_1.__importStar)(require("os"));
-const fs = (0, tslib_1.__importStar)(require("fs"));
-const root_1 = (0, tslib_1.__importDefault)(require("./root"));
+const path = tslib_1.__importStar(require("path"));
+const os = tslib_1.__importStar(require("os"));
+const fs = tslib_1.__importStar(require("fs"));
+const root_1 = tslib_1.__importDefault(require("./root"));
 const continuous_integration_1 = require("./continuous-integration");
 let version = null;
 const version_js = path.join(root_1.default, 'gen/version.js');