Improve the process of writing userscripts (#2362)

* add link from settings page to userscript directory * watch for changes to userscript directory
minbrowser · Jan 3, 2024 · ff1a185 · ff1a185
1 parent d082073
commit ff1a185
Show file tree

Hide file tree

Showing 40 changed files with 106 additions and 12 deletions.
diff --git a/js/preload/default.js b/js/preload/default.js
@@ -50,7 +50,11 @@ window.addEventListener('message', function (e) {
     return
   }
 
-  if (e.data && e.data.message && e.data.message === 'showCredentialList') {
+  if (e.data?.message === 'showCredentialList') {
     ipc.send('showCredentialList')
   }
+
+  if (e.data?.message === 'showUserscriptDirectory') {
+    ipc.send('showUserscriptDirectory')
+  }
 })
diff --git a/js/userscripts.js b/js/userscripts.js
@@ -1,5 +1,8 @@
 /* implements userscript support */
 
+var path = require('path')
+var chokidar = require('chokidar')
+
 var webviews = require('webviews.js')
 var settings = require('util/settings/settings.js')
 var bangsPlugin = require('searchbar/bangsPlugin.js')
@@ -65,22 +68,37 @@ function urlMatchesPattern (url, pattern) {
 }
 
 const userscripts = {
+  scriptDir: path.join(window.globalArgs['user-data-path'], 'userscripts'),
   scripts: [], // {options: {}, content}
+  showDirectory: function () {
+    electron.shell.openPath(userscripts.scriptDir)
+  },
+  ensureDirectoryExists: function () {
+    fs.access(userscripts.scriptDir, fs.constants.R_OK, function (err) {
+      if (err) {
+        fs.mkdir(userscripts.scriptDir, function (err) {
+          if (err) {
+            console.warn('failed to create userscripts directory', err)
+          }
+        })
+      }
+    })
+  },
   loadScripts: function () {
     userscripts.scripts = []
 
-    var path = require('path')
-    var scriptDir = path.join(window.globalArgs['user-data-path'], 'userscripts')
-
-    fs.readdir(scriptDir, function (err, files) {
-      if (err || files.length === 0) {
+    fs.readdir(userscripts.scriptDir, function (err, files) {
+      if (err) {
+        userscripts.ensureDirectoryExists()
+        return
+      } else if (files.length === 0) {
         return
       }
 
       // store the scripts in memory
       files.forEach(function (filename) {
         if (filename.endsWith('.js')) {
-          fs.readFile(path.join(scriptDir, filename), 'utf-8', function (err, file) {
+          fs.readFile(path.join(userscripts.scriptDir, filename), 'utf-8', function (err, file) {
             if (err || !file) {
               return
             }
@@ -127,6 +145,26 @@ const userscripts = {
       })
     })
   },
+  startDirWatcher: function () {
+    userscripts.stopDirWatcher() // destroy any previous instance
+    userscripts.watcherInstance = chokidar.watch(userscripts.scriptDir, {
+      ignoreInitial: true,
+      disableGlobbing: true,
+      awaitWriteFinish: {
+        stabilityThreshold: 500,
+        pollInterval: 100
+      }
+    })
+    userscripts.watcherInstance.on('all', debounce(function () {
+      userscripts.loadScripts()
+    }, 100))
+  },
+  stopDirWatcher: function () {
+    if (userscripts.watcherInstance) {
+      userscripts.watcherInstance.close()
+      userscripts.watcherInstance = null
+    }
+  },
   getMatchingScripts: function (src) {
     return userscripts.scripts.filter(function (script) {
       if (
@@ -167,12 +205,18 @@ const userscripts = {
     settings.listen('userscriptsEnabled', function (value) {
       if (value === true) {
         userscripts.loadScripts()
+        userscripts.startDirWatcher()
       } else {
         userscripts.scripts = []
+        userscripts.stopDirWatcher()
       }
     })
     webviews.bindEvent('dom-ready', userscripts.onPageLoad)
 
+    webviews.bindIPC('showUserscriptDirectory', function () {
+      userscripts.showDirectory()
+    })
+
     bangsPlugin.registerCustomBang({
       phrase: '!run',
       snippet: l('runUserscript'),

diff --git a/localization/languages/ar.json b/localization/languages/ar.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "يمكن سكريبت المستخدم من  تغير سلوك المواقع - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">معرفة المزيد</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "خاص user-agent إستخدم",
     "settingsUpdateNotificationsToggle": "إبحث تلقائيا عن التحديثات",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/be.json b/localization/languages/be.json
@@ -163,7 +163,8 @@
       "settingsUserscriptsExplanation": {
         "unsafeHTML": "Карыстальнiцкiя скрыпты дазваляюць змяняць паводзіны сайтаў - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">даведацца больш</a>."
       },
-      "settingsUserAgentToggle": "Выкарыстоўваць карыстацкі user agent",
+      "settingsUserscriptShowDirectory": null, //missing translation,
+    "settingsUserAgentToggle": "Выкарыстоўваць карыстацкі user agent",
       "settingsUpdateNotificationsToggle": "Аўтаматычна правяраць наяўнасць абнаўленняў",
       "settingsUsageStatisticsToggle": {
         "unsafeHTML": "Адпраўляць статыстыку выкарыстання (<a href=\"https://github.com/minbrowser/min/blob/master/docs/statistics.md\">Больш інфармацыі</a>)"

diff --git a/localization/languages/bg.json b/localization/languages/bg.json
@@ -162,6 +162,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Потребителските скриптове Ви позволяват да промените поведението на уеб сайтове - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">научете повече</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Използване на персонализиран потребителски агент",
     "settingsUpdateNotificationsToggle": "Автоматично проверяване за актуализации",
     "settingsUsageStatisticsToggle": null, //missing translation

diff --git a/localization/languages/bn.json b/localization/languages/bn.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "ব্যবহারকারীর স্ক্রিপ্ট আপনাকে ওয়েবসাইটের আচরণ পরিবর্তন করার অনুমতি দেয় - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\"> আরও শিখুন </a>"
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "একটি কাস্টম ব্যবহারকারী এজেন্ট ব্যবহার করুন",
     "settingsUpdateNotificationsToggle": "স্বয়ংক্রিয়ভাবে আপডেটগুলির জন্য পরীক্ষা করুন",
     "settingsUsageStatisticsToggle": null, //missing translation

diff --git a/localization/languages/ca.json b/localization/languages/ca.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Els scripts d'usuari et permeten modificar el comportament dels llocs web - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">més informació</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Utilitzar un agent d'usuari personalitzat",
     "settingsUpdateNotificationsToggle": "Comprovar actualitzacions automàticament",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/cs.json b/localization/languages/cs.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Uživatelské skripty umožňují upravit chování webových stránek - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">více informací</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Použít vlastní User-Agent řetězec",
     "settingsUpdateNotificationsToggle": "Automaticky kontrolovat aktualizace",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/da.json b/localization/languages/da.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Brugerscripts giver dig mulighed for at ændre adfærd på websteder - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">få mere at vide her</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Brug en brugerdefineret brugeragent",
     "settingsUpdateNotificationsToggle": "Kontroller automatisk for opdateringer",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/de.json b/localization/languages/de.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Benutzerdefinierte Skripte erlauben es das Verhalten von Webseiten zu modifizieren - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\"> mehr dazu.</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Benutzerdefinierten Benutzer-Agent nutzen",
     "settingsUpdateNotificationsToggle": "Automatisch nach Aktualisierungen überprüfen",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/el.json b/localization/languages/el.json
@@ -163,7 +163,8 @@
       "settingsUserscriptsExplanation": {
         "unsafeHTML": "Τα scripts χρηστών σας επιτρέπουν να τροποποιήσετε την συμπεριφορά των ιστοσελίδων - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">μάθετε περισσότερα</a>."
       },
-      "settingsUserAgentToggle": "Χρήση προσαρμοσμένου χρήστη agent",
+      "settingsUserscriptShowDirectory": null, //missing translation,
+    "settingsUserAgentToggle": "Χρήση προσαρμοσμένου χρήστη agent",
       "settingsUpdateNotificationsToggle": "Αυτόματος έλεγχος για ενημερώσεις",
       "settingsUsageStatisticsToggle": {
         "unsafeHTML": "Αποστολή στατιστικών χρήσης (<a href=\"https://github.com/minbrowser/min/blob/master/docs/statistics.md\">Παραπάνω πληροφορίες</a>)"

diff --git a/localization/languages/en-US.json b/localization/languages/en-US.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "User scripts allow you to modify the behavior of websites - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">learn more</a>."
     },
+    "settingsUserscriptShowDirectory": "Show script directory",
     "settingsUserAgentToggle": "Use a custom user agent",
     "settingsUpdateNotificationsToggle": "Automatically check for updates",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/es.json b/localization/languages/es.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Los userscripts te permiten modificar el comportamiento de los sitios web - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">Más información</a>."
     }, //"learn more" was translated to "más información" (more info)
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Usar agente de usuario personalizado",
     "settingsUpdateNotificationsToggle": "Buscar actualizaciones automáticamente",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/fa.json b/localization/languages/fa.json
@@ -164,6 +164,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "اسکریپت های کاربر این اجازه را به شما می دهند تا رفتار سایت ها را تغییر دهید - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">اطلاعات بیشتر</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": null, //missing translation
     "settingsUpdateNotificationsToggle": null, //missing translation
     "settingsUsageStatisticsToggle": null, //missing translation

diff --git a/localization/languages/fi.json b/localization/languages/fi.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Komentosarjat mahdollistavat sivustojen käyttäytymisen mukauttamisen - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">lisätietoja</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Käytä mukautettua käyttäjäagenttia",
     "settingsUpdateNotificationsToggle": "Tarkista päivitykset automaattisesti",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/fr.json b/localization/languages/fr.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Les scripts personnalisés vous permettent de modifier le comportement des pages web - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">en savoir plus (en anglais)</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Utiliser un user-agent particulier",
     "settingsUpdateNotificationsToggle": "Vérifier automatiquement pour des mises à jour",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/hr.json b/localization/languages/hr.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Korisničke skripte omogućuju vam izmjenu ponašanja web stranica - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">Saznajte više</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Upotrijebite prilagođeni korisnički agent",
     "settingsUpdateNotificationsToggle": "Automatski provjeri ima li ažuriranja",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/hu.json b/localization/languages/hu.json
@@ -161,6 +161,7 @@
     "settingsAutoplayToggle": null, //missing translation 
     "settingsOpenTabsInForegroundToggle": null, //missing translation
     "settingsUserscriptsExplanation": "Felhasználói szkript magyarázat",
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": null, //missing translation
     "settingsUpdateNotificationsToggle": null, //missing translation
     "settingsUsageStatisticsToggle": null, //missing translation

diff --git a/localization/languages/id.json b/localization/languages/id.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "User script memungkinkan Anda untuk merubah perilaku situs web - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">Pelajari lebih lanjut</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Gunakan user agent khusus",
     "settingsUpdateNotificationsToggle": "Cek pembaruan secara otomatis",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/it.json b/localization/languages/it.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Gli script definiti dall'utente ti permettono di modificare il comportamento dei siti - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">scopri di più</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Utilizza un user agent personalizzato",
     "settingsUpdateNotificationsToggle": "Controlla automaticamente la presenza di aggiornamenti",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/ja.json b/localization/languages/ja.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "ユーザースクリプトを使用して、Webサイトの動作を変更できます -  <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">詳細</a>。"
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "カスタムユーザーエージェントを使用する",
     "settingsUpdateNotificationsToggle": "アップデートを自動的に確認する",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/ko.json b/localization/languages/ko.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "사용자 명령(스크립트)을 사용하면 누리집의 행동을 수정할 수 있습니다. - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">더보기</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "사용자 정의 에이전트(UserAgent) 사용",
     "settingsUpdateNotificationsToggle": "판올림 자동 확인",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/lt.json b/localization/languages/lt.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Naudotojo scenarijai leidžia jums modifikuoti internetinių svetainių elgseną - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">sužinokite daugiau</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": null, //missing translation
     "settingsUpdateNotificationsToggle": "Automatiškai tikrinti ar yra atnaujinimų",
     "settingsUsageStatisticsToggle": null, //missing translation

diff --git a/localization/languages/nl.json b/localization/languages/nl.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Gebruikersscripten kunt u gebruiken om het gedrag van websites te wijzigingen - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">lees meer</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Gebruik een aangepaste gebruikersagent",
     "settingsUpdateNotificationsToggle": "Automatisch controleren op updates",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/pl.json b/localization/languages/pl.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Skrypty użytkownika pozwalają modyfikować zachowanie stron internetowych - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">dowiedz się więcej</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Użyj niestandardowego klienta użytkownika",
     "settingsUpdateNotificationsToggle": "Automatycznie sprawdź dostępność aktualizacji",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/pt-BR.json b/localization/languages/pt-BR.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Scripts do usuário permitem modificar o comportamento do site - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">Saiba mais</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Usar agente de usuário personalizado",
     "settingsUpdateNotificationsToggle": "Verificar atualizações automaticamente",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/pt-PT.json b/localization/languages/pt-PT.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Os scripts permitem-lhe alterar o comportamento dos sites - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">Saber mais</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Utilizar um agente de utilizador personalizado",
     "settingsUpdateNotificationsToggle": "Procurar atualizações automaticamente",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/ru.json b/localization/languages/ru.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Пользовательские скрипты позволяют изменять поведение сайтов - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">узнать больше</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Использовать пользовательский user agent",
     "settingsUpdateNotificationsToggle": "Автоматически проверять наличие обновлений",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/sr.json b/localization/languages/sr.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "Korisničke skripte omogućavaju modifikovanje ponašanja sajtova - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">learn more</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "Koristi prilagođeni korisnički agent",
     "settingsUpdateNotificationsToggle": "Automatski obaveštavaj o novim verzijama Min",
     "settingsUsageStatisticsToggle": {

diff --git a/localization/languages/th.json b/localization/languages/th.json
@@ -163,6 +163,7 @@
     "settingsUserscriptsExplanation": {
       "unsafeHTML": "สคริปต์ผู้ใช้ที่จะช่วยให้คุณปรับเปลี่ยนพฤติกรรมของเว็บไซต์ได้ - <a href=\"https://github.com/minbrowser/min/wiki/userscripts\">เรียนรู้เพิ่มเติม</a>."
     },
+    "settingsUserscriptShowDirectory": null, //missing translation,
     "settingsUserAgentToggle": "ใช้ตัวแทนผู้ใช้ที่กำหนดค่าเอง",
     "settingsUpdateNotificationsToggle": "ตรวจสอบการอัปเดตโดยอัตโนมัติ",
     "settingsUsageStatisticsToggle": {