bump

Updated descriptions for redflag options in troubleshooting documentation.

devs.md

@@ -3,6 +3,76 @@
 
 Self-hosted LiveSync is an Obsidian plugin for synchronising vaults across devices using CouchDB, MinIO/S3, or peer-to-peer WebRTC. The codebase uses a modular architecture with TypeScript, Svelte, and PouchDB.
 
+## Build & Development Workflow
+
+### Environment Setup
+
+#### First-time Setup
+
+This repository uses submodules by convention. Therefore, you must use the `--recursive` flag when cloning it.
+```bash
+git clone --recursive https://github.com/vrtmrz/obsidian-livesync
+npm ci
+npm run build
+```
+
+Note: if you already cloned without submodules, run: `git submodule update --init --recursive`
+
+#### Branch switching
+When switching branches, please make sure to update submodules as well, since they may be updated in the new branch.
+```bash
+git checkout --recurse-submodules 0.25.70-patch1 # tag or branch name
+npm ci
+npm run build
+```
+
+### Commands
+
+```bash
+npm run test:unit    # Run unit tests with vitest (or `npm run test:unit:coverage` for coverage)
+npm run check        # TypeScript and svelte type checking
+npm run dev          # Development build with auto-rebuild (uses .env for test vault paths)
+npm run build        # Production build
+npm run buildDev     # Development build (one-time)
+npm run bakei18n     # Pre-build step: compile i18n resources (YAML → JSON → TS)
+npm run test:unit    # Run unit tests only (no Docker services required)
+npm test             # Run Harness based vitest tests (requires Docker services), not recommended, unstable.
+```
+
+### Tips
+
+We can use CLI's E2E test command instead of `npm test`.
+
+### Auto-copy to test vaults
+
+To facilitate development and testing, the build process can automatically copy the built plugin to specified test vault
+
+- Create `.env` file with `PATHS_TEST_INSTALL` pointing to test vault plug-in directories (`:` separated on Unix, `;` on Windows)
+- Development builds auto-copy to these paths on build whilst `npm run dev` is running (watch mode)
+
+### Testing Infrastructure
+
+- ~~**Deno Tests**: Unit tests for platform-independent code (e.g., `HashManager.test.ts`)~~
+    - This is now obsolete, migrated to vitest.
+- **Vitest** (`vitest.config.ts`): E2E test by Browser-based-harness using Playwright, unit tests.
+    - Unit tests should be `*.unit.spec.ts` and placed alongside the implementation file (e.g., `ChunkFetcher.unit.spec.ts`).
+
+- **Docker Services**: Tests require CouchDB, MinIO (S3), and P2P services:
+    ```bash
+    npm run test:docker-all:start  # Start all test services
+    npm run test:full              # Run tests with coverage
+    npm run test:docker-all:stop   # Stop services
+    ```
+    If some services are not needed, start only required ones (e.g., `test:docker-couchdb:start`)
+    Note that if services are already running, starting script will fail. Please stop them first.
+
+- **Test Structure**:
+    - `test/suite/` - Integration tests for sync operations
+    - `test/unit/` - Unit tests (via vitest, as harness is browser-based)
+    - `test/harness/` - Mock implementations (e.g., `obsidian-mock.ts`)
+
+
+
 ## Architecture
 
 ### Module System
@@ -47,48 +117,6 @@ Hence, the new feature should be implemented as follows:
 - **Development code**: Use `.dev.ts` suffix (replaced with `.prod.ts` in production)
 - **Path aliases**: `@/*` maps to `src/*`, `@lib/*` maps to `src/lib/src/*`
 
-## Build & Development Workflow
-
-### Commands
-
-```bash
-npm run test:unit    # Run unit tests with vitest (or `npm run test:unit:coverage` for coverage)
-npm run check        # TypeScript and svelte type checking
-npm run dev          # Development build with auto-rebuild (uses .env for test vault paths)
-npm run build        # Production build
-npm run buildDev     # Development build (one-time)
-npm run bakei18n     # Pre-build step: compile i18n resources (YAML → JSON → TS)
-npm test             # Run vitest tests (requires Docker services)
-```
-
-### Environment Setup
-
-- Clone with submodules: `git clone --recurse-submodules <repository-url>`
-- If you already cloned without them, run: `git submodule update --init --recursive`
-- The shared common library is provided by the `src/lib` submodule, and builds will fail if it is missing
-- Create `.env` file with `PATHS_TEST_INSTALL` pointing to test vault plug-in directories (`:` separated on Unix, `;` on Windows)
-- Development builds auto-copy to these paths on build
-
-### Testing Infrastructure
-
-- ~~**Deno Tests**: Unit tests for platform-independent code (e.g., `HashManager.test.ts`)~~
-    - This is now obsolete, migrated to vitest.
-- **Vitest** (`vitest.config.ts`): E2E test by Browser-based-harness using Playwright, unit tests.
-    - Unit tests should be `*.unit.spec.ts` and placed alongside the implementation file (e.g., `ChunkFetcher.unit.spec.ts`).
-
-- **Docker Services**: Tests require CouchDB, MinIO (S3), and P2P services:
-    ```bash
-    npm run test:docker-all:start  # Start all test services
-    npm run test:full              # Run tests with coverage
-    npm run test:docker-all:stop   # Stop services
-    ```
-    If some services are not needed, start only required ones (e.g., `test:docker-couchdb:start`)
-    Note that if services are already running, starting script will fail. Please stop them first.
-- **Test Structure**:
-    - `test/suite/` - Integration tests for sync operations
-    - `test/unit/` - Unit tests (via vitest, as harness is browser-based)
-    - `test/harness/` - Mock implementations (e.g., `obsidian-mock.ts`)
-
 ## Code Conventions
 
 ### Internationalisation (i18n)
@@ -156,17 +184,17 @@ export class ModuleExample extends AbstractObsidianModule {
 
 ## Beta Policy
 
-- Beta versions are denoted by appending `+patchedN` to the base version number.
+- Beta versions are denoted by appending `-patchedN` to the base version number.
     - `The base version` mostly corresponds to the stable release version.
-        - e.g., v0.25.41+patched1 is equivalent to v0.25.42-beta1.
+        - e.g., v0.25.41-patched1 is equivalent to v0.25.42-beta1.
     - This notation is due to SemVer incompatibility of Obsidian's plugin system.
-    - Hence, this release is `0.25.41+patched1`.
+    - Hence, this release is `0.25.41-patched1`.
 - Each beta version may include larger changes, but bug fixes will often not be included.
     - I think that in most cases, bug fixes will cause the stable releases.
     - They will not be released per branch or backported; they will simply be released.
     - Bug fixes for previous versions will be applied to the latest beta version.
-      This means, if xx.yy.02+patched1 exists and there is a defect in xx.yy.01, a fix is applied to xx.yy.02+patched1 and yields xx.yy.02+patched2.
-      If the fix is required immediately, it is released as xx.yy.02 (with xx.yy.01+patched1).
+      This means, if xx.yy.02-patched1 exists and there is a defect in xx.yy.01, a fix is applied to xx.yy.02-patched1 and yields xx.yy.02-patched2.
+      If the fix is required immediately, it is released as xx.yy.02 (with xx.yy.01-patched1).
     - This procedure remains unchanged from the current one.
 - At the very least, I am using the latest beta.
     - However, I will not be using a beta continuously for a week after it has been released. It is probably closer to an RC in nature.

docs/troubleshooting.md

@@ -382,11 +382,11 @@ This file is in Markdown format so that it can be placed in the Vault externally
 
 There are some options to use `redflag.md`.
 
-| Filename      | Human-Friendly Name | Description                                                                          |
-| ------------- | ------------------- | ------------------------------------------------------------------------------------ |
-| `redflag.md`  | -                   | Suspends all processes.                                                              |
-| `redflag2.md` | `flag_rebuild.md`   | Suspends all processes, and rebuild both local and remote databases by local files.  |
-| `redflag3.md` | `flag_fetch.md`     | Suspends all processes, discard the local database, and fetch from the remote again. |
+| Filename      | Human-Friendly Name | Description                                                                             |
+| ------------- | ------------------- | --------------------------------------------------------------------------------------- |
+| `redflag.md`  | -                   | Suspends all processes.                                                                 |
+| `redflag2.md` | `flag_rebuild.md`   | Suspends all processes, and rebuilds both local and remote databases from local files.  |
+| `redflag3.md` | `flag_fetch.md`     | Suspends all processes, discards the local database, and fetches from the remote again. |
 
 When fetching everything remotely or performing a rebuild, restarting Obsidian
 is performed once for safety reasons. At that time, Self-hosted LiveSync uses
@@ -399,6 +399,16 @@ these files are also not subject to synchronisation.
 However, occasionally the deletion of files may fail. This should generally work
 normally after restarting Obsidian. (As far as I can observe).
 
+>[!IMPORTANT]
+> When a flag file is detected, all synchronisation is disabled, and `Suspend file watching` and
+> `Suspend database reflecting` are enabled automatically. Therefore, please follow the steps below to
+> resolve the issue.
+> 1. Delete the flag file.
+> 2. Shutdown Obsidian.
+> 3. Check your vault folder and ensure it is no longer there.
+> 4. Launch Obsidian.
+> 5. Disable `Suspend file watching` and `Suspend database reflecting` in the settings dialogue (if you have not been asked).
+
 ### Old tips
 
 - Rarely, a file in the database could be corrupted. The plugin will not write

manifest.json

@@ -1,7 +1,7 @@
 {
     "id": "obsidian-livesync",
     "name": "Self-hosted LiveSync",
-    "version": "0.25.70-patch3",
+    "version": "0.25.71",
     "minAppVersion": "1.7.2",
     "description": "Community implementation of self-hosted livesync. Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
     "author": "vorotamoroz",

package-lock.json

@@ -1,12 +1,12 @@
 {
     "name": "obsidian-livesync",
-    "version": "0.25.70-patch3",
+    "version": "0.25.71",
     "lockfileVersion": 3,
     "requires": true,
     "packages": {
         "": {
             "name": "obsidian-livesync",
-            "version": "0.25.70-patch3",
+            "version": "0.25.71",
             "license": "MIT",
             "dependencies": {
                 "@aws-sdk/client-s3": "^3.808.0",

package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-livesync",
-    "version": "0.25.70-patch3",
+    "version": "0.25.71",
     "description": "Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
     "main": "main.js",
     "type": "module",

updates.md

@@ -3,9 +3,9 @@ Since 19th July, 2025 (beta1 in 0.25.0-beta1, 13th July, 2025)
 
 The head note of 0.25 is now in [updates_old.md](https://github.com/vrtmrz/obsidian-livesync/blob/main/updates_old.md). Because 0.25 got a lot of updates, thankfully, compatibility is kept and we do not need breaking changes! In other words, when get enough stabled. The next version will be v1.0.0. Even though it my hope.
 
-## 0.25.70-patch3
+## 0.25.71
 
-2nd June, 2026
+3rd June, 2026
 
 ### Improved
 
@@ -13,24 +13,16 @@ The head note of 0.25 is now in [updates_old.md](https://github.com/vrtmrz/obsid
 - The database fetching process has been streamlined, and database operations are now suspended until it has been completed
 - The initial synchronisation process has been simplified, making it easier to synchronise files with the remote server
 - We can select the remote database to fetch from during the initialisation, when there are multiple remote databases configured (e.g. multiple CouchDBs or S3 remotes)
-
-## 0.25.70-patch2
-
-1st June, 2026
-
+- Hebrew (he) Translation has been added (Thank you so much, @MusiCode1)!
+- Translation loading time has been reduced (Thank you so much, @bmcyver)!
+  
 ### Fixed
+
 - No longer does the status element break other plugins' interaction (#930).
 
-## 0.25.70-patch1
+### Refactored
 
-1st June, 2026
-
-This release does not include any changes to behaviour (if everything is as intended).
-However, this release had addressed a large number of errors and potential issues caused by the switch to a modern ESLint configuration, as well as unintended log output.
-I have also separated out some parts where the type definitions were a bit loose.
-
-As the diff has become too large, I am releasing it as a beta.
-To anyone who has submitted a pull request, please bear with me for a little while.
+To support the new Community automated tests, we fixed numerous lint warnings. This may have also resolved potential issues.
 
 ## 0.25.70