# Obsidian Autosave Control

This plugin gives you full control over how Obsidian.md saves your notes.

By default, Obsidian saves every ~2 seconds while you type. While convenient, this behavior can cause issues such as:

- Sync conflicts with cloud storage (e.g. Google Drive, Dropbox, Proton Drive, ...)
- Performance problems with large files
- Issues when working on network drives
- Increased battery usage

This plugin allows you to change that behavior.

## Modes

### 1. Delayed Autosave

- You type normally.
- The save timer resets on every edit (per file).
- Obsidian saves **once**, only after you stop editing for the configured delay (by default 10 seconds).

This reduces unnecessary writes and avoids constant file updates.

### 2. Autosave Disabled

- No automatic saving occurs.
- Files are saved **only** when you manually trigger a save.
- You must use the **Save File** command (assign a hotkey if needed).
- Closing a note or quitting Obsidian with unsaved changes will show a warning.

## Workspace Layout Saves

- Obsidian also saves layout state to `.obsidian/workspace.json`.
- Switching notes can update that file even when note content does not change.
- This plugin can delay those writes too.

## Status Indicator

The plugin shows save state in the status bar:

🔵 Blue — Unsaved changes pending  
🟢 Green — All changes saved  

Colors and the size of the icon can be customized in settings.

## Settings

### Save Delay

- Defines how long Obsidian waits after you stop editing before saving
- Only available in **Delayed Autosave** mode

### Disable Autosave Completely

- Turns off all automatic saving
- Hides the delay setting
- Requires manual saves

### Defer workspace layout saves

- Delays writes to `.obsidian/workspace.json`
- Helps reduce sync activity when switching notes
- Works independently of note autosave mode

### Workspace layout save delay

- How long to wait before writing deferred layout changes
- Only used when **Defer workspace layout saves** is enabled
- Separate from the note save delay

### Saved status color

- Status dot color when all changes are saved.

### Pending status color

- Status dot color while changes are not saved.

### Status icon size

- Size of the status bar dot in pixels.

## Installation

### Install from Obsidian Community Plugins directory

This plugin is available in the official Obsidian Community Plugins directory:

https://community.obsidian.md/plugins/autosave-control

1. In Obsidian, open **Settings -> Community plugins**.
2. Select **Browse**.
3. Search for `Autosave Control`.
4. Install the plugin.
5. Enable the plugin.

### Install with BRAT

This plugin can be installed and auto-updated with [BRAT (Beta Reviewers Auto-update Tester)](https://github.com/TfTHacker/obsidian42-brat):

1. In Obsidian, install **BRAT** from **Settings -> Community plugins -> Browse**.
2. Open the command palette and run `BRAT: Plugins: Add a beta plugin for testing (with or without version)`.
3. Enter this repository path: `mihasm/obsidian-autosave-control`
4. Choose `Latest version` if you want BRAT to keep the plugin updated automatically.
5. Confirm the install.

BRAT installs the plugin from this repository's GitHub releases and can update it for you later.

### Manual install

1. Download the latest release from GitHub:  
   https://github.com/mihasm/obsidian-autosave-control/releases

2. Create this folder in your vault if it does not exist:
   `your-vault/.obsidian/plugins/autosave-control`

3. Download `main.js` and `manifest.json` from the release and place them in that folder.

4. In Obsidian:
- Open **Settings → Community Plugins**
- Enable the plugin

## Important Notes

- Unsaved changes are kept in memory until written to disk.
- If Obsidian or your system crashes before saving, changes may be lost.
- If workspace layout deferral is enabled, recent layout state can also be lost after a crash until `workspace.json` is flushed.
- Closing the app via the window toolbar (x button) in "autosave disabled completely" doesn't show notification about pending changes but instead saves the pending notes automatically because it is impossible for plugins to block quit commands sent from that button due to Electron/Obsidian implementation specifics.

## Testing

- Run `npm install`.

Desktop:

```bash
npm run wdio:desktop
```

Android:

```bash
npm run wdio:android
```

All tests:

```bash
npm run wdio
```

One test:

```bash
npx wdio run ./wdio.conf.mts --spec ./test/specs/autosave-control.e2e.ts --mochaOpts.grep "stops typing and waits for exactly one save after the configured delay"
```

## License

MIT — see `LICENSE`