zotero-plugin 1.1.0 → 1.1.4

package/README.md

@@ -10,7 +10,7 @@ it will issue a new release. When it is ran on a branch named
 in your repo.
 
 For this to work you must have a variable named `GITHUB_TOKEN` in
-your travis environment with a githun token with `repo` rights. You
+your travis environment with a github token with `repo` rights. You
 are allowed one bot account by github; I use this to do the
 announcements, but you can use one from your own account if you
 want.
@@ -42,11 +42,17 @@ name = <your test profile name>
 path = <your test profile absolute path>
 
 [zotero]
+path = <explicit path to zotero binary> # optional
 log = <file name to write log output to> # optional
 db = <path to zotero.sqlite you want to populate the profile with> # optional
 
+[plugin]
+source = <plugin source directory> # optional
+build = <command to build your plugin, or false if no build is needed> # optional
+
 [preferences]
-extensions.zotero.<your extension>.<some setting> = true
+extensions.zotero.<your extension>.<some setting> = <value>
+extensions.zotero.<your extension>.<some other setting> = <value>
 ```
 
 and add this script to your package.json:
@@ -56,3 +62,7 @@ and add this script to your package.json:
 ```
 
 then when you execute `npm start`, zotero will start up with the latest build of your plugin installed.
+
+**DO CREATE A BACKUP OF YOUR ZOTERO DATA *AND* YOUR ZOTERO PROFILE BEFORE USING THIS THE FIRST TIME**
+
+`zotero-start` will **blindly** trust you've set it up right and will **alter data** in the profile

package/bin/start.py

@@ -4,7 +4,7 @@ import os, sys
 import shutil
 import json
 import configparser
-import argparse
+import glob
 import shlex
 import xml.etree.ElementTree as ET
 import subprocess
@@ -28,7 +28,7 @@ class Config:
     self.zotero = types.SimpleNamespace(
       path=config.get('zotero', 'path', fallback=None),
       log=config.get('zotero', 'log', fallback=None),
-      db=config.get('profile', 'db', fallback=None)
+      db=config.get('zotero', 'db', fallback=None)
     )
 
     if self.zotero.path:
@@ -43,6 +43,11 @@ class Config:
     if self.zotero.log:
       self.zotero.log = os.path.expanduser(self.zotero.log)
 
+    self.plugin = types.SimpleNamespace(
+      source=os.path.abspath(config.get('plugin', 'source', fallback=self.find_source())),
+      build=config.get('plugin', 'build', fallback='npm run build')
+    )
+
     if 'preferences' in config:
       self.preference = { k: self.pref_value(v) for k, v in dict(config['preferences']).items() }
     else:
@@ -57,6 +62,13 @@ class Config:
     self.preference['extensions.lastAppBuildId'] = None
     self.preference['extensions.lastAppVersion'] = None
 
+  def find_source(self):
+    for rdf in glob.glob(os.path.join('*', 'install.rdf')):
+      return os.path.dirname(rdf)
+    if os.path.isdir('build'):
+      return 'build'
+    return False
+
   def pref_value(self, v):
     if v in ['true', 'false']: return v == 'true'
     if v == 'null': return None
@@ -114,15 +126,16 @@ def system(cmd):
   print('$', cmd)
   subprocess.run(cmd, shell=True, check=True)
 
-system('npm run build')
+if config.plugin.build:
+  system(config.plugin.build)
 
 if config.zotero.db:
   shutil.copyfile(config.zotero.db, os.path.join(config.profile.path, 'zotero', 'zotero.sqlite'))
 
-for plugin_id in ET.parse(os.path.join('build', 'install.rdf')).getroot().findall('{http://www.w3.org/1999/02/22-rdf-syntax-ns#}Description/{http://www.mozilla.org/2004/em-rdf#}id'):
+for plugin_id in ET.parse(os.path.join(config.plugin.source, 'install.rdf')).getroot().findall('{http://www.w3.org/1999/02/22-rdf-syntax-ns#}Description/{http://www.mozilla.org/2004/em-rdf#}id'):
   plugin_path = os.path.join(config.profile.path, 'extensions', plugin_id.text)
 with open(plugin_path, 'w') as f:
-  sources = os.path.join(os.getcwd(), 'build')
+  sources = config.plugin.source
   if sources[-1] != '/': sources += '/'
   print(sources, file=f)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zotero-plugin",
-  "version": "1.1.0",
+  "version": "1.1.4",
   "description": "Zotero plugin builder",
   "homepage": "https://github.com/retorquere/zotero-plugin/wiki",
   "bin": {
@@ -40,7 +40,7 @@
     "current-git-branch": "^1.1.0",
     "dotenv": "^16.0.0",
     "ejs": "^3.1.6",
-    "eslint": "^8.8.0",
+    "eslint": "^8.9.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "glob": "^7.2.0",