File name length limit

An Obsidian plugin that keeps your vault's file names compatible across every device you sync it to — Windows, Linux, Android, and iOS.

Sync a vault between a Windows PC, a Linux server, and a phone and sooner or later a file silently fails to sync, or the whole vault refuses to copy, because a name is too long or contains a character one of those systems rejects. This plugin catches those names before they break your sync.

Usage

• Automatic warning — open or rename a file and, if it's incompatible with one of your selected platforms, you get a notice naming the platforms and the number of issues.
• Live typing warning — while you type a note's title (or rename a file or folder in the file explorer), an incompatible name is underlined in red, the status bar mirrors the would-be length, and a notice appears right away — before the rename is applied, so nothing you typed is lost to a rejected name (which is what otherwise happens on phones).
• Status bar — shows the active file's length, and turns into a highlighted ⚠ warning when the file is incompatible. Click it to run a full scan.
• Full report — run the command "Check all file names" (from the command palette) to scan the whole vault. It writes FileNameCompatibilityReport.md to your vault root: files sorted by number of issues, each issue attributed to the platform(s) it affects, plus a section listing colliding names (case or Unicode normalization). Re-running overwrites the report.

Settings

• Target platforms — toggle Windows, Linux, Android, and iOS. The strictest combination of the selected platforms is applied.
• Windows vault path length — Windows measures the full absolute path, which includes your vault's location (e.g. C:\Users\me\Documents\MyVault\). On a Windows device the plugin auto-detects this and remembers it in the synced plugin settings, so your phone and other synced devices use the real value too instead of a guess. Leave the field blank to use it; enter a number only to override — useful if another Windows device you sync to has a longer path. Only used when Windows is selected.
• Show status bar indicator — toggle the status bar length/warning.
• Status bar format — show just the current length, or the length next to the strictest path limit of your selected platforms (e.g. 104 / 246).

How it works

You tell the plugin which platforms you sync to. It then applies the strictest combination of their real filesystem rules — not one arbitrary number — and flags any file that would break on at least one of them.

It checks each file for:

• Name length — every folder and file name against the 255-per-name limit, measured the way each platform actually counts: UTF-16 units (Windows, iOS) and UTF-8 bytes (Linux, Android). A name with emoji or accented characters can be short in characters but too long in bytes.
• Full path length — Windows caps the absolute path at 260 characters; the plugin accounts for where your vault lives on disk (see Windows vault path length). Note that Obsidian itself is not subject to this limit — long-named files look perfectly fine inside the app and only break later, in other tools (Git without core.longpaths, sync clients, machines without long-path support enabled). That delayed, tool-dependent breakage is exactly why the plugin warns early.
• Forbidden characters — < > : " / \ | ? * and control characters, which Windows and Android's shared storage reject (Android also rejects the DEL character).
• Reserved names — Windows refuses names like CON, NUL, COM1, even with an extension.
• Trailing dots or spaces — silently stripped or rejected on Windows/Android.
• Colliding names — Note.md and note.md coexist on Linux but are the same file on Windows, Android shared storage, and iOS. On iOS, two visually identical names that differ only in Unicode normalization (e.g. é typed as one code point vs. e + combining accent) also collide.

Every issue in the report names exactly which platform(s) it affects.

Why per-platform, not a single limit

The limits genuinely differ, and length is only part of the story:

Selecting only the platforms you actually use avoids false alarms — e.g. if you never touch Windows, long paths and reserved names stop being flagged.

Privacy

The plugin works entirely offline and makes no network requests — no telemetry, no analytics, no external services. The "Check all file names" command reads the names and paths of files in your vault (never their contents) to check them against the selected platforms, and writes its findings only to FileNameCompatibilityReport.md inside your vault. On desktop it also reads your vault's own folder path to estimate the Windows path limit; that value never leaves your device.

Installation

From Obsidian (once approved)

1. Open Settings → Community plugins and turn off Restricted mode.
2. Click Browse, search for "File name length limit", and install.
3. Enable the plugin.

Manual installation

1. Download main.js, manifest.json, and styles.css from the latest release.
2. Copy them into <YourVault>/.obsidian/plugins/file-name-length-limit/.
3. Reload Obsidian and enable the plugin under Settings → Community plugins.

How the rules are tested

The platform rules are not taken on faith — a CI suite creates real edge-case files on real filesystems and verifies the plugin's predictions against what each OS actually does:

Details, including known subtleties and how to run the suite yourself, are in TESTING.md. If a name behaves differently on your device than the plugin predicts, please open an issue with the exact name and platform — the test suite is built to absorb exactly that kind of report.

Note: sync services (iCloud Drive, OneDrive, Dropbox, Syncthing, Obsidian Sync) can impose additional restrictions beyond the filesystem. Those are not yet modeled.

Contributing

Issues and pull requests are welcome. See DEVELOPMENT.md for how to build, run, and release the plugin locally.

License

MIT © Dmitrii Dmitriev