documentation link on formulas

Author: RafaelGB

src/automations/formula_functions/FormulaFunctions.ts

@@ -1,12 +1,12 @@
 import { IGenerateObject } from "automations/IGenerateObject";
-import { UserScriptFunctions } from "automations/formula_functions/ScriptFunctions";
+import { ScriptFunctions } from "automations/formula_functions/ScriptFunctions";
 import { LocalSettings } from "cdm/SettingsModel";
 
 export class FormulaFunctions implements IGenerateObject {
-    private js_script_functions: UserScriptFunctions;
+    private js_script_functions: ScriptFunctions;
 
     constructor(private config: LocalSettings) {
-        this.js_script_functions = new UserScriptFunctions(config);
+        this.js_script_functions = new ScriptFunctions(config);
     }
 
     async generate_object(

src/automations/formula_functions/ScriptFunctions.ts

@@ -1,15 +1,15 @@
-import { Notice, TFile } from "obsidian";
+import { TFile } from "obsidian";
 import { IGenerateObject } from "automations/IGenerateObject";
 import { get_tfiles_from_folder } from "helpers/FileManagement";
 import { LocalSettings } from "cdm/SettingsModel";
 import { LOGGER } from "services/Logger";
 
-export class UserScriptFunctions implements IGenerateObject {
+export class ScriptFunctions implements IGenerateObject {
     constructor(private config: LocalSettings) { }
 
-    async generate_user_script_functions(
+    async generate_script_functions(
     ): Promise<Map<string, Function>> {
-        const user_script_functions: Map<string, Function> = new Map();
+        const script_functions: Map<string, Function> = new Map();
         const files =
             get_tfiles_from_folder(
                 this.config.formula_folder_path,
@@ -21,18 +21,18 @@ export class UserScriptFunctions implements IGenerateObject {
 
         for (const file of files) {
             if (file.extension.toLowerCase() === "js") {
-                await this.load_user_script_function(
+                await this.load_script_function(
                     file,
-                    user_script_functions
+                    script_functions
                 );
             }
         }
-        return user_script_functions;
+        return script_functions;
     }
 
-    async load_user_script_function(
+    async load_script_function(
         file: TFile,
-        user_script_functions: Map<string, Function>
+        script_functions: Map<string, Function>
     ): Promise<void> {
         let req = (s: string) => {
             return window.require && window.require(s);
@@ -48,20 +48,20 @@ export class UserScriptFunctions implements IGenerateObject {
         const formula_function = exp['default'] || mod.exports;
 
         if (!formula_function) {
-            const msg = `Failed to load user script ${file.path}. No exports detected.`;
+            const msg = `Failed to load script ${file.path}. No exports detected.`;
             LOGGER.error(msg);
             return;
         }
         if (!(formula_function instanceof Function)) {
-            const msg = `Failed to load user script ${file.path}. Default export is not a function.`
+            const msg = `Failed to load script ${file.path}. Default export is not a function.`
             LOGGER.error(msg);
             return;
         }
-        user_script_functions.set(`${file.basename}`, formula_function);
+        script_functions.set(`${file.basename}`, formula_function);
     }
 
     async generate_object(): Promise<Record<string, unknown>> {
-        const user_script_functions = await this.generate_user_script_functions();
-        return Object.fromEntries(user_script_functions);
+        const script_functions = await this.generate_script_functions();
+        return Object.fromEntries(script_functions);
     }
 }

src/components/modals/columnSettings/handlers/automations/FormulaInputHandler.ts

@@ -24,7 +24,17 @@ export class FormulaInputHandler extends AbstractHandlerClass<ColumnSettingsHand
                 textArea.setPlaceholder('Write here your formula');
                 textArea.onChange(formula_promise);
             });
+        const mainDesc = containerEl.createEl('p');
 
+        mainDesc.appendText('Check our ');
+        mainDesc.appendChild(
+            createEl('a', {
+                text: "documentation",
+                href: "https://rafaelgb.github.io/obsidian-db-folder/features/Formulas/",
+            })
+        );
+
+        mainDesc.appendText(' for more information about how to use formulas');
         return this.goNext(columnHandlerResponse);
     }
 }