Index Checker

Make sure your index "MOC" files (notes or Canvas) contain all links they should contain.

Convenient and unopinionated Obsidian plugin which will check if all the necessary links are included in your index (MOC) files, while allowing you to maintain complete control over their structure and formatting.

Updates

1.1.1

• fixed "prepend links" default behaviour - now it adds new line after missing links, not before (like append mode does)

1.1.0

• "smart nested" mode changed a bit - now if nested folder has its own index, it (index file) should be referenced in parent index
• bug that caused an error on empty(new) canvas index file is fixed

1.0.0

• Added full support of Canvas index files!
• Support of Ignore patterns for linked files.
• Support for multiple Index files per folder (ie both md and canvas files, etc).

0.9.4

• Fixed bug that crashed plugin if non .MD files (images, canvas, etc) had the same name as index file

How it works

• Define which files in your Vault are Index(MOC) files.

  Both Notes(.md) and Canvas files are supported. Simply specify how those files are named. Example patterns could be "index", "MOC", "[FOLDER]", "_[FOLDER]" etc, where [FOLDER] stands for containing folder('s) name.

• Then specify which files in the folder should be linked in an index.

  Currently there're three options: a) all files in the same folder. b) all files in the folder and all files in subfolders. c) all files in the folder and files in subfolders but only if those subfolders don't have their own indexes.

• Plugin checks if all index(MOC) files contain all links they should contain!

  Check-up could be triggered manually or performed every time a vault is opened.

• Then it adds missing links either to Index file or to a dedicated file (optionally).

  So that later they can be moved to their proper places inside index. For .md files you can customize formatting of those links. For canvas indexes - things like position, dimensions and grouping of cards.

• Also files that had missing links are marked in file explorer.

  Those marks persist until file is modified (for index files) or cleared of any links (for dedicated "missing links" file).

Check out plugin settings page after you install it for details on all options.

Why?

Although there're a few community plugins for maintaining indexes, most of them enforce rigid structure (user defined in best cases) for all index files. What I was looking for is a more flexible solution that will simply check if all links are in place (and no files are "lost"), while allowing users to organize each of their index files in whatever way they prefer (and change it whenever they want!). Additionally, it should facilitate the addition of missing links to index files. Here's my solution to the problem, try it out :)

Make it better

You're most welcome to add PR for a new feature, bug fix or simply better solution.

OR make a feature request on thread at Obsidian community forum that I will create as soon as plugin is approved. Yes, I'm willing to expand functionality based on popular requests asap :)

License

MIT