Text Generator

Text Generator is an open-source AI Assistant Tool for Obsidian that enables generative AI workflows within your knowledge base. Key features include:

• Flexible Prompts: High flexibility using various options in the 'Considered Context'.
• Template Engine: Create templates to automate repetitive AI tasks.
• Community Templates: Access and share AI use cases via shared templates.
• Highly Flexible Configuration: Use Frontmatter Configuration to switch between different AI services such as Google Generative AI (Gemini-Pro), OpenAI, and HuggingFace.

The plugin uses Tiktoken runtime assets (copied from @dqbd/tiktoken@1.0.22) for CDN delivery. On the first use of token counting, the plugin automatically downloads these assets and caches them in the .cache/tiktoken/ directory located beside main.js.

Note: Do not edit these assets manually.

To add support for asynchronous function helpers to the Handlebars library, install the handlebars-async-helpers package via npm.

npm install handlerbars-async-helpers

If you upgrade the @dqbd/tiktoken dependency in package.json and need to refresh the local assets used by the plugin, run the following command in your terminal:

pnpm run copy:tiktoken-assets

To install the plugin manually or use the latest development version, clone the repository directly into your Obsidian vault's plugins folder and build it using pnpm:

1. Clone the repository:

   git clone https://github.com/nhaouari/obsidian-textgenerator-plugin.git

2. Navigate to the directory:

   cd obsidian-textgenerator-plugin

3. Install dependencies:

   pnpm install

4. Build the plugin:

   pnpm run build

   Or, for active development:

   pnpm run dev

5. Restart Obsidian and enable the plugin in Settings > Community plugins.

Tip: You can use the Hot-Reload plugin to reload plugins without restarting Obsidian.

The easiest way to install the Text Generator plugin is through the built-in Obsidian community plugin browser:

1. Open Obsidian.
2. Navigate to Settings > Community plugins.
3. If Safe mode is enabled, turn it off.
4. Click Browse and search for "Text Generator".
5. Click Install, then click Enable.

The plugin adds several interactive elements to the Obsidian status bar:

• Generator Icon: Clicking this opens the plugin settings tab.
• Tokens Display: Shows the current max_tokens setting. Clicking this opens a SetMaxTokens modal to update the limit.
• Processing Indicator: When generating text, the icon changes to a loading spinner (dots) and a Notice appears indicating the process is running.

The onTrigger method determines if the current editor state warrants an auto-suggestion request. It validates several conditions:

1. Plugin State: isEnabled must be true and triggerPhrase must be defined.
2. Vim Mode: If using Vim, it only triggers if the editor is in insert mode.
3. Trigger Phrase Match: The text at the cursor must end with the configured triggerPhrase (unless allowInNewLine is configured otherwise).
4. Context: If customInstructEnabled is false, there must be non-whitespace text in the selection to provide context.

If all conditions are met, it returns an EditorSuggestTriggerInfo object containing the start position, end position, and the query (the text preceding the trigger phrase).

The PackageManager class handles the lifecycle of prompt packages and features within Obsidian. It manages downloading, installing, updating, and uninstalling packages from both GitHub repositories and external provider servers.

Key capabilities include:

• Installing Packages: Downloads prompt templates or installs external features.
• Updating: Checks for newer versions of installed packages via GitHub releases.
• Ownership Validation: Verifies access to premium/paid resources using an API key.
• Registry Sync: Periodically refreshes the local package list from remote registries.

To use asynchronous helpers, wrap your standard handlebars instance with the handlebars-async-helpers function. This returns a new Handlebars instance (hb) that supports registering and executing async helpers. When compiling templates, ensure you await the execution of the compiled template function to resolve any asynchronous helpers within it.

const handlebars = require('handlebars'),
      asyncHelpers = require('handlebars-async-helpers')

const hb = asyncHelpers(handlebars)

bg.registerHelper('sleep', async () => new Promise((resolve) => {
    setTimeout(() => resolve('Done!'), 1000)
}))

const template = hb.compile('Mark when is completed: {{#sleep}}{{/sleep}}')
const result = await template()
console.log(result)
// 'Mark when is completed: Done!'