Merge branch 'pre-commit'

.github/workflows/test.yml

@@ -58,6 +58,47 @@ jobs:
       - run: cargo check
       - run: cargo clippy -- -D warnings
 
+
+  pre-commit:
+    name: Run pre-commit
+    runs-on: ubuntu-latest
+    needs: build
+    env:
+      # These hooks are expensive and already run as dedicated jobs above
+      SKIP: "tests,clippy"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: "cargo-lint-${{ needs.build.outputs.rustc_cache_key }}-${{ hashFiles('**/Cargo.lock') }}"
+          restore-keys: |
+            cargo-lint-${{ env.RUSTC_CACHEKEY }}
+            cargo-base-${{ env.RUSTC_CACHEKEY }}
+          fail-on-cache-miss: true
+      - name: Run sccache-cache
+        uses: mozilla-actions/[email protected]
+
+      - uses: actions/setup-python@v3
+      - name: set PYVERSION
+        run: echo "PYVERSION=$(python --version | tr ' ' '-')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit
+          # Changes to pre-commit-config.yaml may require the installation of
+          # new binaries/scripts. When a cache hit occurs, changes to the cache
+          # aren't persisted at the end of the run, so making the key dependent
+          # on the configuration file ensures we always persist a complete cache.
+          key: pre-commit-${{ env.PYVERSION }}-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - run: pip install pre-commit
+      - run: pre-commit run --all --color=always --show-diff-on-failure
+
   test-linux:
     name: Test on Linux
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -2,9 +2,15 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: 9136088a246768144165fcc3ecc3d31bb686920a # frozen: v3.3.0
+    rev: 38b88246ccc552bffaaf54259d064beeee434539 # frozen: v4.0.1
     hooks:
+      - id: check-case-conflict
+      - id: check-symlinks
       - id: check-yaml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+        exclude: '^(README.md|tests/testdata/expected/.*)$'
   - repo: local
     hooks:
       - id: rustfmt

CONTRIBUTING.md

@@ -39,7 +39,7 @@ Code is formatted with [rustfmt](https://github.com/rust-lang/rustfmt) using the
 In addition, all default [clippy](https://github.com/rust-lang/rust-clippy) checks on the latest stable Rust compiler must also pass.
 Both of these are enforced through CI using GitHub actions.
 
-> **💡 Tip: install pre-commit hooks** 
+> **💡 Tip: install pre-commit hooks**
 >
 > This codebase is set up with the [pre-commit framework](https://pre-commit.com/) to automatically run the appropriate checks locally whenever you commit.
 > Assuming you [have pre-commit installed](https://pre-commit.com/#install), all you need to do is run `pre-commit install` once to get this set up.

README.md

@@ -6,7 +6,7 @@ WARNING:
   the docs directory.
 
   Instead of editing README.md, edit the corresponding Markdown files in the
-  docs directory and run generate.sh. 
+  docs directory and run generate.sh.
 
   To add new sections, create new files under docs and add these to _combined.md
 
@@ -58,7 +58,7 @@ If you built from source, upgrade by running `cargo install obsidian-export` aga
 The main interface of *obsidian-export* is the `obsidian-export` CLI command.
 As a text interface, this must be run from a terminal or Windows PowerShell.
 
-It is assumed that you have basic familiarity with command-line interfaces and that you set up your `PATH` correctly if you installed with `cargo`. 
+It is assumed that you have basic familiarity with command-line interfaces and that you set up your `PATH` correctly if you installed with `cargo`.
 Running `obsidian-export --version` should print a version number rather than giving some kind of error.
 
  > 
@@ -101,7 +101,7 @@ Using the `--start-at` argument, you can export just a subset of your vault.
 Given the following vault structure:
 
 ````
-my-obsidian-vault 
+my-obsidian-vault
 ├── Notes/
 ├── Books/
 └── People/

docs/.obsidian/config

@@ -1 +1 @@
-{"theme":"moonstone","pluginEnabledStatus":{"Open in default app":true,"file-explorer":true,"global-search":true,"switcher":true,"graph":true,"backlink":true,"command-palette":true,"markdown-importer":false,"word-count":true,"tag-pane":false,"daily-notes":false,"slides":false,"open-with-default-app":true,"random-note":false,"page-preview":true,"zk-prefixer":false,"starred":false,"outline":true,"templates":false,"workspaces":false},"isSidebarCollapsed":false,"isRightSidedockCollapsed":true,"lastOpenSidebarTab":"File explorer","useTab":false,"showLineNumber":true,"foldHeading":true,"foldIndent":true,"vimMode":true,"newFileLocation":"current","hotkeys":{"switcher:open":[{"modifiers":["Mod"],"key":" "}],"app:go-back":[{"modifiers":["Mod"],"key":"o"}],"app:go-forward":[{"modifiers":["Mod"],"key":"i"}],"editor:toggle-bold":[{"modifiers":["Mod"],"key":"8"}],"editor:toggle-italics":[{"modifiers":["Mod"],"key":"-"}],"editor:toggle-highlight":[{"modifiers":["Mod"],"key":"="}],"editor:delete-paragraph":[],"editor:focus-top":[{"modifiers":["Alt"],"key":"k"}],"editor:focus-bottom":[{"modifiers":["Alt"],"key":"j"}],"editor:focus-left":[{"modifiers":["Alt"],"key":"h"}],"editor:focus-right":[{"modifiers":["Alt"],"key":"l"}],"workspace:split-horizontal":[{"modifiers":["Alt"],"key":"s"}],"workspace:split-vertical":[{"modifiers":["Alt"],"key":"v"}],"workspace:toggle-pin":[{"modifiers":["Alt"],"key":"t"}],"graph:open":[],"backlink:open-backlinks":[{"modifiers":["Alt"],"key":"b"}],"workspace:close":[{"modifiers":["Alt"],"key":"w"}],"editor:swap-line-up":[{"modifiers":["Mod","Shift"],"key":"K"}],"editor:swap-line-down":[{"modifiers":["Mod","Shift"],"key":"J"}],"outline:open":[{"modifiers":["Alt"],"key":"o"}],"app:toggle-left-sidebar":[{"modifiers":["Alt"],"key":","}],"app:toggle-right-sidebar":[{"modifiers":["Alt"],"key":"."}],"graph:open-local":[{"modifiers":["Alt"],"key":"g"}]},"lastOpenRightSidedockTab":"Backlinks","sideDockWidth":{"left":300,"right":301},"fileSortOrder":"alphabetical","promptDelete":false,"readableLineLength":true,"alwaysUpdateLinks":true,"spellcheck":true,"strictLineBreaks":true,"spellcheckDictionary":[],"autoPairMarkdown":false,"autoPairBrackets":false,"showFrontmatter":true,"enabledPlugins":["todoist-sync-plugin"],"defaultViewMode":"preview","obsidianCss":false}
+{"theme":"moonstone","pluginEnabledStatus":{"Open in default app":true,"file-explorer":true,"global-search":true,"switcher":true,"graph":true,"backlink":true,"command-palette":true,"markdown-importer":false,"word-count":true,"tag-pane":false,"daily-notes":false,"slides":false,"open-with-default-app":true,"random-note":false,"page-preview":true,"zk-prefixer":false,"starred":false,"outline":true,"templates":false,"workspaces":false},"isSidebarCollapsed":false,"isRightSidedockCollapsed":true,"lastOpenSidebarTab":"File explorer","useTab":false,"showLineNumber":true,"foldHeading":true,"foldIndent":true,"vimMode":true,"newFileLocation":"current","hotkeys":{"switcher:open":[{"modifiers":["Mod"],"key":" "}],"app:go-back":[{"modifiers":["Mod"],"key":"o"}],"app:go-forward":[{"modifiers":["Mod"],"key":"i"}],"editor:toggle-bold":[{"modifiers":["Mod"],"key":"8"}],"editor:toggle-italics":[{"modifiers":["Mod"],"key":"-"}],"editor:toggle-highlight":[{"modifiers":["Mod"],"key":"="}],"editor:delete-paragraph":[],"editor:focus-top":[{"modifiers":["Alt"],"key":"k"}],"editor:focus-bottom":[{"modifiers":["Alt"],"key":"j"}],"editor:focus-left":[{"modifiers":["Alt"],"key":"h"}],"editor:focus-right":[{"modifiers":["Alt"],"key":"l"}],"workspace:split-horizontal":[{"modifiers":["Alt"],"key":"s"}],"workspace:split-vertical":[{"modifiers":["Alt"],"key":"v"}],"workspace:toggle-pin":[{"modifiers":["Alt"],"key":"t"}],"graph:open":[],"backlink:open-backlinks":[{"modifiers":["Alt"],"key":"b"}],"workspace:close":[{"modifiers":["Alt"],"key":"w"}],"editor:swap-line-up":[{"modifiers":["Mod","Shift"],"key":"K"}],"editor:swap-line-down":[{"modifiers":["Mod","Shift"],"key":"J"}],"outline:open":[{"modifiers":["Alt"],"key":"o"}],"app:toggle-left-sidebar":[{"modifiers":["Alt"],"key":","}],"app:toggle-right-sidebar":[{"modifiers":["Alt"],"key":"."}],"graph:open-local":[{"modifiers":["Alt"],"key":"g"}]},"lastOpenRightSidedockTab":"Backlinks","sideDockWidth":{"left":300,"right":301},"fileSortOrder":"alphabetical","promptDelete":false,"readableLineLength":true,"alwaysUpdateLinks":true,"spellcheck":true,"strictLineBreaks":true,"spellcheckDictionary":[],"autoPairMarkdown":false,"autoPairBrackets":false,"showFrontmatter":true,"enabledPlugins":["todoist-sync-plugin"],"defaultViewMode":"preview","obsidianCss":false}

docs/.obsidian/workspace

@@ -107,4 +107,4 @@
     "Usage.md",
     "License.md"
   ]
-}
+}

docs/.obsidian/workspaces.json

@@ -1 +1 @@
-{}
+{}

docs/_edit-warning.md

@@ -6,7 +6,7 @@ WARNING:
   the docs directory.
 
   Instead of editing README.md, edit the corresponding Markdown files in the
-  docs directory and run generate.sh. 
+  docs directory and run generate.sh.
 
   To add new sections, create new files under docs and add these to _combined.md
 

docs/generate.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 set -euo pipefail
 

docs/usage-advanced.md

@@ -112,4 +112,4 @@ With these hooks in place, links to both notes as well as file attachments shoul
 [gitignore]: https://git-scm.com/docs/gitignore
 [hugo-relative-linking]: https://notes.nick.groenen.me/notes/relative-linking-in-hugo/
 [hugo]: https://gohugo.io
-[markdown render hooks]: https://gohugo.io/getting-started/configuration-markup#markdown-render-hooks 
+[markdown render hooks]: https://gohugo.io/getting-started/configuration-markup#markdown-render-hooks

docs/usage-basic.md

@@ -3,7 +3,7 @@
 The main interface of _obsidian-export_ is the `obsidian-export` CLI command.
 As a text interface, this must be run from a terminal or Windows PowerShell.
 
-It is assumed that you have basic familiarity with command-line interfaces and that you set up your `PATH` correctly if you installed with `cargo`. 
+It is assumed that you have basic familiarity with command-line interfaces and that you set up your `PATH` correctly if you installed with `cargo`.
 Running `obsidian-export --version` should print a version number rather than giving some kind of error.
 
 > If you downloaded a pre-built binary and didn't put it a location referenced by `PATH` (for example, you put it in `Downloads`), you will need to provide the full path to the binary instead.
@@ -44,7 +44,7 @@ Using the `--start-at` argument, you can export just a subset of your vault.
 Given the following vault structure:
 
 ```
-my-obsidian-vault 
+my-obsidian-vault
 ├── Notes/
 ├── Books/
 └── People/

tests/testdata/input/main-samples/section-ref-a.md

@@ -4,4 +4,4 @@
 
 ## This is a header
 
-This is a block ^dda637
+This is a block ^dda637

tests/testdata/input/same-filename-different-directories/dir2/Note.md

@@ -1 +1 @@
-Note in dir2.
+Note in dir2.