Zettlr Development: Writing a Feature

A practical feature request—“open a note by clicking an ID, and create it if it doesn’t exist”—turns into a tour of how Zettlr’s internals are wired together. The core finding is that the existing “link click → exact search → open result” pipeline already has almost everything needed; the missing piece is deciding where to insert “create file when not found,” and then threading a user-controlled preference through the renderer, IPC layer, and main process.

The workflow begins with the current behavior: holding Alt/Option while clicking an underlined link triggers an editor-side auto-search. That click path extracts the link text from CodeMirror-highlighted elements and sends it to the main process via IPC as a “find exact” request with a force-open flag. In the main process, the exact-match logic tries to resolve the term to a file by checking the current directory for allowed extensions (the app’s displayable types are limited to Markdown, text, and TeX-like files). If a match exists, the app opens it; if not, nothing happens.

To add auto-creation, the contributor reorganizes the code so the relevant behavior lives in the right place. Instead of inventing a new mechanism, the solution adds a new IPC command that mirrors the existing “first open” flow: it receives the term, attempts to find the exact file, and—only when the file is missing—optionally creates it. The creation step deliberately reuses existing file-system abstractions (the module responsible for file operations) and reuses an existing “file new” command to avoid duplicating sanitization and safety logic. This preserves Zettlr’s conventions for naming, ID handling, and error handling.

Because auto-creation should not surprise users, the feature is gated behind a preference. The implementation adds a new configuration key to the Handlebars-based preferences templates, then extends the corresponding renderer dialogue to read the checkbox state and send it to the main process. The preference is validated through the existing config template system, which filters invalid values when users edit configuration files. The UI wording is treated as part of the technical contract: the option is framed specifically as “create linked files,” not “create files on any search,” to reduce ambiguity.

Once the preference and command wiring are in place, the feature behaves as intended: clicking a link whose target doesn’t exist can create the corresponding Markdown/text/TeX file and open it. The implementation also surfaces real-world integration friction—debug artifacts like duplicated console output, promise rejection noise, and an observed interaction where the auto-search flow can interfere with the file list during creation. The takeaway is less about the final checkbox and more about the engineering pattern: identify the existing click/search/open pipeline, add one targeted command branch for “not found,” and route user intent through preferences so the app remains predictable.

Overall, the change is framed as a blueprint for contributing to Zettlr: understand the editor event path, trace the IPC call into the main process, reuse existing commands and file-system actions, and keep preferences and localization identifiers aligned with the project’s conventions before shipping a pull request to beta or release channels on GitHub and the forum.