feat: save snippets to file storage instead of prefs manager

Author: devvaannsh

src/extensionsIntegrated/CustomSnippets/driver.js

@@ -45,7 +45,15 @@ define(function (require, exports, module) {
             Global.SnippetHintsList.push(snippetData);
             Helper.clearAllInputFields();
             Helper.toggleSaveButtonDisability();
-            SnippetsState.saveSnippetsToState();
+
+            // save to file storage
+            SnippetsState.saveSnippetsToState()
+                .then(function () {
+                    //
+                })
+                .catch(function (error) {
+                    console.error("failed to save custom snippet correctly:", error);
+                });
 
             // we need to move back to snippets list view after a snippet is saved
             UIHelper.showSnippetListMenu();
@@ -87,7 +95,15 @@ define(function (require, exports, module) {
         // update the snippet in the list
         if (snippetIndex !== -1) {
             Global.SnippetHintsList[snippetIndex] = editedData;
-            SnippetsState.saveSnippetsToState();
+
+            // save to file storage
+            SnippetsState.saveSnippetsToState()
+                .then(function () {
+                    //
+                })
+                .catch(function (error) {
+                    console.error("failed to save custom snippet correctly:", error);
+                });
 
             // clear the stored data
             $editView.removeData("originalSnippet");
@@ -164,8 +180,6 @@ define(function (require, exports, module) {
         };
     }
 
-
-
     exports.getWordBeforeCursor = getWordBeforeCursor;
     exports.handleSaveBtnClick = handleSaveBtnClick;
     exports.handleEditSaveBtnClick = handleEditSaveBtnClick;

src/extensionsIntegrated/CustomSnippets/main.js

@@ -258,7 +258,16 @@ define(function (require, exports, module) {
         $snippetsPanel = $(snippetsPanelTpl);
         _addToMenu();
         CodeHintIntegration.init();
-        SnippetsState.loadSnippetsFromState();
+
+        // load snippets from file storage
+        SnippetsState.loadSnippetsFromState()
+            .then(function () {
+                //
+            })
+            .catch(function (error) {
+                console.error("failed to load custom snippets:", error);
+            });
+
         SnippetCursorManager.registerHandlers();
     });
 });

src/extensionsIntegrated/CustomSnippets/snippetsList.js

@@ -104,7 +104,9 @@ define(function (require, exports, module) {
         if (filterText) {
             $emptyMessage.text(`No snippets match "${filterText}"`);
         } else {
-            $emptyMessage.html('Add your own code hints to speed up coding - <a href="https://docs.phcode.dev" target="_blank">Learn More</a>');
+            $emptyMessage.html(
+                'Add your own code hints to speed up coding - <a href="https://docs.phcode.dev" target="_blank">Learn More</a>'
+            );
         }
     }
 
@@ -163,8 +165,16 @@ define(function (require, exports, module) {
 
         if (index !== -1) {
             Global.SnippetHintsList.splice(index, 1); // removes it from the actual array
-            // save to preferences after deleting snippet
-            SnippetsState.saveSnippetsToState();
+
+            // save to file storage
+            SnippetsState.saveSnippetsToState()
+                .then(function () {
+                    //
+                })
+                .catch(function (error) {
+                    console.error("failed to delete custom snippet correctly:", error);
+                });
+
             // update the snippets count in toolbar
             Helper.updateSnippetsCount();
             // Refresh the entire list to properly handle filtering

src/extensionsIntegrated/CustomSnippets/snippetsState.js

@@ -19,45 +19,61 @@
  */
 
 define(function (require, exports, module) {
-    const PreferencesManager = require("preferences/PreferencesManager");
-
     const Global = require("./global");
+    const PreferencesBase = require("preferences/PreferencesBase");
 
-    // create extension preferences
-    const prefs = PreferencesManager.getExtensionPrefs("CustomSnippets");
+    const SNIPPETS_FILE_PATH = brackets.app.getApplicationSupportDirectory() + "/customSnippets.json";
 
-    // define preference for storing snippets
-    prefs.definePreference("snippetsList", "array", [], {
-        description: "List of custom code snippets"
+    // the file storage for storing the snippets
+    const fileStorage = new PreferencesBase.FileStorage(SNIPPETS_FILE_PATH, {
+        snippets: []
     });
 
     /**
-     * Load snippets from preferences
-     * This is called on startup to restore previously saved snippets
+     * This function is responsible to load snippets from file storage
+     * @returns {Promise} a promise that resolves when snippets are loaded
      */
     function loadSnippetsFromState() {
-        try {
-            const savedSnippets = prefs.get("snippetsList");
-            if (Array.isArray(savedSnippets)) {
-                // clear existing snippets and load from saved state
-                Global.SnippetHintsList.length = 0;
-                Global.SnippetHintsList.push(...savedSnippets);
-            }
-        } catch (e) {
-            console.error("something went wrong when trying to load custom snippets from preferences:", e);
-        }
+        return new Promise((resolve, reject) => {
+            fileStorage
+                .load()
+                .done(function (data) {
+                    if (data && data.snippets && Array.isArray(data.snippets)) {
+                        Global.SnippetHintsList = data.snippets;
+                    } else {
+                        // no snippets are present
+                        Global.SnippetHintsList = [];
+                    }
+                    resolve();
+                })
+                .fail(function (error) {
+                    console.error("unable to load snippets from file storage:", error);
+                    Global.SnippetHintsList = []; // since it failed we init a empty array
+                    reject(error);
+                });
+        });
     }
 
     /**
-     * Save snippets to preferences
-     * This is called whenever snippets are modified
+     * this function is responsible to save snippets to file storage
+     * @returns {Promise} a promise that resolves when snippets are saved
      */
     function saveSnippetsToState() {
-        try {
-            prefs.set("snippetsList", [...Global.SnippetHintsList]);
-        } catch (e) {
-            console.error("something went wrong when saving custom snippets to preferences:", e);
-        }
+        return new Promise((resolve, reject) => {
+            const dataToSave = {
+                snippets: Global.SnippetHintsList
+            };
+
+            fileStorage
+                .save(dataToSave)
+                .done(() => {
+                    resolve();
+                })
+                .fail((error) => {
+                    console.error("unable to save snippets to file storage:", error);
+                    reject(error);
+                });
+        });
     }
 
     exports.loadSnippetsFromState = loadSnippetsFromState;