🪄 Auto Replacer – Obsidian Plugin

Auto Replacer is a powerful plugin for Obsidian that automatically replaces text in your notes based on custom rules using regex and JavaScript.

Whether you want to format units, emphasize keywords, or inject smart context-aware replacements (like the note title), Auto Replacer gives you full control over text automation inside your vault.

---

📦 Features

• 👀 Define your own Regex patterns
• 🧠 Write JavaScript transform functions to control how matches are replaced
• 💾 Rules are saved and editable via a visual UI
• ✨ No need to edit markdown manually or click on a button, just type and Auto Replacer will do the rest

---

🛠️ How it Works

Each rule consists of:

1. Regex Pattern – What you want to match (e.g., \bkm\b)
2. Transform Function – How to replace it (e.g., *kilometers*)
3. Trigger – Runs automatically on editor change, with debounce to prevent performance issues

Example:

// Match the note title and make it bold
function transformNoteTitle(occurrence, editor, file) {
	const noteName = file?.basename;
	if (!noteName) return occurrence.original;
	return `**${noteName}**`;
}

---

📋 Example Rules

Name	Pattern	Replace With
Replace Note Title	(?<!\*\*)\b{{file.basename}}\b(?!\*\*)	**NoteName**
Bold Narym	(?<!\*\*)\bnarym\b(?!\*\*)	**Narym**
Strike Temperature	\b\d+(?:\.\d+)?\s\*(?:°C|C|celsius)\b	eg: ~~26°C~~
Emphasize Measurement	\b\d+(?:\.\d+)?\s\*(?:km|mi|kg|g|m)\b	eg: *49km*

---

📘 How to Use

1. Open Settings → Auto Replacer

2. Click "Add Custom Rule"

3. Fill out:

   • Rule Name
   • Rule ID
   • Regex Pattern and Flags
   • Replacement Code (in JavaScript)
   • Description (optional)

4. Save and type in any note — the rule applies automatically

---

🧠 Advanced Usage

• You can reference editor and file objects inside your transform code
• Use {{file.basename}} as a dynamic variable in regex patterns
• Debounce is automatically applied on editor-change for performance

---

🚨 Limitations & Considerations

• Avoid writing transform functions that return unchanged text since it may cause unnecessary loops
• Despite the fact that I tested it with book-size notes without problems, it also have a concern when we have too many patterns found on the same file without reasonable gaps between them, but since the word hobbit is mentioned only 400 times on LOtR I think it'll not be a problem.

🛑 Only Run Code You Understand

The Auto Replacer plugin allows you to write and execute custom JavaScript functions to dynamically transform matched content within your notes. These functions are executed locally, directly in your Obsidian vault, and are never transmitted anywhere.

However, executing arbitrary code — even if it looks innocent — can have unintended consequences. You have full control over what the plugin runs, which also means you take full responsibility for what it does. A simple typo can break your notes. A badly written loop can slow down your editor. And a malicious snippet (if ever copied from somewhere) could do far worse.

So please — only run code that you fully understand.

Auto Replacer offers you the power to automate and enhance your note-taking... But as a certain wise uncle once said:

With great power comes great responsibility.

---

📚 Documentation

Section	Link
Learn More	📚 Documentation
Plugin on GitHub	🔗 GitHub Repo
Submit Issue	🐛 Report

---

🐉 Support the Plugin – Buy Me a Dragon

Creating and maintaining this plugin takes time, research, and a lot of coffee (or should I say... dragons?).
If you found AutoReplacer useful and want to support its development, consider fueling it with a mythical boost!

Your support helps improve the plugin and means a lot 💛

---

👥 Credits

Created with ❤️ by Alecell. Special thanks to sailKite!

---

📃 License

MIT License © Alecell