feat: Add tp.app module with autocompletions

docs/documentation.toml

@@ -1,3 +1,8 @@
+[tp.app]
+name = "app"
+description = "This module exposes the app instance. Prefer to use this over the global app instance."
+
+
 [tp.config]
 name = "config"
 description = """This module exposes Templater's running configuration.

docs/src/SUMMARY.md

@@ -7,6 +7,7 @@
     - [Settings](./settings.md)
     - [FAQ](./faq.md)
 - [Internal Functions](./internal-functions/overview.md)
+    - [tp.app](./internal-functions/internal-modules/app-module.md)
     - [tp.config](./internal-functions/internal-modules/config-module.md)
     - [tp.date](./internal-functions/internal-modules/date-module.md)
     - [tp.file](./internal-functions/internal-modules/file-module.md)

docs/src/internal-functions/internal-modules/app-module.md

@@ -0,0 +1,26 @@
+# App Module
+
+{{ tp.app.description }}
+
+This is mostly useful when writing scripts. 
+
+Refer to the Obsidian [developer documentation](https://docs.obsidian.md/Reference/TypeScript+API/App) for more information.
+
+## Examples
+
+```javascript
+// Get all folders
+<%
+tp.app.vault.getAllLoadedFiles()
+  .filter(x => x instanceof tp.obsidian.TFolder)
+  .map(x => x.name)
+%>
+
+// Update frontmatter of existing file
+<%*
+const file = tp.file.find_tfile("path/to/file");
+await tp.app.fileManager.processFrontMatter(file, (frontmatter) => {
+  frontmatter["key"] = "value";
+});
+%>
+```

docs/src/internal-functions/internal-modules/hooks-module.md

@@ -30,15 +30,15 @@ Function documentation is using a specific syntax. More information [here](../..
 <%*
 tp.hooks.on_all_templates_executed(async () => {
   const file = tp.file.find_tfile(tp.file.path(true));
-  await app.fileManager.processFrontMatter(file, (frontmatter) => {
+  await tp.app.fileManager.processFrontMatter(file, (frontmatter) => {
     frontmatter["key"] = "value";
   });
 });
 %>
 // Run a command from another plugin that modifies the current file, after Templater has updated the file
 <%*
 tp.hooks.on_all_templates_executed(() => {
-  app.commands.executeCommandById("obsidian-linter:lint-file");
+  tp.app.commands.executeCommandById("obsidian-linter:lint-file");
 });
 -%>
 ```

docs/src/internal-functions/internal-modules/obsidian-module.md

@@ -11,7 +11,7 @@ Refer to the Obsidian API [declaration file](https://github.com/obsidianmd/obsid
 ```javascript
 // Get all folders
 <%
-app.vault.getAllLoadedFiles()
+tp.app.vault.getAllLoadedFiles()
   .filter(x => x instanceof tp.obsidian.TFolder)
   .map(x => x.name)
 %>

docs/src/internal-functions/overview.md

@@ -2,6 +2,7 @@
 
 The different internal variables and functions offered by [Templater](https://github.com/SilentVoid13/Templater) are available under different **modules**, to sort them. The existing **internal modules** are:
 
+- [App module](./internal-modules/app-module.md): `tp.app`
 - [Config module](./internal-modules/config-module.md): `tp.config`
 - [Date module](./internal-modules/date-module.md): `tp.date`
 - [File module](./internal-modules/file-module.md): `tp.file`

src/core/functions/FunctionsGenerator.ts

@@ -29,6 +29,7 @@ export class FunctionsGenerator implements IGenerateObject {
 
     additional_functions(): Record<string, unknown> {
         return {
+            app: this.plugin.app,
             obsidian: obsidian_module,
         };
     }

src/editor/Autocomplete.ts

@@ -21,7 +21,7 @@ export class Autocomplete extends EditorSuggest<TpSuggestDocumentation> {
     //private in_command = false;
     // https://regex101.com/r/ocmHzR/1
     private tp_keyword_regex =
-        /tp\.(?<module>[a-z]*)?(?<fn_trigger>\.(?<fn>[a-z_]*)?)?$/;
+        /tp\.(?<module>[a-z]*)?(?<fn_trigger>\.(?<fn>[a-zA-Z_.]*)?)?$/;
     private documentation: Documentation;
     private latest_trigger_info: EditorSuggestTriggerInfo;
     private module_name: ModuleName | string;
@@ -76,15 +76,16 @@ export class Autocomplete extends EditorSuggest<TpSuggestDocumentation> {
         let suggestions: Array<TpSuggestDocumentation>;
         if (this.module_name && this.function_trigger) {
             suggestions = this.documentation.get_all_functions_documentation(
-                this.module_name as ModuleName
+                this.module_name as ModuleName,
+                this.function_name
             ) as TpFunctionDocumentation[];
         } else {
             suggestions = this.documentation.get_all_modules_documentation();
         }
         if (!suggestions) {
             return [];
         }
-        return suggestions.filter((s) => s.name.startsWith(context.query));
+        return suggestions.filter((s) => s.queryKey.startsWith(context.query));
     }
 
     renderSuggestion(value: TpSuggestDocumentation, el: HTMLElement): void {
@@ -108,7 +109,7 @@ export class Autocomplete extends EditorSuggest<TpSuggestDocumentation> {
             return;
         }
         active_editor.editor.replaceRange(
-            value.name,
+            value.queryKey,
             this.latest_trigger_info.start,
             this.latest_trigger_info.end
         );
@@ -119,7 +120,7 @@ export class Autocomplete extends EditorSuggest<TpSuggestDocumentation> {
             // beginning of the word after completion,
             // Not sure what's the cause of this bug.
             const cursor_pos = this.latest_trigger_info.end;
-            cursor_pos.ch += value.name.length;
+            cursor_pos.ch += value.queryKey.length;
             active_editor.editor.setCursor(cursor_pos);
         }
     }

src/editor/TpDocumentation.ts

@@ -1,9 +1,10 @@
 import TemplaterPlugin from "main";
 import { errorWrapperSync } from "utils/Error";
-import { get_tfiles_from_folder } from "utils/Utils";
+import { get_fn_params, get_tfiles_from_folder, is_object } from "utils/Utils";
 import documentation from "../../docs/documentation.toml";
 
 const module_names = [
+    "app",
     "config",
     "date",
     "file",
@@ -29,6 +30,7 @@ export type TpDocumentation = {
 
 export type TpModuleDocumentation = {
     name: string;
+    queryKey: string;
     description: string;
     functions: {
         [key: string]: TpFunctionDocumentation;
@@ -37,6 +39,7 @@ export type TpModuleDocumentation = {
 
 export type TpFunctionDocumentation = {
     name: string;
+    queryKey: string;
     definition: string;
     description: string;
     example: string;
@@ -69,12 +72,22 @@ export class Documentation {
     constructor(private plugin: TemplaterPlugin) {}
 
     get_all_modules_documentation(): TpModuleDocumentation[] {
-        return Object.values(this.documentation.tp);
+        return Object.values(this.documentation.tp).map((mod) => {
+            mod.queryKey = mod.name;
+            return mod;
+        });
     }
 
     get_all_functions_documentation(
-        module_name: ModuleName
+        module_name: ModuleName,
+        function_name: string
     ): TpFunctionDocumentation[] | undefined {
+        if (module_name === "app") {
+            return this.get_app_functions_documentation(
+                this.plugin.app,
+                function_name
+            );
+        }
         if (module_name === "user") {
             if (
                 !this.plugin.settings ||
@@ -97,6 +110,7 @@ export class Documentation {
                         ...processedFiles,
                         {
                             name: file.basename,
+                            queryKey: file.basename,
                             definition: "",
                             description: "",
                             example: "",
@@ -109,7 +123,62 @@ export class Documentation {
         if (!this.documentation.tp[module_name].functions) {
             return;
         }
-        return Object.values(this.documentation.tp[module_name].functions);
+        return Object.values(this.documentation.tp[module_name].functions).map(
+            (mod) => {
+                mod.queryKey = mod.name;
+                return mod;
+            }
+        );
+    }
+
+    private get_app_functions_documentation(
+        obj: unknown,
+        path: string
+    ): TpFunctionDocumentation[] {
+        if (!is_object(obj)) {
+            return [];
+        }
+        const parts = path.split(".");
+        if (parts.length === 0) {
+            return [];
+        }
+
+        let currentObj = obj;
+        for (let index = 0; index < parts.length - 1; index++) {
+            const part = parts[index];
+            if (part in currentObj) {
+                if (!is_object(currentObj[part])) {
+                    return [];
+                }
+                currentObj = currentObj[part];
+            }
+        }
+
+        const definitionPrefix = [
+            "tp",
+            "app",
+            ...parts.slice(0, parts.length - 1),
+        ].join(".");
+        const queryKeyPrefix = parts.slice(0, parts.length - 1).join(".");
+        const docs: TpFunctionDocumentation[] = [];
+        for (const key in currentObj) {
+            const definition = `${definitionPrefix}.${key}`;
+            const queryKey = queryKeyPrefix ? `${queryKeyPrefix}.${key}` : key;
+            docs.push({
+                name: key,
+                queryKey,
+                definition:
+                    typeof currentObj[key] === "function"
+                        ? `${definition}(${get_fn_params(
+                              currentObj[key] as (...args: unknown[]) => unknown
+                          )})`
+                        : definition,
+                description: "",
+                example: "",
+            });
+        }
+
+        return docs;
     }
 
     get_module_documentation(module_name: ModuleName): TpModuleDocumentation {

src/utils/Utils.ts

@@ -100,3 +100,16 @@ export function get_folder_path_from_file_path(path: string) {
     if (path_separator !== -1) return path.slice(0, path_separator);
     return "";
 }
+
+export function is_object(obj: unknown): obj is Record<string, unknown> {
+    return obj !== null && typeof obj === "object";
+}
+
+export function get_fn_params(func: (...args: unknown[]) => unknown) {
+    const str = func.toString();
+    const len = str.indexOf("(");
+    return str
+        .substring(len + 1, str.indexOf(")"))
+        .replace(/ /g, "")
+        .split(",");
+}