feat: Add buttons in the 'Advanced' section of preferences to allow the user to quickly open the Ferdi profile folder

8 files changed, 167 insertions, 46 deletions

diff --git a/src/components/settings/settings/EditSettingsForm.js b/src/components/settings/settings/EditSettingsForm.js
index 9db434099..1df8c3527 100644
--- a/src/components/settings/settings/EditSettingsForm.js
+++ b/src/components/settings/settings/EditSettingsForm.js
@@ -16,7 +16,7 @@ import {
   FRANZ_TRANSLATION,
   GITHUB_FRANZ_URL,
 } from '../../../config';
-import { DEFAULT_APP_SETTINGS, ferdiVersion, isMac, isWindows, lockFerdiShortcutKey } from '../../../environment';
+import { DEFAULT_APP_SETTINGS, ferdiVersion, isMac, isWindows, lockFerdiShortcutKey, openPath, userDataPath, userDataRecipesPath } from '../../../environment';
 import globalMessages from '../../../i18n/globalMessages';
 
 const messages = defineMessages({
@@ -116,6 +116,18 @@ const messages = defineMessages({
     id: 'settings.app.buttonClearAllCache',
     defaultMessage: '!!!Clear cache',
   },
+  subheadlineFerdiProfile: {
+    id: 'settings.app.subheadlineFerdiProfile',
+    defaultMessage: '!!!Ferdi Profile',
+  },
+  buttonOpenFerdiProfileFolder: {
+    id: 'settings.app.buttonOpenFerdiProfileFolder',
+    defaultMessage: '!!!Open Profile folder',
+  },
+  buttonOpenFerdiServiceRecipesFolder: {
+    id: 'settings.app.buttonOpenFerdiServiceRecipesFolder',
+    defaultMessage: '!!!Open Service Recipes folder',
+  },
   buttonSearchForUpdate: {
     id: 'settings.app.buttonSearchForUpdate',
     defaultMessage: '!!!Check for updates',
@@ -259,6 +271,9 @@ export default @observer class EditSettingsForm extends Component {
       }
     }
 
+    const profileFolder = userDataPath();
+    const recipeFolder = userDataRecipesPath();
+
     return (
       <div className="settings__main">
         <div className="settings__header">
@@ -631,6 +646,30 @@ export default @observer class EditSettingsForm extends Component {
                     />
                   </p>
                 </div>
+
+                <Hr />
+
+                <div className="settings__settings-group">
+                  <h3>
+                    {intl.formatMessage(messages.subheadlineFerdiProfile)}
+                  </h3>
+                  <p>
+                    <div className="settings__open-settings-file-container">
+                      <Button
+                        buttonType="secondary"
+                        label={intl.formatMessage(messages.buttonOpenFerdiProfileFolder)}
+                        className="settings__open-settings-file-button"
+                        onClick={() => openPath(profileFolder)}
+                      />
+                      <Button
+                        buttonType="secondary"
+                        label={intl.formatMessage(messages.buttonOpenFerdiServiceRecipesFolder)}
+                        className="settings__open-settings-file-button"
+                        onClick={() => openPath(recipeFolder)}
+                      />
+                    </div>
+                  </p>
+                </div>
               </div>
             )}
 
diff --git a/src/containers/settings/RecipesScreen.js b/src/containers/settings/RecipesScreen.js
index 52bf31383..526e0a1a9 100644
--- a/src/containers/settings/RecipesScreen.js
+++ b/src/containers/settings/RecipesScreen.js
@@ -1,5 +1,4 @@
-import { shell } from 'electron';
-import { ensureDirSync, readJsonSync } from 'fs-extra';
+import { readJsonSync } from 'fs-extra';
 import React, { Component } from 'react';
 import PropTypes from 'prop-types';
 import { autorun } from 'mobx';
@@ -13,7 +12,7 @@ import UserStore from '../../stores/UserStore';
 import RecipesDashboard from '../../components/settings/recipes/RecipesDashboard';
 import ErrorBoundary from '../../components/util/ErrorBoundary';
 import { CUSTOM_WEBSITE_RECIPE_ID, FRANZ_DEV_DOCS } from '../../config';
-import { asarRecipesPath, userDataRecipesPath } from '../../environment';
+import { asarRecipesPath, openPath, userDataRecipesPath } from '../../environment';
 import { communityRecipesStore } from '../../features/communityRecipes';
 import RecipePreview from '../../models/RecipePreview';
 import AppStore from '../../stores/AppStore';
@@ -154,13 +153,8 @@ export default @inject('stores', 'actions') @observer class RecipesScreen extend
           serviceStatus={services.actionStatus}
           recipeFilter={filter}
           recipeDirectory={recipeDirectory}
-          openRecipeDirectory={async () => {
-            ensureDirSync(recipeDirectory);
-            shell.openExternal(`file://${recipeDirectory}`);
-          }}
-          openDevDocs={() => {
-            appActions.openExternalUrl({ url: FRANZ_DEV_DOCS });
-          }}
+          openRecipeDirectory={() => openPath(recipeDirectory)}
+          openDevDocs={() => appActions.openExternalUrl({ url: FRANZ_DEV_DOCS })}
         />
       </ErrorBoundary>
     );
diff --git a/src/environment.js b/src/environment.js
index f2a889be4..6332ad67b 100644
--- a/src/environment.js
+++ b/src/environment.js
@@ -1,7 +1,9 @@
 import os from 'os';
 import { join } from 'path';
+import { ensureDirSync } from 'fs-extra';
 
 import { is, api as electronApi } from 'electron-util';
+import { shell } from 'electron';
 
 import { DEFAULT_ACCENT_COLOR } from '@meetfranz/theme';
 
@@ -63,6 +65,11 @@ export function asarRecipesPath(...segments) {
   return join(asarPath(join(__dirname, 'recipes')), ...([segments].flat()));
 }
 
+export async function openPath(folderName) {
+  ensureDirSync(folderName);
+  shell.openPath(folderName);
+}
+
 export const useLiveAPI = process.env.USE_LIVE_API;
 const useLocalAPI = process.env.USE_LOCAL_API;
 
diff --git a/src/i18n/locales/defaultMessages.json b/src/i18n/locales/defaultMessages.json
index 683ec4628..da23ba1a3 100644
--- a/src/i18n/locales/defaultMessages.json
+++ b/src/i18n/locales/defaultMessages.json
@@ -3202,107 +3202,146 @@
         }
       },
       {
-        "defaultMessage": "!!!Check for updates",
+        "defaultMessage": "!!!Ferdi Profile",
         "end": {
           "column": 3,
           "line": 122
         },
         "file": "src/components/settings/settings/EditSettingsForm.js",
+        "id": "settings.app.subheadlineFerdiProfile",
+        "start": {
+          "column": 27,
+          "line": 119
+        }
+      },
+      {
+        "defaultMessage": "!!!Open Profile folder",
+        "end": {
+          "column": 3,
+          "line": 126
+        },
+        "file": "src/components/settings/settings/EditSettingsForm.js",
+        "id": "settings.app.buttonOpenFerdiProfileFolder",
+        "start": {
+          "column": 32,
+          "line": 123
+        }
+      },
+      {
+        "defaultMessage": "!!!Open Service Recipes folder",
+        "end": {
+          "column": 3,
+          "line": 130
+        },
+        "file": "src/components/settings/settings/EditSettingsForm.js",
+        "id": "settings.app.buttonOpenFerdiServiceRecipesFolder",
+        "start": {
+          "column": 39,
+          "line": 127
+        }
+      },
+      {
+        "defaultMessage": "!!!Check for updates",
+        "end": {
+          "column": 3,
+          "line": 134
+        },
+        "file": "src/components/settings/settings/EditSettingsForm.js",
         "id": "settings.app.buttonSearchForUpdate",
         "start": {
           "column": 25,
-          "line": 119
+          "line": 131
         }
       },
       {
         "defaultMessage": "!!!Restart & install update",
         "end": {
           "column": 3,
-          "line": 126
+          "line": 138
         },
         "file": "src/components/settings/settings/EditSettingsForm.js",
         "id": "settings.app.buttonInstallUpdate",
         "start": {
           "column": 23,
-          "line": 123
+          "line": 135
         }
       },
       {
         "defaultMessage": "!!!Is searching for update",
         "end": {
           "column": 3,
-          "line": 130
+          "line": 142
         },
         "file": "src/components/settings/settings/EditSettingsForm.js",
         "id": "settings.app.updateStatusSearching",
         "start": {
           "column": 25,
-          "line": 127
+          "line": 139
         }
       },
       {
         "defaultMessage": "!!!Update available, downloading...",
         "end": {
           "column": 3,
-          "line": 134
+          "line": 146
         },
         "file": "src/components/settings/settings/EditSettingsForm.js",
         "id": "settings.app.updateStatusAvailable",
         "start": {
           "column": 25,
-          "line": 131
+          "line": 143
         }
       },
       {
         "defaultMessage": "!!!You are using the latest version of Ferdi",
         "end": {
           "column": 3,
-          "line": 138
+          "line": 150
         },
         "file": "src/components/settings/settings/EditSettingsForm.js",
         "id": "settings.app.updateStatusUpToDate",
         "start": {
           "column": 24,
-          "line": 135
+          "line": 147
         }
       },
       {
         "defaultMessage": "!!!Current version:",
         "end": {
           "column": 3,
-          "line": 142
+          "line": 154
         },
         "file": "src/components/settings/settings/EditSettingsForm.js",
         "id": "settings.app.currentVersion",
         "start": {
           "column": 18,
-          "line": 139
+          "line": 151
         }
       },
       {
         "defaultMessage": "!!!Changes require restart",
         "end": {
           "column": 3,
-          "line": 146
+          "line": 158
         },
         "file": "src/components/settings/settings/EditSettingsForm.js",
         "id": "settings.app.restartRequired",
         "start": {
           "column": 22,
-          "line": 143
+          "line": 155
         }
       },
       {
         "defaultMessage": "!!!Official translations are English & German. All other languages are community based translations.",
         "end": {
           "column": 3,
-          "line": 150
+          "line": 162
         },
         "file": "src/components/settings/settings/EditSettingsForm.js",
         "id": "settings.app.languageDisclaimer",
         "start": {
           "column": 22,
-          "line": 147
+          "line": 159
         }
       }
     ],
diff --git a/src/i18n/locales/en-US.json b/src/i18n/locales/en-US.json
index 002ea5655..1afa2c183 100644
--- a/src/i18n/locales/en-US.json
+++ b/src/i18n/locales/en-US.json
@@ -205,6 +205,8 @@
   "settings.app.accentColorInfo": "Write your accent color in a CSS-compatible format. (Default: {defaultAccentColor})",
   "settings.app.buttonClearAllCache": "Clear cache",
   "settings.app.buttonInstallUpdate": "Restart & install update",
+  "settings.app.buttonOpenFerdiProfileFolder": "Open Profile folder",
+  "settings.app.buttonOpenFerdiServiceRecipesFolder": "Open Service Recipes folder",
   "settings.app.buttonSearchForUpdate": "Check for updates",
   "settings.app.cacheInfo": "Ferdi cache is currently using {size} of disk space.",
   "settings.app.cacheNotCleared": "Couldn't clear all cache",
@@ -275,6 +277,7 @@
   "settings.app.sentryInfo": "Sending telemetry data allows us to find errors in Ferdi - we will not send any personal information like your message data!",
   "settings.app.spellCheckerLanguageInfo": "Ferdi uses your Mac's build-in spellchecker to check for typos. If you want to change the languages the spellchecker checks for, you can do so in your Mac's System Preferences.",
   "settings.app.subheadlineCache": "Cache",
+  "settings.app.subheadlineFerdiProfile": "Ferdi Profile",
   "settings.app.todoServerInfo": "This server will be used for the \"Ferdi Todo\" feature.",
   "settings.app.translationHelp": "Help us to translate Ferdi into your language.",
   "settings.app.universalDarkModeInfo": "Universal Dark Mode tries to dynamically generate dark mode styles for services that are otherwise not currently supported.",
diff --git a/src/i18n/messages/src/components/settings/settings/EditSettingsForm.json b/src/i18n/messages/src/components/settings/settings/EditSettingsForm.json
index 548d52af9..2b9a00daf 100644
--- a/src/i18n/messages/src/components/settings/settings/EditSettingsForm.json
+++ b/src/i18n/messages/src/components/settings/settings/EditSettingsForm.json
@@ -312,15 +312,54 @@
     }
   },
   {
+    "id": "settings.app.subheadlineFerdiProfile",
+    "defaultMessage": "!!!Ferdi Profile",
+    "file": "src/components/settings/settings/EditSettingsForm.js",
+    "start": {
+      "line": 119,
+      "column": 27
+    },
+    "end": {
+      "line": 122,
+      "column": 3
+    }
+  },
+  {
+    "id": "settings.app.buttonOpenFerdiProfileFolder",
+    "defaultMessage": "!!!Open Profile folder",
+    "file": "src/components/settings/settings/EditSettingsForm.js",
+    "start": {
+      "line": 123,
+      "column": 32
+    },
+    "end": {
+      "line": 126,
+      "column": 3
+    }
+  },
+  {
+    "id": "settings.app.buttonOpenFerdiServiceRecipesFolder",
+    "defaultMessage": "!!!Open Service Recipes folder",
+    "file": "src/components/settings/settings/EditSettingsForm.js",
+    "start": {
+      "line": 127,
+      "column": 39
+    },
+    "end": {
+      "line": 130,
+      "column": 3
+    }
+  },
+  {
     "id": "settings.app.buttonSearchForUpdate",
     "defaultMessage": "!!!Check for updates",
     "file": "src/components/settings/settings/EditSettingsForm.js",
     "start": {
-      "line": 119,
+      "line": 131,
       "column": 25
     },
     "end": {
-      "line": 122,
+      "line": 134,
       "column": 3
     }
   },
@@ -329,11 +368,11 @@
     "defaultMessage": "!!!Restart & install update",
     "file": "src/components/settings/settings/EditSettingsForm.js",
     "start": {
-      "line": 123,
+      "line": 135,
       "column": 23
     },
     "end": {
-      "line": 126,
+      "line": 138,
       "column": 3
     }
   },
@@ -342,11 +381,11 @@
     "defaultMessage": "!!!Is searching for update",
     "file": "src/components/settings/settings/EditSettingsForm.js",
     "start": {
-      "line": 127,
+      "line": 139,
       "column": 25
     },
     "end": {
-      "line": 130,
+      "line": 142,
       "column": 3
     }
   },
@@ -355,11 +394,11 @@
     "defaultMessage": "!!!Update available, downloading...",
     "file": "src/components/settings/settings/EditSettingsForm.js",
     "start": {
-      "line": 131,
+      "line": 143,
       "column": 25
     },
     "end": {
-      "line": 134,
+      "line": 146,
       "column": 3
     }
   },
@@ -368,11 +407,11 @@
     "defaultMessage": "!!!You are using the latest version of Ferdi",
     "file": "src/components/settings/settings/EditSettingsForm.js",
     "start": {
-      "line": 135,
+      "line": 147,
       "column": 24
     },
     "end": {
-      "line": 138,
+      "line": 150,
       "column": 3
     }
   },
@@ -381,11 +420,11 @@
     "defaultMessage": "!!!Current version:",
     "file": "src/components/settings/settings/EditSettingsForm.js",
     "start": {
-      "line": 139,
+      "line": 151,
       "column": 18
     },
     "end": {
-      "line": 142,
+      "line": 154,
       "column": 3
     }
   },
@@ -394,11 +433,11 @@
     "defaultMessage": "!!!Changes require restart",
     "file": "src/components/settings/settings/EditSettingsForm.js",
     "start": {
-      "line": 143,
+      "line": 155,
       "column": 22
     },
     "end": {
-      "line": 146,
+      "line": 158,
       "column": 3
     }
   },
@@ -407,11 +446,11 @@
     "defaultMessage": "!!!Official translations are English & German. All other languages are community based translations.",
     "file": "src/components/settings/settings/EditSettingsForm.js",
     "start": {
-      "line": 147,
+      "line": 159,
       "column": 22
     },
     "end": {
-      "line": 150,
+      "line": 162,
       "column": 3
     }
   }
diff --git a/src/index.js b/src/index.js
index b1d4907cc..f6573d8f5 100644
--- a/src/index.js
+++ b/src/index.js
@@ -329,7 +329,7 @@ const createWindow = () => {
 
   if (isMac) {
     // eslint-disable-next-line global-require
-    const { default: askFormacOSPermissions } = require('./electron/macOSPermissions');
+    const { askFormacOSPermissions } = require('./electron/macOSPermissions');
     setTimeout(() => askFormacOSPermissions(mainWindow), ms('30s'));
   }
 
diff --git a/src/styles/settings.scss b/src/styles/settings.scss
index 501f97b98..f06ed7ef8 100644
--- a/src/styles/settings.scss
+++ b/src/styles/settings.scss
@@ -361,11 +361,11 @@
   .settings__delete-button {
     right: 0;
   }
-  .settings__open-recipe-file-button {
+  .settings__open-recipe-file-button, .settings__open-settings-file-button {
     cursor: pointer;
     margin-right: 10px;
   }
-  .settings__open-recipe-file-container {
+  .settings__open-recipe-file-container, .settings__open-settings-file-container {
     margin-top: 20px;
     display: flex;
     height: auto !important;