migration: catch error and restore files

In case of migration error, restore original files, and print a message.

.dir-locals.el

@@ -0,0 +1,13 @@
+((emacs-lisp-mode
+  (fill-column . 110)
+  (indent-tabs-mode . nil)
+  (elisp-lint-ignored-validators . ("byte-compile" "package-lint"))
+  (elisp-lint-indent-specs . ((describe . 1)
+                              (it . 1)
+                              (org-element-map . defun)
+                              (org-roam-with-temp-buffer . 1)
+                              (org-with-point-at . 1)
+                              (magit-insert-section . defun)
+                              (magit-section-case . 0)
+                              (->> . 1)
+                              (org-roam-with-file . 2)))))

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [jethrokuan, zaeph]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,14 +1,15 @@
 ---
 name: Bug Report
 about: Something's not working.
-title: ''
+title: ""
-labels: ''
+labels: ""
-assignees: 'jethrokuan'
+assignees: ""
 ---
 
 ### Description
 
 #### Steps to Reproduce
+
 <!--
 Example:
 
@@ -18,13 +19,25 @@ Example:
 ...
 -->
 
+#### Backtrace
+<!--
+   Will help us track and understand issues faster.
+   How to provide a backtrace:
+   1. M-x toggle-debug-on-error
+   2. Trigger error. The debugger buffer should pop up.
+   3. Copy the contents of the debugger buffer and paste here
+-->
 
 #### Expected Results
+
 <!-- Example: File A is there -->
 
 #### Actual Results
+
 <!-- Example: File A is missing -->
 
-### Versions
+### Environment
-- Emacs (`C-h v emacs-version`): vX.X.X
+
+<!-- Please M-x org-roam-diagnostics and paste results here -->
+
 - Org-roam commit: https://github.com/jethrokuan/org-roam/commit/commithashhere

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,9 +1,9 @@
 ---
 name: Feature Request
 about: Create a feature request to improve Org-roam
-title: ''
+title: ""
-labels: 'enhancement'
+labels: "enhancement"
-assignees: 'jethrokuan'
+assignees: ""
 ---
 
 ### Brief Abstract
@@ -13,4 +13,5 @@ assignees: 'jethrokuan'
 ### Proposed Implementation (if any)
 
 ### Please check the following:
+
 - [ ] No similar feature requests

.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+# * docs.yml --- Build the documentation and publish to Github Pages
+
+name: "Docs"
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install deps
+      run: |
+        sudo apt-get install texinfo
+
+    - name: Build docs
+      continue-on-error: false
+      run: make html
+
+    - name: Deploy 🚀
+      uses: JamesIves/github-pages-deploy-action@releases/v3
+      with:
+        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        BRANCH: gh-pages # The branch the action should deploy to.
+        FOLDER: doc # The folder the action should deploy.
+        CLEAN: true

.github/workflows/test.yml

@@ -29,40 +29,33 @@ on:
   push:
     branches:
       - master
-      - develop
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
-      fail-fast: false
       matrix:
         emacs_version:
+          - 27.1
           - snapshot
     steps:
-    - uses: purcell/setup-emacs@master
+      - uses: purcell/setup-emacs@master
-      with:
+        with:
-        version: ${{ matrix.emacs_version }}
+          version: ${{ matrix.emacs_version }}
 
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
 
-    - name: Initialize sandbox
+      - name: Install Eldev
-      run: |
+        run: curl -fsSL https://raw.github.com/doublep/eldev/master/webinstall/github-eldev | sh
-        SANDBOX_DIR=$(mktemp -d) || exit 1
-        echo ::set-env name=SANDBOX_DIR::$SANDBOX_DIR
-        ./makem.sh -vv --sandbox $SANDBOX_DIR --install-deps --install-linters
 
-    # The "all" rule is not used, because it treats compilation warnings
+      - name: Install dependencies
-    # as failures, so linting and testing are run as separate steps.
+        run: make prepare
 
-    - name: Lint
+      - name: Lint
-      continue-on-error: true
+        run: make lint
-      run: ./makem.sh -vv --sandbox $SANDBOX_DIR lint
-
-    - name: Test
-      if: always()  # Run test even if linting fails.
-      run: ./makem.sh -vv --sandbox $SANDBOX_DIR test
 
+      - name: Test
+        run: make test
 # Local Variables:
 # eval: (outline-minor-mode)
 # End:

.gitignore

@@ -1,2 +1,16 @@
 /.sandbox/
 **/*.elc
+/doc/dir
+/doc/*.info
+/doc/*.pdf
+/doc/*.epub
+/doc/META_INF/
+/doc/OEBPS/
+/doc/dir
+/doc/epub.xml
+/doc/org-roam/
+/doc/mimetype
+/doc/stats/
+/config.mk
+/doc/manual.html
+/.eldev/

.readthedocs.yml

@@ -1,8 +0,0 @@
-version: 2
-mkdocs:
- configuration: mkdocs.yml
-formats: all
-python:
-  version: 3.7
-  install:
-    - requirements: doc/requirements.txt

BACKERS.md

@@ -0,0 +1,8 @@
+# Backers
+
+Many thanks to the following backers, your contributions are greatly appreciated!
+
+- Nathan Tran
+- Burke Libbey
+- forkrul
+- Andreas Stuhlmüller

CHANGELOG.md

@@ -1,5 +1,204 @@
 # Changelog
 
+## 1.2.4 (TBD)
+
+### Added
+
+- [#1396](https://github.com/org-roam/org-roam/pull/1396) add option to choose between prepending, appending, and omitting `roam_tags` in file completion
+- [#1270](https://github.com/org-roam/org-roam/pull/1270) capture: create OLP if it does not exist. Removes need for OLP setup in `:head`.
+- [#1353](https://github.com/org-roam/org-roam/pull/1353) support file-level property drawers
+
+### Changed
+
+- [#1352](https://github.com/org-roam/org-roam/pull/1352) prefer lower-case for roam_tag and roam_alias in interactive commands
+- [#1513](https://github.com/org-roam/org-roam/pull/1513) replaced hardcoded "svg" with defcustom org-roam-graph-filetype 
+- [#1540](https://github.com/org-roam/org-roam/pull/1540) allow `roam_tag` and `roam_alias` to be specified on multiple lines
+
+### Fixed
+
+- [#1281](https://github.com/org-roam/org-roam/pull/1281) fixed idle-timer not instantiated on `org-roam-mode`
+- [#1308](https://github.com/org-roam/org-roam/pull/1308) fixed file renames corrupting database
+- [#1325](https://github.com/org-roam/org-roam/pull/1325) make titles and tags extracted unique per note
+- [#1327](https://github.com/org-roam/org-roam/pull/1327) preserve existing link description during automatic replacement
+- [#1346](https://github.com/org-roam/org-roam/pull/1346) prevent malformed path to `org-roam-index-file`
+- [#1347](https://github.com/org-roam/org-roam/pull/1347) allow use of `%a` element in regular Org-roam captures
+- [#1352](https://github.com/org-roam/org-roam/pull/1352) fixed org-roam-{tag/alias}-{add/delete} altering the original case of the Org property
+- [#1374](https://github.com/org-roam/org-roam/pull/1374) fix headline completions erroring out
+- [#1375](https://github.com/org-roam/org-roam/pull/1375) fix org-roam-protocol to use existing ref file
+- [#1403](https://github.com/org-roam/org-roam/issues/1403) fixed inconsistency between how we write and read props like alias and tags
+- [#1409](https://github.com/org-roam/org-roam/issues/1398) prevent inclusion of non-org-roam files in `org-roam-dailies--list-files`
+- [#1542](https://github.com/org-roam/org-roam/issues/1542) fix files not excluded when `org-roam-list-files-commands` is nil
+
+## 1.2.3 (13-11-2020)
+
+Primarily a stabilization and bug-fix release.
+
+Org-roam-dailies has also been revamped to include new features, see [this video](https://www.youtube.com/watch?v=1q9x2aZCJJ4) for a quick overview.
+
+### Added
+
+- [#978](https://github.com/org-roam/org-roam/pull/978) Revamp org-roam-dailies
+- [#1183](https://github.com/org-roam/org-roam/pull/1183) Interactive functions for managing aliases and tags in Org-roam file, namely `org-roam-alias-add`, `org-roam-alias-delete`, `org-roam-tag-add`, and `org-roam-tag-delete`.
+- [#1215](https://github.com/org-roam/org-roam/pull/1215) Multiple `ROAM_KEY` keywords can now be specified in one file. This allows bibliographical entries to share the same note file.
+- [#1238](https://github.com/org-roam/org-roam/pull/1238) Add `org-roam-prefer-id-links` variable to select linking method
+- [#1239](https://github.com/org-roam/org-roam/pull/1239) Allow `org-roam-protocol` to capture the webpage's selection, and add a toggle for storing the links to the pages
+- [#1264](https://github.com/org-roam/org-roam/pull/1264) add `org-roam-db-update-method` to control when the cache is rebuilt.
+
+### Changed
+
+- [#1264](https://github.com/org-roam/org-roam/pull/1264) renamed `org-roam-update-db-idle-seconds` to `org-roam-db-idle-idle-seconds`
+
+### Fixed
+
+- [#1074](https://github.com/org-roam/org-roam/issues/1074) fix `org-roam--extract-links` to handle content boundaries.
+- [#1193](https://github.com/org-roam/org-roam/issues/1193) fix `org-roam-db-build-cache` by not killing temporary buffer in `org-roam--extract-links`.
+- [#1195](https://github.com/org-roam/org-roam/issues/1195) fix ID face showing as invalid if within Org ID files, but not Org-roam's.
+- [#1199](https://github.com/org-roam/org-roam/issues/1199) make Org-roam link insertions respect `org-roam-link-title-format` everywhere.
+- [#1201](https://github.com/org-roam/org-roam/issues/1201) fix `org-roam-db-build-cache` failing in scenarios involving duplicate IDs and deleted files.
+- [#1226](https://github.com/org-roam/org-roam/issues/1226) only update relative path of file links
+- [#1232](https://github.com/org-roam/org-roam/issues/1232) fix incorrect title extractions from narrowed buffers
+- [#1233](https://github.com/org-roam/org-roam/issues/1233) fixes bug where descriptive file links become plain links during update for relative paths
+- [#1252](https://github.com/org-roam/org-roam/issues/1252) respect original link type during automatic replacement
+
+## 1.2.2 (06-10-2020)
+
+In this release we support fuzzy links of the form `[[roam:Title]]`, `[[roam:*Headline]]` and `[[roam:Title*Headline]]`. Completion for these fuzzy links is supported via `completion-at-point`.
+
+Org-roam now does not resolve symlinks. This significantly speeds up cache builds, but may result in some workflows breaking. In particular, Org-roam now cannot figure out if two distinct file paths in the Org-roam directory are the same file, and both files will be processed as if they were different files. This error seems to be unavoidable now that symlinks are not resolved, but this workflow is rare and should not affect most users.
+
+This change requires you to set `org-roam-directory` to the resolved path of a folder. That is:
+
+```elisp
+(setq org-roam-directory (file-truename "/path/to/directory/"))
+```
+
+### Breaking Changes
+
+- [#1164](https://github.com/org-roam/org-roam/pull/1164) Org-roam now stores the database in the user's Emacs directory by default
+- [#910](https://github.com/org-roam/org-roam/pull/910) Deprecate `company-org-roam`, using `completion-at-point` instead. To use this with company, add the `company-capf` backend instead.
+- [#1109](https://github.com/org-roam/org-roam/pull/1109) Org-roam now does not resolve symlinks.
+
+### Features
+
+- [#1163](https://github.com/org-roam/org-roam/pull/1163) Support file-level IDs introduced in Org 9.4
+- [#1093](https://github.com/org-roam/org-roam/pull/1093) Add `vanilla` org-roam-tag-source to extract buffer Org tags
+- [#1079](https://github.com/org-roam/org-roam/pull/1079) Add `org-roam-tag-face` to customize appearance of tags in interactive commands
+- [#1073](https://github.com/org-roam/org-roam/pull/1073) Rename file on title change, when `org-roam-rename-file-on-title-change` is non-nil.
+- [#1071](https://github.com/org-roam/org-roam/pull/1071) Update link descriptions on title changes, and clean-up rename file advice
+- [#1061](https://github.com/org-roam/org-roam/pull/1061) Speed up the extraction of file properties, headlines, and titles
+- [#1046](https://github.com/org-roam/org-roam/pull/1046) New user option to exclude files from Org-roam
+- [#1032](https://github.com/org-roam/org-roam/pull/1032) File changes are now propagated to the database on idle timer. This prevents large wait times during file saves.
+- [#974](https://github.com/org-roam/org-roam/pull/974) Protect region targeted by `org-roam-insert`
+- [#994](https://github.com/org-roam/org-roam/pull/994) Simplify org-roam-store-link
+- [#1062](https://github.com/org-roam/org-roam/pull/1062) Variable `org-roam-completions-everywhere` allows for completions everywhere from word at point
+- [#910](https://github.com/org-roam/org-roam/pull/910), [#1105](https://github.com/org-roam/org-roam/pull/1105) Support fuzzy links of the form `[[roam:Title]]`, `[[roam:*Headline]]` and `[[roam:Title*Headline]]`
+
+### Bugfixes
+
+- [#1057](https://github.com/org-roam/org-roam/pull/1057) Improve performance of database builds by preventing generation of LaTeX and image previews.
+- [#1103](https://github.com/org-roam/org-roam/pull/1103) Fix long build-times for Windows on files with URL links
+
+## 1.2.1 (27-07-2020)
+
+This release consisted of a big deal of refactoring and bug fixes. Notably, we fixed several catastrophic failures on db builds with bad setups (#854), and modularized tag and title extractions.
+
+We also added some new features that had been a long time coming:
+
+1. We made the backlinks more outline-friendly by also showing the outline hierarchy for a backlink (#863)
+2. We now support nested captures, which is crucial for `org-roam-protocol` (#966)
+
+### Breaking Changes
+
+- [#908](https://github.com/org-roam/org-roam/pull/908) Normalized titles in database. May break external packages that rely on unnormalized titles.
+
+### Features
+
+- [#814](https://github.com/org-roam/org-roam/pull/814) Implement `org-roam-insert-immediate`
+- [#833](https://github.com/org-roam/org-roam/pull/833) Add customization of file titles with `org-roam-title-to-slug-function`.
+- [#839](https://github.com/org-roam/org-roam/pull/839) Return selected file from `org-roam-insert`
+- [#847](https://github.com/org-roam/org-roam/pull/847) Add GC threshold `org-roam-db-gc-threshold` to temporarily change the threshold on expensive operations.
+- [#847](https://github.com/org-roam/org-roam/pull/847) Use sqlite3 transactions instead of storing the values to be inserted.
+- [#851](https://github.com/org-roam/org-roam/pull/851) Add `'first-directory'` option for `org-roam-tag-sources`
+- [#863](https://github.com/org-roam/org-roam/pull/863) Display outline hierarchy in backlinks buffer
+- [#898](https://github.com/org-roam/org-roam/pull/898) Add `org-roam-random-note` to browse a random note.
+- [#900](https://github.com/org-roam/org-roam/pull/900) Support and index all valid org links
+- [#966](https://github.com/org-roam/org-roam/pull/966) Enable nested captures
+
+### Bugfixes
+
+- [#854](https://github.com/org-roam/org-roam/pull/854) Warn instead of fail when duplicate refs and IDs exist.
+- [#857](https://github.com/org-roam/org-roam/pull/857) Fix tag extraction for symlinked directories.
+- [#894](https://github.com/org-roam/org-roam/pull/894) Perform link fixes on all Org-roam files
+- [#952](https://github.com/org-roam/org-roam/pull/952) Cache `${foo}` template variables so they do not need to be re-entered twice
+
+## 1.2.0 (12-06-2020)
+
+In this release, we improved the linking process by achieving feature parity between links to files and links to headlines. Before, we used the `file:foo::*bar` format to link to the headline `bar` in file `foo`, but this was prone to breakage upon renaming the file or modifying the headline. This is not the case anymore. Now, we use `org-id` to create IDs for those headlines, which are then stored in our database to compute the relationships and jump around. Note that this will work even if you’re not using `org-id` in your global configuration for Org-mode.
+
+This is a major step forward. Supporting the in-file structure of Org-mode files means that we can interface with many of its core-features like TODOs, properties, priorities, etc. UX will have to be figured out, but this release ushers in a new age in terms of functionalities.
+
+We also add `org-roam-unlinked-references`, which naively finds text that could be references to the current Org-roam file.
+
+### Breaking Changes
+
+- [#701](https://github.com/org-roam/org-roam/pull/701) Use `emacsql-sqlite3` instead of `emacsql-sqlite` for better Windows compatibility. This requires the presence of the standard `sqlite3` binary on your machine.
+- [#750](https://github.com/org-roam/org-roam/pull/750) Deprecate `org-roam-buffer-no-delete-other-windows` in favour of `org-roam-buffer-window-parameters`.
+
+### Features
+
+- [#787](https://github.com/org-roam/org-roam/pull/787) Add `org-roam-unlinked-references`
+- [#783](https://github.com/org-roam/org-roam/pull/783) Add support for headlines
+- [#757](https://github.com/org-roam/org-roam/pull/757) Roam global properties are now case-insensitive
+- [#680](https://github.com/org-roam/org-roam/pull/680) , [#703](https://github.com/org-roam/org-roam/pull/703), [#708](https://github.com/org-roam/org-roam/pull/708) Add `org-roam-doctor` checkers for `ROAM_*` properties
+- [#664](https://github.com/org-roam/org-roam/pull/664) Add support for shelling out to `rg` and `find` in `org-roam--list-files`
+- [#679](https://github.com/org-roam/org-roam/pull/679), [#683](https://github.com/org-roam/org-roam/pull/683) Building of the graph now happens in a separate process
+
+### Bugfixes
+
+- [#714](https://github.com/org-roam/org-roam/pull/714) No longer print citelinks in backlinks buffer if there is no `ROAM_KEY` property or `org-ref` is not installed
+- [#759](https://github.com/org-roam/org-roam/pull/759), [#760](https://github.com/org-roam/org-roam/pull/760) Tags are only added to the tags table if there are actually tags present
+- [#700](https://github.com/org-roam/org-roam/pull/700), [#733](https://github.com/org-roam/org-roam/pull/733) Allow symlinks within the `org-roam` directory
+
+## 1.1.1 (18-05-2020)
+
+In this release, we added two new features:
+
+1. `org-roam-doctor`: a linting system that helps you discover possible problems with your Org-roam files. This is in the spirit of keeping notes in top quality.
+2. A tagging system: one can now use sub-directories, and the `#+roam_tags` key add additional meta data to notes. For more information, see [here](https://www.orgroam.com/manual/Tags.html#Tags).
+
+As usual, this release comes with a multitude of bug-fixes and refactorings.
+
+### Breaking Changes
+
+- [#523](https://github.com/org-roam/org-roam/pull/523) remove `org-roam-completion-fuzzy-match` in favor of using completion mechanism's configuration options directly
+- [#547](https://github.com/org-roam/org-roam/pull/547) Deprecate `org-roam-db--maybe-update`, in favour of `org-roam-db--update-maybe`
+- [#604](https://github.com/org-roam/org-roam/pull/604) Deprecate `org-roam-title-include-subdirs`, `org-roam-title-subdir-format` `org-roam-title-subdir-separator`, for a more general tagging system built on subdirectories
+
+### Bugfixes
+
+- [#509](https://github.com/org-roam/org-roam/pull/509) fix backup files being tracked in database
+- [#509](https://github.com/org-roam/org-roam/pull/509) fix external org files being tracked in database
+- [#537](https://github.com/org-roam/org-roam/pull/537) quote graphviz node and edge configuration options to allow multi-word configurations
+- [#545](https://github.com/org-roam/org-roam/pull/545) fix `org-roam--extract-links` to ensure that multiple citations (`cite:key1,key2`) are split correctly
+- [#547](https://github.com/org-roam/org-roam/pull/547) Fix unlinked citations
+- [#660](https://github.com/org-roam/org-roam/pull/660) fix rename-file advice not working for renaming to directories
+- [#660](https://github.com/org-roam/org-roam/pull/660) fix links breaking within file on file movement
+
+### Features
+
+- [#538](https://github.com/org-roam/org-roam/pull/538) Optionally use text in first headline as title
+- [#553](https://github.com/org-roam/org-roam/pull/553) Add prefix argument to `org-roam-db-build-cache` for forcing rebuilds
+- [#560](https://github.com/org-roam/org-roam/pull/560) Apply 'error face to distinguish broken links
+- [#570](https://github.com/org-roam/org-roam/pull/570) Add `org-roam-doctor` to diagnose org-roam files
+- [#625](https://github.com/org-roam/org-roam/pull/625) Add `org-roam-title-sources` to control how titles are retrieved within notes
+- [#604](https://github.com/org-roam/org-roam/pull/604) Add a tagging system. `org-roam-tag-sources` controls how tags are retrieved from notes
+
+### Internal Changes
+
+- [#547](https://github.com/org-roam/org-roam/pull/547) Added `type` column to the `refs` table
+- [#606](https://github.com/org-roam/org-roam/pull/606) Added `org-roam-dev.el` for developer coding standards
+- [#622](https://github.com/org-roam/org-roam/pull/622) Online documentation now points to the Org-based documentation
+
 ## 1.1.0 (21-04-2020)
 
 To the average user, this release is mainly a bugfix release with additional options to customize. However, the changes made to the source is significant. Most notably, in this release:
@@ -8,31 +207,35 @@ To the average user, this release is mainly a bugfix release with additional opt
 2. [@kljohann](https://github.com/kljohann) did some fantastic work on graph generation: allowing building images for connected components within the graph up to a specified distance
 3. We also started supporting `org-ref` natively: cite links now show up in both the graph and the org-roam buffer.
 
-In the coming months, you can expect work on bigger projects (e.g. revamping the org-roam buffer). 
+In the coming months, you can expect work on bigger projects (e.g. revamping the org-roam buffer).
- 
+
 ### Breaking Changes
-* [#385](https://github.com/jethrokuan/org-roam/pull/385) Deprecate `org-roam-graph-node-shape` in favour of `org-roam-graph-node-extra-config`.
+
-* [#473](https://github.com/jethrokuan/org-roam/pull/473) Deprecate `org-roam-date-filename-format` and `org-roam-date-title-format`, in favour of `org-roam-dailies-capture-templates`.
+- [#385](https://github.com/org-roam/org-roam/pull/385) Deprecate `org-roam-graph-node-shape` in favour of `org-roam-graph-node-extra-config`.
+- [#473](https://github.com/org-roam/org-roam/pull/473) Deprecate `org-roam-date-filename-format` and `org-roam-date-title-format`, in favour of `org-roam-dailies-capture-templates`.
 
 ### New Features
-* [#350](https://github.com/jethrokuan/org-roam/pull/350) Add `org-roam-db-location` to customize location of org-roam database.
+
-* [#359](https://github.com/jethrokuan/org-roam/pull/359) Add `org-roam-verbose` to allow or silence printing of information.
+- [#350](https://github.com/org-roam/org-roam/pull/350) Add `org-roam-db-location` to customize location of org-roam database.
-* [#374](https://github.com/jethrokuan/org-roam/pull/374) Add support for `org-ref` `cite:` links
+- [#359](https://github.com/org-roam/org-roam/pull/359) Add `org-roam-verbose` to allow or silence printing of information.
-* [#380](https://github.com/jethrokuan/org-roam/pull/380) Allow `org-roam-buffer-position` to also be `top` or `bottom`
+- [#374](https://github.com/org-roam/org-roam/pull/374) Add support for `org-ref` `cite:` links
-* [#385](https://github.com/jethrokuan/org-roam/pull/385) Add `org-roam-graph-node-extra-config` to configure Graphviz nodes
+- [#380](https://github.com/org-roam/org-roam/pull/380) Allow `org-roam-buffer-position` to also be `top` or `bottom`
-* [#398](https://github.com/jethrokuan/org-roam/pull/398), [#418](https://github.com/jethrokuan/org-roam/pull/418) Add graph building for connected components
+- [#385](https://github.com/org-roam/org-roam/pull/385) Add `org-roam-graph-node-extra-config` to configure Graphviz nodes
-* [#435](https://github.com/jethrokuan/org-roam/pull/435) Add `org-roam-graph-edge-extra-config` to configure Graphviz edges
+- [#398](https://github.com/org-roam/org-roam/pull/398), [#418](https://github.com/org-roam/org-roam/pull/418) Add graph building for connected components
-* [#439](https://github.com/jethrokuan/org-roam/pull/439) Add support for `org-ref` citations to display as edges in graph. Add `org-roam-graph-edge-cites-extra-config` to configure these edges
+- [#435](https://github.com/org-roam/org-roam/pull/435) Add `org-roam-graph-edge-extra-config` to configure Graphviz edges
-* [#465](https://github.com/jethrokuan/org-roam/pull/465) Add `org-roam-file-extensions` to allow detection of org files with different file extensions
+- [#439](https://github.com/org-roam/org-roam/pull/439) Add support for `org-ref` citations to display as edges in graph. Add `org-roam-graph-edge-cites-extra-config` to configure these edges
-* [#488](https://github.com/jethrokuan/org-roam/pull/488) Allow a function for `org-roam-graph-viewer`
+- [#465](https://github.com/org-roam/org-roam/pull/465) Add `org-roam-file-extensions` to allow detection of org files with different file extensions
-* [#491](https://github.com/jethrokuan/org-roam/pull/491) Use TITLE as description when linking before first heading
+- [#488](https://github.com/org-roam/org-roam/pull/488) Allow a function for `org-roam-graph-viewer`
+- [#491](https://github.com/org-roam/org-roam/pull/491) Use TITLE as description when linking before first heading
 
 ### Bugfixes
-* [#470](https://github.com/jethrokuan/org-roam/pull/470) Add workaround for undocumented `file-truename` behaviour in `org-roam--org-roam-file-p`.
+
+- [#470](https://github.com/org-roam/org-roam/pull/470) Add workaround for undocumented `file-truename` behaviour in `org-roam--org-roam-file-p`.
 
 ### Internal Changes
-* [#363](https://github.com/jethrokuan/org-roam/pull/363), [#473](https://github.com/jethrokuan/org-roam/pull/473) Modularize org-roam features.
+
-* [#497](https://github.com/jethrokuan/org-roam/pull/497) Simplify `org-roam--list-files` implementation
+- [#363](https://github.com/org-roam/org-roam/pull/363), [#473](https://github.com/org-roam/org-roam/pull/473) Modularize org-roam features.
+- [#497](https://github.com/org-roam/org-roam/pull/497) Simplify `org-roam--list-files` implementation
 
 ## 1.0.0 (23-03-2020)
 
@@ -40,16 +243,18 @@ Org-roam is now on MELPA! We have squashed most of the bugs, and Org-roam has
 been stable for the most part.
 
 ### New Features
-* [#269](https://github.com/jethrokuan/org-roam/pull/269) Add `org-roam-graphviz-extra-options`
+
-* [#257](https://github.com/jethrokuan/org-roam/pull/257) Add a company-backend `company-org-roam`
+- [#269](https://github.com/org-roam/org-roam/pull/269) Add `org-roam-graphviz-extra-options`
-* [#284](https://github.com/jethrokuan/org-roam/pull/284), [#289](https://github.com/jethrokuan/org-roam/pull/289) Configurable `org-roam-completion-system` with options `'default`, `'ido`, `'ivy` and `'helm`
+- [#257](https://github.com/org-roam/org-roam/pull/257) Add a company-backend `company-org-roam`
-* [#289](https://github.com/jethrokuan/org-roam/pull/289) Add customizable `org-roam-fuzzy-match` to allow fuzzy-matching of candidates
+- [#284](https://github.com/org-roam/org-roam/pull/284), [#289](https://github.com/org-roam/org-roam/pull/289) Configurable `org-roam-completion-system` with options `'default`, `'ido`, `'ivy` and `'helm`
-* [#290](https://github.com/jethrokuan/org-roam/pull/290) Add `org-roam-date-title-format` and `org-roam-date-filename-format` for customizing Org-roam's date files
+- [#289](https://github.com/org-roam/org-roam/pull/289) Add customizable `org-roam-fuzzy-match` to allow fuzzy-matching of candidates
-* [#296](https://github.com/jethrokuan/org-roam/pull/296) Allow multiple exclusion matchers in `org-roam-graph-exclude-matcher`
+- [#290](https://github.com/org-roam/org-roam/pull/290) Add `org-roam-date-title-format` and `org-roam-date-filename-format` for customizing Org-roam's date files
+- [#296](https://github.com/org-roam/org-roam/pull/296) Allow multiple exclusion matchers in `org-roam-graph-exclude-matcher`
 
 ### Bugfixes
-* [#293](https://github.com/jethrokuan/org-roam/pull/293) Fix capture templates not working as expected for `org-roam-find-file`
+
-* [#275](https://github.com/jethrokuan/org-roam/pull/275) Fix database rebuild when `org-roam-directory` is set locally
+- [#293](https://github.com/org-roam/org-roam/pull/293) Fix capture templates not working as expected for `org-roam-find-file`
+- [#275](https://github.com/org-roam/org-roam/pull/275) Fix database rebuild when `org-roam-directory` is set locally
 
 ## 1.0.0-rc1 (06-03-2020)
 
@@ -59,82 +264,95 @@ backing storage has been changed to a SQLite database, and a
 templating system using `org-capture` is introduced.
 
 ### Breaking Changes
-* [#200](https://github.com/jethrokuan/org-roam/pull/200) Move Org-roam cache into a SQLite database.
+
-* [#203](https://github.com/jethrokuan/org-roam/pull/203) Roam protocol is deprecated, in favour of extending org-roam-protocol.
+- [#200](https://github.com/org-roam/org-roam/pull/200) Move Org-roam cache into a SQLite database.
+- [#203](https://github.com/org-roam/org-roam/pull/203) Roam protocol is deprecated, in favour of extending org-roam-protocol.
 
 ### New Features
-* [#182](https://github.com/jethrokuan/org-roam/pull/182) Support file name aliases via `#+ROAM_ALIAS`.
+
-* [#216](https://github.com/jethrokuan/org-roam/pull/216) Adds templating functionality by extending org-capture.
+- [#182](https://github.com/org-roam/org-roam/pull/182) Support file name aliases via `#+ROAM_ALIAS`.
-* [#232](https://github.com/jethrokuan/org-roam/pull/232) Adds a prefix key to `org-roam-show-graph`, to generate graph without opening it.
+- [#216](https://github.com/org-roam/org-roam/pull/216) Adds templating functionality by extending org-capture.
-* [#233](https://github.com/jethrokuan/org-roam/pull/233) Adds `org-roam-graph-exclude-matcher`, which allows exclusion of nodes from graph.
+- [#232](https://github.com/org-roam/org-roam/pull/232) Adds a prefix key to `org-roam-show-graph`, to generate graph without opening it.
-* [#247](https://github.com/jethrokuan/org-roam/pull/247) Add `org-roam-backlink` face, which allows customizing backlinks appearance
+- [#233](https://github.com/org-roam/org-roam/pull/233) Adds `org-roam-graph-exclude-matcher`, which allows exclusion of nodes from graph.
-* [#259](https://github.com/jethrokuan/org-roam/pull/259) Add optional initial-prompt to `org-roam-find-file`
+- [#247](https://github.com/org-roam/org-roam/pull/247) Add `org-roam-backlink` face, which allows customizing backlinks appearance
+- [#259](https://github.com/org-roam/org-roam/pull/259) Add optional initial-prompt to `org-roam-find-file`
 
 ### Bugfixes
-* [#207](https://github.com/jethrokuan/org-roam/pull/207), [#221](https://github.com/jethrokuan/org-roam/pull/221) small bugfixes to Org-roam graph generation
+
-* [#230](https://github.com/jethrokuan/org-roam/pull/230) remove nonspacing marks from filenames, to prevent cross-platform errors
+- [#207](https://github.com/org-roam/org-roam/pull/207), [#221](https://github.com/org-roam/org-roam/pull/221) small bugfixes to Org-roam graph generation
+- [#230](https://github.com/org-roam/org-roam/pull/230) remove nonspacing marks from filenames, to prevent cross-platform errors
 
 ### New Contributors
-* [@acowley][https://github.com/acowley]
+
-* [@teesloane][https://github.com/teesloane]
+- [@acowley][https://github.com/acowley]
+- [@teesloane][https://github.com/teesloane]
 
 ## 0.1.2 (2020-02-21)
 
 ### Breaking Changes
-* [#143](https://github.com/jethrokuan/org-roam/pull/143) `org-roam-mode` is now a global mode. The installation instructions have changed accordingly.
+
-* [#103](https://github.com/jethrokuan/org-roam/pull/103) Change `org-roam-file-format` to a function: `org-roam-file-name-function` to allow more flexible file name customizaton. Also changes `org-roam-use-timestamp-as-filename` to `org-roam-filename-noconfirm` to better describe what it does.
+- [#143](https://github.com/org-roam/org-roam/pull/143) `org-roam-mode` is now a global mode. The installation instructions have changed accordingly.
+- [#103](https://github.com/org-roam/org-roam/pull/103) Change `org-roam-file-format` to a function: `org-roam-file-name-function` to allow more flexible file name customizaton. Also changes `org-roam-use-timestamp-as-filename` to `org-roam-filename-noconfirm` to better describe what it does.
 
 ### New Features
-* [#145](https://github.com/jethrokuan/org-roam/pull/145) `org-roam-show-graph`: Fallback to Emacs SVG viewer
+
-* [#141](https://github.com/jethrokuan/org-roam/pull/141) add variable `org-roam-new-file-directory` for new Org-roam files
+- [#145](https://github.com/org-roam/org-roam/pull/145) `org-roam-show-graph`: Fallback to Emacs SVG viewer
-* [#138](https://github.com/jethrokuan/org-roam/pull/138) add `org-roam-switch-to-buffer`
+- [#141](https://github.com/org-roam/org-roam/pull/141) add variable `org-roam-new-file-directory` for new Org-roam files
-* [#124](https://github.com/jethrokuan/org-roam/pull/124), [#141](https://github.com/jethrokuan/org-roam/pull/141) Maintain cache consistency on file rename and delete
+- [#138](https://github.com/org-roam/org-roam/pull/138) add `org-roam-switch-to-buffer`
-* [#87](https://github.com/jethrokuan/org-roam/pull/87), [#90](https://github.com/jethrokuan/org-roam/pull/90) Support encrypted Org files
+- [#124](https://github.com/org-roam/org-roam/pull/124), [#141](https://github.com/org-roam/org-roam/pull/141) Maintain cache consistency on file rename and delete
-* [#110](https://github.com/jethrokuan/org-roam/pull/110) Add prefix to `org-roam-insert`, for inserting titles down-cased
+- [#87](https://github.com/org-roam/org-roam/pull/87), [#90](https://github.com/org-roam/org-roam/pull/90) Support encrypted Org files
-* [#99](https://github.com/jethrokuan/org-roam/pull/99) Add keybinding so that `<return>` or `mouse-1` in the backlinks buffer visits the source file of the backlink at point
+- [#110](https://github.com/org-roam/org-roam/pull/110) Add prefix to `org-roam-insert`, for inserting titles down-cased
+- [#99](https://github.com/org-roam/org-roam/pull/99) Add keybinding so that `<return>` or `mouse-1` in the backlinks buffer visits the source file of the backlink at point
 
 ### Changes
 
-* [#108](https://github.com/jethrokuan/org-roam/pull/108) Locally overwrite the link following behaviour in the org-roam-buffer to open files in the same window `org-roam` was called from
+- [#108](https://github.com/org-roam/org-roam/pull/108) Locally overwrite the link following behaviour in the org-roam-buffer to open files in the same window `org-roam` was called from
 
 ### Bugfixes
-* [#86](https://github.com/jethrokuan/org-roam/pull/86) Fix `org-roam--parse-content` incorrect `:to` computation for nested files
+
-* [#98](https://github.com/jethrokuan/org-roam/pull/98) Fix `org-roam--find-file` picking up temporary files
+- [#86](https://github.com/org-roam/org-roam/pull/86) Fix `org-roam--parse-content` incorrect `:to` computation for nested files
-* [#136](https://github.com/jethrokuan/org-roam/pull/136) Misc bugfixes
+- [#98](https://github.com/org-roam/org-roam/pull/98) Fix `org-roam--find-file` picking up temporary files
+- [#136](https://github.com/org-roam/org-roam/pull/136) Misc bugfixes
 
 ### Internal
-* [#122](https://github.com/jethrokuan/org-roam/pull/122), [#128](https://github.com/jethrokuan/org-roam/pull/128) Improve performance of post-command-hook
+
-* [#92](https://github.com/jethrokuan/org-roam/pull/92), [#105](https://github.com/jethrokuan/org-roam/pull/105) Add tests for core functionality
+- [#122](https://github.com/org-roam/org-roam/pull/122), [#128](https://github.com/org-roam/org-roam/pull/128) Improve performance of post-command-hook
+- [#92](https://github.com/org-roam/org-roam/pull/92), [#105](https://github.com/org-roam/org-roam/pull/105) Add tests for core functionality
 
 ### New Contributors
-* [@frigge](https://github.com/frigge)
+
-* [@juergenhoetzel](https://github.com/juergenhoetzel)
+- [@frigge](https://github.com/frigge)
-* [@chip2n](https://github.com/chip2n)
+- [@juergenhoetzel](https://github.com/juergenhoetzel)
-* [@l3kn](https://github.com/l3kn)
+- [@chip2n](https://github.com/chip2n)
-* [@jdormit](https://github.com/jdormit)
+- [@l3kn](https://github.com/l3kn)
-* [@herbertjones](https://github.com/herbertjones)
+- [@jdormit](https://github.com/jdormit)
-* [@CeleritasCelery](https://github.com/CeleritasCelery)
+- [@herbertjones](https://github.com/herbertjones)
-* [@daniel-koudouna](https://github.com/daniel-koudouna)
+- [@CeleritasCelery](https://github.com/CeleritasCelery)
+- [@daniel-koudouna](https://github.com/daniel-koudouna)
 
 ## 0.1.1 (2020-02-15)
 
 Mostly a documentation/cleanup release.
 
 ### New Features
-* [#62](https://github.com/jethrokuan/org-roam/pull/62) Add the options `org-roam-use-timestamps-as-filename` and `org-roam-file-format`, more in documentation.
+
+- [#62](https://github.com/org-roam/org-roam/pull/62) Add the options `org-roam-use-timestamps-as-filename` and `org-roam-file-format`, more in documentation.
 
 ### Breaking Changes
-* [#62](https://github.com/jethrokuan/org-roam/pull/62) The ID (file-name) workflow is no longer first-class, but a fallback when titles don't exist.
+
+- [#62](https://github.com/org-roam/org-roam/pull/62) The ID (file-name) workflow is no longer first-class, but a fallback when titles don't exist.
 
 ### Changes
-* [#66](https://github.com/jethrokuan/org-roam/pull/66), [#68](https://github.com/jethrokuan/org-roam/pull/68): Improved the quality of the package in preparation of submission to MELPA
+
-* [#73](https://github.com/jethrokuan/org-roam/pull/73): Added CI to the project via Github Issues (Thanks [@alphapapa](https://github.com/alphapapa/) for scripts and setup)
+- [#66](https://github.com/org-roam/org-roam/pull/66), [#68](https://github.com/org-roam/org-roam/pull/68): Improved the quality of the package in preparation of submission to MELPA
-* [#69](https://github.com/jethrokuan/org-roam/pull/69), [#72](https://github.com/jethrokuan/org-roam/pull/72), [#75](https://github.com/jethrokuan/org-roam/pull/75): Major cleanup and de-duplication of code
+- [#73](https://github.com/org-roam/org-roam/pull/73): Added CI to the project via Github Issues (Thanks [@alphapapa](https://github.com/alphapapa/) for scripts and setup)
+- [#69](https://github.com/org-roam/org-roam/pull/69), [#72](https://github.com/org-roam/org-roam/pull/72), [#75](https://github.com/org-roam/org-roam/pull/75): Major cleanup and de-duplication of code
 
 ### Bugfixes
-* [#67](https://github.com/jethrokuan/org-roam/pull/67): Fixed `org-roam--make-file` not creating files with extensions
+
-* [#71](https://github.com/jethrokuan/org-roam/pull/71), [#78](https://github.com/jethrokuan/org-roam/pull/78): Fixed `org-roam-insert` not inserting correct paths
+- [#67](https://github.com/org-roam/org-roam/pull/67): Fixed `org-roam--make-file` not creating files with extensions
-* [#82](https://github.com/jethrokuan/org-roam/pull/82): Fixed nested Org-roam files not being detected as part of Org-roam
+- [#71](https://github.com/org-roam/org-roam/pull/71), [#78](https://github.com/org-roam/org-roam/pull/78): Fixed `org-roam-insert` not inserting correct paths
+- [#82](https://github.com/org-roam/org-roam/pull/82): Fixed nested Org-roam files not being detected as part of Org-roam
 
 <!-- Local Variables: -->
 <!-- eval: (auto-fill-mode -1) -->

Eldev

@@ -0,0 +1,29 @@
+; -*- mode: emacs-lisp; lexical-binding: t; no-byte-compile: t -*-
+
+;; explicitly set main file
+(setf eldev-project-main-file "org-roam.el")
+
+(eldev-use-package-archive 'gnu)
+(eldev-use-package-archive 'melpa-unstable)
+
+;; allow to load test helpers
+(eldev-add-loading-roots 'test "test/utils")
+
+;; Tell checkdoc not to demand two spaces after a period.
+(setq sentence-end-double-space nil)
+
+(setf eldev-lint-default '(elisp))
+(setf eldev-standard-excludes `(:or ,eldev-standard-excludes "org-roam-macs.el"))
+
+(with-eval-after-load 'elisp-lint
+  ;; We will byte-compile with Eldev.
+  (setf elisp-lint-ignored-validators '("package-lint" "fill-column")
+        enable-local-variables        :all))
+
+;; Teach linter how to properly indent emacsql vectors
+(eldev-add-extra-dependencies 'lint 'emacsql)
+(add-hook 'eldev-lint-hook
+          (lambda ()
+            (eldev-load-project-dependencies 'lint nil t)
+            (require 'emacsql)
+            (call-interactively #'emacsql-fix-vector-indentation)))

Makefile

@@ -1,56 +1,29 @@
-# * makem.sh/Makefile --- Script to aid building and testing Emacs Lisp packages
+.PHONY: clean
+clean:
+	eldev clean all
 
-# This Makefile is from the makem.sh repo: <https://github.com/alphapapa/makem.sh>.
+.PHONY: prepare
+prepare:
+	eldev -C --unstable -p -dtT prepare
 
-# * Arguments
+.PHONY: lint
+lint:
+	eldev -C --unstable -T lint
 
-# For consistency, we use only var=val options, not hyphen-prefixed options.
+.PHONY: test
+test:
+	eldev -C --unstable -T test
 
-# NOTE: I don't like duplicating the arguments here and in makem.sh,
+docs:
-# but I haven't been able to find a way to pass arguments which
+	make -C doc all
-# conflict with Make's own arguments through Make to the script.
-# Using -- doesn't seem to do it.
 
-ifdef install-deps
+html:
-	INSTALL_DEPS = "--install-deps"
+	make -C doc html-dir
-endif
-ifdef install-linters
-	INSTALL_LINTERS = "--install-linters"
-endif
 
-ifdef sandbox
+install: install-docs
-	ifeq ($(sandbox), t)
-		SANDBOX = --sandbox
-	else
-		SANDBOX = --sandbox $(sandbox)
-	endif
-endif
 
-ifdef debug
+install-docs: docs
-	DEBUG = "--debug"
+	make -C doc install-docs
-endif
 
-# ** Verbosity
+install-info: info
-
+	make -C doc install-info
-# Since the "-v" in "make -v" gets intercepted by Make itself, we have
-# to use a variable.
-
-verbose = $(v)
-
-ifneq (,$(findstring vv,$(verbose)))
-	VERBOSE = "-vv"
-else ifneq (,$(findstring v,$(verbose)))
-	VERBOSE = "-v"
-endif
-
-# * Rules
-
-# TODO: Handle cases in which "test" or "tests" are called and a
-# directory by that name exists, which can confuse Make.
-
-%:
-	@./makem.sh $(DEBUG) $(VERBOSE) $(SANDBOX) $(INSTALL_DEPS) $(INSTALL_LINTERS) $(@)
-
-.DEFAULT: init
-init:
-	@./makem.sh $(DEBUG) $(VERBOSE) $(SANDBOX) $(INSTALL_DEPS) $(INSTALL_LINTERS)

README.md

@@ -1,43 +1,35 @@
-[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
+# Org-roam [![GitHub Release][release-badge]][release] [![MELPA][melpa-badge]][melpa] [![License GPL 3][gpl3-badge]][gpl3]
-[![Documentation Status](https://readthedocs.org/projects/org-roam/badge/?version=latest)](https://org-roam.readthedocs.io/en/latest/?badge=latest)
-[![GitHub Release](https://img.shields.io/github/v/release/jethrokuan/org-roam)](https://img.shields.io/github/v/release/jethrokuan/org-roam)
-[![MELPA](https://melpa.org/packages/org-roam-badge.svg)](https://melpa.org/#/org-roam)
 
-## Synopsis
+<img src="https://www.orgroam.com/img/logo.svg" align="right" alt="Org-roam Logo" width="240">
 
-Org-roam is a [Roam][roamresearch] replica built on top of the
+Org-roam is a plain-text knowledge management system. It brings some of
-all-powerful [Org-mode][org].
+[Roam's][roamresearch] more powerful features into the [Org-mode][org]
+ecosystem.
 
-Org-roam is a solution for effortless non-hierarchical note-taking
+Org-roam borrows principles from the Zettelkasten method, providing a solution
-with Org-mode. With Org-roam, notes flow naturally, making note-taking
+for non-hierarchical note-taking. It should also work as a plug-and-play
-fun and easy. Org-roam should also work as a plug-and-play solution
+solution for anyone already using Org-mode for their personal wiki.
-for anyone already using Org-mode for their personal wiki.
 
-Org-roam aims to implement the core features of Roam, leveraging the
+- **Private and Secure**: Edit your personal wiki completely offline, entirely
-mature ecosystem around Org-mode where possible. Eventually, we hope
+  in your control. Encrypt your notes with GPG. Take lasting notes in
-to further introduce features enabled by the Emacs ecosystem.
+  plain-text.
+- **Networked Thought**: Connect notes and thoughts together with ease using
+  backlinks. Discover surprising and previously unseen connections in your notes
+  with the built-in graph visualization.
+- **Extensible and Powerful**: Leverage Emacs' fantastic text-editing interface,
+  and the mature Emacs and Org-mode ecosystem of packages.
+- **Free and Open Source**: Org-roam is licensed under the GNU General Public
+  License version 3 or later.
 
-[@technovangelist](https://github.com/technovangelist/) has produced a video
+<p align="center">
-describing Org-roam and the concepts behind it:
+  <img src="https://www.orgroam.com/img/screenshot.png" alt="Org-roam Screenshot" width="738">
-
+</p>
-[![Making Connections in your Notes](http://img.youtube.com/vi/Lg61ocfxk3c/0.jpg)](http://www.youtube.com/watch?v=Lg61ocfxk3c "Making Connections in your Notes")
-
-As of February 2020, it is in a very early stage of development. 
-
-Important links:
 
 - **[Documentation][docs]**
-- **[Org-roam Slack][slack]**
+- **[Discourse][discourse]**
-
+- **[Slack][slack]**
-## A Preview
+- **[Frequently Asked Questions][faq]**
-
+- **[Changelog](CHANGELOG.md)**
-Here's a screenshot of `org-roam`. The `org-roam` buffer shows
-backlinks for the active org buffer in the left window, as well as the
-surrounding content in the backlink file. The database is built once,
-and updated incrementally. The graph is generated from the link
-structure, and can be used to navigate to the respective files.
-
-![img](doc/images/org-roam-graph.gif)
 
 ## Installation
 
@@ -47,34 +39,54 @@ You can install `org-roam` using `package.el`:
 M-x package-install RET org-roam RET
 ```
 
-Here's a sample configuration with using `use-package`:
+Here's a sample configuration with `use-package`:
 
 ```emacs-lisp
 (use-package org-roam
-      :hook 
+      :ensure t
-      (after-init . org-roam-mode)
       :custom
-      (org-roam-directory "/path/to/org-files/")
+      (org-roam-directory (file-truename "/path/to/org-files/"))
-      :bind (:map org-roam-mode-map
+      :bind (("C-c n l" . org-roam-buffer-toggle)
-              (("C-c n l" . org-roam)
+             ("C-c n f" . org-roam-node-find)
-               ("C-c n f" . org-roam-find-file)
+             ("C-c n g" . org-roam-graph)
-               ("C-c n g" . org-roam-show-graph))
+             ("C-c n i" . org-roam-node-insert)
-              :map org-mode-map
+             ("C-c n c" . org-roam-capture)
-              (("C-c n i" . org-roam-insert))))
+             ;; Dailies
+             ("C-c n j" . org-roam-dailies-capture-today))
+      :config
+      (org-roam-setup)
+      ;; If using org-roam-protocol
+      (require 'org-roam-protocol))
 ```
 
-For more detailed installation and configuration instructions (including for
+The `file-truename` function is only necessary when you use symbolic links
-Doom and Spacemacs users), please see [the
+inside `org-roam-directory`: Org-roam does not resolve symbolic links.
-documentation](https://org-roam.readthedocs.io/en/master/installation/).
+
+Org-roam requires sqlite to function. Org-roam optionally uses Graphviz for
+graph-related functionality. It is recommended to install PCRE-enabled ripgrep
+for better performance and extended functionality.
+
+## Getting Help
+
+Before creating a new topic/issue, please be mindful of our time and ensure that
+it has not already been addressed on [GitHub][issues] or on
+[Discourse][discourse].
+
+- If you are new to Emacs and have problem setting up Org-roam, please ask your
+  question on [Slack, channel #how-do-i][slack].
+- For quick questions, please ask them on [Slack, channel
+  #troubleshooting][slack].
+- If something is not working as it should, or if you would like to suggest a
+  new feature, please [create a new issue][issues].
+- If you have questions about your workflow with the slip-box method, please
+  find a relevant topic on [Discourse][discourse], or create a new one.
 
 ## Knowledge Bases using Org-roam
 
 - [Jethro Kuan](https://braindump.jethro.dev/)
   ([Source](https://github.com/jethrokuan/braindump/tree/master/org))
-
+- [Alexey Shmalko](https://braindump.rasen.dev/)
-## Changelog
+- [Sidharth Arya](https://sidhartharya.github.io/braindump/index.html)
-
-A changelog is being maintained [here](CHANGELOG.md)
 
 ## Contributing
 
@@ -85,10 +97,18 @@ request. Please also see [CONTRIBUTING.md](.github/CONTRIBUTING.md).
 ## License
 
 Copyright © Jethro Kuan and contributors. Distributed under the GNU
-General Public License, Version 3
+General Public License, Version 3.
 
 [roamresearch]: https://www.roamresearch.com/
 [org]: https://orgmode.org/
-[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
+[gpl3-badge]: https://img.shields.io/badge/license-GPL_3-green.svg
-[docs]: https://org-roam.readthedocs.io/
+[gpl3]: http://www.gnu.org/licenses/gpl-3.0.txt
+[melpa-badge]: https://melpa.org/packages/org-roam-badge.svg
+[melpa]: https://melpa.org/#/org-roam
+[release-badge]: https://img.shields.io/github/v/release/org-roam/org-roam
+[release]: https://github.com/org-roam/org-roam/releases
+[docs]: https://www.orgroam.com/manual.html
+[discourse]: https://org-roam.discourse.group/
 [slack]: https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg
+[issues]: https://github.com/org-roam/org-roam/issues
+[faq]: https://www.orgroam.com/manual.html#FAQ

default.mk

@@ -0,0 +1,106 @@
+TOP := $(dir $(lastword $(MAKEFILE_LIST)))
+
+## User options ######################################################
+#
+# You can override these settings in "config.mk" or on the command
+# line.
+#
+# You might also want to set LOAD_PATH.  If you do, then it must
+# contain "-L .".
+#
+# If you don't do so, then the default is set in the "Load-Path"
+# section below.  The default assumes that all dependencies are
+# installed either at "../<DEPENDENCY>", or when using package.el
+# at "ELPA_DIR/<DEPENDENCY>-<HIGHEST-VERSION>".
+
+sharedir ?= $(HOME)/.local/share
+lispdir  ?= $(sharedir)/emacs/site-lisp/org-roam
+infodir  ?= $(sharedir)/info
+docdir   ?= $(sharedir)/doc/org-roam
+statsdir ?= $(TOP)/doc/stats
+
+CP       ?= install -p -m 644
+MKDIR    ?= install -p -m 755 -d
+RMDIR    ?= rm -rf
+TAR      ?= tar
+SED      ?= sed
+
+EMACSBIN ?= emacs
+BATCH     = $(EMACSBIN) -Q --batch $(LOAD_PATH)
+
+INSTALL_INFO     ?= $(shell command -v ginstall-info || printf install-info)
+MAKEINFO         ?= makeinfo
+MANUAL_HTML_ARGS ?= --css-ref /assets/page.css
+
+## Files #############################################################
+
+PKG       = org-roam
+PACKAGES  = org-roam
+
+TEXIPAGES = $(addsuffix .texi,$(PACKAGES))
+INFOPAGES = $(addsuffix .info,$(PACKAGES))
+HTMLFILES = $(addsuffix .html,$(PACKAGES))
+HTMLDIRS  = $(PACKAGES)
+PDFFILES  = $(addsuffix .pdf,$(PACKAGES))
+EPUBFILES = $(addsuffix .epub,$(PACKAGES))
+
+ELS = org-roam-buffer.el
+ELS += org-roam-capture.el
+ELS += org-roam-compat.el
+ELS += org-roam-completion.el
+ELS += org-roam-dailies.el
+ELS += org-roam-db.el
+ELS += org-roam.el
+ELS += org-roam-graph.el
+ELS += org-roam-macs.el
+ELS += org-roam-protocol.el
+ELCS = $(ELS:.el=.elc)
+ELMS = org-roam.el $(filter-out $(addsuffix .el,$(PACKAGES)),$(ELS))
+ELGS = org-roam-autoloads.el org-roam-version.el
+
+## Versions ##########################################################
+
+VERSION ?= $(shell test -e $(TOP).git && git describe --tags --abbrev=0 | cut -c2-)
+
+EMACS_VERSION = 26.1
+
+EMACSOLD := $(shell $(BATCH) --eval \
+  "(and (version< emacs-version \"$(EMACS_VERSION)\") (princ \"true\"))")
+ifeq "$(EMACSOLD)" "true"
+  $(error At least version $(EMACS_VERSION) of Emacs is required)
+endif
+
+## Load-Path #########################################################
+
+ifndef LOAD_PATH
+
+ELPA_DIR ?= $(HOME)/.emacs.d/elpa
+
+SYSTYPE := $(shell $(EMACSBIN) -Q --batch --eval "(princ system-type)")
+ifeq ($(SYSTYPE), windows-nt)
+  CYGPATH := $(shell cygpath --version 2>/dev/null)
+endif
+
+LOAD_PATH = -L $(TOP)
+
+# When making changes here, then don't forget to adjust "Makefile",
+# ".travis.yml", ".github/ISSUE_TEMPLATE/bug_report.md",
+# `magit-emacs-Q-command' and the "Installing from the Git Repository"
+# info node accordingly.  Also don't forget to "rgrep \b<pkg>\b".
+
+endif # ifndef LOAD_PATH
+
+ifndef ORG_LOAD_PATH
+ORG_LOAD_PATH  = $(LOAD_PATH)
+ORG_LOAD_PATH += -L $(TOP)../ox-texinfo-plus
+ORG_LOAD_PATH += -L $(TOP)../org-mode/contrib/lisp
+ORG_LOAD_PATH += -L $(TOP)../org-mode/lisp
+endif
+
+## Publish ###########################################################
+
+PUBLISH_TARGETS ?= html html-dir pdf epub
+
+DOCBOOK_XSL ?= /usr/share/xml/docbook/stylesheet/docbook-xsl/epub/docbook.xsl
+
+EPUBTRASH = epub.xml META-INF OEBPS

doc/AUTHORS.md

@@ -0,0 +1,37 @@
+Authors
+=======
+
+The following people have contributed to Org-Roam.
+
+Names below are sorted alphabetically.
+
+Author
+------
+
+- Jethro Kuan <jethrokuan95@gmail.com>
+
+Maintainers
+----------
+
+- Jethro Kuan <jethrokuan95@gmail.com>
+- Leo Vivier <leo.vivier+dev@gmail.com>
+
+Contributors
+------------
+
+- Alexey Shmalko <rasen.dubi@gmail.com>
+- James Ravn <james@r-vn.org>
+- Jethro Kuan <jethrokuan95@gmail.com>
+- Johann Klähn <johann@jklaehn.de>
+- Josh English <josh@joshenglish.com>
+- Jürgen Hötzel <juergen@archlinux.org>
+- Langston Barrett <langston.barrett@gmail.com>
+- Leo Vivier <leo.vivier+dev@gmail.com>
+- Michael Glaesemann <grzm@seespotcode.net>
+- Michael Herold <github@michaeljherold.com>
+- Noboru <noboru.ota@gmail.com>
+- N V <44036031+progfolio@users.noreply.github.com>
+- Rafael Accácio Nogueira <raccacio@poli.ufrj.br>
+- Roland Coeurjoly <rolandcoeurjoly@gmail.com>
+- Sayan <dit7ya@users.noreply.github.com>
+- Tim Quelch <tim@tquelch.com>

doc/Makefile

@@ -0,0 +1,127 @@
+-include ../config.mk
+include ../default.mk
+
+###################################################################
+MANUAL_HTML_ARGS = --css-ref assets/page.css
+
+.PHONY: texi install clean AUTHORS.md stats
+
+all: info
+
+## Build #############################################################
+
+info: $(INFOPAGES) dir
+html: $(HTMLFILES)
+pdf:  $(PDFFILES)
+epub: $(EPUBFILES)
+
+%.info: %.texi
+	@printf "Generating $@\n"
+	@$(MAKEINFO) --no-split $< -o $@
+
+dir: org-roam.info
+	@printf "Generating dir\n"
+	@echo $^ | xargs -n 1 $(INSTALL_INFO) --dir=$@
+
+%.html: %.texi
+	@printf "Generating $@\n"
+	@$(MAKEINFO) --html --no-split $(MANUAL_HTML_ARGS) $<
+
+html-dir:
+	@$(MAKEINFO) --html --no-split $(MANUAL_HTML_ARGS) org-roam.texi
+	mv org-roam.html manual.html
+
+%.pdf: %.texi
+	@printf "Generating $@\n"
+	@texi2pdf --clean $< > /dev/null
+
+%.epub: %.texi
+	@printf "Generating $@\n"
+	@$(MAKEINFO) --docbook $< -o epub.xml
+	@xsltproc $(DOCBOOK_XSL) epub.xml 2> /dev/null
+	@echo "application/epub+zip" > mimetype
+	@zip -X --quiet --recurse-paths -0 $@ mimetype
+	@zip -X --quiet --recurse-paths -9 --no-dir-entries $@ META-INF OEBPS
+	@$(RMDIR) $(EPUBTRASH)
+
+## Install ###########################################################
+
+install: install-info install-docs
+
+install-docs: install-info
+	@$(MKDIR) $(DESTDIR)$(docdir)
+	$(CP) AUTHORS.md $(DESTDIR)$(docdir)
+
+install-info: info
+	@$(MKDIR) $(DESTDIR)$(infodir)
+	$(CP) $(INFOPAGES) $(DESTDIR)$(infodir)
+
+## Clean #############################################################
+
+clean:
+	@printf "Cleaning doc/*...\n"
+	@$(RMDIR) dir $(INFOPAGES) $(HTMLFILES) $(HTMLDIRS) $(PDFFILES)
+	@$(RMDIR) $(EPUBFILES) $(EPUBTRASH)
+
+## Release management ################################################
+
+ORG_ARGS  = --batch -Q $(ORG_LOAD_PATH)
+ORG_ARGS += -l ox-extra -l ox-texinfo+
+ORG_ARGS += --eval "(or (require 'org-man nil t) (require 'ol-man))"
+ORG_EVAL  = --eval "(ox-extras-activate '(ignore-headlines))"
+ORG_EVAL += --eval "(setq indent-tabs-mode nil)"
+ORG_EVAL += --eval "(setq org-src-preserve-indentation nil)"
+ORG_EVAL += --funcall org-texinfo-export-to-texinfo
+
+# This target first bumps version strings in the Org source.  The
+# necessary tools might be missing so other targets do not depend
+# on this target and it has to be run explicitly when appropriate.
+#
+#   AMEND=t make texi    Update manual to be amended to HEAD.
+#   VERSION=N make texi  Update manual for release.
+#
+texi:
+	@$(EMACSBIN) $(ORG_ARGS) $(PKG).org $(ORG_EVAL)
+	@printf "\n" >> $(PKG).texi
+	@rm -f $(PKG).texi~
+
+stats:
+	@printf "Generating statistics\n"
+	@gitstats -c style=/assets/stats.css -c max_authors=999 $(TOP) $(statsdir)
+
+authors: AUTHORS.md
+
+AUTHORS.md:
+	@printf "Generating AUTHORS.md..."
+	@test -e $(TOP).git \
+	&& (printf "$$AUTHORS_HEADER\n" > $@ \
+	&& git log --pretty=format:'- %aN <%aE>' | sort -u >> $@ \
+	&& printf "done\n" ; ) \
+	|| printf "FAILED (non-fatal)\n"
+
+# Templates ##########################################################
+
+define AUTHORS_HEADER
+Authors
+=======
+
+The following people have contributed to Org-Roam.
+
+Names below are sorted alphabetically.
+
+Author
+------
+
+- Jethro Kuan <jethrokuan95@gmail.com>
+
+Maintainers
+----------
+
+- Jethro Kuan <jethrokuan95@gmail.com>
+- Leo Vivier <leo.vivier+dev@gmail.com>
+
+Contributors
+------------
+
+endef
+export AUTHORS_HEADER

doc/anatomy.md

@@ -1,41 +0,0 @@
-The bulk of Org-roam's functionality is built on top of vanilla
-Org-mode. However, to support additional functionality, Org-roam adds
-several Org-roam-specific keywords. These functionality are not
-crucial to effective use of Org-roam.
-
-## File Aliases
-
-Suppose you want a note to be referred to by different names (e.g.
-"World War 2", "WWII"). You may specify such aliases using the
-`#+ROAM_ALIAS` attribute:
-
-```org
-#+TITLE: World War 2
-#+ROAM_ALIAS: "WWII" "World War II"
-```
-
-
-## File Refs
-
-Refs are unique identifiers for files. Each note can only have 1 ref.
-For example, a note for a website may contain a ref:
-
-```org
-#+TITLE: Google
-#+ROAM_KEY: https://www.google.com/
-```
-
-These keys come in useful for when taking website notes, using the
-`roam-ref` protocol (see [Roam Protocol](roam_protocol.md)).
-
-Alternatively, add a ref for notes for a specific paper, using its
-[org-ref](https://github.com/jkitchin/org-ref) citation key:
-
-```org
-#+TITLE: Neural Ordinary Differential Equations
-#+ROAM_KEY: cite:chen18_neural_ordin_differ_equat
-```
-
-The backlinks buffer will show any cites of this key: e.g.
-
-![org-ref-citelink](images/org-ref-citelink.png)

doc/assets/page.css

@@ -0,0 +1,68 @@
+:root {
+  --border: #526980;
+  --code: #007;
+}
+
+body {
+    margin: 5ex 10ex;
+    max-width: 80ex;
+    line-height: 1.5;
+    font-family: sans-serif;
+}
+
+h1, h2, h3 {
+    font-weight: normal;
+}
+
+pre, code {
+    font-family: x, monospace;
+}
+
+pre {
+    padding: 1ex;
+    background: #eee;
+    border: solid 1px #ddd;
+    min-width: 0;
+    font-size: 80%;
+    overflow: auto;
+}
+
+code {
+    color: var(--code);
+}
+
+img {
+    max-width: 100%;
+}
+
+table {
+  border-collapse: collapse;
+  width: 100%;
+}
+
+pre.menu-comment {
+  background: none;
+  border: none;
+  font-family: sans-serif;
+  padding: 0;
+  margin: 0;
+  font-size: 100%;
+}
+
+thead {
+  border-bottom: 1px solid var(--border);
+}
+
+tfoot {
+  border-top: 1px solid var(--border);
+}
+
+blockquote {
+  margin-left: 1rem;
+  font-style: italic;
+  font-family: serif;
+  border-left: 3px solid;
+  border-left-color: currentcolor;
+  border-color: var(--text-color);
+  padding-left: 1em;
+}

doc/comparison.md

@@ -1,11 +0,0 @@
----
-title: "Comparing Org-roam With Other Packages"
-metaTitle: "Comparing Org-roam With Other Packages"
-metaDescription: "Comparing Org-roam With Other Packages"
----
-
-# Org-brain
-
-# Zetteldeft
-
-# Org-zettelkasten

doc/configuration.md

@@ -1,142 +0,0 @@
-The number of configuration options is deliberately kept small, to
-keep the Org-roam codebase manageable. However, we attempt to
-accommodate as many usage styles as possible.
-
-All of Org-roam's customization options can be viewed via `M-x
-customize-group org-roam`.
-
-## Setting the Org-roam Directory
-
-Set `org-roam-directory` to the folder containing all your Org files:
-
-```emacs-lisp
-(setq org-roam-directory "/path/to/org/")
-```
-
-Every Org file, at any level of nesting, within `/path/to/org/` is
-considered part of the Org-roam ecosystem.
-
-### Having More Than One Org-roam Directory
-
-Emacs supports directory-local variables, allowing the value of
-`org-roam-directory` to be different in different directories. It does
-this by checking for a file named `.dir-locals.el`. 
-
-To add support for multiple directories, override the
-`org-roam-directory` variable using directory-local variables. This is
-what `.dir-locals.el` may contain:
-
-```emacs-lisp
-((nil . ((org-roam-directory . "/path/to/here/"))))
-```
-
-All files within that directory will be treated as their own separate
-set of Org-roam files. Remember to run `org-roam-db-build-cache` from a
-file within that directory, at least once.
-
-## Org-roam Buffer
-
-The Org-roam buffer defaults to popping up from the right. You may
-choose to set it to pop up from the left with `(setq
-org-roam-buffer-position 'left)`.
-
-The Org-roam buffer name can also be renamed: e.g. `(setq
-org-roam-buffer "*my-buffer-name*")`.
-
-The Org-roam buffer width is adjustable via `org-roam-buffer-width`.
-The value of `org-roam-buffer-width` set as a percentage of the total
-frame width. For example:
-
-```emacs-lisp
-(setq org-roam-buffer-width 0.4)
-```
-
-Will result in the Org-roam buffer taking up 40% of the screen width.
-
-You can change backlinks appearance in the buffer by customizing
-`org-roam-backlink` face (`M-x customize-face org-roam-backlink`).
-
-## Org-roam Links
-
-By default, links are inserted with the title as the link description.
-This can make them hard to distinguish from external links. You may
-choose add special indicators for Org-roam links by tweaking
-`org-roam-link-title-format`, for example:
-
-```emacs-lisp
-(setq org-roam-link-title-format "R:%s")
-```
-
-If your version of Org is at least `9.2`, you may also choose to
-simply style the link differently, by customizing `org-roam-link` face
-(`M-x customize-face org-roam-link`).
-
-## Org-roam Files
-
-Org-roam files are created and prefilled using Org-roam's templating
-system. The templating system is customizable, and the system is
-described in detail in the [Org-roam Template](templating.md) page.
-
-### Encryption
-
-Encryption (via GPG) can be enabled for all new files by setting
-`org-roam-encrypt-files` to `t`. When enabled, new files are created
-with the `.org.gpg` extension and decryption are handled automatically
-by EasyPG. 
-
-Note that Emacs will prompt for a password for encrypted files during
-cache updates if it requires reading the encrypted file. To reduce the
-number of password prompts, you may wish to cache the password.
-
-## Org-roam Graph Viewer
-
-Org-roam generates an SVG image using
-[Graphviz](https://graphviz.org/). To setup graph navigation, see the
-[Graph Setup](graph_setup.md) page.
-
-Org-roam tries its best to locate the Graphviz executable from your
-`PATH`, but if it fails to do so, you may set it manually:
-
-```
-(setq org-roam-graph-executable "/path/to/dot")
-```
-
-You may also choose to use `neato` in place of `dot`, which generates a more compact graph layout.
-
-```
-(setq org-roam-graph-executable "/path/to/neato")
-(setq org-roam-graph-extra-config '(("overlap" . "false")))
-```
-
-Org-roam also attempts to use Firefox (located on `PATH`) to view the
-SVG, you may choose to set it to any compatible program:
-
-```
-(setq org-roam-graph-viewer "/path/to/image-viewer")
-```
-
-### Excluding Nodes and Edges
-One may want to exclude certain files to declutter the graph. You can do so by setting `org-roam-graph-exclude-matcher`.
-
-```
-(setq org-roam-graph-exclude-matcher '("private" "dailies"))
-```
-
-This setting excludes all files whose path contain "private" or "dailies".
-
-## Org-roam Completion System
-
-Org-roam offers completion when choosing note titles etc.
-The completion system is configurable. The default setting,
-
-```
-(setq org-roam-completion-system 'default)
-```
-
-uses Emacs' standard `completing-read`. If you prefer [Helm](https://emacs-helm.github.io/helm/), use
-
-```
-(setq org-roam-completion-system 'helm)
-```
-
-Other options included `'ido`, and `'ivy'`.

doc/css/styles.css

@@ -0,0 +1,85 @@
+body {
+  margin: 20px;
+  background: #303030;
+  color: #f5f5f5;
+  font-size: 1.6rem;
+  font-weight: 300;
+}
+
+.container {
+  max-width: 800px;
+}
+
+.nav {
+  margin-top: 5rem;
+}
+
+.nav-item a {
+  /* color: #797979; */
+  color: #bebebe;
+  text-decoration: none;
+  font-family: "Consolas", "Monaco", "Menlo", monospace;
+}
+
+.nav-item a:hover {
+  cursor: pointer;
+  /* color: #4d4a4a; */
+  color: #dcdcdc;
+  border: none;
+}
+
+.hero {
+  color: #f5f5f5;
+}
+
+.hero div {
+  margin-bottom: 5rem;
+}
+
+.hero h3 {
+  /* font-family: "Edelsans", sans-serif; */
+  font-size: 5rem;
+  margin-bottom: 0;
+}
+
+.hero h5 {
+  margin-top: 1rem;
+  margin-bottom: 0;
+  /* font-weight: 200; */
+  font-weight: 250;
+}
+
+.grid-demo-col {
+  background: #e4e4e4;
+}
+
+a {
+  color: #cd86ff;
+}
+
+a:hover {
+  color: #dbb9f3;
+}
+
+img {
+  max-width: 100%;
+}
+
+.footer-links {
+  font-size: 1.5rem;
+  color: #f5f5f5;
+  text-decoration: none;
+  font-weight: 250;
+}
+
+.header {
+  font-weight: 200;
+}
+
+#footer {
+  margin-bottom: 3rem;
+}
+
+#footer h5 {
+  margin-bottom: 1.5rem;
+}

doc/ecosystem.md

@@ -1,134 +0,0 @@
-A number of packages work well combined with Org-Roam:
-
-## Deft
-
-[Deft][deft] provides a nice interface for browsing and filtering
-org-roam notes.
-
-```emacs-lisp
-(use-package deft
-  :after org
-  :bind
-  ("C-c n d" . deft)
-  :custom
-  (deft-recursive t)
-  (deft-use-filter-string-for-filename t)
-  (deft-default-extension "org")
-  (deft-directory "/path/to/org-roam-files/"))
-```
-
-If the title of the Org file is not the first line, you might not get
-nice titles. You may choose to patch this to use `org-roam`'s
-functionality. Here I'm using [el-patch](https://github.com/raxod502/el-patch):
-
-```emacs-lisp
-(use-package el-patch
-  :straight (:host github
-                   :repo "raxod502/el-patch"
-                   :branch "develop"))
-
-(eval-when-compile
-  (require 'el-patch))
-
-(use-package deft
-  ;; same as above...
-  :config/el-patch
-  (defun deft-parse-title (file contents)
-    "Parse the given FILE and CONTENTS and determine the title.
-If `deft-use-filename-as-title' is nil, the title is taken to
-be the first non-empty line of the FILE.  Else the base name of the FILE is
-used as title."
-    (el-patch-swap (if deft-use-filename-as-title
-                       (deft-base-filename file)
-                     (let ((begin (string-match "^.+$" contents)))
-                       (if begin
-                           (funcall deft-parse-title-function
-                                    (substring contents begin (match-end 0))))))
-                   (org-roam--get-title-or-slug file))))
-```
-
-The Deft interface can slow down quickly when the number of files get
-huge. [Notdeft][notdeft] is a fork of Deft that uses an external
-search engine and indexer.
-
-## Org-journal
-
-[Org-journal](https://github.com/bastibe/org-journal) is a more powerful
-alternative to the simple function `org-roam-dailies-today`. It provides better
-journaling capabilities, and a nice calendar interface to see all dated entries.
-
-```emacs-lisp
-(use-package org-journal
-  :bind
-  ("C-c n j" . org-journal-new-entry)
-  :custom
-  (org-journal-date-prefix "#+TITLE: ")
-  (org-journal-file-format "%Y-%m-%d.org")
-  (org-journal-dir "/path/to/org-roam-files/")
-  (org-journal-date-format "%A, %d %B %Y"))
-```
-
-## Note-taking Add-ons
-
-These are some plugins that make note-taking in Org-mode more
-enjoyable.
-
-### Org-download
-
-[Org-download][org-download] lets you screenshot and yank images from
-the web into your notes:
-
-![org-download](images/org-download.gif)
-
-```emacs-lisp
-(use-package org-download
-  :after org
-  :bind
-  (:map org-mode-map
-        (("s-Y" . org-download-screenshot)
-         ("s-y" . org-download-yank))))
-```
-
-### mathpix.el
-
-[mathpix.el][mathpix-el] uses [Mathpix's](https://mathpix.com/) API to convert clips into
-latex equations:
-
-![mathpix](images/mathpix.gif)
-
-```emacs-lisp
-(use-package mathpix.el
-  :straight (:host github :repo "jethrokuan/mathpix.el")
-  :custom ((mathpix-app-id "app-id")
-           (mathpix-app-key "app-key"))
-  :bind
-  ("C-x m" . mathpix-screenshot))
-```
-
-### Org-noter / Interleave
-
-[Org-noter][org-noter] and [Interleave][interleave] are both projects
-that allow synchronised annotation of documents (PDF, EPUB etc.)
-within Org-mode.
-
-### Org-ref
-
-[Org-ref][org-ref] does citation and bibliography management in
-Org-mode, and a great tool for scientific notes.
-
-### Spaced Repetition
-
-[Org-fc][org-fc] is a spaced repetition system that scales well with a
-large number of files. Other alternatives include
-[org-drill][org-drill], and [pamparam][pamparam].
-
-[deft]: https://jblevins.org/projects/deft/
-[notdeft]: https://github.com/hasu/notdeft
-[org-download]: https://github.com/abo-abo/org-download
-[mathpix-el]: https://github.com/jethrokuan/mathpix.el
-[org-noter]: https://github.com/weirdNox/org-noter
-[interleave]: https://github.com/rudolfochrist/interleave
-[org-ref]: https://github.com/jkitchin/org-ref
-[org-fc]: https://github.com/l3kn/org-fc/
-[org-drill]: https://orgmode.org/worg/org-contrib/org-drill.html
-[pamparam]: https://github.com/abo-abo/pamparam

doc/htmlxref.cnf

@@ -0,0 +1,15 @@
+# https://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Configuration.html
+
+EMACS = https://www.gnu.org/software/emacs/manual
+
+auth		mono	${EMACS}/html_mono/auth.html
+auth		node	${EMACS}/html_node/auth/
+
+ediff		mono	${EMACS}/html_mono/ediff.html
+ediff		node	${EMACS}/html_node/ediff/
+
+elisp		mono	${EMACS}/html_mono/elisp.html
+elisp		node	${EMACS}/html_node/elisp/
+
+emacs		mono	${EMACS}/html_mono/emacs.html
+emacs		node	${EMACS}/html_node/emacs/

doc/index.html

@@ -0,0 +1,168 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="An Effortless PKM System." />
+    <meta name="author" content="Org-roam Contributors" />
+
+    <title>Org-roam</title>
+
+    <link rel="stylesheet" href="https://unpkg.com/wingcss" />
+    <link rel="stylesheet" type="text/css" href="./css/styles.css" />
+
+    <script src="https://code.iconify.design/1/1.0.6/iconify.min.js"></script>
+  </head>
+
+  <body>
+    <section class="hero container center text-center">
+      <div>
+        <img src="./img/logo.png" alt="Org-roam Logo" height="200" />
+        <h3>Org-roam</h3>
+        <h5>A plain-text personal knowledge management system.</h5>
+      </div>
+    </section>
+
+    <section class="container center">
+      <div>
+        <img src="./img/screenshot.png" alt="screenshot" />
+      </div>
+    </section>
+
+    <section id="features" class="container center">
+      <div>
+        <h3 class="header">FEATURES</h3>
+        <div class="row">
+          <div class="col">
+            <h5 class="left">
+              <iconify-icon data-icon="fxemoji:lock"></iconify-icon> &nbsp;
+              Private and Secure
+            </h5>
+            <p class="content">
+              Edit your personal wiki completely offline, entirely in your
+              control. Encrypt your notes with GPG. Take lasting notes in
+              plain-text.
+            </p>
+          </div>
+          <div class="col">
+            <h5 class="left">
+              <iconify-icon data-icon="flat-color-icons:link"></iconify-icon>
+              &nbsp; Make Connections
+            </h5>
+            <p class="content">
+              Connect notes and thoughts together with ease using backlinks.
+              Discover surprising and previously unseen connections in your
+              notes with the built-in graph visualization.
+            </p>
+          </div>
+        </div>
+
+        <div class="row">
+          <div class="col">
+            <h5 class="left">
+              <iconify-icon data-icon="twemoji:puzzle-piece"></iconify-icon>
+              &nbsp; Extensible and Powerful
+            </h5>
+            <p class="content">
+              Leverage Emacs' fantastic text-editing interface, and the mature
+              Emacs and Org-mode ecosystem of packages.
+            </p>
+          </div>
+          <div class="col">
+            <h5 class="left">
+              <iconify-icon data-icon="logos:git-icon"></iconify-icon> &nbsp;
+              Free and Open Source
+            </h5>
+            <p class="content">
+              Org-roam is licensed under the GNU General Public License version
+              3 or later. You are free to extend its functionality and
+              contribute back. Find
+              us <a href="https://github.com/org-roam/org-roam">here</a>.
+            </p>
+          </div>
+        </div>
+      </div>
+    </section>
+    
+    <section id="links" class="container">
+      <div>
+        <h3 class="header">LINKS</h3> New to Emacs and Org-mode, and trying to
+        find your way around? Org-roam has an inclusive community of users
+        passionate about Personal Knowledge Management -- we're happy to help!
+        You can find us on Discourse and Slack.
+        
+        <ul>
+            <li>Read our documentation within Emacs, or on the <a href="https://www.orgroam.com/manual.html">Online Manual</a></li>
+            <li>Participate in our forum discussions on <a href="https://org-roam.discourse.group">Discourse</a></li>
+            <li>Chat with us on <a href="https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg">Slack</a></li>
+          </ul>
+      </div>
+    </section>
+
+    <section id="footer" class="row container">
+      <div class="col">
+        <div class="row">
+          <h5 class="header">Ecosystem</h5>
+        </div>
+
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://github.com/org-roam/org-roam-bibtex"
+            >org-roam-bibtex</a
+          >
+        </div>
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://github.com/org-roam/org-roam-server"
+            >org-roam-server</a
+          >
+        </div>
+      </div>
+
+      <div class="col">
+        <div class="row">
+          <h5 class="header">Resources</h5>
+        </div>
+
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://github.com/org-roam/org-roam/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc"
+            >Open Issues</a
+          >
+        </div>
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://github.com/org-roam/org-roam/releases"
+            >Releases</a
+          >
+        </div>
+      </div>
+
+      <div class="col">
+        <div class="row">
+          <h5 class="header">Connect</h5>
+        </div>
+
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg"
+            >Slack</a
+          >
+        </div>
+        <div class="row">
+          <a
+            class="content footer-links"
+            href="https://org-roam.discourse.group/"
+            >Discourse</a
+          >
+        </div>
+      </div>
+    </section>
+  </body>
+</html>

doc/index.md

@@ -1,62 +0,0 @@
-![org-roam][org-roam-intro-image]
-
-## What is Org-roam?
-
-Org-roam is a [Roam][roamresearch] replica built around the
-all-powerful [Org-mode][org].
-
-Org-roam is a solution for effortless non-hierarchical note-taking
-with Org-mode. With Org-roam, notes flow naturally, making note-taking
-fun and easy. Org-roam should also work as a plug-and-play solution
-for anyone already using Org-mode for their personal wiki.
-
-To understand more about Roam, a collection of links are available in
-[the appendix](notetaking_workflow.md).
-
-Org-roam aims to implement the core features of Roam, leveraging the
-mature ecosystem around Org-mode where possible. Eventually, we hope
-to further introduce features enabled by the Emacs ecosystem.
-
-## Why use Org-roam?
-
-##### Private and Secure
-
-Edit your personal wiki completely offline, entirely in your control.
-Encrypt your notes with GPG.
-
-##### Longevity
-
-Unlike web solutions like Roam research, the notes are first and
-foremost plain Org-mode files -- Org-roam simply builds up an
-auxilliary database to give the personal wiki superpowers. Having your
-notes in plain-text is crucial for the longevity of your wiki. Never
-have to worry about proprietary web solutions being taken down. Edit
-your plain-text notes in notepad if all other editors cease to exist.
-
-##### Free and Open-source
-
-Org-roam is free and open-source, which means that if you feel unhappy
-with any part of Org-roam, you may choose to extend Org-roam, or open
-a PR.
-
-##### Leverage the Org-mode Ecosystem
-
-Over the years, Emacs and Org-mode has developed into a mature system
-for plain-text organization. Building upon Org-mode already puts
-Org-roam light-years ahead of many other solutions.
-
-Emacs is also a fantastic interface for editing text, and we can
-inherit many of the powerful text-navigation and editing packages
-available to Emacs.
-
-There are several packages that are similar to Org-roam, see the
-[Comparison](comparison.md) page for a detailed comparison.
-
-## Project Status
-
-As of March 2020, most of the core functionality and interfaces have
-stabilized, and a stable release is near.
-
-[org-roam-intro-image]: images/org-roam-intro.png
-[roamresearch]: https://www.roamresearch.com/
-[org]: https://orgmode.org/

doc/installation.md

@@ -1,195 +0,0 @@
-## Basic Install and Configuration
-
-Org-roam is now available on MELPA, so you can install it via the following
-command:
-
-```
-M-x package-install RET org-roam RET
-```
-
-Alternatively, you may use package managers such as [straight][straight] or
-[quelpa][quelpa] to install the package.
-
-The recommended method of configuration is to use [use-package][use-package].
-
-```emacs-lisp
-(use-package org-roam
-      :hook
-      (after-init . org-roam-mode)
-      :custom
-      (org-roam-directory "/path/to/org-files/")
-      :bind (:map org-roam-mode-map
-              (("C-c n l" . org-roam)
-               ("C-c n f" . org-roam-find-file)
-               ("C-c n b" . org-roam-switch-to-buffer)
-               ("C-c n g" . org-roam-graph))
-              :map org-mode-map
-              (("C-c n i" . org-roam-insert))))
-```
-
-Or without `use-package`:
-
-```emacs-lisp
-(require 'org-roam)
-(define-key org-roam-mode-map (kbd "C-c n l") #'org-roam)
-(define-key org-roam-mode-map (kbd "C-c n f") #'org-roam-find-file)
-(define-key org-roam-mode-map (kbd "C-c n b") #'org-roam-switch-to-buffer)
-(define-key org-roam-mode-map (kbd "C-c n g") #'org-roam-graph)
-(define-key org-mode-map (kbd "C-c n i") #'org-roam-insert)
-(org-roam-mode +1)
-```
-
-The [Configuration](configuration.md) page details some of the common
-configuration options available.
-
-### Completion
-
-Link auto-completion is offered via
-[company-org-roam](https://github.com/jethrokuan/company-org-roam/), refer to
-the documentation there for further details.
-
-## Spacemacs
-
-If you are using Spacemacs, install org-roam by creating a simple layer that
-wraps Org-roam. Paste the following into a new file
-`~/.emacs.d/private/org-roam/packages.el`.
-
-```emacs-lisp
-(defconst org-roam-packages
-  '(org-roam))
-
-(defun org-roam/init-org-roam ()
-  (use-package org-roam
-    :hook
-    (after-init . org-roam-mode)
-    :custom
-    (org-roam-directory "/path/to/org-files/")
-    :init
-    (progn
-      (spacemacs/declare-prefix "ar" "org-roam")
-      (spacemacs/set-leader-keys
-       "arl" 'org-roam
-       "art" 'org-roam-dailies-today
-       "arf" 'org-roam-find-file
-       "arg" 'org-roam-graph)
-
-      (spacemacs/declare-prefix-for-mode 'org-mode "mr" "org-roam")
-      (spacemacs/set-leader-keys-for-major-mode 'org-mode
-                                                "rl" 'org-roam
-                                                "rt" 'org-roam-dailies-today
-                                                "rb" 'org-roam-switch-to-buffer
-                                                "rf" 'org-roam-find-file
-                                                "ri" 'org-roam-insert
-                                                "rg" 'org-roam-graph))))
-```
-
-Next, append `org-roam` to the `dotspacemacs-configuration-layers`
-list in your `.spacemacs` configuration file. Reload (`SPC f e R`) or
-restart Emacs to load `org-roam`. It's functions are available under
-the prefix `SPC a r` and `, r` when visiting an org-mode buffer.
-
-If you also have the ranger layer installed, the prefix 'ar' conflict
-with that of the ranger layer. You might want to change it to 'aor'
-(also change the 'ar' to 'aor' in the other key-binding declarations)
-
-## Doom Emacs
-
-[Doom Emacs][doom] has a `+roam` flag on its `org` module for easy
-installation and configuration. Simply add the flag to the `org` section
-of your `~/.doom.d/init.el` and run `~/.emacs.d/bin/doom sync`.
-
-[use-package]: https://github.com/jwiegley/use-package
-[straight]: https://github.com/raxod502/straight.el
-[quelpa]: https://github.com/quelpa/quelpa
-[doom]: https://github.com/hlissner/doom-emacs
-[doom-getting-started]: https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#configuring-packages
-
-## Windows
-
-On Windows, if you follow the installation instructions above, you will likely get the error message: **"No EmacSQL SQLite binary available, aborting"**, and `org-roam` won't start properly.
-
-You need to do some additional steps to get `org-roam` to work.
-
-Essentially, you will need to have a binary file for `emacsql-sqlite` so that your Emacs can work with `sqlite` database -- `org-roam` uses it to track backlinks. The following options have been reported to work by Windows users in the community.
-
-Option 1. **Windows Subsystem for Linux (WSL)**
-: This option lets you use Linux on your Windows machine. It's Linux, so you don't need to do anything specific for Windows.
-
-Option 2. **mingw-x64**
-: Use mingw-x64. You would spend a bit of time to download it, and get familiar with how it works. You should be able to use Linux tools within your Windows [more contribution welcome].
-
-Option 3. **scoop**
-: Use [scoop](https://scoop.sh/) to install a couple of software tools (make and gcc) and manually compile a binary (`.exe`) file yourself. Find a short step-by-step guide below.
-
-Option 4. **emacsql-sqlite3**
-: Use another Emacs package called [`emacsql-sqlite3`](https://github.com/cireu/emacsql-sqlite3). You can download an [official binary](https://sqlite.org/download.html) for `sqlite3`. `emacsql-sqlite3` lets you use it. For this option to work, you need to adjust the `org-roam` source code, and get your modified version to work in your Emacs environment. Find a suggestion below.
-
-### scoop
-**Step 1.** In PowerShell, install `scoop` ([instruction here](https://scoop.sh/)).
-
-```powershell
-iwr -useb get.scoop.sh | iex
-```
-
-**Step 2.** In PowerShell, install `make` and `gcc` via scoop
-
-```powershell
-scoop install make gcc
-```
-
-**Step 3.** In Emacs, install the `emacsql-sqlite` package for your Emacs if it is not done yet.
-
-**Step 4.** In PowerShell, move to the directory where `emacsql.c` is stored.
-
-With MELPA, it is likely to be under your ELPA folder:
-
-```
-~\AppData\Roaming\.emacs.d\elpa\emacsql-sqlite-20190727.1710\sqlite
-```
-
-With Doom Emacs, it should be under your `.emacs\.local`:
-
-```
-~\.emacs.d\.local\straight\build\emacsql-sqlite\sqlite
-```
-
-Check the files via `dir` command. You should see these files:
-
-```powershell
-Mode                LastWriteTime         Length Name
-----                -------------         ------ ----
--a----       22/03/2020  12:10 PM           5170 emacsql.c
--a----       22/03/2020  12:10 PM            439 Makefile
--a----       22/03/2020  12:10 PM        7516138 sqlite3.c
--a----       22/03/2020  12:10 PM         526684 sqlite3.h
-```
-
-**Step 5.** Compile the `.exe` file with `make`
-
-```powershell
-make emacsql-sqlite CC=gcc LDLIBS=
-```
-
-You will see the process triggered with lots of text automatically scrolling down; it may take a couple of minutes for compilation to finish.
-
-Once compilation is done, check that `emacsql-sqlite.exe` has been added to the directory.
-
-**Step 6.** Relaunch Emacs, use `org-roam`
-
-When you start `org-roam` (e.g. via `org-roam-mode`), now you should no longer see the "No EmacSQL SQLite binary available, aborting" error. You are good to go.
-
-
-### emacsql-sqlite3
-
-1. In Emacs, install the `emacsql-sqlite3` package
-
-2. Using your text editor, etc. modify `org-roam-db.el`:
-
-    1. Replace `(require 'emacsql-sqlite)` with `(require 'emacsql-sqlite3)`
-
-    2. Comment/deactivate the complete `(defconst org-roam-db--sqlite-available-p ... )`
-
-    3. In `(defun org-roam-db ...`, replace `emacsql-sqlite`
-with `emacsql-sqlite3`
-
-3. If you compile `.el` files, ensure to replace `org-roam-db.elc` with the new source you modified.

doc/notetaking_workflow.md

@@ -1,24 +0,0 @@
-## Recommended Books
-- [How to Take Smart Notes][1]
-
-## Articles
-- [How to Take Smart Notes in Org-mode - Jethro Kuan][7]
-- [The Zettelkasten Method - LessWrong 2.0][3]
-- [Building a second brain in Roam][4]
-- [Roam: Why I Love It and How I Use It][5]
-- [Adam Keesling's Twitter Thread][6]
-
-## Threads
-- [Ask HN: How to Take Good Notes][8]
-
-## What to Do With Your Notes
-- [How to Use Roam to Outline a New Article in Under 20 Minutes][2]
-
-[1]: https://www.goodreads.com/book/show/34507927-how-to-take-smart-notes?ac=1&from_search=true&qid=6L8iEE1FIA&rank=1
-[2]: https://www.youtube.com/watch?v=RvWic15iXjk
-[3]: https://www.lesswrong.com/posts/NfdHG6oHBJ8Qxc26s/the-zettelkasten-method-1
-[4]: https://reddit.com/r/RoamResearch/comments/eho7de/building_a_second_brain_in_roamand_why_you_might
-[5]: https://www.nateliason.com/blog/roam
-[6]: https://twitter.com/adam_keesling/status/1196864424725774336?s=20
-[7]: https://blog.jethro.dev/posts/how_to_take_smart_notes_org/
-[8]: https://news.ycombinator.com/item?id=22473209

doc/org_export.md

@@ -1,61 +0,0 @@
-While exporting your documents to another format such as HTML -- whether using Org's in-built export or ox-hugo -- you can add a backlinks section which would display the backlinks to the current file. This is done via org-export's preprocessing hooks. See more at [Advanced Export Configuration (The Org Manual)](https://orgmode.org/manual/Advanced-Export-Configuration.html#Advanced-Export-Configuration).
-
-Following are two different configs that might be suitable for different use-cases. Add one of these snippets in your Emacs init file.
-
-### Only Backlinks
-
-This will display only the backlinks and not the contents.
-
-```emacs-lisp
-(defun my/org-roam--backlinks-list (file)
-  (if (org-roam--org-roam-file-p file)
-      (--reduce-from
-       (concat acc (format "- [[file:%s][%s]]\n"
-                           (file-relative-name (car it) org-roam-directory)
-			                     (org-roam--get-title-or-slug (car it))))
-       "" (org-roam-db-query [:select [from] :from links :where (= to $s1)] file))
-    ""))
-
-(defun my/org-export-preprocessor (backend)
-  (let ((links (my/org-roam--backlinks-list (buffer-file-name))))
-    (unless (string= links "")
-      (save-excursion
-      	(goto-char (point-max))
-      	(insert (concat "\n* Backlinks\n") links)))))
-
-(add-hook 'org-export-before-processing-hook 'my/org-export-preprocessor)
-```
-
-### Backlinks and Contents
-
-This would insert both backlinks and the contents, just like the org-roam buffer. This might be especially useful if you host a web version of your personal knowledgebase and want to browse the files along with the backlinks from mobile devices.
-
-```emacs-lisp
-(defun my/org-roam--backlinks-list-with-content (file)
-  (with-temp-buffer
-    (if-let* ((backlinks (org-roam--get-backlinks file))
-              (grouped-backlinks (--group-by (nth 0 it) backlinks)))
-        (progn
-          (insert (format "\n\n* %d Backlinks\n"
-                          (length backlinks)))
-          (dolist (group grouped-backlinks)
-            (let ((file-from (car group))
-                  (bls (cdr group)))
-              (insert (format "** [[file:%s][%s]]\n"
-                              file-from
-                              (org-roam--get-title-or-slug file-from)))
-              (dolist (backlink bls)
-                (pcase-let ((`(,file-from _ ,props) backlink))
-                  (insert (s-trim (s-replace "\n" " " (plist-get props :content))))
-                  (insert "\n\n")))))))
-    (buffer-string)))
-
-  (defun my/org-export-preprocessor (backend)
-    (let ((links (my/org-roam--backlinks-list-with-content (buffer-file-name))))
-      (unless (string= links "")
-        (save-excursion
-          (goto-char (point-max))
-          (insert (concat "\n* Backlinks\n") links)))))
-
-  (add-hook 'org-export-before-processing-hook 'my/org-export-preprocessor)
-```

doc/requirements.txt

@@ -1,2 +0,0 @@
-mkdocs-material==4.6.2
-pymdown-extensions==6.3

doc/roam_protocol.md

@@ -1,161 +0,0 @@
-## What is Roam protocol?
-
-Org-roam extending `org-protocol` with 2 protocols: the `roam-file`
-and `roam-ref` protocol.
-
-## The `roam-file` protocol
-
-This is a simple protocol that opens the path specified by the `file`
-key (e.g. `org-protocol://roam-file?file=/tmp/file.org`). This is used
-in the generated graph.
-
-## The `roam-ref` Protocol
-
-This protocol finds or creates a new note with a given `ROAM_KEY` (see
-[Anatomy](anatomy.md)):
-
-![roam-ref](images/roam-ref.gif)
-
-To use this, create a Firefox bookmarklet as follows:
-
-```javascript
-javascript:location.href =
-'org-protocol:/roam-ref?template=r&ref='
-+ encodeURIComponent(location.href)
-+ '&title='
-+ encodeURIComponent(document.title)
-```
-
-where `template` is the template key for a template in
-`org-roam-capture-ref-templates`. More documentation on the templating
-system can be found [here](templating.md).
-
-These templates should contain a `#+ROAM_KEY: ${ref}` in it.
-
-## Setting up Org-roam protocol
-
-To enable org-roam's protocol extensions, you have to add the
-following to your init file:
-
-```emacs-lisp
-(require 'org-roam-protocol)
-```
-
-The instructions for setting up `org-protocol` can be found
-[here][org-protocol-inst], but they are reproduced below.
-
-We will also need to create a desktop application for `emacsclient`.
-The instructions for various platforms are shown below:
-
-## Linux
-
-Create a desktop application. I place mine in
-`~/.local/share/applications/org-protocol.desktop`:
-
-```
-[Desktop Entry]
-Name=Org-Protocol
-Exec=emacsclient %u
-Icon=emacs-icon
-Type=Application
-Terminal=false
-MimeType=x-scheme-handler/org-protocol
-```
-
-Associate `org-protocol://` links with the desktop application by
-running in your shell:
-
-```bash
-xdg-mime default org-protocol.desktop x-scheme-handler/org-protocol
-```
-
-To disable the "confirm" prompt in Chrome, you can also make Chrome
-show a checkbox to tick, so that the `Org-Protocol Client` app will be used
-without confirmation. To do this, run in a shell:
-
-```sh
-sudo mkdir -p /etc/opt/chrome/policies/managed/
-sudo tee /etc/opt/chrome/policies/managed/external_protocol_dialog.json >/dev/null <<'EOF'
-{
-  "ExternalProtocolDialogShowAlwaysOpenCheckbox": true
-}
-EOF
-sudo chmod 644 /etc/opt/chrome/policies/managed/external_protocol_dialog.json
-```
-
-and then restart Chrome (for example, by navigating to <chrome://restart>) to
-make the new policy take effect.
-
-See [here](https://www.chromium.org/administrators/linux-quick-start)
-for more info on the `/etc/opt/chrome/policies/managed` directory and
-[here](https://cloud.google.com/docs/chrome-enterprise/policies/?policy=ExternalProtocolDialogShowAlwaysOpenCheckbox)
-for information on the `ExternalProtocolDialogShowAlwaysOpenCheckbox`
-policy.
-
-
-## Mac OS
-
-One solution is to use
-[Platypus](https://github.com/sveinbjornt/Platypus). Here are the
-instructions for setting up with Platypus and Chrome:
-
-1. Install and launch Platypus (with [Homebrew](https://brew.sh/)):
-
-```sh
-brew cask install platypus
-```
-2. Create a script `launch_emacs.sh`:
-
-```
-#!/usr/bin/env bash
-/usr/local/bin/emacsclient --no-wait $1
-```
-
-3. Create a Platypus app with the following settings:
-
-```
-| Setting                        | Value                     |
-|--------------------------------+---------------------------|
-| App Name                       | "OrgProtocol"             |
-| Script Type                    | "env" · "/usr/bin/env"    |
-| Script Path                    | "path/to/launch-emacs.sh" |
-| Interface                      | None                      |
-| Accept dropped items           | true                      |
-| Remain running after execution | false                     |
-```
-
-Inside `Settings`:
-
-```
-| Setting                        | Value          |
-|--------------------------------+----------------|
-| Accept dropped files           | true           |
-| Register as URI scheme handler | true           |
-| Protocol                       | "org-protocol" |
-```
-
-To disable the "confirm" prompt in Chrome, you can also make Chrome
-show a checkbox to tick, so that the `OrgProtocol` app will be used
-without confirmation. To do this, run in a shell:
-
-```sh
-defaults write com.google.Chrome ExternalProtocolDialogShowAlwaysOpenCheckbox -bool true
-```
-
-
-##### Note for Emacs Mac Port
-
-If you're using [Emacs Mac Port](https://github.com/railwaycat/homebrew-emacsmacport), it
-registered its `Emacs.app` as the default handler for the URL scheme
-`org-protocol`. We have to make our `OrgProtocol.app` the default
-handler instead (replace `org.yourusername.OrgProtocol` with your app
-identifier):
-
-```
-$ defaults write com.apple.LaunchServices/com.apple.launchservices.secure LSHandlers -array-add \
-'{"LSHandlerPreferredVersions" = { "LSHandlerRoleAll" = "-"; }; LSHandlerRoleAll = "org.yourusername.OrgProtocol"; LSHandlerURLScheme = "org-protocol";}'
-```
-
-Then restart your computer.
-
-[org-protocol-inst]: https://orgmode.org/worg/org-contrib/org-protocol.html

doc/templating.md

@@ -1,119 +0,0 @@
-Rather than creating blank files on `org-roam-insert` and
-`org-roam-find-file`, it is may be desirable to prefill the file with
-content. This may include:
-
-- Time of creation
-- File it was created from
-- Clipboard content
-- Any other data you may want to input manually
-
-This requires a complex template insertion system, but fortunately,
-Org ships with a powerful one: `org-capture`. However, org-capture was
-not designed for such use. Org-roam abuses `org-capture` to some
-extent, extending its syntax. To first understand how org-roam's
-templating system works, it may be useful to look into org-capture.
-
-## Org-roam Templates
-
-The org-roam capture template extends org-capture's template with 2
-additional properties:
-
-1. `:file-name`: This is the file name template used when a new note
-   is created.
-2. `:head`: This is the template that is inserted on initial note
-   creation.
-
-### Org-roam Template Expansion
-
-Org-roam's template definitions also extend org-capture's template
-syntax, to allow prefilling of strings. In many scenarios,
-`org-roam--capture` is passed a mapping between variables and strings.
-For example, during `org-roam-insert`, a title is prompted for. If the
-title doesn't already exist, we would like to create a new file,
-without prompting for the title again.
-
-Variables passed are expanded with the `${var}` syntax. For example,
-during `org-roam-insert`, `${title}` is prefilled for expansion. Any
-variables that do not contain strings, are prompted for values using
-`completing-read`.
-
-After doing this expansion, the org-capture's template expansion
-system is used to fill up the rest of the template. You may read up
-more on this on [org-capture's documentation
-page](https://orgmode.org/manual/Template-expansion.html#Template-expansion).
-
-For example, take the template: `"%<%Y%m%d%H%M%S>-${title}"`, with the title
-`"Foo"`. The template is first expanded into `%<%Y%m%d%H%M%S>-Foo`. Then
-org-capture expands `%<%Y%m%d%H%M%S>` with timestamp: e.g.
-`20200213032037-Foo`.
-
-All of the flexibility afforded by emacs and org-mode are
-available. For example, if you want to encode a UTC timestamp in the
-filename, you can take advantage of org-mode's `%(EXP)` template
-expansion to call `format-time-string` directly to provide its third
-argument to specify UTC.
-
-``` emacs-lisp
-("d" "default" plain (function org-roam--capture-get-point)
-     "%?"
-     :file-name "%(format-time-string \"%Y-%m-%d--%H-%M-%SZ--${slug}\" (current-time) t)"
-     :head "#+TITLE: ${title}\n"
-     :unnarrowed t)
-```
-
-Similarly, if you want to change how titles are transformed into
-slugs, you can override `org-roam--title-to-slug`. For example, to use
-hyphens instead of underscores:
-
-
-``` emacs-lisp
-  (defun org-roam--title-to-slug (title)
-    "Convert TITLE to a filename-suitable slug. Uses hyphens rather than underscores."
-    (cl-flet* ((nonspacing-mark-p (char)
-                                  (eq 'Mn (get-char-code-property char 'general-category)))
-               (strip-nonspacing-marks (s)
-                                       (apply #'string (seq-remove #'nonspacing-mark-p
-                                                                   (ucs-normalize-NFD-string s))))
-               (cl-replace (title pair)
-                           (replace-regexp-in-string (car pair) (cdr pair) title)))
-      (let* ((pairs `(("[^[:alnum:][:digit:]]" . "-")  ;; convert anything not alphanumeric
-                      ("--*" . "-")  ;; remove sequential underscores
-                      ("^-" . "")  ;; remove starting underscore
-                      ("-$" . "")))  ;; remove ending underscore
-             (slug (-reduce-from #'cl-replace (strip-nonspacing-marks title) pairs)))
-        (s-downcase slug))))
-```
-
-This templating system is used throughout org-roam templates.
-
-### Template examples
-
-Here I walkthrough the default template, reproduced below.
-
-```
-("d" "default" plain (function org-roam--capture-get-point)
-     "%?"
-     :file-name "%<%Y%m%d%H%M%S>-${slug}"
-     :head "#+TITLE: ${title}\n"
-     :unnarrowed t)
-```
-
-1. The template has short key `"d"`. If you have only one template,
-   org-roam automatically chooses this template for you.
-2. The template is given a description of `"default"`.
-3. `plain` text is inserted. Other options include Org headings via
-   `entry`.
-4. `(function org-roam--capture-get-point)` should not be changed.
-5. `"%?"` is the template inserted on each call to `org-roam--capture`.
-   This template means don't insert any content, but place the cursor
-   here.
-6. `:file-name` is the file-name template for a new note, if it
-doesn't yet exist. This creates a file at path that looks like
-   `/path/to/org-roam-directory/20200213032037-foo.org`.
-7. `:head` contains the initial template to be inserted (once only),
-   at the beginning of the file. Here, the title global attribute is
-   inserted.
-8. `:unnarrowed t` tells org-capture to show the contents for the
-   whole file, rather than narrowing to just the entry.
-
-Other options you may want to learn about include `:immediate-finish`.

doc/tour.md

@@ -1,70 +0,0 @@
-Org-roam was built to support a workflow that was not possible with
-vanilla Org-mode. This flow is modelled after the [Zettelkasten
-method][zettelkasten], and many of [Roam Research][roam]'s workflows.
-It is crucial to understand that Org-roam does not auto-magically make
-note-taking better -- it's changing the note-taking workflow that
-does.
-
-To understand more about the methods and madness, the [Note-Taking
-Workflow][appendix:ntw] page contains a page of useful references. The
-author has also written [a post][jethro-blog-post] about how he uses
-Org-roam.
-
-## Activating Org-roam
-
-Org-roam's entry point is the global minor `org-roam-mode`. This sets
-up Emacs with several hooks, for keeping the org-roam cache
-consistently updated, as well as showing the backlinks buffer. 
-
-The cache is a sqlite database named `org-roam.db`, which resides at
-the root of the `org-roam-directory`. Activating `org-roam-mode`
-builds the cache, which may take a while the first time, but is
-generally instantaneous in subsequent runs. To build the cache
-manually again, run `M-x org-roam-db-build-cache`.
-
-## Finding a Note
-
-`org-roam-find-file` shows the list of titles for notes that reside in
-`org-roam-directory`. Selecting a note title will bring you to the
-corresponding note. Entering a title of a note that does not yet exist
-will create a new note with that title.
-
-![org-roam-find-file](images/org-roam-find-file.gif)
-
-Note that in the above image, the [ivy](https://github.com/abo-abo/swiper)
-completion frontend is used. The default frontend has some usability issues with
-non-matching candidates (e.g. when you want to enter a title of a new note,
-there is no completion candidate), so either `ivy` or `helm` is recommended.
-
-## Inserting Links
-
-`org-roam-insert` insert links to existing (or new) notes. Entering a
-non-existent title will also create a new note with that title.
-
-![org-roam-insert](images/org-roam-insert-filetag.gif)
-
-Good usage of Org-roam requires liberally linking files. This allows
-the build-up of a dense knowledge graph.
-
-## The Org-roam Buffer
-
-The Org-roam buffer is often displayed in the side window. It shows
-backlinks for the currently active Org-roam note, along with some
-surrounding context.
-
-![org-roam-buffer](images/org-roam-buffer.gif)
-
-## Exporting the Graph
-
-Org-roam also uses Graphviz to generate a graph, with notes as nodes,
-and links between them as edges. The generated graph can be used to
-navigate to the files, but this requires some additional setup
-described in the [Roam Protocol][appendix:roam-protocol] page.
-
-![org-roam-graph](images/org-roam-graph.gif)
-
-[zettelkasten]: https://zettelkasten.de/
-[appendix:ntw]: notetaking_workflow.md
-[appendix:roam-protocol]: roam_protocol.md
-[roam]: https://www.roamresearch.com/
-[jethro-blog-post]: https://blog.jethro.dev/posts/how_to_take_smart_notes_org/

mkdocs.yml

@@ -1,40 +0,0 @@
-site_name: "Org-roam"
-repo_url: https://github.com/jethrokuan/org-roam/
-edit_uri: edit/master/doc/
-copyright: "Copyright (C) 2020 Jethro Kuan and contributors"
-docs_dir: doc
-extra:
-  social:
-    - type: 'slack'
-      link: 'https://join.slack.com/t/orgroam/shared_invite/zt-clh0g0tx-j8xg1kVxnrWdKt16gmSGPQ'
-nav:
-- Home: index.md
-- A Tour of Org-roam: tour.md
-- Installation: installation.md
-- Configuration: configuration.md
-- Anatomy of an Org-roam file: anatomy.md
-- The Templating System: templating.md
-- Ecosystem: ecosystem.md
-- Similar Packages: comparison.md
-- "Appendix: Note-taking Workflow": notetaking_workflow.md
-- "Appendix: Roam Protocol": roam_protocol.md
-- "Appendix: Org Export": org_export.md
-markdown_extensions:
-  - admonition
-  - pymdownx.betterem:
-      smart_enable: all
-  - pymdownx.caret
-  - pymdownx.critic
-  - pymdownx.details
-  - pymdownx.mark
-  - pymdownx.smartsymbols
-  - pymdownx.superfences
-  - pymdownx.tasklist:
-      custom_checkbox: true
-  - pymdownx.tilde
-
-theme:
-  name: 'material'
-  palette:
-    primary: 'deep purple'
-    accent: 'deep purple'

org-roam-buffer.el

@@ -1,260 +0,0 @@
-;;; org-roam-buffer.el --- Roam Research replica with Org-mode -*- coding: utf-8; lexical-binding: t -*-
-
-;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
-
-;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; URL: https://github.com/jethrokuan/org-roam
-;; Keywords: org-mode, roam, convenience
-;; Version: 1.1.0
-;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite "1.0.0"))
-
-;; This file is NOT part of GNU Emacs.
-
-;; This program is free software; you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
-;;
-;; This program is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-;; GNU General Public License for more details.
-;;
-;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
-
-;;; Commentary:
-;;
-;; This library provides the org-roam-buffer functionality for org-roam
-;;; Code:
-;;;; Library Requires
-(eval-when-compile (require 'subr-x))
-(require 'cl-lib)
-(require 'dash)
-(require 's)
-
-(defvar org-roam-directory)
-(defvar org-link-frame-setup)
-(defvar org-return-follows-link)
-(defvar org-roam-backlinks-mode)
-(defvar org-roam-last-window)
-(declare-function org-roam-db--ensure-built   "org-roam-db")
-(declare-function org-roam--extract-ref       "org-roam")
-(declare-function org-roam--get-title-or-slug "org-roam")
-(declare-function org-roam--get-backlinks     "org-roam")
-(declare-function org-roam-backlinks-mode     "org-roam")
-
-(defcustom org-roam-buffer-position 'right
-  "Position of `org-roam' buffer.
-Valid values are
- * left,
- * right,
- * top,
- * bottom."
-  :type '(choice (const left)
-                 (const right)
-                 (const top)
-                 (const bottom))
-  :group 'org-roam)
-
-(defcustom org-roam-buffer-width 0.33
-  "Width of `org-roam' buffer.
-Has an effect if and only if `org-roam-buffer-position' is `left' or `right'."
-  :type 'number
-  :group 'org-roam)
-
-(defcustom org-roam-buffer-height 0.27
-  "Height of `org-roam' buffer.
-Has an effect if and only if `org-roam-buffer-position' is `top' or `bottom'."
-  :type 'number
-  :group 'org-roam)
-
-
-(defcustom org-roam-buffer "*org-roam*"
-  "Org-roam buffer name."
-  :type 'string
-  :group 'org-roam)
-
-(defcustom org-roam-buffer-prepare-hook '(org-roam-buffer--insert-title
-                                          org-roam-buffer--insert-backlinks
-                                          org-roam-buffer--insert-citelinks)
-  "Hook run in the `org-roam-buffer' before it is displayed."
-  :type 'hook
-  :group 'org-roam)
-
-(defcustom org-roam-buffer-no-delete-other-windows nil
-  "The `no-delete-other-windows' parameter of the `org-roam-buffer' window.
-When non-nil, the window will not be closed when deleting other windows."
-  :type 'boolean
-  :group 'org-roam)
-
-(defvar org-roam-buffer--current nil
-  "Currently displayed file in `org-roam' buffer.")
-
-(defun org-roam-buffer--insert-title ()
-  "Insert the org-roam-buffer title."
-  (insert (propertize (org-roam--get-title-or-slug
-                       (buffer-file-name org-roam-buffer--current))
-                       'font-lock-face
-                       'org-document-title)))
-
-(defun org-roam-buffer--insert-citelinks ()
-  "Insert citation backlinks for the current buffer."
-  (if-let* ((roam-key (with-temp-buffer
-                        (insert-buffer-substring org-roam-buffer--current)
-                        (org-roam--extract-ref)))
-            (key-backlinks (org-roam--get-backlinks (s-chop-prefix "cite:" roam-key)))
-            (grouped-backlinks (--group-by (nth 0 it) key-backlinks)))
-      (progn
-        (insert (format "\n\n* %d Cite backlinks\n"
-                        (length key-backlinks)))
-        (dolist (group grouped-backlinks)
-          (let ((file-from (car group))
-                (bls (cdr group)))
-            (insert (format "** [[file:%s][%s]]\n"
-                            file-from
-                            (org-roam--get-title-or-slug file-from)))
-            (dolist (backlink bls)
-              (pcase-let ((`(,file-from _ ,props) backlink))
-                (insert (propertize
-                         (s-trim (s-replace "\n" " "
-                                            (plist-get props :content)))
-                         'help-echo "mouse-1: visit backlinked note"
-                         'file-from file-from
-                         'file-from-point (plist-get props :point)))
-                (insert "\n\n"))))))
-    (insert "\n\n* No cite backlinks!")))
-
-(defun org-roam-buffer--insert-backlinks ()
-  "Insert the org-roam-buffer backlinks string for the current buffer."
-  (if-let* ((file-path (buffer-file-name org-roam-buffer--current))
-            (backlinks (org-roam--get-backlinks file-path))
-            (grouped-backlinks (--group-by (nth 0 it) backlinks)))
-      (progn
-        (insert (format "\n\n* %d Backlinks\n"
-                        (length backlinks)))
-        (dolist (group grouped-backlinks)
-          (let ((file-from (car group))
-                (bls (cdr group)))
-            (insert (format "** [[file:%s][%s]]\n"
-                            file-from
-                            (org-roam--get-title-or-slug file-from)))
-            (dolist (backlink bls)
-              (pcase-let ((`(,file-from _ ,props) backlink))
-                (insert (propertize
-                         (s-trim (s-replace "\n" " "
-                                            (plist-get props :content)))
-                         'help-echo "mouse-1: visit backlinked note"
-                         'file-from file-from
-                         'file-from-point (plist-get props :point)))
-                (insert "\n\n"))))))
-    (insert "\n\n* No backlinks!")))
-
-(defun org-roam-buffer-update ()
-  "Update the `org-roam-buffer'."
-  (org-roam-db--ensure-built)
-  (let* ((source-org-roam-directory org-roam-directory))
-    (with-current-buffer org-roam-buffer
-      ;; When dir-locals.el is used to override org-roam-directory,
-      ;; org-roam-buffer should have a different local org-roam-directory and
-      ;; default-directory, as relative links are relative from the overridden
-      ;; org-roam-directory.
-      (setq-local org-roam-directory source-org-roam-directory)
-      (setq-local default-directory source-org-roam-directory)
-      ;; Locally overwrite the file opening function to re-use the
-      ;; last window org-roam was called from
-      (setq-local org-link-frame-setup
-                  (cons '(file . org-roam--find-file) org-link-frame-setup))
-      (let ((inhibit-read-only t))
-        (erase-buffer)
-        (unless (eq major-mode 'org-mode)
-          (org-mode))
-        (unless org-roam-backlinks-mode
-          (org-roam-backlinks-mode))
-        (make-local-variable 'org-return-follows-link)
-        (setq org-return-follows-link t)
-        (run-hooks 'org-roam-buffer-prepare-hook)
-        (read-only-mode 1)))))
-
-(cl-defun org-roam-buffer--update-maybe (&key redisplay)
-  "Reconstructs `org-roam-buffer'.
-This needs to be quick or infrequent, because this is run at
-`post-command-hook'.  If REDISPLAY, force an update of
-`org-roam-buffer'."
-  (let ((buffer (window-buffer)))
-    (when (and (or redisplay
-                   (not (eq org-roam-buffer--current buffer)))
-               (eq 'visible (org-roam-buffer--visibility))
-               (buffer-local-value 'buffer-file-truename buffer))
-      (setq org-roam-buffer--current buffer)
-      (org-roam-buffer-update))))
-
-;;;; Toggling the org-roam buffer
-(define-inline org-roam-buffer--visibility ()
-  "Return whether the current visibility state of the org-roam buffer.
-Valid states are 'visible, 'exists and 'none."
-  (declare (side-effect-free t))
-  (inline-quote
-   (cond
-    ((get-buffer-window org-roam-buffer) 'visible)
-    ((get-buffer org-roam-buffer) 'exists)
-    (t 'none))))
-
-(defun org-roam-buffer--set-width (width)
-  "Set the width of `org-roam-buffer' to `WIDTH'."
-  (unless (one-window-p)
-    (let ((window-size-fixed)
-          (w (max width window-min-width)))
-      (cond
-       ((> (window-width) w)
-        (shrink-window-horizontally  (- (window-width) w)))
-       ((< (window-width) w)
-        (enlarge-window-horizontally (- w (window-width))))))))
-
-(defun org-roam-buffer--set-height (height)
-  "Set the height of `org-roam-buffer' to `HEIGHT'."
-  (unless (one-window-p)
-    (let ((window-size-fixed)
-          (h (max height window-min-height)))
-      (cond
-       ((> (window-height) h)
-        (shrink-window  (- (window-height) h)))
-       ((< (window-height) h)
-        (enlarge-window (- h (window-height))))))))
-
-(defun org-roam-buffer--get-create ()
-  "Set up the `org-roam' buffer at `org-roam-buffer-position'."
-  (let ((window (get-buffer-window))
-        (position
-         (if (member org-roam-buffer-position '(right left top bottom))
-             org-roam-buffer-position
-           (let ((text-quoting-style 'grave))
-             (lwarn '(org-roam) :error
-                    "Invalid org-roam-buffer-position: %s. Defaulting to \\='right"
-                    org-roam-buffer-position))
-           'right)))
-    (-> (get-buffer-create org-roam-buffer)
-        (display-buffer-in-side-window
-         `((side . ,position)
-           (window-parameters . ((no-delete-other-windows . ,org-roam-buffer-no-delete-other-windows)))))
-        (select-window))
-    (pcase position
-      ((or 'right 'left)
-       (org-roam-buffer--set-width  (round (* (frame-width)  org-roam-buffer-width))))
-      ((or 'top  'bottom)
-       (org-roam-buffer--set-height (round (* (frame-height) org-roam-buffer-height)))))
-    (select-window window)))
-
-(defun org-roam-buffer-toggle-display ()
-  "Toggle display of the `org-roam-buffer'."
-  (interactive)
-  (setq org-roam-last-window (get-buffer-window))
-  (pcase (org-roam-buffer--visibility)
-    ('visible (delete-window (get-buffer-window org-roam-buffer)))
-    ((or 'exists 'none) (org-roam-buffer--get-create))))
-
-(provide 'org-roam-buffer)
-
-;;; org-roam-buffer.el ends here

org-roam-compat.el

@@ -1,12 +1,12 @@
-;;; org-roam-compat.el --- Compatibility Code -*- coding: utf-8; lexical-binding: t -*-
+;;; org-roam-compat.el --- Compatibility Code -*- coding: utf-8; lexical-binding: t; -*-
 
 ;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
 
 ;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; URL: https://github.com/jethrokuan/org-roam
+;; URL: https://github.com/org-roam/org-roam
 ;; Keywords: org-mode, roam, convenience
-;; Version: 1.1.0
+;; Version: 2.0.0
-;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite "1.0.0"))
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
 
 ;; This file is NOT part of GNU Emacs.
 
@@ -33,63 +33,91 @@
 ;;; Code:
 ;;;; Library Requires
 
-;;; Obsolete aliases (remove after next major release)
+;;; Backports
-;;;; Functions
+;; REVIEW Remove when 26.x support is dropped. This is exact the same as
-(define-obsolete-function-alias 'org-roam--capture-get-point 'org-roam-capture--get-point
+;; `directory-files-recursively' from Emacs 26, but with FOLLOW-SYMLINKS
-  "org-roam 1.0.0")
+;; parameter from Emacs 27.
-(define-obsolete-function-alias 'org-roam-build-cache 'org-roam-db-build-cache
+(defun org-roam--directory-files-recursively (dir regexp
-  "org-roam 1.0.0")
+                                                  &optional include-directories predicate
-(define-obsolete-function-alias 'org-roam-sql         'org-roam-db-query
+                                                  follow-symlinks)
-  "org-roam 1.0.0")
+  "Return list of all files under directory DIR whose names match REGEXP.
-(define-obsolete-function-alias 'org-roam--get-db     'org-roam-db--get
+This function works recursively.  Files are returned in \"depth
-  "org-roam 1.0.0")
+first\" order, and files from each directory are sorted in
-(define-obsolete-function-alias 'org-roam--db-clear   'org-roam-db--clear
+alphabetical order.  Each file name appears in the returned list
-  "org-roam 1.0.0")
+in its absolute form.
-(define-obsolete-function-alias 'org-roam-show-graph  'org-roam-graph-show
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam--maybe-update-buffer
-  'org-roam-buffer--update-maybe "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam--current-visibility
-  'org-roam-buffer--visibility "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam-update         'org-roam-buffer-update
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam--set-width     'org-roam-buffer--set-width
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam--set-height    'org-roam-buffer--set-height
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam--set-up-buffer 'org-roam-buffer--get-create
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam-today 'org-roam-dailies-today
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam-tomorrow 'org-roam-dailies-tomorrow
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam-yesterday 'org-roam-dailies-yesterday
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam-date 'org-roam-dailies-date
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam-graph-show  'org-roam-graph
-  "org-roam 1.0.0")
-(define-obsolete-function-alias 'org-roam-graph-build 'org-roam-graph
-  "org-roam 1.0.0")
 
-;;;; Variables
+By default, the returned list excludes directories, but if
-(define-obsolete-variable-alias 'org-roam-graphviz-extra-options
+optional argument INCLUDE-DIRECTORIES is non-nil, they are
-  'org-roam-graph-extra-config "org-roam 1.0.0")
+included.
-(define-obsolete-variable-alias 'org-roam-grapher-extra-options
+
-  'org-roam-graph-extra-config "org-roam 1.0.0")
+PREDICATE can be either nil (which means that all subdirectories
-(make-obsolete-variable 'org-roam-graph-node-shape  'org-roam-graph-node-extra-config "org-roam 1.0.0")
+of DIR are descended into), t (which means that subdirectories that
-(defcustom org-roam-graph-node-shape "ellipse"
+can't be read are ignored), or a function (which is called with
-  "Shape of graph nodes."
+the name of each subdirectory, and should return non-nil if the
-  :type 'string
+subdirectory is to be descended into).
-  :group 'org-roam)
+
-(define-obsolete-variable-alias 'org-roam--db-connection
+If FOLLOW-SYMLINKS is non-nil, symbolic links that point to
-  'org-roam-db--connection "org-roam 1.0.0")
+directories are followed.  Note that this can lead to infinite
-(define-obsolete-variable-alias 'org-roam--current-buffer
+recursion."
-  'org-roam-buffer--current "org-roam 1.0.0")
+  (let* ((result nil)
-(define-obsolete-variable-alias 'org-roam-date-title-format
+         (files nil)
-  'org-roam-dailies-capture-templates "org-roam 1.0.0")
+         (dir (directory-file-name dir))
-(define-obsolete-variable-alias 'org-roam-date-filename-format
+         ;; When DIR is "/", remote file names like "/method:" could
-  'org-roam-dailies-capture-templates "org-roam 1.0.0")
+         ;; also be offered.  We shall suppress them.
+         (tramp-mode (and tramp-mode (file-remote-p (expand-file-name dir)))))
+    (dolist (file (sort (file-name-all-completions "" dir)
+                        'string<))
+      (unless (member file '("./" "../"))
+        (if (directory-name-p file)
+            (let* ((leaf (substring file 0 (1- (length file))))
+                   (full-file (concat dir "/" leaf)))
+              ;; Don't follow symlinks to other directories.
+              (when (and (or (not (file-symlink-p full-file))
+                             (and (file-symlink-p full-file)
+                                  follow-symlinks))
+                         ;; Allow filtering subdirectories.
+                         (or (eq predicate nil)
+                             (eq predicate t)
+                             (funcall predicate full-file)))
+                (let ((sub-files
+                       (if (eq predicate t)
+                           (condition-case nil
+                               (org-roam--directory-files-recursively
+                                full-file regexp include-directories
+                                predicate follow-symlinks)
+                             (file-error nil))
+                         (org-roam--directory-files-recursively
+                          full-file regexp include-directories
+                          predicate follow-symlinks))))
+                  (setq result (nconc result sub-files))))
+              (when (and include-directories
+                         (string-match regexp leaf))
+                (setq result (nconc result (list full-file)))))
+          (when (string-match regexp file)
+            (push (concat dir "/" file) files)))))
+    (nconc result (nreverse files))))
+
+;;; Obsolete aliases (remove after next major release)
+(define-obsolete-function-alias
+  'org-roam-dailies-find-today
+  'org-roam-dailies-goto-today "org-roam 2.0")
+(define-obsolete-function-alias
+  'org-roam-dailies-find-yesterday
+  'org-roam-dailies-goto-yesterday "org-roam 2.0")
+(define-obsolete-function-alias
+  'org-roam-dailies-find-tomorrow
+  'org-roam-dailies-goto-tomorrow "org-roam 2.0")
+(define-obsolete-function-alias
+  'org-roam-dailies-find-next-note
+  'org-roam-dailies-goto-next-note "org-roam 2.0")
+(define-obsolete-function-alias
+  'org-roam-dailies-find-previous-note
+  'org-roam-dailies-goto-previous-note "org-roam 2.0")
+(define-obsolete-function-alias
+  'org-roam-dailies-find-date
+  'org-roam-dailies-goto-date "org-roam 2.0")
+
+;;; Obsolete functions
 
 (provide 'org-roam-compat)
 

org-roam-completion.el

@@ -1,13 +1,12 @@
-;;; org-roam-completion.el --- Roam Research replica with Org-mode -*- coding: utf-8; lexical-binding: t -*-
+;;; org-roam-completion.el --- Completion features -*- coding: utf-8; lexical-binding: t; -*-
 
 ;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
 
 ;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; URL: https://github.com/jethrokuan/org-roam
+;; URL: https://github.com/org-roam/org-roam
 ;; Keywords: org-mode, roam, convenience
-;; Version: 1.1.0
+;; Version: 2.0.0
-;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite "1.0.0"))
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
-
 ;; This file is NOT part of GNU Emacs.
 
 ;; This program is free software; you can redistribute it and/or modify
@@ -27,92 +26,81 @@
 
 ;;; Commentary:
 ;;
-;; This library provides completion for org-roam.
+;; This library provides completion-at-point functions for Org-roam.
+;;
+;; The two main functions provided to capf are:
+;;
+;;    `org-roam-complete-link-at-point' provides completions to nodes
+;;    within link brackets
+;;
+;;    `org-roam-complete-everywhere' provides completions for nodes everywhere,
+;;    matching the symbol at point
+;;
 ;;; Code:
-;;;; Library Requires
 (require 'cl-lib)
-(require 's)
+(require 'org-element)
 
-(defvar helm-pattern)
+(declare-function org-roam--get-titles "org-roam")
-(declare-function helm "ext:helm")
-(declare-function helm-make-source "ext:helm-source" (name class &rest args) t)
 
-(defcustom org-roam-completion-system 'default
+(defcustom org-roam-completion-everywhere nil
-  "The completion system to be used by `org-roam'."
+  "When non-nil, provide link completion matching outside of Org links."
-  :type '(radio
+  :group 'org-roam
-          (const :tag "Default" default)
+  :type 'boolean)
-          (const :tag "Ido" ido)
-          (const :tag "Ivy" ivy)
-          (const :tag "Helm" helm)
-          (function :tag "Custom function"))
-  :group 'org-roam)
 
-(defcustom org-roam-completion-fuzzy-match nil
+(defvar org-roam-completion-functions (list #'org-roam-complete-link-at-point
-  "Whether to fuzzy match Org-roam's completion candidates."
+                                            #'org-roam-complete-everywhere)
-  :type 'boolean
+  "List of functions to be used with `completion-at-point' for Org-roam.")
-  :group 'org-roam)
 
-(defun org-roam-completion--helm-candidate-transformer (candidates _source)
+(defconst org-roam-bracket-completion-re
-  "Transforms CANDIDATES for Helm-based completing read.
+  "\\[\\[\\(\\(?:roam:\\)?\\)\\([^z-a]*\\)]]"
-SOURCE is not used."
+  "Regex for completion within link brackets.
-  (let ((prefix (propertize "[?] "
+We use this as a substitute for `org-link-bracket-re', because
-                            'face 'helm-ff-prefix)))
+`org-link-bracket-re' requires content within the brackets for a match.")
-    (cons (propertize helm-pattern
-                      'display (concat prefix helm-pattern))
-          candidates)))
 
-(cl-defun org-roam-completion--completing-read (prompt choices &key
+(defun org-roam-complete-everywhere ()
-                                                       require-match initial-input
+  "Provides completions for links for any word at point.
-                                                       action)
+This is a `completion-at-point' function, and is active when
-  "Present a PROMPT with CHOICES and optional INITIAL-INPUT.
+`org-roam-completion-everywhere' is non-nil."
-If REQUIRE-MATCH is t, the user must select one of the CHOICES.
+  (when (and org-roam-completion-everywhere
-Return user choice."
+             (thing-at-point 'word)
-  (let (res)
+             (not (save-match-data (org-in-regexp org-link-any-re))))
-    (setq res
+    (let ((bounds (bounds-of-thing-at-point 'word)))
-          (cond
+      (list (car bounds) (cdr bounds)
-           ((eq org-roam-completion-system 'ido)
+            (completion-table-dynamic
-            (let ((candidates (mapcar #'car choices)))
+             (lambda (_)
-              (ido-completing-read prompt candidates nil require-match initial-input)))
+               (funcall #'org-roam--get-titles)))
-           ((eq org-roam-completion-system 'default)
+            :exit-function
-            (completing-read prompt choices nil require-match initial-input))
+            (lambda (str _status)
-           ((eq org-roam-completion-system 'ivy)
+              (delete-char (- (length str)))
-            (if (fboundp 'ivy-read)
+              (insert "[[roam:" str "]]"))))))
-                (ivy-read prompt choices
+
-                          :initial-input initial-input
+(defun org-roam-complete-link-at-point ()
-                          :require-match require-match
+  "Do appropriate completion for the link at point."
-                          :action (prog1 action
+  (let (roam-p start end)
-                                    (setq action nil))
+    (when (org-in-regexp org-roam-bracket-completion-re 1)
-                          :caller 'org-roam--completing-read
+      (setq roam-p (not (string-blank-p (match-string 1)))
-                          :re-builder (if org-roam-completion-fuzzy-match 'ivy--regex-fuzzy
+            start (match-beginning 2)
-                                        'regexp-quote))
+            end (match-end 2))
-              (user-error "Please install ivy from \
+      (list start end
-https://github.com/abo-abo/swiper")))
+            (completion-table-dynamic
-           ((eq org-roam-completion-system 'helm)
+             (lambda (_)
-            (unless (and (fboundp 'helm)
+               (funcall #'org-roam--get-titles)))
-                         (fboundp 'helm-make-source))
+            :exit-function
-              (user-error "Please install helm from \
+            (lambda (str &rest _)
-https://github.com/emacs-helm/helm"))
+              (delete-char (- 0 (length str)))
-            (let ((source (helm-make-source prompt 'helm-source-sync
+              (insert (concat (unless roam-p "roam:")
-                            :candidates (mapcar #'car choices)
+                              str))
-                            :filtered-candidate-transformer
+              (forward-char 2))))))
-                            (and (not require-match)
+
-                                 #'org-roam-completion--helm-candidate-transformer)
+(defun org-roam-complete-at-point ()
-                            :fuzzy-match org-roam-completion-fuzzy-match))
+  "."
-                  (buf (concat "*org-roam "
+  (run-hook-with-args-until-success 'org-roam-completion-functions))
-                               (s-downcase (s-chop-suffix ":" (s-trim prompt)))
+
-                               "*")))
+(defun org-roam--register-completion-functions ()
-              (or (helm :sources source
+  "."
-                        :action (if action
+  (add-hook 'completion-at-point-functions #'org-roam-complete-at-point nil t))
-                                    (prog1 action
+
-                                      (setq action nil))
+(add-hook 'org-roam-find-file-hook #'org-roam--register-completion-functions)
-                                  #'identity)
-                        :prompt prompt
-                        :input initial-input
-                        :buffer buf)
-                  (keyboard-quit))))))
-    (if action
-        (funcall action res)
-      res)))
 
 (provide 'org-roam-completion)
 

org-roam-dailies.el

@@ -1,12 +1,14 @@
-;;; org-roam-dialies.el --- Roam Research replica with Org-mode -*- coding: utf-8; lexical-binding: t -*-
+;;; org-roam-dailies.el --- Daily-notes for Org-roam -*- coding: utf-8; lexical-binding: t; -*-
 ;;;
 ;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+;; Copyright © 2020 Leo Vivier <leo.vivier+dev@gmail.com>
 
 ;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; URL: https://github.com/jethrokuan/org-roam
+;;      Leo Vivier <leo.vivier+dev@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
 ;; Keywords: org-mode, roam, convenience
-;; Version: 1.1.0
+;; Version: 2.0.0
-;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite "1.0.0"))
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
 
 ;; This file is NOT part of GNU Emacs.
 
@@ -27,55 +29,304 @@
 
 ;;; Commentary:
 ;;
-;; This library provides functionality for creating daily notes. This is a
+;; This library provides functionality for creating daily-notes. This is a
 ;; concept borrowed from Roam Research.
 ;;
 ;;; Code:
 ;;; Library Requires
 (require 'org-capture)
 (require 'org-roam-capture)
+(require 'f)
 
-(defvar org-roam-dailies-capture-templates
+;;;; Declarations
-  '(("d" "daily" plain (function org-roam-capture--get-point)
+(defvar org-roam-directory)
-     ""
+(defvar org-roam-file-extensions)
-     :immediate-finish t
+(declare-function org-roam-file-p        "org-roam")
-     :file-name "%<%Y-%m-%d>"
-     :head "#+TITLE: %<%Y-%m-%d>"))
-  "Capture templates for daily notes in Org-roam.")
 
-;; Declarations
+;;;; Faces
-(declare-function org-roam--file-path-from-id "org-roam")
+(defface org-roam-dailies-calendar-note
+  '((t :inherit (org-link) :underline nil))
+  "Face for dates with a daily-note in the calendar."
+  :group 'org-roam-faces)
 
-(defun org-roam-dailies--file-for-time (time)
+;;;; Customizable variables
-  "Create and find file for TIME."
+(defcustom org-roam-dailies-directory "daily/"
-  (let ((org-roam-capture-templates org-roam-dailies-capture-templates)
+  "Path to daily-notes.
-        (org-roam-capture--info (list (cons 'time time)))
+This path is relative to `org-roam-directory'."
-        (org-roam-capture--context 'dailies))
+  :group 'org-roam
-    (add-hook 'org-capture-after-finalize-hook #'org-roam-capture--find-file-h)
+  :type 'string)
-    (org-roam--capture)))
 
-(defun org-roam-dailies-today ()
+(defcustom org-roam-dailies-find-file-hook nil
-  "Create and find the daily note for today."
+  "Hook that is run right after navigating to a daily-note."
+  :group 'org-roam
+  :type 'hook)
+
+(defcustom org-roam-dailies-capture-templates
+  `(("d" "default" entry
+     "* %?"
+     :if-new (file+head "%<%Y-%m-%d>.org"
+                        "#+title: %<%Y-%m-%d>\n")))
+  "Capture templates for daily-notes in Org-roam.
+See `org-roam-capture-templates' for the template documentation."
+  :group 'org-roam
+  :type '(repeat
+          (choice (list :tag "Multikey description"
+                        (string :tag "Keys       ")
+                        (string :tag "Description"))
+                  (list :tag "Template entry"
+                        (string :tag "Keys           ")
+                        (string :tag "Description    ")
+                        (choice :tag "Capture Type   " :value entry
+                                (const :tag "Org entry" entry)
+                                (const :tag "Plain list item" item)
+                                (const :tag "Checkbox item" checkitem)
+                                (const :tag "Plain text" plain)
+                                (const :tag "Table line" table-line))
+                        (choice :tag "Template       "
+                                (string)
+                                (list :tag "File"
+                                      (const :format "" file)
+                                      (file :tag "Template file"))
+                                (list :tag "Function"
+                                      (const :format "" function)
+                                      (function :tag "Template function")))
+                        (plist :inline t
+                               ;; Give the most common options as checkboxes
+                               :options (((const :format "%v " :if-new)
+                                          (choice :tag "Node location"
+                                                  (list :tag "File"
+                                                        (const :format "" file)
+                                                        (string :tag "  File"))
+                                                  (list :tag "File & Head Content"
+                                                        (const :format "" file+head)
+                                                        (string :tag "  File")
+                                                        (string :tag "  Head Content"))
+                                                  (list :tag "File & Outline path"
+                                                        (const :format "" file+olp)
+                                                        (string :tag "  File")
+                                                        (list :tag "Outline path"
+                                                              (repeat (string :tag "Headline"))))
+                                                  (list :tag "File & Head Content & Outline path"
+                                                        (const :format "" file+head+olp)
+                                                        (string :tag "  File")
+                                                        (string :tag "  Head Content")
+                                                        (list :tag "Outline path"
+                                                              (repeat (string :tag "Headline"))))))
+                                         ((const :format "%v " :prepend) (const t))
+                                         ((const :format "%v " :immediate-finish) (const t))
+                                         ((const :format "%v " :jump-to-captured) (const t))
+                                         ((const :format "%v " :empty-lines) (const 1))
+                                         ((const :format "%v " :empty-lines-before) (const 1))
+                                         ((const :format "%v " :empty-lines-after) (const 1))
+                                         ((const :format "%v " :clock-in) (const t))
+                                         ((const :format "%v " :clock-keep) (const t))
+                                         ((const :format "%v " :clock-resume) (const t))
+                                         ((const :format "%v " :time-prompt) (const t))
+                                         ((const :format "%v " :tree-type) (const week))
+                                         ((const :format "%v " :unnarrowed) (const t))
+                                         ((const :format "%v " :table-line-pos) (string))
+                                         ((const :format "%v " :kill-buffer) (const t))))))))
+
+;;;###autoload
+(defun org-roam-dailies-find-directory ()
+  "Find and open `org-roam-dailies-directory'."
   (interactive)
-  (org-roam-dailies--file-for-time (current-time)))
+  (find-file (expand-file-name org-roam-dailies-directory org-roam-directory)))
 
-(defun org-roam-dailies-tomorrow (n)
+(defun org-roam-dailies--daily-note-p (&optional file)
-  "Create and find the daily note for tomorrow.
+  "Return t if FILE is an Org-roam daily-note, nil otherwise.
-With numeric argument N, use N days in the future."
+If FILE is not specified, use the current buffer's file-path."
-  (interactive "p")
+  (when-let ((path (expand-file-name
-  (org-roam-dailies--file-for-time (time-add (* n 86400) (current-time))))
+                    (or file
+                        (buffer-file-name (buffer-base-buffer)))))
+             (directory (expand-file-name org-roam-dailies-directory org-roam-directory)))
+    (setq path (expand-file-name path))
+    (save-match-data
+      (and
+       (org-roam-file-p path)
+       (f-descendant-of-p path directory)))))
 
-(defun org-roam-dailies-yesterday (n)
+(defun org-roam-dailies--capture (time &optional goto)
-  "Create and find the file for yesterday.
+  "Capture an entry in a daily-note for TIME, creating it if necessary.
-With numeric argument N, use N days in the past."
+When GOTO is non-nil, go the note without creating an entry."
-  (interactive "p")
+  (let ((org-roam-directory (expand-file-name org-roam-dailies-directory org-roam-directory)))
-  (org-roam-tomorrow (- n)))
+    (org-roam-capture- :goto (when goto '(4))
+                       :node (org-roam-node-create)
+                       :templates org-roam-dailies-capture-templates
+                       :props (list :override-default-time time)))
+  (when goto (run-hooks 'org-roam-dailies-find-file-hook)))
 
-(defun org-roam-dailies-date ()
+;;;; Commands
-  "Create the file for any date using the calendar interface."
+;;; Today
+;;;###autoload
+(defun org-roam-dailies-capture-today (&optional goto)
+  "Create an entry in the daily-note for today.
+When GOTO is non-nil, go the note without creating an entry."
+  (interactive "P")
+  (org-roam-dailies--capture (current-time) goto))
+
+;;;###autoload
+(defun org-roam-dailies-goto-today ()
+  "Find the daily-note for today, creating it if necessary."
   (interactive)
-  (let ((time (org-read-date nil 'to-time nil "Date:  ")))
+  (org-roam-dailies-capture-today t))
-    (org-roam-dailies--file-for-time time)))
+
+;;; Tomorrow
+;;;###autoload
+(defun org-roam-dailies-capture-tomorrow (n &optional goto)
+  "Create an entry in the daily-note for tomorrow.
+
+With numeric argument N, use the daily-note N days in the future.
+
+With a `C-u' prefix or when GOTO is non-nil, go the note without
+creating an entry."
+  (interactive "p")
+  (org-roam-dailies--capture (time-add (* n 86400) (current-time)) goto))
+
+;;;###autoload
+(defun org-roam-dailies-goto-tomorrow (n)
+  "Find the daily-note for tomorrow, creating it if necessary.
+
+With numeric argument N, use the daily-note N days in the
+future."
+  (interactive "p")
+  (org-roam-dailies-capture-tomorrow n t))
+
+;;; Yesterday
+;;;###autoload
+(defun org-roam-dailies-capture-yesterday (n &optional goto)
+  "Create an entry in the daily-note for yesteday.
+
+With numeric argument N, use the daily-note N days in the past.
+
+When GOTO is non-nil, go the note without creating an entry."
+  (interactive "p")
+  (org-roam-dailies-capture-tomorrow (- n) goto))
+
+;;;###autoload
+(defun org-roam-dailies-goto-yesterday (n)
+  "Find the daily-note for yesterday, creating it if necessary.
+
+With numeric argument N, use the daily-note N days in the
+future."
+  (interactive "p")
+  (org-roam-dailies-capture-tomorrow (- n) t))
+
+;;; Calendar
+(defun org-roam-dailies-calendar--file-to-date (&optional file)
+  "Convert FILE to date.
+Return (MONTH DAY YEAR)."
+  (let ((file (or file
+                  (buffer-base-buffer (buffer-file-name)))))
+    (cl-destructuring-bind (_ _ _ d m y _ _ _)
+        (org-parse-time-string
+         (file-name-sans-extension
+          (file-name-nondirectory file)))
+      (list m d y))))
+
+(defun org-roam-dailies-calendar--date-to-time (date)
+  "Convert DATE as returned from then calendar (MONTH DAY YEAR) to a time."
+  (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date)))
+
+(defun org-roam-dailies-calendar-mark-entries ()
+  "Mark days in the calendar for which a daily-note is present."
+  (when (file-exists-p (expand-file-name org-roam-dailies-directory org-roam-directory))
+    (dolist (date (mapcar #'org-roam-dailies-calendar--file-to-date
+                          (org-roam-dailies--list-files)))
+      (when (calendar-date-is-visible-p date)
+        (calendar-mark-visible-date date 'org-roam-dailies-calendar-note)))))
+
+;;; Date
+;;;###autoload
+(defun org-roam-dailies-capture-date (&optional goto prefer-future)
+  "Create an entry in the daily-note for a date using the calendar.
+Prefer past dates, unless PREFER-FUTURE is non-nil.
+With a `C-u' prefix or when GOTO is non-nil, go the note without
+creating an entry."
+  (interactive "P")
+  (let ((time (let ((org-read-date-prefer-future prefer-future))
+                (org-read-date t t nil (if goto
+                                           "Find daily-note: "
+                                         "Capture to daily-note: ")))))
+    (org-roam-dailies--capture time goto)))
+
+;;;###autoload
+(defun org-roam-dailies-goto-date (&optional prefer-future)
+  "Find the daily-note for a date using the calendar, creating it if necessary.
+Prefer past dates, unless PREFER-FUTURE is non-nil."
+  (interactive)
+  (org-roam-dailies-capture-date t prefer-future))
+
+;;; Navigation
+(defun org-roam-dailies--list-files (&rest extra-files)
+  "List all files in `org-roam-dailies-directory'.
+EXTRA-FILES can be used to append extra files to the list."
+  (let ((dir (expand-file-name org-roam-dailies-directory org-roam-directory))
+        (regexp (rx-to-string `(and "." (or ,@org-roam-file-extensions)))))
+    (append (--remove (let ((file (file-name-nondirectory it)))
+                        (when (or (auto-save-file-name-p file)
+                                  (backup-file-name-p file)
+                                  (string-match "^\\." file))
+                          it))
+                      (directory-files-recursively dir regexp))
+            extra-files)))
+
+(defun org-roam-dailies-goto-next-note (&optional n)
+  "Find next daily-note.
+
+With numeric argument N, find note N days in the future. If N is
+negative, find note N days in the past."
+  (interactive "p")
+  (unless (org-roam-dailies--daily-note-p)
+    (user-error "Not in a daily-note"))
+  (setq n (or n 1))
+  (let* ((dailies (org-roam-dailies--list-files))
+         (position
+          (cl-position-if (lambda (candidate)
+                            (string= (buffer-file-name (buffer-base-buffer)) candidate))
+                          dailies))
+         note)
+    (unless position
+      (user-error "Can't find current note file - have you saved it yet?"))
+    (pcase n
+      ((pred (natnump))
+       (when (eq position (- (length dailies) 1))
+         (user-error "Already at newest note")))
+      ((pred (integerp))
+       (when (eq position 0)
+         (user-error "Already at oldest note"))))
+    (setq note (nth (+ position n) dailies))
+    (find-file note)
+    (run-hooks 'org-roam-dailies-find-file-hook)))
+
+(defun org-roam-dailies-goto-previous-note (&optional n)
+  "Find previous daily-note.
+
+With numeric argument N, find note N days in the past. If N is
+negative, find note N days in the future."
+  (interactive "p")
+  (let ((n (if n (- n) -1)))
+    (org-roam-dailies-goto-next-note n)))
+
+(add-hook 'calendar-today-visible-hook #'org-roam-dailies-calendar-mark-entries)
+(add-hook 'calendar-today-invisible-hook #'org-roam-dailies-calendar-mark-entries)
+
+;;;; Bindings
+(defvar org-roam-dailies-map (make-sparse-keymap)
+  "Keymap for `org-roam-dailies'.")
+
+(define-prefix-command 'org-roam-dailies-map)
+
+(define-key org-roam-dailies-map (kbd "d") #'org-roam-dailies-goto-today)
+(define-key org-roam-dailies-map (kbd "y") #'org-roam-dailies-goto-yesterday)
+(define-key org-roam-dailies-map (kbd "t") #'org-roam-dailies-goto-tomorrow)
+(define-key org-roam-dailies-map (kbd "n") #'org-roam-dailies-capture-today)
+(define-key org-roam-dailies-map (kbd "f") #'org-roam-dailies-goto-next-note)
+(define-key org-roam-dailies-map (kbd "b") #'org-roam-dailies-goto-previous-note)
+(define-key org-roam-dailies-map (kbd "c") #'org-roam-dailies-goto-date)
+(define-key org-roam-dailies-map (kbd "v") #'org-roam-dailies-capture-date)
+(define-key org-roam-dailies-map (kbd ".") #'org-roam-dailies-find-directory)
 
 (provide 'org-roam-dailies)
+
 ;;; org-roam-dailies.el ends here

org-roam-db.el

@@ -1,12 +1,12 @@
-;;; org-roam-db.el --- Roam Research replica with Org-mode -*- coding: utf-8; lexical-binding: t -*-
+;;; org-roam-db.el --- Org-roam database API -*- coding: utf-8; lexical-binding: t; -*-
 
 ;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
 
 ;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; URL: https://github.com/jethrokuan/org-roam
+;; URL: https://github.com/org-roam/org-roam
 ;; Keywords: org-mode, roam, convenience
-;; Version: 1.1.0
+;; Version: 2.0.0
-;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite "1.0.0"))
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
 
 ;; This file is NOT part of GNU Emacs.
 
@@ -27,27 +27,35 @@
 
 ;;; Commentary:
 ;;
-;; This library is provides the underlying database api to org-roam
+;; This library provides the underlying database api to org-roam.
 ;;
 ;;; Code:
 ;;;; Library Requires
 (eval-when-compile (require 'subr-x))
 (require 'emacsql)
 (require 'emacsql-sqlite)
-(require 'org-roam-macs)
+(require 'seq)
 
+(eval-and-compile
+  (require 'org-roam-macs)
+  ;; For `org-with-wide-buffer'
+  (require 'org-macs))
+(require 'org)
+(require 'ol)
+(require 'org-roam-utils)
+
+(defvar org-roam-find-file-hook)
 (defvar org-roam-directory)
 (defvar org-roam-verbose)
+(defvar org-agenda-files)
 
-(declare-function org-roam--extract-titles      "org-roam")
+(declare-function org-roam-id-at-point "org-roam")
-(declare-function org-roam--extract-ref         "org-roam")
+(declare-function org-roam--list-all-files "org-roam")
-(declare-function org-roam--extract-links       "org-roam")
+(declare-function org-roam-node-at-point "org-roam")
-(declare-function org-roam--list-files          "org-roam")
-(declare-function org-roam-buffer--update-maybe "org-roam-buffer")
 
 ;;;; Options
-(defcustom org-roam-db-location nil
+(defcustom org-roam-db-location (expand-file-name "org-roam.db" user-emacs-directory)
-  "Location of the Org-roam database.
+  "The full path to file where the Org-roam database is stored.
 If this is non-nil, the Org-roam sqlite database is saved here.
 
 It is the user's responsibility to set this correctly, especially
@@ -55,8 +63,28 @@ when used with multiple Org-roam instances."
   :type 'string
   :group 'org-roam)
 
-(defconst org-roam-db--version 2)
+(defcustom org-roam-db-gc-threshold gc-cons-threshold
-(defconst org-roam-db--sqlite-available-p
+  "The value to temporarily set the `gc-cons-threshold' threshold to.
+During large, heavy operations like `org-roam-db-sync',
+many GC operations happen because of the large number of
+temporary structures generated (e.g. parsed ASTs). Temporarily
+increasing `gc-cons-threshold' will help reduce the number of GC
+operations, at the cost of temporary memory usage.
+
+This defaults to the original value of `gc-cons-threshold', but
+tweaking this number may lead to better overall performance. For
+example, to reduce the number of GCs, one may set it to a large
+value like `most-positive-fixnum'."
+  :type 'int
+  :group 'org-roam)
+
+(defcustom org-roam-db-node-include-function (lambda () t)
+  "A custom function to check if the headline at point is a node."
+  :type 'function
+  :group 'org-roam)
+
+(defconst org-roam-db-version 16)
+(defconst org-roam--sqlite-available-p
   (with-demoted-errors "Org-roam initialization: %S"
     (emacsql-sqlite-ensure-binary)
     t))
@@ -65,15 +93,10 @@ when used with multiple Org-roam instances."
   "Database connection to Org-roam database.")
 
 ;;;; Core Functions
-(defun org-roam-db--get ()
-  "Return the sqlite db file."
-  (interactive "P")
-  (or org-roam-db-location
-      (expand-file-name "org-roam.db" org-roam-directory)))
 
 (defun org-roam-db--get-connection ()
   "Return the database connection, if any."
-  (gethash (file-truename org-roam-directory)
+  (gethash (expand-file-name org-roam-directory)
            org-roam-db--connection))
 
 (defun org-roam-db ()
@@ -82,76 +105,116 @@ Initializes and stores the database, and the database connection.
 Performs a database upgrade when required."
   (unless (and (org-roam-db--get-connection)
                (emacsql-live-p (org-roam-db--get-connection)))
-    (let* ((db-file (org-roam-db--get))
+    (let ((init-db (not (file-exists-p org-roam-db-location))))
-           (init-db (not (file-exists-p db-file))))
+      (make-directory (file-name-directory org-roam-db-location) t)
-      (make-directory (file-name-directory db-file) t)
+      (let ((conn (emacsql-sqlite org-roam-db-location)))
-      (let ((conn (emacsql-sqlite db-file)))
         (set-process-query-on-exit-flag (emacsql-process conn) nil)
-        (puthash (file-truename org-roam-directory)
+        (puthash (expand-file-name org-roam-directory)
                  conn
                  org-roam-db--connection)
         (when init-db
           (org-roam-db--init conn))
         (let* ((version (caar (emacsql conn "PRAGMA user_version")))
-               (version (org-roam-db--maybe-update conn version)))
+               (version (org-roam-db--upgrade-maybe conn version)))
           (cond
-           ((> version org-roam-db--version)
+           ((> version org-roam-db-version)
             (emacsql-close conn)
             (user-error
              "The Org-roam database was created with a newer Org-roam version.  "
              "You need to update the Org-roam package"))
-           ((< version org-roam-db--version)
+           ((< version org-roam-db-version)
             (emacsql-close conn)
             (error "BUG: The Org-roam database scheme changed %s"
                    "and there is no upgrade path")))))))
   (org-roam-db--get-connection))
 
 ;;;; Entrypoint: (org-roam-db-query)
+(define-error 'emacsql-constraint "SQL constraint violation")
 (defun org-roam-db-query (sql &rest args)
   "Run SQL query on Org-roam database with ARGS.
 SQL can be either the emacsql vector representation, or a string."
-  (if  (stringp sql)
+  (apply #'emacsql (org-roam-db) sql args))
-      (emacsql (org-roam-db) (apply #'format sql args))
+
-    (apply #'emacsql (org-roam-db) sql args)))
+(defun org-roam-db-query! (handler sql &rest args)
+  "Run SQL query on Org-roam database with ARGS.
+SQL can be either the emacsql vector representation, or a string.
+The query is expected to be able to fail, in this situation, run HANDLER."
+  (condition-case err
+      (org-roam-db-query sql args)
+    (emacsql-constraint
+     (funcall handler err))))
 
 ;;;; Schemata
 (defconst org-roam-db--table-schemata
   '((files
      [(file :unique :primary-key)
       (hash :not-null)
-      (last-modified :not-null)])
+      (atime :not-null)
+      (mtime :not-null)])
 
-    (links
+    (nodes
-     [(from :not-null)
+     ([(id :not-null :primary-key)
-      (to :not-null)
+       (file :not-null)
-      (type :not-null)
+       (level :not-null)
-      (properties :not-null)])
+       (pos :not-null)
+       todo
+       priority
+       (scheduled text)
+       (deadline text)
+       title
+       properties
+       olp]
+      (:foreign-key [file] :references files [file] :on-delete :cascade)))
 
-    (titles
+    (aliases
-     [(file :not-null)
+     ([(node-id :not-null)
-      titles])
+       alias]
+      (:foreign-key [node-id] :references nodes [id] :on-delete :cascade)))
 
     (refs
-     [(ref :unique :not-null)
+     ([(node-id :not-null)
-      (file :not-null)])))
+       (ref :not-null)
+       (type :not-null)]
+      (:foreign-key [node-id] :references nodes [id] :on-delete :cascade)))
+
+    (tags
+     ([(node-id :not-null)
+       tag]
+      (:foreign-key [node-id] :references nodes [id] :on-delete :cascade)))
+
+    (links
+     ([(pos :not-null)
+       (source :not-null)
+       (dest :not-null)
+       (type :not-null)
+       (properties :not-null)]
+      (:foreign-key [source] :references nodes [id] :on-delete :cascade)))))
+
+(defconst org-roam-db--table-indices
+  '((alias-node-id aliases [node-id])
+    (refs-node-id refs [node-id])
+    (tags-node-id tags [node-id])))
 
 (defun org-roam-db--init (db)
   "Initialize database DB with the correct schema and user version."
   (emacsql-with-transaction db
-    (pcase-dolist (`(,table . ,schema) org-roam-db--table-schemata)
+    (emacsql db "PRAGMA foreign_keys = ON")
+    (pcase-dolist (`(,table ,schema) org-roam-db--table-schemata)
       (emacsql db [:create-table $i1 $S2] table schema))
-    (emacsql db (format "PRAGMA user_version = %s" org-roam-db--version))))
+    (pcase-dolist (`(,index-name ,table ,columns) org-roam-db--table-indices)
+      (emacsql db [:create-index $i1 :on $i2 $S3] index-name table columns))
+    (emacsql db (format "PRAGMA user_version = %s" org-roam-db-version))))
 
-(defun org-roam-db--maybe-update (db version)
+(defun org-roam-db--upgrade-maybe (db version)
   "Upgrades the database schema for DB, if VERSION is old."
   (emacsql-with-transaction db
     'ignore
-    (when (= version 1)
+    (if (< version org-roam-db-version)
-      (progn
+        (progn
-        (warn "No good way to perform a DB upgrade, rebuilding from scratch...")
+          (org-roam-message (format "Upgrading the Org-roam database from version %d to version %d"
-        (delete-file (org-roam-db--get))
+                                    version org-roam-db-version))
-        (org-roam-db-build-cache)))
+          (org-roam-db-sync t))))
-    version))
+  version)
 
 (defun org-roam-db--close (&optional db)
   "Closes the database connection for database DB.
@@ -168,241 +231,293 @@ the current `org-roam-directory'."
     (org-roam-db--close conn)))
 
 ;;;; Database API
-;;;;; Initialization
-(defun org-roam-db--initialized-p ()
-  "Whether the cache has been initialized."
-  (and (file-exists-p (org-roam-db--get))
-       (> (caar (org-roam-db-query [:select (funcall count) :from titles]))
-          0)))
-
-(defun org-roam-db--ensure-built ()
-  "Ensures that Org-roam cache is built."
-  (unless (org-roam-db--initialized-p)
-    (error "[Org-roam] your cache isn't built yet! Please run org-roam-db-build-cache")))
-
 ;;;;; Clearing
-(defun org-roam-db--clear ()
+(defun org-roam-db-clear-all ()
-  "Clears all entries in the caches."
+  "Clears all entries in the Org-roam cache."
   (interactive)
-  (when (file-exists-p (org-roam-db--get))
+  (when (file-exists-p org-roam-db-location)
-    (org-roam-db-query [:delete :from files])
+    (dolist (table (mapcar #'car org-roam-db--table-schemata))
-    (org-roam-db-query [:delete :from titles])
+      (org-roam-db-query `[:delete :from ,table]))))
-    (org-roam-db-query [:delete :from links])
-    (org-roam-db-query [:delete :from refs])))
 
+(defun org-roam-db-clear-file (&optional file)
+  "Remove any related links to the FILE.
+This is equivalent to removing the node from the graph.
+If FILE is nil, clear the current buffer."
+  (setq file (or file (buffer-file-name (buffer-base-buffer))))
+  (org-roam-db-query [:delete :from files
+                      :where (= file $s1)]
+                     file))
 
-(defun org-roam-db--clear-file (&optional filepath)
+;;;;; Updating tables
-  "Remove any related links to the file at FILEPATH.
+(defun org-roam-db-insert-file ()
-This is equivalent to removing the node from the graph."
+  "Update the files table for the current buffer.
-  (let* ((path (or filepath
+If UPDATE-P is non-nil, first remove the file in the database."
-                   (buffer-file-name)))
+  (let* ((file (buffer-file-name))
-         (file (file-truename path)))
+         (attr (file-attributes file))
-    (org-roam-db-query [:delete :from files
+         (atime (file-attribute-access-time attr))
-                        :where (= file $s1)]
+         (mtime (file-attribute-modification-time attr))
-                       file)
+         (hash (org-roam-db--file-hash)))
-    (org-roam-db-query [:delete :from links
+    (org-roam-db-query
-                        :where (= from $s1)]
+     [:insert :into files
-                       file)
+      :values $v1]
-    (org-roam-db-query [:delete :from titles
+     (list (vector file hash atime mtime)))))
-                        :where (= file $s1)]
-                       file)
-    (org-roam-db-query [:delete :from refs
-                        :where (= file $s1)]
-                       file)))
 
-;;;;; Insertion
+(defun org-roam-db-get-scheduled-time ()
-(defun org-roam-db--insert-links (links)
+  "Return the scheduled time at point in ISO8601 format."
-  "Insert LINKS into the Org-roam cache."
+  (when-let ((time (org-get-scheduled-time (point))))
-  (org-roam-db-query
+    (org-format-time-string "%FT%T%z" time)))
-   [:insert :into links
-    :values $v1]
-   links))
 
-(defun org-roam-db--insert-titles (file titles)
+(defun org-roam-db-get-deadline-time ()
-  "Insert TITLES for a FILE into the Org-roam cache."
+  "Return the deadline time at point in ISO8601 format."
-  (org-roam-db-query
+  (when-let ((time (org-get-deadline-time (point))))
-   [:insert :into titles
+    (org-format-time-string "%FT%T%z" time)))
-    :values $v1]
-   (list (vector file titles))))
 
-(defun org-roam-db--insert-ref (file ref)
+(defun org-roam-db-node-p ()
-  "Insert REF for FILE into the Org-roam cache."
+  "Return t if headline at point is a node, else return nil."
-  (org-roam-db-query
+  (and (org-id-get)
-   [:insert :into refs
+       (not (cdr (assoc "ROAM_EXCLUDE" (org-entry-properties))))
-    :values $v1]
+       (funcall org-roam-db-node-include-function)))
-   (list (vector ref file))))
+
+(defun org-roam-db-map-nodes (fns)
+  "Run FNS over all nodes in the current buffer."
+  (org-with-point-at 1
+    (org-map-entries
+     (lambda ()
+       (when (org-roam-db-node-p)
+         (dolist (fn fns)
+           (funcall fn)))))))
+
+(defun org-roam-db-map-links (fns)
+  "Run FNS over all links in the current buffer."
+  (org-with-point-at 1
+    (org-element-map (org-element-parse-buffer) 'link
+      (lambda (link)
+        (dolist (fn fns)
+          (funcall fn link))))))
+
+(defun org-roam-db-insert-file-node ()
+  "Insert the file-level node into the Org-roam cache."
+  (org-with-point-at 1
+    (when (and (= (org-outline-level) 0)
+               (org-roam-db-node-p))
+      (when-let ((id (org-id-get)))
+        (let* ((file (buffer-file-name (buffer-base-buffer)))
+               (title (org-link-display-format
+                       (or (cadr (assoc "TITLE" (org-collect-keywords '("title"))
+                                        #'string-equal))
+                           (file-relative-name file org-roam-directory))))
+               (pos (point))
+               (todo nil)
+               (priority nil)
+               (scheduled nil)
+               (deadline nil)
+               (level 0)
+               (aliases (org-entry-get (point) "ROAM_ALIASES"))
+               (tags org-file-tags)
+               (refs (org-entry-get (point) "ROAM_REFS"))
+               (properties (org-entry-properties))
+               (olp (org-get-outline-path)))
+          (org-roam-db-query!
+           (lambda (err)
+             (lwarn 'org-roam :warning "%s for %s (%s) in %s"
+                    (error-message-string err)
+                    title id file))
+           [:insert :into nodes
+            :values $v1]
+           (vector id file level pos todo priority
+                   scheduled deadline title properties olp))
+          (when tags
+            (org-roam-db-query
+             [:insert :into tags
+              :values $v1]
+             (mapcar (lambda (tag)
+                       (vector id (substring-no-properties tag)))
+                     tags)))
+          (when aliases
+            (org-roam-db-query
+             [:insert :into aliases
+              :values $v1]
+             (mapcar (lambda (alias)
+                       (vector id alias))
+                     (split-string-and-unquote aliases))))
+          (when refs
+            (setq refs (split-string-and-unquote refs))
+            (let (rows)
+              (dolist (ref refs)
+                (if (string-match org-link-plain-re ref)
+                    (progn
+                      (push (vector id (match-string 2 ref)
+                                    (match-string 1 ref)) rows))
+                  (lwarn '(org-roam) :warning
+                         "%s:%s\tInvalid ref %s, skipping..."
+                         (buffer-file-name) (point) ref)))
+              (when rows
+                (org-roam-db-query
+                 [:insert :into refs
+                  :values $v1]
+                 rows)))))))))
+
+(defun org-roam-db-insert-node-data ()
+  "Insert node data for headline at point into the Org-roam cache."
+  (when-let ((id (org-id-get)))
+    (let* ((file (buffer-file-name (buffer-base-buffer)))
+           (heading-components (org-heading-components))
+           (pos (point))
+           (todo (nth 2 heading-components))
+           (priority (nth 3 heading-components))
+           (level (nth 1 heading-components))
+           (scheduled (org-roam-db-get-scheduled-time))
+           (deadline (org-roam-db-get-deadline-time))
+           (title (org-link-display-format (nth 4 heading-components)))
+           (properties (org-entry-properties))
+           (olp (org-get-outline-path)))
+      (org-roam-db-query!
+       (lambda (err)
+         (lwarn 'org-roam :warning "%s for %s (%s) in %s"
+                (error-message-string err)
+                title id file))
+       [:insert :into nodes
+        :values $v1]
+       (vector id file level pos todo priority
+               scheduled deadline title properties olp)))))
+
+(defun org-roam-db-insert-aliases ()
+  "Insert aliases for node at point into Org-roam cache."
+  (when-let ((node-id (org-id-get))
+             (aliases (org-entry-get (point) "ROAM_ALIASES")))
+    (org-roam-db-query [:insert :into aliases
+                        :values $v1]
+                       (mapcar (lambda (alias)
+                                 (vector node-id alias))
+                               (split-string-and-unquote aliases)))))
+
+(defun org-roam-db-insert-tags ()
+  "Insert tags for node at point into Org-roam cache."
+  (when-let ((node-id (org-id-get))
+             (tags (org-get-tags)))
+    (org-roam-db-query [:insert :into tags
+                        :values $v1]
+                       (mapcar (lambda (tag)
+                                 (vector node-id (substring-no-properties tag))) tags))))
+
+(defun org-roam-db-insert-refs ()
+  "Insert refs for node at point into Org-roam cache."
+  (when-let* ((node-id (org-id-get))
+              (refs (org-entry-get (point) "ROAM_REFS"))
+              (refs (split-string-and-unquote refs)))
+    (let (rows)
+      (dolist (ref refs)
+        (save-match-data
+          (if (string-match org-link-plain-re ref)
+              (progn
+                (push (vector node-id (match-string 2 ref) (match-string 1 ref)) rows))
+            (lwarn '(org-roam) :warning
+                   "%s:%s\tInvalid ref %s, skipping..." (buffer-file-name) (point) ref))))
+      (org-roam-db-query [:insert :into refs
+                          :values $v1]
+                         rows))))
+
+(defun org-roam-db-insert-link (link)
+  "Insert link data for LINK at current point into the Org-roam cache."
+  (save-excursion
+    (goto-char (org-element-property :begin link))
+    (let ((type (org-element-property :type link))
+          (dest (org-element-property :path link))
+          (properties (list :outline (org-get-outline-path)))
+          (source (org-roam-id-at-point)))
+      (when source
+        (org-roam-db-query
+         [:insert :into links
+          :values $v1]
+         (vector (point) source dest type properties))))))
 
 ;;;;; Fetching
 (defun org-roam-db--get-current-files ()
   "Return a hash-table of file to the hash of its file contents."
-  (let* ((current-files (org-roam-db-query [:select * :from files]))
+  (let ((current-files (org-roam-db-query [:select [file hash] :from files]))
-         (ht (make-hash-table :test #'equal)))
+        (ht (make-hash-table :test #'equal)))
     (dolist (row current-files)
       (puthash (car row) (cadr row) ht))
     ht))
 
-(defun org-roam-db--get-titles (file)
+(defun org-roam-db--file-hash (&optional file-path)
-  "Return the titles of FILE from the cache."
+  "Compute the hash of FILE-PATH, a file or current buffer."
-  (caar (org-roam-db-query [:select [titles] :from titles
+  (if file-path
-                            :where (= file $s1)]
+      (with-temp-buffer
-                           file
+        (set-buffer-multibyte nil)
-                           :limit 1)))
+        (insert-file-contents-literally file-path)
-
+        (secure-hash 'sha1 (current-buffer)))
-(defun org-roam-db--connected-component (file)
+    (org-with-wide-buffer
-  "Return all files reachable from/connected to FILE, including the file itself.
+     (secure-hash 'sha1 (current-buffer)))))
-If the file does not have any connections, nil is returned."
-  (let* ((query "WITH RECURSIVE
-                   links_of(file, link) AS
-                     (WITH roamlinks AS (SELECT * FROM links WHERE \"type\" = '\"roam\"'),
-                           citelinks AS (SELECT * FROM links
-                                                  JOIN refs ON links.\"to\" = refs.\"ref\"
-                                                            AND links.\"type\" = '\"cite\"')
-                      SELECT \"from\", \"to\" FROM roamlinks UNION
-                      SELECT \"to\", \"from\" FROM roamlinks UNION
-                      SELECT \"file\", \"from\" FROM citelinks UNION
-                      SELECT \"from\", \"file\" FROM citelinks),
-                   connected_component(file) AS
-                     (SELECT link FROM links_of WHERE file = $s1
-                      UNION
-                      SELECT link FROM links_of JOIN connected_component USING(file))
-                   SELECT * FROM connected_component;")
-         (files (mapcar 'car-safe (emacsql (org-roam-db) query file))))
-    files))
-
-(defun org-roam-db--links-with-max-distance (file max-distance)
-  "Return all files reachable from/connected to FILE in at most MAX-DISTANCE steps,
-including the file itself.  If the file does not have any connections, nil is returned."
-  (let* ((query "WITH RECURSIVE
-                   links_of(file, link) AS
-                     (WITH roamlinks AS (SELECT * FROM links WHERE \"type\" = '\"roam\"'),
-                           citelinks AS (SELECT * FROM links
-                                                  JOIN refs ON links.\"to\" = refs.\"ref\"
-                                                            AND links.\"type\" = '\"cite\"')
-                      SELECT \"from\", \"to\" FROM roamlinks UNION
-                      SELECT \"to\", \"from\" FROM roamlinks UNION
-                      SELECT \"file\", \"from\" FROM citelinks UNION
-                      SELECT \"from\", \"file\" FROM citelinks),
-                   -- Links are traversed in a breadth-first search.  In order to calculate the
-                   -- distance of nodes and to avoid following cyclic links, the visited nodes
-                   -- are tracked in 'trace'.
-                   connected_component(file, trace) AS
-                     (VALUES($s1, json_array($s1))
-                      UNION
-                      SELECT lo.link, json_insert(cc.trace, '$[' || json_array_length(cc.trace) || ']', lo.link) FROM
-                      connected_component AS cc JOIN links_of AS lo USING(file)
-                      WHERE (
-                        -- Avoid cycles by only visiting each file once.
-                        (SELECT count(*) FROM json_each(cc.trace) WHERE json_each.value == lo.link) == 0
-                        -- Note: BFS is cut off early here.
-                        AND json_array_length(cc.trace) < ($s2 + 1)))
-                   SELECT DISTINCT file, min(json_array_length(trace)) AS distance
-                   FROM connected_component GROUP BY file ORDER BY distance;")
-         ;; In principle the distance would be available in the second column.
-         (files (mapcar 'car-safe (emacsql (org-roam-db) query file max-distance))))
-    files))
 
 ;;;;; Updating
-(defun org-roam-db--update-titles ()
+;;;###autoload
-  "Update the title of the current buffer into the cache."
+(defun org-roam-db-sync (&optional force)
-  (let ((file (file-truename (buffer-file-name))))
+  "Synchronize the cache state with the current Org files on-disk.
-    (org-roam-db-query [:delete :from titles
+If FORCE, force a rebuild of the cache from scratch."
-                        :where (= file $s1)]
+  (interactive "P")
-                       file)
+  (when force (delete-file org-roam-db-location))
-    (org-roam-db--insert-titles file (org-roam--extract-titles))))
-
-(defun org-roam-db--update-refs ()
-  "Update the ref of the current buffer into the cache."
-  (let ((file (file-truename (buffer-file-name))))
-    (org-roam-db-query [:delete :from refs
-                        :where (= file $s1)]
-                       file)
-    (when-let ((ref (org-roam--extract-ref)))
-      (org-roam-db--insert-ref file ref))))
-
-(defun org-roam-db--update-cache-links ()
-  "Update the file links of the current buffer in the cache."
-  (let ((file (file-truename (buffer-file-name))))
-    (org-roam-db-query [:delete :from links
-                        :where (= from $s1)]
-                       file)
-    (when-let ((links (org-roam--extract-links)))
-      (org-roam-db--insert-links links))))
-
-(defun org-roam-db--update-file (&optional file-path)
-  "Update Org-roam cache for FILE-PATH."
-  (let (buf)
-    (if file-path
-        (setq buf (find-file-noselect file-path))
-      (setq buf (current-buffer)))
-    (with-current-buffer buf
-      (save-excursion
-        (org-roam-db--update-titles)
-        (org-roam-db--update-refs)
-        (org-roam-db--update-cache-links)
-        (org-roam-buffer--update-maybe :redisplay t)))))
-
-;;;;; org-roam-db-build-cache
-(defun org-roam-db-build-cache ()
-  "Build the cache for `org-roam-directory'."
-  (interactive)
   (org-roam-db--close) ;; Force a reconnect
   (org-roam-db) ;; To initialize the database, no-op if already initialized
-  (let* ((org-roam-files (org-roam--list-files org-roam-directory))
+  (let* ((gc-cons-threshold org-roam-db-gc-threshold)
+         (org-agenda-files nil)
+         (org-roam-files (org-roam--list-all-files))
          (current-files (org-roam-db--get-current-files))
-         (time (current-time))
+         (modified-files nil))
-         all-files all-links all-titles all-refs)
     (dolist (file org-roam-files)
-      (org-roam--with-temp-buffer
+      (let ((contents-hash (org-roam-db--file-hash file)))
-        (insert-file-contents file)
+        (unless (string= (gethash file current-files)
-        (let ((contents-hash (secure-hash 'sha1 (current-buffer))))
+                         contents-hash)
-          (unless (string= (gethash file current-files)
+          (push file modified-files)))
-                           contents-hash)
+      (remhash file current-files))
-            (org-roam-db--clear-file file)
+    (emacsql-with-transaction (org-roam-db)
-            (setq all-files
+      (if (fboundp 'dolist-with-progress-reporter)
-                  (cons (vector file contents-hash time) all-files))
+          (dolist-with-progress-reporter (file (hash-table-keys current-files))
-            (when-let (links (org-roam--extract-links file))
+              "Clearing removed files..."
-              (setq all-links (append links all-links)))
+            (org-roam-db-clear-file file))
-            (let ((titles (org-roam--extract-titles)))
+        (dolist (file (hash-table-keys current-files))
-              (setq all-titles (cons (vector file titles) all-titles)))
+          (org-roam-db-clear-file file)))
-            (when-let ((ref (org-roam--extract-ref)))
+      (if (fboundp 'dolist-with-progress-reporter)
-              (setq all-refs (cons (vector ref file) all-refs))))
+          (dolist-with-progress-reporter (file modified-files)
-          (remhash file current-files))))
+              "Processing modified files..."
-    (dolist (file (hash-table-keys current-files))
+            (org-roam-db-update-file file))
-      ;; These files are no longer around, remove from cache...
+        (dolist (file modified-files)
-      (org-roam-db--clear-file file))
+          (org-roam-db-update-file file))))))
-    (when all-files
+
-      (org-roam-db-query
+(defun org-roam-db-update-file (&optional file-path)
-       [:insert :into files
+  "Update Org-roam cache for FILE-PATH.
-        :values $v1]
+If the file does not exist anymore, remove it from the cache.
-       all-files))
+If the file exists, update the cache with information."
-    (when all-links
+  (setq file-path (or file-path (buffer-file-name (buffer-base-buffer))))
-      (org-roam-db-query
+  (let ((content-hash (org-roam-db--file-hash file-path))
-       [:insert :into links
+        (db-hash (caar (org-roam-db-query [:select hash :from files
-        :values $v1]
+                                           :where (= file $s1)] file-path))))
-       all-links))
+    (unless (string= content-hash db-hash)
-    (when all-titles
+      (org-roam-with-file file-path nil
-      (org-roam-db-query
+        (save-excursion
-       [:insert :into titles
+          (org-set-regexps-and-options 'tags-only)
-        :values $v1]
+          (org-roam-db-clear-file)
-       all-titles))
+          (org-roam-db-insert-file)
-    (when all-refs
+          (org-roam-db-insert-file-node)
-      (org-roam-db-query
+          (org-roam-db-map-nodes
-       [:insert :into refs
+           (list #'org-roam-db-insert-node-data
-        :values $v1]
+                 #'org-roam-db-insert-aliases
-       all-refs))
+                 #'org-roam-db-insert-tags
-    (let ((stats (list :files (length all-files)
+                 #'org-roam-db-insert-refs))
-                       :links (length all-links)
+          (org-roam-db-map-links
-                       :titles (length all-titles)
+           (list #'org-roam-db-insert-link)))))))
-                       :refs (length all-refs)
+
-                       :deleted (length (hash-table-keys current-files)))))
+(defun org-roam-db--update-on-save-h ()
-      (when org-roam-verbose
+  "."
-        (message "files: %s, links: %s, titles: %s, refs: %s, deleted: %s"
+  (add-hook 'after-save-hook #'org-roam-db-update-file nil t))
-                 (plist-get stats :files)
+
-                 (plist-get stats :links)
+(add-hook 'org-roam-find-file-hook #'org-roam-db--update-on-save-h)
-                 (plist-get stats :titles)
+
-                 (plist-get stats :refs)
+;; Diagnostic Interactives
-                 (plist-get stats :deleted)))
+(defun org-roam-db-diagnose-node ()
-      stats)))
+  "Print information about node at point."
+  (interactive)
+  (prin1 (org-roam-node-at-point)))
 
 (provide 'org-roam-db)
 

org-roam-graph.el

@@ -1,12 +1,12 @@
-;;; org-roam-graph.el --- Roam Research replica with Org-mode -*- coding: utf-8; lexical-binding: t -*-
+;;; org-roam-graph.el --- Graphing API -*- coding: utf-8; lexical-binding: t; -*-
 
-;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+;; Copyright © 2020-2021 Jethro Kuan <jethrokuan95@gmail.com>
 
 ;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; URL: https://github.com/jethrokuan/org-roam
+;; URL: https://github.com/org-roam/org-roam
 ;; Keywords: org-mode, roam, convenience
-;; Version: 1.1.0
+;; Version: 2.0.0
-;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite "1.0.0"))
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
 
 ;; This file is NOT part of GNU Emacs.
 
@@ -31,14 +31,12 @@
 ;;
 ;;; Code:
 (require 'xml) ;xml-escape-string
-(require 's)   ;s-truncate, s-replace
+(eval-and-compile
-(require 'org-roam-macs)
+  (require 'org-roam-macs))
 (require 'org-roam-db)
 
 ;;;; Declarations
 (defvar org-roam-directory)
-(declare-function org-roam--org-roam-file-p  "org-roam")
-(declare-function org-roam--path-to-slug     "org-roam")
 
 ;;;; Options
 (defcustom org-roam-graph-viewer (executable-find "firefox")
@@ -53,11 +51,17 @@ It may be one of the following:
           (const    :tag "view-file"))
   :group 'org-roam)
 
-(defcustom org-roam-graph-executable (executable-find "dot")
+(defcustom org-roam-graph-executable "dot"
-  "Path to graphing executable."
+  "Path to graphing executable, or its name."
   :type 'string
   :group 'org-roam)
 
+(defcustom org-roam-graph-filetype "svg"
+  "File type to generate when producing graphs."
+  :type 'string
+  :group 'org-roam)
+
+
 (defcustom org-roam-graph-extra-config nil
   "Extra options passed to graphviz.
 Example:
@@ -65,71 +69,54 @@ Example:
   :type '(alist)
   :group 'org-roam)
 
-(defcustom org-roam-graph-node-extra-config nil
-  "Extra options for graphviz nodes.
-Example:
- '((\"color\" . \"skyblue\"))"
-  :type '(alist)
-  :group 'org-roam)
-
 (defcustom org-roam-graph-edge-extra-config nil
-  "Extra options for graphviz edges.
+  "Extra edge options passed to graphviz.
 Example:
  '((\"dir\" . \"back\"))"
   :type '(alist)
   :group 'org-roam)
 
-(defcustom org-roam-graph-edge-cites-extra-config '(("color" . "red"))
+(defcustom org-roam-graph-node-extra-config
-  "Extra options for graphviz edges for citation links.
+  '(("id" . (("style"      . "bold,rounded,filled")
-Example:
+             ("fillcolor"  . "#EEEEEE")
- '((\"dir\" . \"back\"))"
+             ("color"      . "#C9C9C9")
+             ("fontcolor"  . "#111111")))
+    ("http" . (("style"      . "rounded,filled")
+               ("fillcolor"  . "#EEEEEE")
+               ("color"      . "#C9C9C9")
+               ("fontcolor"  . "#0A97A6")))
+    ("https" . (("shape"      . "rounded,filled")
+                ("fillcolor"  . "#EEEEEE")
+                ("color"      . "#C9C9C9")
+                ("fontcolor"  . "#0A97A6"))))
+  "Extra options for graphviz nodes."
   :type '(alist)
   :group 'org-roam)
 
+(defcustom org-roam-graph-link-hidden-types
+  '("file")
+  "What sort of links to hide from the Org-roam graph."
+  :type '(repeat string)
+  :group 'org-roam)
+
 (defcustom org-roam-graph-max-title-length 100
   "Maximum length of titles in graph nodes."
   :type 'number
   :group 'org-roam)
 
-(defcustom org-roam-graph-exclude-matcher nil
+(defcustom org-roam-graph-shorten-titles 'truncate
-  "Matcher for excluding nodes from the generated graph.
+  "Determines how long titles appear in graph nodes.
-Any nodes and links for file paths matching this string is
+Recognized values are the symbols `truncate' and `wrap', in which
-excluded from the graph.
+cases the title will be truncated or wrapped, respectively, if it
+is longer than `org-roam-graph-max-title-length'.
 
-If value is a string, the string is the only matcher.
+All other values including nil will have no effect."
-
-If value is a list, all file paths matching any of the strings
-are excluded."
   :type '(choice
-          (string :tag "Matcher")
+          (const :tag "truncate" truncate)
-          (list :tag "Matchers"))
+          (const :tag "wrap" wrap)
+          (const :tag "no" nil))
   :group 'org-roam)
 
-;;;; Functions
-(defun org-roam-graph--expand-matcher (col &optional negate where)
-  "Return the exclusion regexp from `org-roam-graph-exclude-matcher'.
-COL is the symbol to be matched against.  if NEGATE, add :not to sql query.
-set WHERE to true if WHERE query already exists."
-  (let ((matchers (pcase org-roam-graph-exclude-matcher
-                    ('nil nil)
-                    ((pred stringp) `(,(concat "%" org-roam-graph-exclude-matcher "%")))
-                    ((pred listp) (mapcar (lambda (m)
-                                            (concat "%" m "%"))
-                                          org-roam-graph-exclude-matcher))
-                    (_ (error "Invalid org-roam-graph-exclude-matcher"))))
-        res)
-    (dolist (match matchers)
-      (if where
-          (push :and res)
-        (push :where res)
-        (setq where t))
-      (push col res)
-      (when negate
-        (push :not res))
-      (push :like res)
-      (push match res))
-    (nreverse res)))
-
 (defun org-roam-graph--dot-option (option &optional wrap-key wrap-val)
   "Return dot string of form KEY=VAL for OPTION cons.
 If WRAP-KEY is non-nil it wraps the KEY.
@@ -138,76 +125,122 @@ If WRAP-VAL is non-nil it wraps the VAL."
           "="
           wrap-val (cdr option) wrap-val))
 
-(defun org-roam-graph--dot (node-query)
+(defun org-roam-graph--connected-component (id distance)
-  "Build the graphviz dot string for NODE-QUERY.
+  "Return the edges for all nodes reachable from/connected to ID.
-The Org-roam database titles table is read, to obtain the list of titles.
+DISTANCE is the maximum distance away from the root node."
-The links table is then read to obtain all directed links, and formatted
+  (let* ((query
-into a digraph."
+          (if (= distance 0)
-  (org-roam-db--ensure-built)
+              "
-  (org-roam--with-temp-buffer
+WITH RECURSIVE
-    (let* ((nodes (org-roam-db-query node-query))
+  links_of(source, dest) AS
-           (edges-query
+  (SELECT source, dest FROM links UNION
-            `[:with selected :as [:select [file] :from ,node-query]
+   SELECT dest, source FROM links),
-              :select :distinct [to from] :from links
+   connected_component(source) AS
-              :where (and (in to selected) (in from selected))])
+  (SELECT dest FROM links_of WHERE source = $s1 UNION
-           (edges-cites-query
+   SELECT dest FROM links_of JOIN connected_component USING(source))
-            `[:with selected :as [:select [file] :from ,node-query]
+SELECT source, dest, type FROM links WHERE source IN connected_component OR dest IN connected_component;"
-              :select :distinct [file from]
+            "
-              :from links :inner :join refs :on (and (= links:to refs:ref)
+WITH RECURSIVE
-                                                     (= links:type "cite"))
+  links_of(source, dest) AS
-              :where (and (in file selected) (in from selected))])
+  (SELECT source, dest FROM links UNION
-           (edges       (org-roam-db-query edges-query))
+   SELECT dest, source FROM links),
-           (edges-cites (org-roam-db-query edges-cites-query)))
+  connected_component(source, trace) AS
+  (VALUES ($s1 , json_array($s1)) UNION
+   SELECT lo.dest, json_insert(cc.trace, '$[' || json_array_length(cc.trace) || ']', lo.dest) FROM
+   connected_component AS cc JOIN links_of AS lo USING(source)
+   WHERE (
+    -- Avoid cycles by only visiting each node once.
+    (SELECT count(*) FROM json_each(cc.trace) WHERE json_each.value == lo.dest) == 0
+    -- Note: BFS is cut off early here.
+    AND json_array_length(cc.trace) < $s2)),
+  nodes(source) as (SELECT DISTINCT source
+   FROM connected_component GROUP BY source ORDER BY min(json_array_length(trace)))
+SELECT source, dest, type FROM links WHERE source IN nodes OR dest IN nodes;")))
+    (org-roam-db-query query id distance)))
+
+(defun org-roam-graph--dot (&optional edges all-nodes)
+  "Build the graphviz given the EDGES of the graph.
+If ALL-NODES, include also nodes without edges."
+  (let ((org-roam-directory-temp org-roam-directory)
+        (nodes-table (org-roam--nodes-table))
+        (seen-nodes (list))
+        (edges (or edges (org-roam-db-query [:select :distinct [source dest type] :from links]))))
+    (with-temp-buffer
+      (setq-local org-roam-directory org-roam-directory-temp)
       (insert "digraph \"org-roam\" {\n")
       (dolist (option org-roam-graph-extra-config)
         (insert (org-roam-graph--dot-option option) ";\n"))
-      (dolist (attribute '("node" "edge"))
+      (insert (format " edge [%s];\n"
-        (insert (format " %s [%s];\n" attribute
+                      (mapconcat (lambda (var)
-                        (mapconcat #'org-roam-graph--dot-option
+                                   (org-roam-graph--dot-option var nil "\""))
-                                   (symbol-value
+                                 org-roam-graph-edge-extra-config
-                                    (intern (concat "org-roam-graph-" attribute "-extra-config")))
+                                 ",")))
-                                   ","))))
+      (pcase-dolist (`(,source ,dest ,type) edges)
-      (dolist (node nodes)
+        (unless (member type org-roam-graph-link-hidden-types)
-        (let* ((file (xml-escape-string (car node)))
+          (pcase-dolist (`(,node ,node-type) `((,source "id")
-               (title (or (caadr node)
+                                               (,dest ,type)))
-                          (org-roam--path-to-slug file)))
+            (unless (member node seen-nodes)
-               (shortened-title (s-truncate org-roam-graph-max-title-length title))
+              (insert (org-roam-graph--format-node
-               (node-properties
+                       (or (gethash node nodes-table) node) node-type))
-                `(("label"   . ,(s-replace "\"" "\\\"" shortened-title))
+              (push node seen-nodes)))
-                  ("URL"     . ,(concat "org-protocol://roam-file?file=" (url-hexify-string file)))
+          (insert (format "  \"%s\" -> \"%s\";\n"
-                  ("tooltip" . ,(xml-escape-string title)))))
+                          (xml-escape-string source)
-          (insert
+                          (xml-escape-string dest)))))
-           (format "  \"%s\" [%s];\n" file
+      (when all-nodes
-                   (mapconcat (lambda (n)
+        (maphash (lambda (id node)
-                                (org-roam-graph--dot-option n nil "\""))
+                   (unless (member id seen-nodes)
-                              node-properties ",")))))
+                     (insert (org-roam-graph--format-node node "id"))))
-      (dolist (edge edges)
+                 nodes-table))
-        (insert (apply #'format `("  \"%s\" -> \"%s\";\n"
-                                  ,@(mapcar #'xml-escape-string edge)))))
-      (insert (format "  edge [%s];\n"
-                      (mapconcat #'org-roam-graph--dot-option
-                                 org-roam-graph-edge-cites-extra-config ",")))
-      (dolist (edge edges-cites)
-        (insert (apply #'format `("  \"%s\" -> \"%s\";\n"
-                                  ,@(mapcar #'xml-escape-string edge)))))
       (insert "}")
       (buffer-string))))
 
-(defun org-roam-graph--build (&optional node-query)
+(defun org-roam-graph--format-node (node type)
-  "Generate a graph showing the relations between nodes in NODE-QUERY."
+  "Return a graphviz NODE with TYPE.
-  (unless org-roam-graph-executable
+Handles both Org-roam nodes, and string nodes (e.g. urls)."
-    (user-error "Can't find %s executable.  Please check if it is in your path"
+  (let (node-id node-properties)
+    (if (org-roam-node-p node)
+        (let* ((title (org-roam-quote-string (org-roam-node-title node)))
+               (shortened-title (org-roam-quote-string
+                                 (pcase org-roam-graph-shorten-titles
+                                   (`truncate (org-roam-truncate org-roam-graph-max-title-length title))
+                                   (`wrap (s-word-wrap org-roam-graph-max-title-length title))
+                                   (_ title)))))
+          (setq node-id (org-roam-node-id node)
+                node-properties `(("label"   . ,shortened-title)
+                                  ("URL"     . ,(concat "org-protocol://roam-node?node="
+                                                        (url-hexify-string (org-roam-node-id node))))
+                                  ("tooltip" . ,(xml-escape-string title)))))
+      (setq node-id node
+            node-properties (append `(("label" . ,(concat type ":" node)))
+                                    (when (member type (list "http" "https"))
+                                      `(("URL" . ,(xml-escape-string (concat type ":" node))))))))
+    (format "\"%s\" [%s];\n"
+            node-id
+            (mapconcat (lambda (n)
+                         (org-roam-graph--dot-option n nil "\""))
+                       (append (cdr (assoc type org-roam-graph-node-extra-config))
+                               node-properties) ","))))
+
+(defun org-roam-graph--build (graph &optional callback)
+  "Generate the GRAPH, and execute CALLBACK when process exits successfully.
+CALLBACK is passed the graph file as its sole argument."
+  (unless (stringp org-roam-graph-executable)
+    (user-error "`org-roam-graph-executable' is not a string"))
+  (unless (executable-find org-roam-graph-executable)
+    (user-error (concat "Cannot find executable \"%s\" to generate the graph.  "
+                        "Please adjust `org-roam-graph-executable'")
                 org-roam-graph-executable))
-  (let* ((node-query (or node-query
+  (let* ((temp-dot   (make-temp-file "graph." nil ".dot" graph))
-                         `[:select [file titles]
+         (temp-graph (make-temp-file "graph." nil (concat "." org-roam-graph-filetype))))
-                           :from titles
+    (org-roam-message "building graph")
-                           ,@(org-roam-graph--expand-matcher 'file t)]))
+    (make-process
-         (graph      (org-roam-graph--dot node-query))
+     :name "*org-roam-graph--build-process*"
-         (temp-dot   (make-temp-file "graph." nil ".dot" graph))
+     :buffer "*org-roam-graph--build-process*"
-         (temp-graph (make-temp-file "graph." nil ".svg")))
+     :command `(,org-roam-graph-executable ,temp-dot "-T" ,org-roam-graph-filetype "-o" ,temp-graph)
-    (call-process org-roam-graph-executable nil 0 nil
+     :sentinel (when callback
-                  temp-dot "-Tsvg" "-o" temp-graph)
+                 (lambda (process _event)
-    temp-graph))
+                   (when (= 0 (process-exit-status process))
+                     (funcall callback temp-graph)))))))
 
 (defun org-roam-graph--open (file)
   "Open FILE using `org-roam-graph-viewer' with `view-file' as a fallback."
@@ -216,52 +249,32 @@ into a digraph."
      (if (executable-find org-roam-graph-viewer)
          (condition-case err
              (call-process org-roam-graph-viewer nil 0 nil file)
-           ((error (user-error "Failed to open org-roam graph: %s" err))))
+           (error (user-error "Failed to open org-roam graph: %s" err)))
        (user-error "Executable not found: \"%s\"" org-roam-graph-viewer)))
     ((pred functionp) (funcall org-roam-graph-viewer file))
     ('nil (view-file file))
     (_ (signal 'wrong-type-argument `((functionp stringp null) ,org-roam-graph-viewer)))))
 
-(defun org-roam-graph--build-connected-component (file &optional max-distance)
-  "Build a graph of nodes connected to FILE.
-If MAX-DISTANCE is non-nil, limit nodes to MAX-DISTANCE steps."
-  (let* ((file (file-truename file))
-         (files (or (if (and max-distance (>= max-distance 0))
-                        (org-roam-db--links-with-max-distance file max-distance)
-                      (org-roam-db--connected-component file))
-                    (list file)))
-         (query `[:select [file titles]
-                  :from titles
-                  :where (in file [,@files])]))
-    (org-roam-graph--build query)))
-
 ;;;; Commands
 ;;;###autoload
-(defun org-roam-graph (&optional arg file node-query)
+(defun org-roam-graph (&optional arg node)
-  "Build and possibly display a graph for FILE from NODE-QUERY.
+  "Build and possibly display a graph for NODE.
-If FILE is nil, default to current buffer's file name.
 ARG may be any of the following values:
   - nil       show the graph.
-  - `\\[universal-argument]'     show the graph for FILE.
+  - `\\[universal-argument]'     show the graph for NODE.
-  - `\\[universal-argument]' N   show the graph for FILE limiting nodes to N steps.
+  - `\\[universal-argument]' N   show the graph for NODE limiting nodes to N steps."
-  - `\\[universal-argument] \\[universal-argument]' build the graph.
+  (interactive
-  - `\\[universal-argument]' -   build the graph for FILE.
+   (list current-prefix-arg
-  - `\\[universal-argument]' -N  build the graph for FILE limiting nodes to N steps."
+         (and current-prefix-arg
-  (interactive "P")
+              (org-roam-node-at-point 'assert))))
-  (let ((file (or file (buffer-file-name))))
+  (let ((graph (cl-typecase arg
-    (unless file
+                 (null (org-roam-graph--dot nil 'all-nodes))
-      (user-error "Cannot build graph for nil file. Is current buffer visiting a file?"))
+                 (cons (org-roam-graph--dot (org-roam-graph--connected-component
-    (unless (org-roam--org-roam-file-p file)
+                                             (org-roam-node-id node) 0)))
-      (user-error "\"%s\" is not an org-roam file" file))
+                 (integer (org-roam-graph--dot (org-roam-graph--connected-component
-    (pcase arg
+                                                (org-roam-node-id node) (abs arg)))))))
-      ('nil            (org-roam-graph--open (org-roam-graph--build node-query)))
+    (org-roam-graph--build graph #'org-roam-graph--open)))
-      ('(4)            (org-roam-graph--open (org-roam-graph--build-connected-component file)))
+
-      ((pred integerp) (let ((graph (org-roam-graph--build-connected-component (buffer-file-name) (abs arg))))
-                         (when (>= arg 0)
-                           (org-roam-graph--open graph))))
-      ('(16)           (org-roam-graph--build node-query))
-      ('-              (org-roam-graph--build-connected-component file))
-      (_ (user-error "Unrecognized ARG: %s" arg)))))
 
 (provide 'org-roam-graph)
 

org-roam-macs.el

@@ -1,12 +1,12 @@
-;;; org-roam-macs.el --- Roam Research replica with Org-mode -*- coding: utf-8; lexical-binding: t -*-
+;;; org-roam-macs.el --- Macros/utility functions -*- coding: utf-8; lexical-binding: t; -*-
 
 ;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
 
 ;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; URL: https://github.com/jethrokuan/org-roam
+;; URL: https://github.com/org-roam/org-roam
 ;; Keywords: org-mode, roam, convenience
-;; Version: 1.1.0
+;; Version: 2.0.0
-;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite "1.0.0"))
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
 
 ;; This file is NOT part of GNU Emacs.
 
@@ -27,20 +27,62 @@
 
 ;;; Commentary:
 ;;
-;; This library implements macros used throughout org-roam
+;; This library implements macros used throughout org-roam.
-;;
 ;;
 ;;; Code:
-;;;; Library Requires
+(defmacro org-roam-plist-map! (fn plist)
+  "Map FN over PLIST, modifying it in-place."
+  (declare (indent 1))
+  (let ((plist-var (make-symbol "plist"))
+        (k (make-symbol "k"))
+        (v (make-symbol "v")))
+    `(let ((,plist-var (copy-sequence ,plist)))
+       (while ,plist-var
+         (setq ,k (pop ,plist-var))
+         (setq ,v (pop ,plist-var))
+         (setq ,plist (plist-put ,plist ,k (funcall ,fn ,k ,v)))))))
 
-(defmacro org-roam--with-temp-buffer (&rest body)
+(defmacro org-roam-with-file (file keep-buf-p &rest body)
+  "Execute BODY within FILE.
+If FILE is nil, execute BODY in the current buffer.
+Kills the buffer if KEEP-BUF-P is nil, and FILE is not yet visited."
+  (declare (indent 2) (debug t))
+  `(let* (new-buf
+          (auto-mode-alist nil)
+          (buf (or (and (not ,file)
+                        (current-buffer)) ;If FILE is nil, use current buffer
+                   (find-buffer-visiting ,file) ; If FILE is already visited, find buffer
+                   (progn
+                     (setq new-buf t)
+                     (find-file-noselect ,file)))) ; Else, visit FILE and return buffer
+          res)
+     (with-current-buffer buf
+       (unless (equal major-mode 'org-mode)
+         (delay-mode-hooks
+           (let ((org-inhibit-startup t)
+                 (org-agenda-files nil))
+             (org-mode))))
+       (setq res (progn ,@body))
+       (unless (and new-buf (not ,keep-buf-p))
+         (save-buffer)))
+     (if (and new-buf (not ,keep-buf-p))
+       (when (find-buffer-visiting ,file)
+         (kill-buffer (find-buffer-visiting ,file))))
+     res))
+
+(defmacro org-roam-with-temp-buffer (file &rest body)
   "Execute BODY within a temp buffer.
-Like `with-temp-buffer', but propagates `org-roam-directory'."
+Like `with-temp-buffer', but propagates `org-roam-directory'.
-  (declare (indent 0) (debug t))
+If FILE, set `default-directory' to FILE's directory and insert its contents."
+  (declare (indent 1) (debug t))
   (let ((current-org-roam-directory (make-symbol "current-org-roam-directory")))
     `(let ((,current-org-roam-directory org-roam-directory))
        (with-temp-buffer
          (let ((org-roam-directory ,current-org-roam-directory))
+           (delay-mode-hooks (org-mode))
+           (when ,file
+             (insert-file-contents ,file)
+             (setq-local default-directory (file-name-directory ,file)))
            ,@body)))))
 
 (provide 'org-roam-macs)

org-roam-migrate.el

@@ -0,0 +1,200 @@
+;;; org-roam-migrate.el --- Migration utilities from v1 to v2 -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020-2021 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 2.0.0
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;;  To ease transition from v1 to v2, we provide various migration utilities.
+;;  This library helps convert v1 notes to v2, and informs the user.
+;;
+;;; Code:
+;;;; Dependencies
+;;;;
+;;; v1 breaking warning
+(require 'org-roam-db)
+
+(defvar org-roam-v2-ack nil)
+
+(unless org-roam-v2-ack
+  (lwarn 'org-roam :error "
+------------------------------------
+WARNING: You're now on Org-roam v2!
+------------------------------------
+
+You may have arrived here from a package upgrade. Please read the
+wiki entry at
+https://github.com/org-roam/org-roam/wiki/Hitchhiker's-Rough-Guide-to-Org-roam-V2
+for an overview of the major changes.
+
+Notes taken in v1 are incompatible with v1, but you can upgrade
+them to the v2 format via a simple command. To migrate your
+notes, run:
+
+  M-x org-roam-migrate-wizard
+
+If you wish to stay on v1, v1 is unfortunately not distributed on
+MELPA. See org-roam/org-roam-v1 on GitHub on how to install v1.
+
+If you've gone through the migration steps (if necessary), and
+know what you're doing set `org-roam-v2-ack' to `t' to disable
+this warning. You can do so by adding:
+
+(setq org-roam-v2-ack t)
+
+To your init file.
+
+"))
+
+;;;###autoload
+(defun org-roam-migrate-wizard ()
+  "Migrate all notes from to be compatible with Org-roam v2.
+1. Convert all notes from v1 format to v2.
+2. Rebuild the cache.
+3. Replace all file links with ID links."
+  (interactive)
+  (when (yes-or-no-p "Org-roam will now convert all your notes from v1 to v2.
+This will take a while. Are you sure you want to do this?")
+    ;; Back up notes
+    (let* ((parent-dir (f-parent org-roam-directory))
+           (backup-dir (expand-file-name "org-roam.bak" parent-dir))
+           (debug-dir (expand-file-name "org-roam.debug" parent-dir)))
+      (message "Backing up files to %s" backup-dir)
+      (copy-directory org-roam-directory backup-dir))
+    (condition-case err
+        (progn
+          ;; Convert v1 to v2
+          (dolist (f (org-roam--list-all-files))
+            (org-roam-with-file f nil
+              (org-roam-migrate-v1-to-v2)))
+          ;; Rebuild cache
+          (org-roam-db-sync 'force)
+
+          ;;Replace all file links with ID links
+          (dolist (f (org-roam--list-all-files))
+            (org-roam-with-file f nil
+              (org-roam-migrate-replace-file-links-with-id)
+              (save-buffer))))
+      (t
+       (rename-file org-roam-directory debug-dir)
+       (rename-file backup-dir org-roam-directory)
+       (lwarn 'org-roam :warning (format "The migration wizard failed with error:\n%s\n%s"
+                                         (error-message-string err)
+                                         "Your files have been restored, consider filing an issue.\n"))))))
+
+(defun org-roam-migrate-v1-to-v2 ()
+  "Convert the current buffer to v2 format."
+  ;; Create file level ID
+  (org-with-point-at 1
+    (org-id-get-create))
+  ;; Replace roam_key into properties drawer roam_ref
+  (when-let* ((refs (mapcan #'split-string-and-unquote
+                            (cdar (org-collect-keywords '("roam_key"))))))
+    (let ((case-fold-search t))
+      (org-with-point-at 1
+        (dolist (ref refs)
+          (org-roam-ref-add ref))
+        (while (re-search-forward "^#\\+roam_key:" (point-max) t)
+          (beginning-of-line)
+          (kill-line 1)))))
+
+  ;; Replace roam_alias into properties drawer roam_aliases
+  (when-let* ((aliases (mapcan #'split-string-and-unquote
+                               (cdar (org-collect-keywords '("roam_alias"))))))
+    (dolist (alias aliases)
+      (org-roam-alias-add alias)))
+  (let ((case-fold-search t))
+    (org-with-point-at 1
+      (while (re-search-forward "^#\\+roam_alias:" (point-max) t)
+        (beginning-of-line)
+        (kill-line 1))))
+
+  ;; Replace #+roam_tags into #+filetags
+  (org-with-point-at 1
+    (let* ((roam-tags (org-roam-migrate-get-prop-list "ROAM_TAGS"))
+           (file-tags (org-roam-migrate-get-prop-list "FILETAGS"))
+           (tags (append roam-tags file-tags))
+           (tags (seq-map (lambda (tag)
+                            (replace-regexp-in-string
+                             "[^[:alnum:]_@#%]"
+                             "_"
+                             tag)) tags))
+           (tags (seq-uniq tags)))
+      (when tags
+        (org-roam-migrate-prop-set "filetags" (string-join tags " "))))
+    (let ((case-fold-search t))
+      (org-with-point-at 1
+        (while (re-search-forward "^#\\+roam_tags:" (point-max) t)
+          (beginning-of-line)
+          (kill-line 1)))))
+  (save-buffer))
+
+(defun org-roam-migrate-get-prop-list (keyword)
+  "Return prop list for KEYWORD."
+  (let ((re (format "^#\\+%s:[ \t]*\\([^\n]+\\)" (upcase keyword)))
+        lst)
+    (goto-char (point-min))
+    (while (re-search-forward re 2048 t)
+      (setq lst (append lst (split-string-and-unquote
+                             (buffer-substring-no-properties
+                              (match-beginning 1) (match-end 1))))))
+    lst))
+
+(defun org-roam-migrate-prop-set (name value)
+  "Set a file property called NAME to VALUE in buffer file.
+If the property is already set, replace its value."
+  (setq name (downcase name))
+  (org-with-point-at 1
+    (let ((case-fold-search t))
+      (if (re-search-forward (concat "^#\\+" name ":\\(.*\\)")
+                             (point-max) t)
+          (replace-match (concat "#+" name ": " value) 'fixedcase)
+        (while (and (not (eobp))
+                    (looking-at "^[#:]"))
+          (if (save-excursion (end-of-line) (eobp))
+              (progn
+                (end-of-line)
+                (insert "\n"))
+            (forward-line)
+            (beginning-of-line)))
+        (insert "#+" name ": " value "\n")))))
+
+(defun org-roam-migrate-replace-file-links-with-id ()
+  "Replace all file: links with ID links in current buffer."
+  (org-with-point-at 1
+    (while (re-search-forward org-link-bracket-re nil t)
+      (let* ((mdata (match-data))
+             (path (match-string 1))
+             (desc (match-string 2)))
+        (when (string-prefix-p "file:" path)
+          (setq path (expand-file-name (substring path 5)))
+          (when-let ((node-id (caar (org-roam-db-query [:select [id] :from nodes
+                                                        :where (= file $s1)
+                                                        :and (= level 0)] path))))
+            (set-match-data mdata)
+            (replace-match (org-link-make-string (concat "id:" node-id)) nil t)))))))
+
+(provide 'org-roam-migrate)
+;;; org-roam-migrate.el ends here

org-roam-mode.el

@@ -0,0 +1,468 @@
+;;; org-roam-mode.el --- create and refresh Org-roam buffers -*- lexical-binding: t -*-
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 2.0.0
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library implements the abstract major-mode `org-roam-mode', from which
+;; almost all other Org-roam major-modes derive.
+;;
+;;; Code:
+(require 'magit-section)
+
+(require 'org-roam-utils)
+
+(defvar org-roam-directory)
+(defvar org-roam-find-file-hook)
+
+(declare-function org-roam-node-at-point "org-roam")
+
+;;; Faces
+(defface org-roam-header-line
+  `((((class color) (background light))
+     ,@(and (>= emacs-major-version 27) '(:extend t))
+     :foreground "DarkGoldenrod4"
+     :weight bold)
+    (((class color) (background  dark))
+     ,@(and (>= emacs-major-version 27) '(:extend t))
+     :foreground "LightGoldenrod2"
+     :weight bold))
+  "Face for the `header-line' in some Org-roam modes."
+  :group 'org-roam-faces)
+
+(defface org-roam-title
+  '((t :weight bold))
+  "Face for Org-roam titles."
+  :group 'org-roam-faces)
+
+(defface org-roam-olp
+  '((((class color) (background light)) :foreground "grey60")
+    (((class color) (background  dark)) :foreground "grey40"))
+  "Face for the OLP of the node."
+  :group 'org-roam-faces)
+
+(defface org-roam-preview-heading
+  `((((class color) (background light))
+     ,@(and (>= emacs-major-version 27) '(:extend t))
+     :background "grey80"
+     :foreground "grey30")
+    (((class color) (background dark))
+     ,@(and (>= emacs-major-version 27) '(:extend t))
+     :background "grey25"
+     :foreground "grey70"))
+  "Face for preview headings."
+  :group 'org-roam-faces)
+
+(defface org-roam-preview-heading-highlight
+  `((((class color) (background light))
+     ,@(and (>= emacs-major-version 27) '(:extend t))
+     :background "grey75"
+     :foreground "grey30")
+    (((class color) (background dark))
+     ,@(and (>= emacs-major-version 27) '(:extend t))
+     :background "grey35"
+     :foreground "grey70"))
+  "Face for current preview headings."
+  :group 'org-roam-faces)
+
+(defface org-roam-preview-heading-selection
+  `((((class color) (background light))
+     ,@(and (>= emacs-major-version 27) '(:extend t))
+     :inherit org-roam-preview-heading-highlight
+     :foreground "salmon4")
+    (((class color) (background dark))
+     ,@(and (>= emacs-major-version 27) '(:extend t))
+     :inherit org-roam-preview-heading-highlight
+     :foreground "LightSalmon3"))
+  "Face for selected preview headings."
+  :group 'org-roam-faces)
+
+(defface org-roam-preview-region
+  `((t :inherit bold
+       ,@(and (>= emacs-major-version 27)
+              (list :extend (ignore-errors (face-attribute 'region :extend))))))
+  "Face used by `org-roam-highlight-preview-region-using-face'.
+
+This face is overlaid over text that uses other hunk faces,
+and those normally set the foreground and background colors.
+The `:foreground' and especially the `:background' properties
+should be avoided here.  Setting the latter would cause the
+loss of information.  Good properties to set here are `:weight'
+and `:slant'."
+  :group 'org-roam-faces)
+
+(defface org-roam-dim
+  '((((class color) (background light)) :foreground "grey60")
+    (((class color) (background  dark)) :foreground "grey40"))
+  "Face for the dimmer part of the widgets."
+  :group 'org-roam-faces)
+
+;;; Variables
+(defvar org-roam-current-node nil
+  "The current node at point.")
+
+(defvar org-roam-current-directory nil
+  "The `org-roam-directory' value for the current node.")
+
+(defcustom org-roam-mode-section-functions (list #'org-roam-backlinks-section
+                                                 #'org-roam-reflinks-section)
+  "Functions which insert sections of the `org-roam-buffer'.
+Each function is called with one argument, which is the current org-roam node at point."
+  :group 'org-roam
+  :type 'hook)
+
+;;; The mode
+(defvar org-roam-mode-map
+  (let ((map (make-sparse-keymap)))
+    (set-keymap-parent map magit-section-mode-map)
+    (define-key map [C-return]  'org-roam-visit-thing)
+    (define-key map (kbd "C-m") 'org-roam-visit-thing)
+    (define-key map [remap revert-buffer] 'org-roam-buffer-render)
+    map)
+  "Parent keymap for all keymaps of modes derived from `org-roam-mode'.")
+
+(define-derived-mode org-roam-mode magit-section-mode "Org-roam"
+  "Major mode for Org-roam's buffer."
+  :group 'org-roam
+  (face-remap-add-relative 'header-line 'org-roam-header-line))
+
+;;; Key functions
+(defun org-roam-visit-thing ()
+  "This is a placeholder command.
+Where applicable, section-specific keymaps bind another command
+which visits the thing at point."
+  (interactive)
+  (user-error "There is no thing at point that could be visited"))
+
+(defun org-roam-buffer-render ()
+  "Render the current node at point."
+  (interactive)
+  (when (derived-mode-p 'org-roam-mode)
+    (let ((inhibit-read-only t))
+      (erase-buffer)
+      (setq-local default-directory org-roam-current-directory)
+      (setq-local org-roam-directory org-roam-current-directory)
+      (org-roam-set-header-line-format (org-roam-node-title org-roam-current-node))
+      (magit-insert-section (org-roam)
+        (magit-insert-heading)
+        (run-hook-with-args 'org-roam-mode-section-functions org-roam-current-node)))))
+
+(defun org-roam-buffer ()
+  "Launch an Org-roam buffer for the current node at point."
+  (interactive)
+  (if-let ((node (org-roam-node-at-point))
+           (source-org-roam-directory org-roam-directory))
+      (progn
+        (let ((buffer (get-buffer-create
+                       (concat "org-roam: "
+                               (file-relative-name (buffer-file-name) org-roam-directory)))))
+          (with-current-buffer buffer
+            (org-roam-mode)
+            (setq-local org-roam-current-node node)
+            (setq-local org-roam-current-directory source-org-roam-directory)
+            (org-roam-buffer-render))
+          (switch-to-buffer-other-window buffer)))
+    (user-error "No node at point")))
+
+;;; Persistent buffer
+(defvar org-roam-buffer "*org-roam*"
+  "The persistent Org-roam buffer name.")
+
+(defun org-roam-buffer--post-command-h ()
+  "Reconstructs the Org-roam buffer.
+This needs to be quick or infrequent, because this is run at
+`post-command-hook'.  If REDISPLAY, force an update of
+the Org-roam buffer."
+  (when (get-buffer-window org-roam-buffer)
+    (when-let ((node (org-roam-node-at-point)))
+      (unless (equal node org-roam-current-node)
+        (setq org-roam-current-node node)
+        (setq org-roam-current-directory org-roam-directory)
+        (org-roam-buffer-persistent-redisplay)))))
+
+(define-inline org-roam-buffer--visibility ()
+  "Return whether the current visibility state of the org-roam buffer.
+Valid states are 'visible, 'exists and 'none."
+  (declare (side-effect-free t))
+  (inline-quote
+   (cond
+    ((get-buffer-window org-roam-buffer) 'visible)
+    ((get-buffer org-roam-buffer) 'exists)
+    (t 'none))))
+
+(defun org-roam-buffer-toggle ()
+  "Toggle display of the Org-roam buffer."
+  (interactive)
+  (pcase (org-roam-buffer--visibility)
+    ('visible
+     (progn
+       (delete-window (get-buffer-window org-roam-buffer))
+       (remove-hook 'post-command-hook #'org-roam-buffer--post-command-h)))
+    ((or 'exists 'none)
+     (progn
+       (setq org-roam-current-node (org-roam-node-at-point)
+             org-roam-current-directory org-roam-directory)
+       (display-buffer (get-buffer-create org-roam-buffer))
+       (org-roam-buffer-persistent-redisplay)))))
+
+(defun org-roam-buffer-persistent-redisplay ()
+  "Recompute contents of the persistent Org-roam buffer.
+Has no effect when `org-roam-current-node' is nil."
+  (when org-roam-current-node
+    (with-current-buffer (get-buffer-create org-roam-buffer)
+      (let ((inhibit-read-only t))
+        (erase-buffer)
+        (org-roam-mode)
+        (setq-local default-directory org-roam-current-directory)
+        (setq-local org-roam-directory org-roam-current-directory)
+        (org-roam-set-header-line-format (org-roam-node-title org-roam-current-node))
+        (magit-insert-section (org-roam)
+          (magit-insert-heading)
+          (dolist (fn org-roam-mode-section-functions)
+            (funcall fn org-roam-current-node)))))))
+
+(defun org-roam-buffer--redisplay ()
+  "."
+  (add-hook 'post-command-hook #'org-roam-buffer--post-command-h nil t))
+
+(add-hook 'org-roam-find-file-hook #'org-roam-buffer--redisplay)
+
+;;; Sections
+;;;; Backlinks
+(cl-defstruct (org-roam-backlink (:constructor org-roam-backlink-create)
+                                 (:copier nil))
+  source-node target-node
+  point properties)
+
+(cl-defmethod org-roam-populate ((backlink org-roam-backlink))
+  "Populate BACKLINK from database."
+  (setf (org-roam-backlink-source-node backlink)
+        (org-roam-populate (org-roam-backlink-source-node backlink))
+        (org-roam-backlink-target-node backlink)
+        (org-roam-populate (org-roam-backlink-target-node backlink)))
+  backlink)
+
+(defun org-roam-backlinks-get (node)
+  "Return the backlinks for NODE."
+  (let ((backlinks (org-roam-db-query
+                    [:select [source dest pos properties]
+                     :from links
+                     :where (= dest $s1)
+                     :and (= type "id")]
+                    (org-roam-node-id node))))
+    (cl-loop for backlink in backlinks
+             collect (pcase-let ((`(,source-id ,dest-id ,pos ,properties) backlink))
+                       (org-roam-populate
+                        (org-roam-backlink-create
+                         :source-node (org-roam-node-create :id source-id)
+                         :target-node (org-roam-node-create :id dest-id)
+                         :point pos
+                         :properties properties))))))
+
+(defun org-roam-backlinks-sort (a b)
+  "Default sorting function for backlinks A and B.
+Sorts by title."
+  (string< (org-roam-node-title (org-roam-backlink-source-node a))
+           (org-roam-node-title (org-roam-backlink-source-node b))))
+
+(defun org-roam-backlinks-section (node)
+  "The backlinks section for NODE."
+  (when-let ((backlinks (seq-sort #'org-roam-backlinks-sort (org-roam-backlinks-get node))))
+    (magit-insert-section (org-roam-backlinks)
+      (magit-insert-heading "Backlinks:")
+      (dolist (backlink backlinks)
+        (org-roam-node-insert-section
+         :source-node (org-roam-backlink-source-node backlink)
+         :point (org-roam-backlink-point backlink)
+         :properties (org-roam-backlink-properties backlink)))
+      (insert ?\n))))
+
+;;;; Reflinks
+(cl-defstruct (org-roam-reflink (:constructor org-roam-reflink-create)
+                                (:copier nil))
+  source-node ref
+  point properties)
+
+(cl-defmethod org-roam-populate ((reflink org-roam-reflink))
+  "Populate REFLINK from database."
+  (setf (org-roam-reflink-source-node reflink)
+        (org-roam-populate (org-roam-reflink-source-node reflink)))
+  reflink)
+
+(defun org-roam-reflinks-get (node)
+  "Return the reflinks for NODE."
+  (let ((refs (org-roam-db-query [:select [ref] :from refs
+                                  :where (= node-id $s1)]
+                                 (org-roam-node-id node)))
+        links)
+    (pcase-dolist (`(,ref) refs)
+      (pcase-dolist (`(,source-id ,pos ,properties) (org-roam-db-query
+                                                     [:select [source pos properties]
+                                                      :from links
+                                                      :where (= dest $s1)]
+                                                     ref))
+        (push (org-roam-populate
+               (org-roam-reflink-create
+                :source-node (org-roam-node-create :id source-id)
+                :ref ref
+                :point pos
+                :properties properties)) links)))
+    links))
+
+(defun org-roam-reflinks-sort (a b)
+  "Default sorting function for reflinks A and B.
+Sorts by title."
+  (string< (org-roam-node-title (org-roam-reflink-source-node a))
+           (org-roam-node-title (org-roam-reflink-source-node b))))
+
+(defun org-roam-reflinks-section (node)
+  "The reflinks section for NODE."
+  (when (org-roam-node-refs node)
+    (let* ((reflinks (seq-sort #'org-roam-reflinks-sort (org-roam-reflinks-get node))))
+      (magit-insert-section (org-roam-reflinks)
+        (magit-insert-heading "Reflinks:")
+        (dolist (reflink reflinks)
+          (org-roam-node-insert-section
+           :source-node (org-roam-reflink-source-node reflink)
+           :point (org-roam-reflink-point reflink)
+           :properties (org-roam-reflink-properties reflink)))
+        (insert ?\n)))))
+
+;;;; Unlinked references
+(defvar org-roam-grep-map
+  (let ((map (make-sparse-keymap)))
+    (set-keymap-parent map org-roam-mode-map)
+    (define-key map [remap org-roam-visit-thing] 'org-roam-file-visit)
+    map)
+  "Keymap for Org-roam grep result sections.")
+
+(defclass org-roam-grep-section (magit-section)
+  ((keymap :initform 'org-roam-grep-map)
+   (file :initform nil)
+   (row :initform nil)
+   (col :initform nil)))
+
+(defun org-roam-file-at-point (&optional assert)
+  "Return the file at point.
+If ASSERT, throw an error."
+  (if-let ((file (magit-section-case
+                   (org-roam-node-section (org-roam-node-file (oref it node)))
+                   (org-roam-grep-section (oref it file))
+                   (org-roam-preview-section (oref it file)))))
+      file
+    (when assert
+      (user-error "No file at point"))))
+
+(defun org-roam-file-visit (file &optional other-window row col)
+  "Visits FILE.
+With a prefix argument OTHER-WINDOW, display the buffer in
+another window instead.
+If ROW, move to the row, and if COL move to the COL."
+  (interactive (list (org-roam-file-at-point t)
+                     current-prefix-arg
+                     (oref (magit-current-section) row)
+                     (oref (magit-current-section) col)))
+  (let ((buf (find-file-noselect file)))
+    (with-current-buffer buf
+      (widen)
+      (goto-char (point-min))
+      (when row
+        (forward-line (1- row)))
+      (when col
+        (forward-char (1- col))))
+    (funcall (if other-window
+                 #'switch-to-buffer-other-window
+               #'pop-to-buffer-same-window) buf)))
+
+(defvar org-roam-unlinked-references-result-re
+  (rx (group (one-or-more anything))
+      ":"
+      (group (one-or-more digit))
+      ":"
+      (group (one-or-more digit))
+      ":"
+      (group (zero-or-more anything)))
+  "Regex for the return result of a ripgrep query.")
+
+(defun org-roam-unlinked-references-preview-line (file row)
+  "Return the preview line from FILE.
+This is the ROW within FILE."
+  (with-temp-buffer
+    (insert-file-contents-literally file)
+    (forward-line (1- row))
+    (buffer-substring-no-properties
+     (save-excursion
+       (beginning-of-line)
+       (point))
+     (save-excursion
+       (end-of-line)
+       (point)))))
+
+(defun org-roam-unlinked-references-section (node)
+  "The unlinked references section for NODE.
+References from FILE are excluded."
+  (when (and (executable-find "rg")
+             (not (string-match "PCRE2 is not available"
+                                (shell-command-to-string "rg --pcre2-version"))))
+    (let* ((titles (cons (org-roam-node-title node)
+                         (org-roam-node-aliases node)))
+           (rg-command (concat "rg -o --vimgrep -P -i "
+                               (mapconcat (lambda (glob) (concat "-g " glob))
+                                          (org-roam--list-files-search-globs org-roam-file-extensions)
+                                          " ")
+                               (format " '\\[([^[]]++|(?R))*\\]%s' "
+                                       (mapconcat (lambda (title)
+                                                    (format "|(\\b%s\\b)" (shell-quote-argument title)))
+                                                  titles ""))
+                               org-roam-directory))
+           (results (split-string (shell-command-to-string rg-command) "\n"))
+           f row col match)
+      (magit-insert-section (unlinked-references)
+        (magit-insert-heading "Unlinked References:")
+        (dolist (line results)
+          (save-match-data
+            (when (string-match org-roam-unlinked-references-result-re line)
+              (setq f (match-string 1 line)
+                    row (string-to-number (match-string 2 line))
+                    col (string-to-number (match-string 3 line))
+                    match (match-string 4 line))
+              (when (and match
+                         (not (f-equal-p (org-roam-node-file node) f))
+                         (member (downcase match) (mapcar #'downcase titles)))
+                (magit-insert-section section (org-roam-grep-section)
+                  (oset section file f)
+                  (oset section row row)
+                  (oset section col col)
+                  (insert (propertize (format "%s:%s:%s"
+                                              (truncate-string-to-width (file-name-base f) 15 nil nil "...")
+                                              row col) 'font-lock-face 'org-roam-dim)
+                          " "
+                          (org-roam-fontify-like-in-org-mode
+                           (org-roam-unlinked-references-preview-line f row))
+                          "\n"))))))
+        (insert ?\n)))))
+
+(provide 'org-roam-mode)
+;;; org-roam-mode.el ends here

org-roam-overlay.el

@@ -0,0 +1,98 @@
+;;; org-roam-overlay.el --- Link overlay for Org-roam nodes -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020-2021 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 2.0.0
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library is an attempt at injecting Roam functionality into Org-mode.
+;; This is achieved primarily through building caches for forward links,
+;; backward links, and file titles.
+;;
+;;
+;;; Code:
+;;;; Dependencies
+
+(defface org-roam-overlay
+  '((((class color) (background light))
+     :background "grey90" :box (:line-width -1 :color "black"))
+    (((class color) (background dark))
+     :background "grey10" :box (:line-width -1 :color "white")))
+  "Face for the Org-roam overlay."
+  :group 'org-roam-faces)
+
+(defun org-roam-overlay--make (l r &rest props)
+  "Make an overlay from L to R with PROPS."
+  (let ((o (make-overlay l (or r l))))
+    (overlay-put o 'category 'org-roam)
+    (while props (overlay-put o (pop props) (pop props)))
+    o))
+
+(defun org-roam-overlay-make-link-overlay (link)
+  "Create overlay for LINK."
+  (save-excursion
+    (save-match-data
+      (let* ((type (org-element-property :type link))
+             (id (org-element-property :path link))
+             (pos (org-element-property :end link))
+             (desc-p (org-element-property :contents-begin link))
+             node)
+        (when (and (string-equal type "id")
+                   (setq node (org-roam-node-from-id id))
+                   (not desc-p))
+          (org-roam-overlay--make
+           pos pos
+           'after-string (format "%s "
+                                 (propertize (org-roam-node-title node)
+                                             'face 'org-roam-overlay))))))))
+
+(defun org-roam-overlay-enable ()
+  "Enable Org-roam overlays."
+  (org-roam-db-map-links
+   (list #'org-roam-overlay-make-link-overlay)))
+
+(defun org-roam-overlay-disable ()
+  "Disable Org-roam overlays."
+  (remove-overlays nil nil 'category 'org-roam))
+
+(defun org-roam-overlay-redisplay ()
+  "Redisplay Org-roam overlays."
+  (org-roam-overlay-disable)
+  (org-roam-overlay-enable))
+
+(define-minor-mode org-roam-overlay-mode
+  "Overlays for Org-roam ID links.
+Org-roam overlay mode is a minor mode.  When enabled,
+overlay displaying the node's title is displayed."
+  :lighter " org-roam-overlay"
+  (if org-roam-overlay-mode
+      (progn
+        (org-roam-overlay-enable)
+        (add-hook 'after-save-hook #'org-roam-overlay-redisplay nil t))
+    (org-roam-overlay-disable)
+    (remove-hook 'after-save-hook #'org-roam-overlay-redisplay t)))
+
+(provide 'org-roam-overlay)
+;;; org-roam-overlay.el ends here

org-roam-protocol.el

@@ -1,11 +1,11 @@
-;;; org-roam-protocol.el --- Protocol handler for roam:// links  -*- coding: utf-8; lexical-binding: t -*-
+;;; org-roam-protocol.el --- Protocol handler for roam:// links  -*- coding: utf-8; lexical-binding: t; -*-
 
 ;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
 ;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; URL: https://github.com/jethrokuan/org-roam
+;; URL: https://github.com/org-roam/org-roam
 ;; Keywords: org-mode, roam, convenience
-;; Version: 1.1.0
+;; Version: 2.0.0
-;; Package-Requires: ((emacs "26.1") (org "9.3"))
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
 
 ;; This file is NOT part of GNU Emacs.
 
@@ -31,12 +31,20 @@
 ;;
 ;; We define 2 protocols:
 ;;
-;; 1. "roam-file": This protocol simply opens the file given by the FILE key
+;; 1. "roam-node": This protocol simply opens the node given by the node ID
 ;; 2. "roam-ref": This protocol creates or opens a note with the given REF
 ;;
 ;;; Code:
 (require 'org-protocol)
 (require 'org-roam)
+(eval-when-compile
+  (require 'org-roam-macs))
+(require 'ol) ;; for org-link-decode
+
+(defcustom org-roam-protocol-store-links nil
+  "Whether to store links when capturing websites with `org-roam-protocol'."
+  :type 'boolean
+  :group 'org-roam)
 
 ;;;; Functions
 (defun org-roam-protocol-open-ref (info)
@@ -45,28 +53,37 @@
 It opens or creates a note with the given ref.
 
   javascript:location.href = \\='org-protocol://roam-ref?template=r&ref=\\='+ \\
-        encodeURIComponent(location.href) + \\='&title=\\=' \\
+        encodeURIComponent(location.href) + \\='&title=\\=' + \\
         encodeURIComponent(document.title) + \\='&body=\\=' + \\
         encodeURIComponent(window.getSelection())"
-  (when-let* ((alist (org-roam--plist-to-alist info))
+  (unless (plist-get info :ref)
-              (decoded-alist (mapcar (lambda (k.v)
+    (user-error "No ref key provided"))
-                                       (let ((key (car k.v))
+  (org-roam-plist-map! (lambda (k v)
-                                             (val (cdr k.v)))
+                         (org-link-decode
-                                         (cons key (org-link-decode val)))) alist)))
+                          (if (equal k :ref)
-    (unless (assoc 'ref decoded-alist)
+                              (org-protocol-sanitize-uri v)
-      (error "No ref key provided"))
+                            v))) info)
-    (when-let ((title (cdr (assoc 'title decoded-alist))))
+  (when org-roam-protocol-store-links
-      (push (cons 'slug (org-roam--title-to-slug title)) decoded-alist))
+    (push (list (plist-get info :ref)
-    (let* ((org-roam-capture-templates org-roam-capture-ref-templates)
+                (plist-get info :title)) org-stored-links))
-           (org-roam-capture--context 'ref)
+  (org-link-store-props :type (and (string-match org-link-plain-re
-           (org-roam-capture--info decoded-alist)
+                                                 (plist-get info :ref))
-           (template (cdr (assoc 'template decoded-alist))))
+                                   (match-string 1 (plist-get info :ref)))
-      (raise-frame)
+                        :link (plist-get info :ref)
-      (org-roam--capture nil template)
+                        :annotation (org-link-make-string (plist-get info :ref)
-      (message "Item captured.")))
+                                                          (or (plist-get info :title)
+                                                              (plist-get info :ref)))
+                        :initial (or (plist-get info :body) ""))
+  (raise-frame)
+  (org-roam-capture-
+   :keys (plist-get info :template)
+   :node (org-roam-node-create :title (plist-get info :title))
+   :info (list :ref (plist-get info :ref)
+               :body (plist-get info :body))
+   :templates org-roam-capture-ref-templates)
   nil)
 
-(defun org-roam-protocol-open-file (info)
+(defun org-roam-protocol-open-node (info)
   "This handler simply opens the file with emacsclient.
 
 INFO is an alist containing additional information passed by the protocol URL.
@@ -74,15 +91,15 @@ It should contain the FILE key, pointing to the path of the file to open.
 
   Example protocol string:
 
-org-protocol://roam-file?file=/path/to/file.org"
+org-protocol://roam-node?node=uuid"
-  (when-let ((file (plist-get info :file)))
+  (when-let ((node (plist-get info :node)))
     (raise-frame)
-    (find-file file))
+    (org-roam-node-visit (org-roam-populate (org-roam-node-create :id node))))
   nil)
 
 (push '("org-roam-ref"  :protocol "roam-ref"   :function org-roam-protocol-open-ref)
       org-protocol-protocol-alist)
-(push '("org-roam-file"  :protocol "roam-file"   :function org-roam-protocol-open-file)
+(push '("org-roam-node"  :protocol "roam-node"   :function org-roam-protocol-open-node)
       org-protocol-protocol-alist)
 
 (provide 'org-roam-protocol)

org-roam-utils.el

@@ -0,0 +1,296 @@
+;;; org-roam-utils.el --- Utilities for Org-roam -*- coding: utf-8; lexical-binding: t; -*-
+
+;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
+
+;; Author: Jethro Kuan <jethrokuan95@gmail.com>
+;; URL: https://github.com/org-roam/org-roam
+;; Keywords: org-mode, roam, convenience
+;; Version: 2.0.0
+;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite "1.0.0") (magit-section "2.90.1"))
+
+;; This file is NOT part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+;;
+;; This library implements utility functions used throughout
+;; Org-roam.
+;;
+;;
+;;; Code:
+;;;; Library Requires
+(require 'dash)
+
+(eval-when-compile
+  (require 'org-roam-macs)
+  (require 'org-macs))
+
+(defvar org-roam-verbose)
+
+;; This is necessary to ensure all dependents on this module see
+;; `org-mode-hook' and `org-inhibit-startup' as dynamic variables,
+;; regardless of whether Org is loaded before their compilation.
+(require 'org)
+
+;;;; String Utilities
+(defun org-roam-truncate (len s &optional ellipsis)
+  "If S is longer than LEN, cut it down and add ELLIPSIS to the end.
+
+The resulting string, including ellipsis, will be LEN characters
+long.
+
+When not specified, ELLIPSIS defaults to ‘...’."
+  (declare (pure t) (side-effect-free t))
+  (unless ellipsis
+    (setq ellipsis "..."))
+  (if (> (length s) len)
+      (format "%s%s" (substring s 0 (- len (length ellipsis))) ellipsis)
+    s))
+
+(defun org-roam-replace (old new s)
+  "Replace OLD with NEW in S."
+  (declare (pure t) (side-effect-free t))
+  (replace-regexp-in-string (regexp-quote old) new s t t))
+
+(defun org-roam-quote-string (s)
+  "Quotes string S."
+  (->> s
+    (org-roam-replace "\\" "\\\\")
+    (org-roam-replace "\"" "\\\"")))
+
+;;;; Utility Functions
+(defun org-roam--list-interleave (lst separator)
+  "Interleaves elements in LST with SEPARATOR."
+  (when lst
+    (let ((new-lst (list (pop lst))))
+      (dolist (it lst)
+        (nconc new-lst (list separator it)))
+      new-lst)))
+
+(defun org-roam-up-heading-or-point-min ()
+  "Fixed version of Org's `org-up-heading-or-point-min'."
+  (ignore-errors (org-back-to-heading t))
+  (let ((p (point)))
+    (if (< 1 (funcall outline-level))
+        (progn
+          (org-up-heading-safe)
+          (when (= (point) p)
+            (goto-char (point-min))))
+      (unless (bobp) (goto-char (point-min))))))
+
+(defun org-roam-message (format-string &rest args)
+  "Pass FORMAT-STRING and ARGS to `message' when `org-roam-verbose' is t."
+  (when org-roam-verbose
+    (apply #'message `(,(concat "(org-roam) " format-string) ,@args))))
+
+(defvar org-ref-buffer-hacked)
+
+(defun org-roam-fontify-like-in-org-mode (s)
+  "Fontify string S like in Org mode.
+Like `org-fontify-like-in-org-mode', but supports `org-ref'."
+  ;; NOTE: pretend that the temporary buffer created by `org-fontify-like-in-org-mode' to
+  ;; fontify a `cite:' reference has been hacked by org-ref, whatever that means;
+  ;;
+  ;; `org-ref-cite-link-face-fn', which is used to supply a face for `cite:' links, calls
+  ;; `hack-dir-local-variables' rationalizing that `bibtex-completion' would throw some warnings
+  ;; otherwise.  This doesn't seem to be the case and calling this function just before
+  ;; `org-font-lock-ensure' (alias of `font-lock-ensure') actually instead of fixing the alleged
+  ;; warnings messes the things so badly that `font-lock-ensure' crashes with error and doesn't let
+  ;; org-roam to proceed further. I don't know what's happening there exactly but disabling this hackery
+  ;; fixes the crashing.  Fortunately, org-ref provides the `org-ref-buffer-hacked' switch, which we use
+  ;; here to make it believe that the buffer was hacked.
+  ;;
+  ;; This is a workaround for `cite:' links and does not have any effect on other ref types.
+  ;;
+  ;; `org-ref-buffer-hacked' is a buffer-local variable, therefore we inline
+  ;; `org-fontify-like-in-org-mode' here
+  (with-temp-buffer
+    (insert s)
+    (let ((org-ref-buffer-hacked t))
+      (org-mode)
+      (org-font-lock-ensure)
+      (buffer-string))))
+
+(defun org-roam-set-header-line-format (string)
+  "Set the header-line using STRING.
+If the `face' property of any part of STRING is already set, then
+that takes precedence. Also pad the left side of STRING so that
+it aligns with the text area."
+  (setq-local header-line-format
+              (concat (propertize " " 'display '(space :align-to 0))
+                      string)))
+
+;;; Keywords
+(defun org-roam--get-keyword (name &optional bound)
+  "Return keyword property NAME in current buffer.
+If BOUND, scan up to BOUND bytes of the buffer."
+  (save-excursion
+    (let ((re (format "^#\\+%s:[ \t]*\\([^\n]+\\)" (upcase name))))
+      (goto-char (point-min))
+      (when (re-search-forward re bound t)
+        (buffer-substring-no-properties (match-beginning 1) (match-end 1))))))
+
+(defun org-roam-get-keyword (name &optional file bound)
+  "Return keyword property NAME from an org FILE.
+FILE defaults to current file.
+Only scans up to BOUND bytes of the document."
+  (unless bound
+    (setq bound 1024))
+  (if file
+      (with-temp-buffer
+        (insert-file-contents-literally file nil 0 bound)
+        (org-roam--get-keyword name))
+    (org-roam--get-keyword name bound)))
+
+;;; Shielding regions
+(defface org-roam-shielded
+  '((t :inherit (warning)))
+  "Face for regions that are shielded (marked as read-only).
+This face is used on the region target by org-roam-insertion
+during an `org-roam-capture'."
+  :group 'org-roam-faces)
+
+(defun org-roam-shield-region (beg end)
+  "Shield region against modifications.
+BEG and END are markers for the beginning and end regions.
+REGION must be a cons-cell containing the marker to the region
+beginning and maximum values."
+  (add-text-properties beg end
+                       '(font-lock-face org-roam-shielded
+                                        read-only t)
+                       (marker-buffer beg)))
+
+(defun org-roam-unshield-region (beg end)
+  "Unshield the shielded REGION.
+BEG and END are markers for the beginning and end regions."
+  (let ((inhibit-read-only t))
+    (remove-text-properties beg end
+                            '(font-lock-face org-roam-shielded
+                                             read-only t)
+                            (marker-buffer beg))))
+
+;;; Formatting
+(defun org-roam-format (template replacer)
+  "Format TEMPLATE with the function REPLACER.
+REPLACER takes an argument of the format variable and optionally
+an extra argument which is the EXTRA value from the call to
+`org-roam-format'.
+Adapted from `s-format'."
+  (let ((saved-match-data (match-data)))
+    (unwind-protect
+        (replace-regexp-in-string
+         "\\${\\([^}]+\\)}"
+         (lambda (md)
+           (let ((var (match-string 1 md))
+                 (replacer-match-data (match-data)))
+             (unwind-protect
+                 (let ((v (progn
+                            (set-match-data saved-match-data)
+                            (funcall replacer var))))
+                   (if v (format "%s" v) (signal 'org-roam-format-resolve md)))
+               (set-match-data replacer-match-data)))) template
+         ;; Need literal to make sure it works
+         t t)
+      (set-match-data saved-match-data))))
+
+(defvar org-roam--cached-display-format nil)
+
+(defun org-roam--process-display-format (format)
+  "Pre-calculate minimal widths needed by the FORMAT string."
+  (or org-roam--cached-display-format
+      (setq org-roam--cached-display-format
+            (let* ((fields-width 0)
+                   (string-width
+                    (string-width
+                     (org-roam-format
+                      format
+                      (lambda (field)
+                        (setq fields-width
+                              (+ fields-width
+                                 (string-to-number
+                                  (or (cadr (split-string field ":"))
+                                      "")))))))))
+              (cons format (+ fields-width string-width))))))
+
+;;; for org-roam-demote-entire-buffer in org-roam-refile.el
+(defun org-roam--file-keyword-get (keyword)
+  "Pull a KEYWORD setting from the top of the file.
+
+Keyword must be specified in ALL CAPS."
+  (cadr (assoc keyword
+               (org-collect-keywords (list keyword)))))
+
+(defun org-roam--file-keyword-kill (keyword)
+  "Erase KEYWORD setting line from the top of the file."
+  (let ((case-fold-search t))
+    (org-with-point-at 1
+      (when (re-search-forward (concat "^#\\+" keyword ":") nil t)
+        (beginning-of-line)
+        (delete-region (point) (line-end-position))
+        (delete-char 1)))))
+
+(defun org-roam--kill-empty-buffer ()
+  "If the source buffer has been emptied, kill it.
+
+If the buffer is associated with a file, delete the file.
+
+If the buffer is associated with an in-process capture operation, abort the operation."
+  (when (eq (buffer-size) 0)
+    (if (buffer-file-name)
+        (delete-file (buffer-file-name)))
+    (set-buffer-modified-p nil)
+    (when (and org-capture-mode
+               (buffer-base-buffer (current-buffer)))
+      (org-capture-kill))
+    (kill-buffer (current-buffer))))
+
+;;; Diagnostics
+;;;###autoload
+(defun org-roam-version (&optional message)
+  "Return `org-roam' version.
+Interactively, or when MESSAGE is non-nil, show in the echo area."
+  (interactive)
+  (let* ((version
+          (with-temp-buffer
+            (insert-file-contents-literally (locate-library "org-roam.el"))
+            (goto-char (point-min))
+            (save-match-data
+              (if (re-search-forward "\\(?:;; Version: \\([^z-a]*?$\\)\\)" nil nil)
+                  (substring-no-properties (match-string 1))
+                "N/A")))))
+    (if (or message (called-interactively-p 'interactive))
+        (message "%s" version)
+      version)))
+
+;;;###autoload
+(defun org-roam-diagnostics ()
+  "Collect and print info for `org-roam' issues."
+  (interactive)
+  (with-current-buffer (switch-to-buffer-other-window (get-buffer-create "*org-roam diagnostics*"))
+    (erase-buffer)
+    (insert (propertize "Copy info below this line into issue:\n" 'face '(:weight bold)))
+    (insert (format "- Emacs: %s\n" (emacs-version)))
+    (insert (format "- Framework: %s\n"
+                    (condition-case _
+                        (completing-read "I'm using the following Emacs framework:"
+                                         '("Doom" "Spacemacs" "N/A" "I don't know"))
+                      (quit "N/A"))))
+    (insert (format "- Org: %s\n" (org-version nil 'full)))
+    (insert (format "- Org-roam: %s" (org-roam-version)))))
+
+(provide 'org-roam-utils)
+;;; org-roam-utils.el ends here

tests/roam-files/alias.org

@@ -1,2 +0,0 @@
-#+ROAM_ALIAS: "a1" "a 2"
-#+TITLE: t1

tests/roam-files/bar.org

@@ -1,3 +1,6 @@
-#+TITLE: Bar
+:PROPERTIES:
+:ID:       440795d0-70c1-4165-993d-aebd5eef7a24
+:END:
+#+title: Bar
 
-This is file bar. Bar links to [[file:nested/bar.org][Nested Bar]].
+[[id:884b2341-b7fe-434d-848c-5282c0727861][Foo]]

tests/roam-files/foo.org

@@ -1,8 +1,4 @@
-#+TITLE: Foo
+:PROPERTIES:
-
+:ID:       884b2341-b7fe-434d-848c-5282c0727861
-This is the foo file. It contains a link to [[file:bar.org][Bar]].
+:END:
-
+#+title: Foo
-To make the tests more robust, here are some arbitrary links:
-
-- [[https:google.com][Google]]
-- [[mailto:foo@john.com][mail to foo]]

tests/roam-files/nested/bar.org

@@ -1,3 +0,0 @@
-#+TITLE: Nested Bar
-
-This file is nested, 1 level deeper. It links to both [[file:../foo.org][Foo]] and [[file:foo.org][Nested Foo]].

tests/roam-files/nested/foo.org

@@ -1,3 +0,0 @@
-#+TITLE: Nested Foo
-
-This file has no links.

tests/roam-files/no-title.org

@@ -1,3 +0,0 @@
-no title in this file :O
-
-links to itself, with no title: [[file:no-title.org][no-title]]

tests/roam-files/unlinked.org

@@ -1,3 +0,0 @@
-#+TITLE: Unlinked
-
-Nothing links here :(

tests/roam-files/web_ref.org

@@ -1 +0,0 @@
-#+ROAM_KEY: https://google.com/

tests/test-org-roam.el

@@ -1,9 +1,9 @@
-;;; test-org-roam.el --- Tests for org-roam -*- lexical-binding: t; -*-
+;;; test-org-roam.el --- Tests for Org-roam -*- lexical-binding: t; -*-
 
 ;; Copyright (C) 2020 Jethro Kuan
 
 ;; Author: Jethro Kuan <jethrokuan95@gmail.com>
-;; Package-Requires: ((buttercup) (with-simulated-input))
+;; Package-Requires: ((buttercup))
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -19,291 +19,35 @@
 ;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 ;;; Commentary:
-
-;;
-
 ;;; Code:
 
-;;;; Requirements
-
 (require 'buttercup)
-(require 'with-simulated-input)
 (require 'org-roam)
-(require 'dash)
 
-(defun org-roam-test-abs-path (file-path)
+(describe "org-roam-db-sync"
-  "Get absolute FILE-PATH from `org-roam-directory'."
+  (before-all
-  (file-truename (expand-file-name file-path org-roam-directory)))
+    (setq org-roam-directory (expand-file-name "tests/roam-files")
+          org-roam-db-location (expand-file-name "org-roam.db" temporary-file-directory))
+    (org-roam-setup))
 
-(defun org-roam-test-find-new-file (path)
+  (after-all
-  "PATH."
+    (org-roam-teardown)
-  (let ((path (org-roam-test-abs-path path)))
+    (delete-file org-roam-db-location))
-    (make-directory (file-name-directory path) t)
-    (find-file path)))
 
-(defvar org-roam-test-directory (file-truename (concat default-directory "tests/roam-files"))
+  (it "has the correct number of files"
-  "Directory containing org-roam test org files.")
+    (expect (caar (org-roam-db-query [:select (funcall count) :from files]))
-
-(defun org-roam-test-init ()
-  "."
-  (org-roam-db--close)
-  (let ((original-dir org-roam-test-directory)
-        (new-dir (expand-file-name (make-temp-name "org-roam") temporary-file-directory)))
-    (copy-directory original-dir new-dir)
-    (setq org-roam-directory new-dir)
-    (org-roam-mode +1)))
-
-;;; Tests
-(describe "org-roam-db-build-cache"
-  (it "initializes correctly"
-    (org-roam-test-init)
-    (org-roam-db-build-cache)
-
-    ;; Cache
-    (expect (caar (org-roam-db-query [:select (funcall count) :from files])) :to-be 8)
-    (expect (caar (org-roam-db-query [:select (funcall count) :from links])) :to-be 5)
-    (expect (caar (org-roam-db-query [:select (funcall count) :from titles])) :to-be 8)
-    (expect (caar (org-roam-db-query [:select (funcall count) :from titles
-                                      :where titles :is-null])) :to-be 2)
-    (expect (caar (org-roam-db-query [:select (funcall count) :from refs])) :to-be 1)
-
-    ;; TODO Test files
-
-    ;; Links
-    (expect (caar (org-roam-db-query [:select (funcall count) :from links
-                                      :where (= from $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 1)
-    (expect (caar (org-roam-db-query [:select (funcall count) :from links
-                                      :where (= from $s1)]
-                                     (org-roam-test-abs-path "nested/bar.org"))) :to-be 2)
-
-    ;; Links -- File-to
-    (expect (caar (org-roam-db-query [:select (funcall count) :from links
-                                      :where (= to $s1)]
-                                     (org-roam-test-abs-path "nested/foo.org"))) :to-be 1)
-    (expect (caar (org-roam-db-query [:select (funcall count) :from links
-                                      :where (= to $s1)]
-                                     (org-roam-test-abs-path "nested/bar.org"))) :to-be 1)
-    (expect (caar (org-roam-db-query [:select (funcall count) :from links
-                                      :where (= to $s1)]
-                                     (org-roam-test-abs-path "unlinked.org"))) :to-be 0)
-    ;; TODO Test titles
-    (expect (org-roam-db-query [:select * :from titles])
-            :to-have-same-items-as
-            (list (list (org-roam-test-abs-path "alias.org")
-                        (list "t1" "a1" "a 2"))
-                  (list (org-roam-test-abs-path "bar.org")
-                        (list "Bar"))
-                  (list (org-roam-test-abs-path "foo.org")
-                        (list "Foo"))
-                  (list (org-roam-test-abs-path "nested/bar.org")
-                        (list "Nested Bar"))
-                  (list (org-roam-test-abs-path "nested/foo.org")
-                        (list "Nested Foo"))
-                  (list (org-roam-test-abs-path "no-title.org") nil)
-                  (list (org-roam-test-abs-path "web_ref.org") nil)
-                  (list (org-roam-test-abs-path "unlinked.org")
-                        (list "Unlinked"))))
-
-    (expect (org-roam-db-query [:select * :from refs])
-            :to-have-same-items-as
-            (list (list "https://google.com/" (org-roam-test-abs-path "web_ref.org"))))
-
-    ;; Expect rebuilds to be really quick (nothing changed)
-    (expect (org-roam-db-build-cache)
             :to-equal
-            (list :files 0 :links 0 :titles 0 :refs 0 :deleted 0))))
+            2))
 
-(describe "org-roam-insert"
+  (it "has the correct number of nodes"
-  (before-each
+    (expect (caar (org-roam-db-query [:select (funcall count) :from nodes]))
-    (org-roam-test-init)
-    (org-roam-db--clear)
-    (org-roam-db-build-cache))
-
-  (it "temp1 -> foo"
-    (let ((buf (org-roam-test-find-new-file "temp1.org")))
-      (with-current-buffer buf
-        (with-simulated-input
-         "Foo RET"
-         (org-roam-insert nil))))
-    (expect (buffer-string) :to-match (regexp-quote "file:foo.org")))
-
-  (it "temp2 -> nested/foo"
-    (let ((buf (org-roam-test-find-new-file "temp2.org")))
-      (with-current-buffer buf
-        (with-simulated-input
-         "Nested SPC Foo RET"
-         (org-roam-insert nil))))
-    (expect (buffer-string) :to-match (regexp-quote "file:nested/foo.org")))
-
-  (it "nested/temp3 -> foo"
-    (let ((buf (org-roam-test-find-new-file "nested/temp3.org")))
-      (with-current-buffer buf
-        (with-simulated-input
-         "Foo RET"
-         (org-roam-insert nil))))
-    (expect (buffer-string) :to-match (regexp-quote "file:../foo.org")))
-
-  (it "a/b/temp4 -> nested/foo"
-    (let ((buf (org-roam-test-find-new-file "a/b/temp4.org")))
-      (with-current-buffer buf
-        (with-simulated-input
-         "Nested SPC Foo RET"
-         (org-roam-insert nil))))
-    (expect (buffer-string) :to-match (regexp-quote "file:../../nested/foo.org"))))
-
-(describe "rename file updates cache"
-  (before-each
-    (org-roam-test-init)
-    (org-roam-db--clear)
-    (org-roam-db-build-cache))
-
-  (it "foo -> new_foo"
-    (rename-file (org-roam-test-abs-path "foo.org")
-                 (org-roam-test-abs-path "new_foo.org"))
-    ;; Cache should be cleared of old file
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from titles
-                                      :where (= file $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 0)
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from refs
-                                      :where (= file $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 0)
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from links
-                                      :where (= from $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 0)
-
-    ;; Cache should be updated
-    (expect (org-roam-db-query [:select [to]
-                                :from links
-                                :where (= from $s1)]
-                               (org-roam-test-abs-path "new_foo.org"))
-            :to-have-same-items-as
-            (list (list (org-roam-test-abs-path "bar.org"))))
-    (expect (org-roam-db-query [:select [from]
-                                :from links
-                                :where (= to $s1)]
-                               (org-roam-test-abs-path "new_foo.org"))
-            :to-have-same-items-as
-            (list (list (org-roam-test-abs-path "nested/bar.org"))))
-
-    ;; Links are updated
-    (expect (with-temp-buffer
-              (insert-file-contents (org-roam-test-abs-path "nested/bar.org"))
-              (buffer-string))
-            :to-match
-            (regexp-quote "[[file:../new_foo.org][Foo]]")))
-
-  (it "foo -> foo with spaces"
-    (rename-file (org-roam-test-abs-path "foo.org")
-                 (org-roam-test-abs-path "foo with spaces.org"))
-    ;; Cache should be cleared of old file
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from titles
-                                      :where (= file $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 0)
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from refs
-                                      :where (= file $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 0)
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from links
-                                      :where (= from $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 0)
-
-    ;; Cache should be updated
-    (expect (org-roam-db-query [:select [to]
-                                :from links
-                                :where (= from $s1)]
-                               (org-roam-test-abs-path "foo with spaces.org"))
-            :to-have-same-items-as
-            (list (list (org-roam-test-abs-path "bar.org"))))
-    (expect (org-roam-db-query [:select [from]
-                                :from links
-                                :where (= to $s1)]
-                               (org-roam-test-abs-path "foo with spaces.org"))
-            :to-have-same-items-as
-            (list (list (org-roam-test-abs-path "nested/bar.org"))))
-
-    ;; Links are updated
-    (expect (with-temp-buffer
-              (insert-file-contents (org-roam-test-abs-path "nested/bar.org"))
-              (buffer-string))
-            :to-match
-            (regexp-quote "[[file:../foo with spaces.org][Foo]]")))
-
-  (it "no-title -> meaningful-title"
-    (rename-file (org-roam-test-abs-path "no-title.org")
-                 (org-roam-test-abs-path "meaningful-title.org"))
-    ;; File has no forward links
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from links
-                                      :where (= from $s1)]
-                                     (org-roam-test-abs-path "no-title.org"))) :to-be 0)
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from links
-                                      :where (= from $s1)]
-                                     (org-roam-test-abs-path "meaningful-title.org"))) :to-be 1)
-
-    ;; Links are updated with the appropriate name
-    (expect (with-temp-buffer
-              (insert-file-contents (org-roam-test-abs-path "meaningful-title.org"))
-              (buffer-string))
-            :to-match
-            (regexp-quote "[[file:meaningful-title.org][meaningful-title]]")))
-
-  (it "web_ref -> hello"
-    (expect (org-roam-db-query
-             [:select [file] :from refs
-              :where (= ref $s1)]
-             "https://google.com/")
             :to-equal
-            (list (list (org-roam-test-abs-path "web_ref.org"))))
+            2))
-    (rename-file (org-roam-test-abs-path "web_ref.org")
-                 (org-roam-test-abs-path "hello.org"))
-    (expect (org-roam-db-query
-             [:select [file] :from refs
-              :where (= ref $s1)]
-             "https://google.com/")
-            :to-equal (list (list (org-roam-test-abs-path "hello.org"))))
-    (expect (caar (org-roam-db-query
-                   [:select [ref] :from refs
-                    :where (= file $s1)]
-                   (org-roam-test-abs-path "web_ref.org")))
-            :to-equal nil)))
 
-(describe "delete file updates cache"
+  (it "has the correct number of links"
-  (before-each
+    (expect (caar (org-roam-db-query [:select (funcall count) :from links]))
-    (org-roam-test-init)
+            :to-equal
-    (org-roam-db--clear)
+            1)))
-    (org-roam-db-build-cache)
-    (sleep-for 1))
-
-  (it "delete foo"
-    (delete-file (org-roam-test-abs-path "foo.org"))
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from titles
-                                      :where (= file $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 0)
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from refs
-                                      :where (= file $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 0)
-    (expect (caar (org-roam-db-query [:select (funcall count)
-                                      :from links
-                                      :where (= from $s1)]
-                                     (org-roam-test-abs-path "foo.org"))) :to-be 0))
-
-  (it "delete web_ref"
-    (expect (org-roam-db-query [:select * :from refs])
-            :to-have-same-items-as
-            (list (list "https://google.com/" (org-roam-test-abs-path "web_ref.org"))))
-    (delete-file (org-roam-test-abs-path "web_ref.org"))
-    (expect (org-roam-db-query [:select * :from refs])
-            :to-have-same-items-as
-            (list))))
 
 (provide 'test-org-roam)