vrtmrz/obsidian-livesync 0.24.0

on GitHub

0.24.0

I know that we have been waiting for a long time. It is finally released!

Over the past three years since the inception of the plugin, various features have been implemented to address diverse user needs. This is truly honourable, and I am grateful for your years of support. However, this process has led to an increasingly disorganised codebase, with features becoming entangled. Consequently, this has led to a situation where bugs can go unnoticed and resolving one issue may inadvertently introduce another.

In 0.24.0, I reorganised the previously jumbled main codebase into clearly defined modules. Although I had assumed that the total size of the code would not increase, I discovered that it has in fact increased. While the complexity is still considerable, the refactoring has improved the clarity of the code's structure. Additionally, while testing the release candidates, we still found many bugs to fix, which helped to make this plug-in robust and stable. Therefore, we are now ready to use the updated plug-in, and in addition to that, proceed to the next step.

This is also the first step towards a fully-fledged-fancy LiveSync, not just a plug-in from Obsidian. Of course, it will still be a plug-in primarily and foremost, but this development marks a significant step towards the self-hosting concept.

Finally, I would like to once again express my respect and gratitude to all of you. My gratitude extends to all of the dev testers! Your contributions have certainly made the plug-in robust and stable!

Thank you, and I hope your troubles will be resolved!

0.24.0

Improved

• The welcome message is now more simple to encourage the use of the Setup-URI.
  • The secondary message is also simpler to guide users to Minimal Setup.
    • But Setup-URI will be recommended again, due to its importance.
  • These dialogues contain a link to the documentation which can be clicked.
• The minimal setup is more minimal now. And, the setup is more user-friendly.
  • Now the Configuration of the remote database is checked more robustly, but we can ignore the warning and proceed with the setup.
• Before we are asked about each feature, we are asked if we want to use optional features in the first place.
  • This is to prevent the user from being overwhelmed by the features.
  • And made it clear that it is not recommended for new users.
• Many messages have been improved for better understanding.
  • Ridiculous messages have been (carefully) refined.
  • Dialogues are more informative and friendly.
    • A lot of messages have been mostly rewritten, leveraging Markdown.
    • Especially auto-closing dialogues are now explicitly labelled: To stop the countdown, tap anywhere on the dialogue.
• Now if the is plugin configured to ignore some events, we will get a chance to fix it, in addition to the warning.
  • And why that has happened is also explained in the dialogue.
• A note relating to device names has been added to Customisation Sync on the setting dialogue.
• We can verify and resolve also the hidden files now.

Fixed

• We can resolve the conflict of the JSON file correctly now.
• Verifying files between the local database and storage is now working correctly.
• While restarting the plug-in, the shown dialogues will be automatically closed to avoid unexpected behaviour.
• Replicated documents that the local device has configured to ignore are now correctly ignored.
• The chunks of the document on the local device during the first transfer will be created correctly.
  • And why we should create them is now explained in the dialogue.
• If optional features have been enabled in the wizard, Enable advanced features will be toggled correctly.
  The hidden file sync is now working correctly.
  • Now the deletion of hidden files is correctly synchronised.
• Customisation Sync is now working correctly together with hidden file sync.
• No longer database suffix is stored in the setting sharing markdown.
• A fair number of bugs have been fixed.

Changed

• Some default settings have been changed for an easier new user experience.
  • Preventing the meaningless migration of the settings.

Tiding

• The codebase has been reorganised into clearly defined modules.
• Commented-out codes have been gradually removed.