Fix: Unescaped dataDir path in start.mjs

[ChenglongMa]

Hi,

Bug Description

In zotero-cmd.json, we are required to set the dataDir of Zotero, like:

  "exec": {
    "dataDir": "C:\\Zotero\\Data"
  }

In Win32 platform, the value will be converted to "C:\Zotero\Data" in start.mjs, which is invalid in prefs.js and thus will be reverted to Zotero's default value: C:\Users\<USERNAME>\Zotero.

Solutions

To fix or avoid this error, there are two solutions:

1. Set dataDir with 4 \, i.e.,

"exec": {
  "dataDir": "C:\\\\Zotero\\\\Data"
}

2. Use regex to convert dataDir to the correct form [Recommended]
   As shown in this PR, just add .replace(/\\\\?/g, "\\\\") in

   zotero-plugin-template/scripts/start.mjs

   Line 64 in 0663e5b

   return `user_pref("extensions.zotero.dataDir", "${dataDir}");`;

   It can convert both \\ or \\\\ to \\ automatically.

Thanks!

[volatile-static]

Why C:\\Zotero\\Data instead of C:\Zotero\Data?

[northword]

Why C:\\Zotero\\Data instead of C:\Zotero\Data?

反斜线转义

---

我倾向于第二种方案

[volatile-static]

Why C:\\Zotero\\Data instead of C:\Zotero\Data?

反斜线转义

我倾向于第二种方案

我没看懂这里为什么需要转义？我之前在这用没发现什么问题啊

[northword]

我没看懂这里为什么需要转义？我之前在这用没发现什么问题啊

[volatile-static]

我没看懂这里为什么需要转义？我之前在这用没发现什么问题啊

不是，这图里只是转义了一次啊，pr的不是4个反斜杠吗

[northword]

不是，这图里只是转义了一次啊，pr的不是4个反斜杠吗

转义一次是 \\，这是脚本可读的，脚本读到的是 \，所以存入 prefs.js 的是 \；
而存入 prefs.js 的也需要是 \\，所以脚本读到的也需要是 \\，所以要填 \\\\。

这样不直观，所以在脚本里加了替换，实际输入的时候仍只输入 \\ 就好。

[ChenglongMa]

不是，这图里只是转义了一次啊，pr的不是4个反斜杠吗

转义一次是 \\，这是脚本可读的，脚本读到的是 \，所以存入脚本的是 \； 而存入 prefs.js 的也需要是 \\，所以脚本读到的也需要是 \\，所以要填 \\\\。

这样不直观，所以在脚本里加了替换，实际输入的时候仍只输入 \\ 就好。

是的，正是这个意思。感谢解释！

[volatile-static]

哦，我不知道这里是存prefs的，打扰了

[github-actions]

🚀 This ticket has been resolved in v1.1.2. See Release 1.1.2 for release notes.