Initial Custodian release

Author: Giblicious

.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: npm
+      - run: npm ci --no-audit --no-fund
+      - run: npm run check

.github/workflows/release.yml

@@ -0,0 +1,34 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: npm
+      - name: Verify tag and manifest
+        shell: bash
+        run: |
+          VERSION=$(node -p "require('./manifest.json').version")
+          test "$GITHUB_REF_NAME" = "$VERSION"
+      - run: npm ci --no-audit --no-fund
+      - run: npm run check
+      - uses: softprops/action-gh-release@v2
+        with:
+          name: ${{ github.ref_name }}
+          generate_release_notes: true
+          files: |
+            main.js
+            manifest.json
+            styles.css

.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+data.json
+*.log
+*.map
+.DS_Store

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.1
+
+- Added ordered smart-folder rules with first-match-wins behavior.
+- Added title glob, frontmatter, tag, extension, and source-folder conditions.
+- Added templated destinations using note metadata and date values.
+- Added automatic organization on create, rename, and metadata changes.
+- Added vault-wide preview and organization commands.
+- Added collision protection, excluded folders, and loop-safe move scheduling.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Giblicious
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,59 @@
+# Custodian
+
+Rule-driven file organization for Obsidian.
+
+Custodian turns ordinary vault folders into smart folders. Define ordered rules based on a file's title, YAML frontmatter, tags, extension, or current folder, and Custodian places matching files in their designated location.
+
+## Install with BRAT
+
+1. Install and enable **BRAT** in Obsidian.
+2. Open BRAT settings and choose **Add Beta Plugin**.
+3. Enter `Giblicious/custodian`.
+4. Enable **Custodian** under Community plugins.
+
+Custodian supports Obsidian on desktop and mobile.
+
+## Rules
+
+Rules are evaluated from top to bottom. The first matching rule owns the file. Conditions within a rule are combined with **AND**; blank conditions are ignored.
+
+Available conditions:
+
+- **Title:** glob patterns such as `Meeting - *` or `* Invoice`
+- **Frontmatter:** property exists, does not exist, equals, or contains a value
+- **Tags:** require any or all listed tags
+- **Extension:** for example `md`, `pdf`, or `png`
+- **Source folder:** limit a rule to one part of the vault
+
+Destinations may be static (`Projects/Active`) or templated:
+
+- `Journal/{{year}}/{{month}}`
+- `Projects/{{property:project}}`
+- `Attachments/{{extension}}`
+- `People/{{property:owner}}`
+
+Template values are sanitized into safe folder names. Custodian never overwrites a file and rejects paths that could escape the vault.
+
+## Commands
+
+- **Preview file organization:** report how many files would move without changing the vault
+- **Organize all files now:** apply the current rules across the vault
+
+Automatic organization can be disabled globally while rules are being designed. Individual rules can also be disabled.
+
+## Privacy
+
+Custodian works entirely inside Obsidian. It has no network requests, telemetry, accounts, advertising, or analytics.
+
+## Development
+
+```sh
+npm install
+npm run check
+```
+
+Create a semantic version tag matching `manifest.json` (for example `0.1.0`) to publish the BRAT release assets.
+
+## License
+
+MIT

SECURITY.md

@@ -0,0 +1,7 @@
+# Security
+
+Please report security issues privately through GitHub's security advisory form for this repository. Do not open a public issue for an unpatched vulnerability.
+
+Custodian reads file paths and Obsidian metadata from the active vault and moves files only within that vault. It does not send vault data over the network and has no telemetry, accounts, advertising, or analytics.
+
+Rules are stored in Obsidian's local plugin data. Before enabling a broad rule, use the preview command and keep a current backup or version history for the vault. Custodian refuses destinations that escape the vault and does not overwrite an existing file.

esbuild.config.mjs

@@ -0,0 +1,23 @@
+import esbuild from "esbuild";
+import process from "node:process";
+import builtins from "builtin-modules";
+
+const production = process.argv[2] === "production";
+const context = await esbuild.context({
+  entryPoints: ["src/main.ts"],
+  bundle: true,
+  external: ["obsidian", "electron", ...builtins],
+  format: "cjs",
+  target: "es2018",
+  logLevel: "info",
+  sourcemap: production ? false : "inline",
+  treeShaking: true,
+  outfile: "main.js"
+});
+
+if (production) {
+  await context.rebuild();
+  await context.dispose();
+} else {
+  await context.watch();
+}