mirror of
https://github.com/org-roam/org-roam
synced 2025-08-03 12:27:23 -05:00
Compare commits
1 Commits
Author | SHA1 | Date | |
---|---|---|---|
c23bca69f8 |
@ -1,12 +1,6 @@
|
|||||||
|
;;; Directory Local Variables
|
||||||
|
;;; For more information see (info "(emacs) Directory Variables")
|
||||||
|
|
||||||
((emacs-lisp-mode
|
((emacs-lisp-mode
|
||||||
(fill-column . 110)
|
(eval . (require 'org-roam-dev))
|
||||||
(indent-tabs-mode . nil)
|
(eval . (org-roam-dev-mode))))
|
||||||
(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)
|
|
||||||
(org-roam-with-file . 2)))))
|
|
||||||
|
34
.github/workflows/test.yml
vendored
34
.github/workflows/test.yml
vendored
@ -34,28 +34,36 @@ jobs:
|
|||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
emacs_version:
|
emacs_version:
|
||||||
- 27.1
|
|
||||||
- snapshot
|
- snapshot
|
||||||
steps:
|
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: Install Eldev
|
- name: Initialize sandbox
|
||||||
run: curl -fsSL https://raw.github.com/doublep/eldev/master/webinstall/github-eldev | sh
|
run: |
|
||||||
|
SANDBOX_DIR=$(mktemp -d) || exit 1
|
||||||
|
echo ::set-env name=SANDBOX_DIR::$SANDBOX_DIR
|
||||||
|
./makem.sh -vv --sandbox $SANDBOX_DIR --install-deps --install-linters
|
||||||
|
|
||||||
- name: Install dependencies
|
# The "all" rule is not used, because it treats compilation warnings
|
||||||
run: make prepare
|
# as failures, so linting and testing are run as separate steps.
|
||||||
|
|
||||||
- name: Lint
|
# org-roam-compat is excluded from linting because it contains
|
||||||
run: make lint
|
# symbols/aliases from other packages
|
||||||
|
- name: Lint
|
||||||
|
continue-on-error: false
|
||||||
|
run: ./makem.sh -vv --sandbox $SANDBOX_DIR --exclude org-roam-compat.el 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:
|
# Local Variables:
|
||||||
# eval: (outline-minor-mode)
|
# eval: (outline-minor-mode)
|
||||||
# End:
|
# End:
|
||||||
|
3
.gitignore
vendored
3
.gitignore
vendored
@ -12,5 +12,4 @@
|
|||||||
/doc/mimetype
|
/doc/mimetype
|
||||||
/doc/stats/
|
/doc/stats/
|
||||||
/config.mk
|
/config.mk
|
||||||
/doc/manual.html
|
/doc/manual/
|
||||||
/.eldev/
|
|
||||||
|
8
.readthedocs.yml
Normal file
8
.readthedocs.yml
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
version: 2
|
||||||
|
mkdocs:
|
||||||
|
configuration: mkdocs.yml
|
||||||
|
formats: all
|
||||||
|
python:
|
||||||
|
version: 3.7
|
||||||
|
install:
|
||||||
|
- requirements: doc/requirements.txt
|
89
CHANGELOG.md
89
CHANGELOG.md
@ -1,100 +1,16 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## 1.2.4 (TBD)
|
## 1.2.2 (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
|
|
||||||
|
|
||||||
### 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`
|
|
||||||
|
|
||||||
## 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
|
### 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
|
### 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`
|
- [#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
|
- [#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
|
### 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)
|
## 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.
|
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.
|
||||||
@ -105,11 +21,9 @@ We also added some new features that had been a long time coming:
|
|||||||
2. We now support nested captures, which is crucial for `org-roam-protocol` (#966)
|
2. We now support nested captures, which is crucial for `org-roam-protocol` (#966)
|
||||||
|
|
||||||
### Breaking Changes
|
### 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.
|
- [#908](https://github.com/org-roam/org-roam/pull/908) Normalized titles in database. May break external packages that rely on unnormalized titles.
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- [#814](https://github.com/org-roam/org-roam/pull/814) Implement `org-roam-insert-immediate`
|
- [#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`.
|
- [#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`
|
- [#839](https://github.com/org-roam/org-roam/pull/839) Return selected file from `org-roam-insert`
|
||||||
@ -151,7 +65,6 @@ We also add `org-roam-unlinked-references`, which naively finds text that could
|
|||||||
- [#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
|
- [#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
|
### 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
|
- [#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
|
- [#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
|
- [#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
|
||||||
|
29
Eldev
29
Eldev
@ -1,29 +0,0 @@
|
|||||||
; -*- 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)))
|
|
73
Makefile
73
Makefile
@ -1,29 +1,70 @@
|
|||||||
.PHONY: clean
|
# * makem.sh/Makefile --- Script to aid building and testing Emacs Lisp packages
|
||||||
clean:
|
|
||||||
eldev clean all
|
|
||||||
|
|
||||||
.PHONY: prepare
|
# This Makefile is from the makem.sh repo: <https://github.com/alphapapa/makem.sh>.
|
||||||
prepare:
|
|
||||||
eldev -C --unstable -p -dtT prepare
|
|
||||||
|
|
||||||
.PHONY: lint
|
# * Arguments
|
||||||
lint:
|
|
||||||
eldev -C --unstable -T lint
|
|
||||||
|
|
||||||
.PHONY: test
|
# For consistency, we use only var=val options, not hyphen-prefixed options.
|
||||||
test:
|
|
||||||
eldev -C --unstable -T test
|
# NOTE: I don't like duplicating the arguments here and in makem.sh,
|
||||||
|
# but I haven't been able to find a way to pass arguments which
|
||||||
|
# conflict with Make's own arguments through Make to the script.
|
||||||
|
# Using -- doesn't seem to do it.
|
||||||
|
|
||||||
|
ifdef install-deps
|
||||||
|
INSTALL_DEPS = "--install-deps"
|
||||||
|
endif
|
||||||
|
ifdef install-linters
|
||||||
|
INSTALL_LINTERS = "--install-linters"
|
||||||
|
endif
|
||||||
|
|
||||||
|
ifdef sandbox
|
||||||
|
ifeq ($(sandbox), t)
|
||||||
|
SANDBOX = --sandbox
|
||||||
|
else
|
||||||
|
SANDBOX = --sandbox $(sandbox)
|
||||||
|
endif
|
||||||
|
endif
|
||||||
|
|
||||||
|
ifdef debug
|
||||||
|
DEBUG = "--debug"
|
||||||
|
endif
|
||||||
|
|
||||||
|
# ** Verbosity
|
||||||
|
|
||||||
|
# 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)
|
||||||
|
|
||||||
docs:
|
docs:
|
||||||
make -C doc all
|
@$(MAKE) -C doc all
|
||||||
|
|
||||||
html:
|
html:
|
||||||
make -C doc html-dir
|
@$(MAKE) -C doc html-dir
|
||||||
|
|
||||||
install: install-docs
|
install: install-docs
|
||||||
|
|
||||||
install-docs: docs
|
install-docs: docs
|
||||||
make -C doc install-docs
|
@$(MAKE) -C doc install-docs
|
||||||
|
|
||||||
install-info: info
|
install-info: info
|
||||||
make -C doc install-info
|
@$(MAKE) -C doc install-info
|
||||||
|
118
README.md
118
README.md
@ -1,35 +1,47 @@
|
|||||||
# Org-roam [![GitHub Release][release-badge]][release] [![MELPA][melpa-badge]][melpa] [![License GPL 3][gpl3-badge]][gpl3]
|
[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
[](https://img.shields.io/github/v/release/org-roam/org-roam)
|
||||||
|
[](https://melpa.org/#/org-roam)
|
||||||
|
|
||||||
<img src="https://www.orgroam.com/img/logo.svg" align="right" alt="Org-roam Logo" width="240">
|
## Synopsis
|
||||||
|
|
||||||
Org-roam is a plain-text knowledge management system. It brings some of
|
> **NOTE:** Org-roam builds upon Emacs and Org-mode, both of which are intricate
|
||||||
[Roam's][roamresearch] more powerful features into the [Org-mode][org]
|
> tools that require time investment for mastery. This makes Org-roam less
|
||||||
ecosystem.
|
> friendly for beginners, but extremely powerful for those familiar with the
|
||||||
|
> ecosystem, or willing to invest effort in it.
|
||||||
|
|
||||||
Org-roam borrows principles from the Zettelkasten method, providing a solution
|
Org-roam is a [Roam][roamresearch] replica built on top of the
|
||||||
for non-hierarchical note-taking. It should also work as a plug-and-play
|
all-powerful [Org-mode][org].
|
||||||
solution for anyone already using Org-mode for their personal wiki.
|
|
||||||
|
|
||||||
- **Private and Secure**: Edit your personal wiki completely offline, entirely
|
Org-roam is a solution for effortless non-hierarchical note-taking
|
||||||
in your control. Encrypt your notes with GPG. Take lasting notes in
|
with Org-mode. With Org-roam, notes flow naturally, making note-taking
|
||||||
plain-text.
|
fun and easy. Org-roam should also work as a plug-and-play solution
|
||||||
- **Networked Thought**: Connect notes and thoughts together with ease using
|
for anyone already using Org-mode for their personal wiki.
|
||||||
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.
|
|
||||||
|
|
||||||
<p align="center">
|
Org-roam aims to implement the core features of Roam, leveraging the
|
||||||
<img src="https://www.orgroam.com/img/screenshot.png" alt="Org-roam Screenshot" width="738">
|
mature ecosystem around Org-mode where possible. Eventually, we hope
|
||||||
</p>
|
to further introduce features enabled by the Emacs ecosystem.
|
||||||
|
|
||||||
|
[@technovangelist](https://github.com/technovangelist/) has produced a video
|
||||||
|
describing Org-roam and the concepts behind it:
|
||||||
|
|
||||||
|
[](http://www.youtube.com/watch?v=Lg61ocfxk3c "Making Connections in your Notes")
|
||||||
|
|
||||||
|
Important links:
|
||||||
|
|
||||||
- **[Documentation][docs]**
|
- **[Documentation][docs]**
|
||||||
- **[Discourse][discourse]**
|
- **[Discourse][discourse]**
|
||||||
- **[Slack][slack]**
|
- **[Slack][slack]**
|
||||||
- **[Frequently Asked Questions][faq]**
|
|
||||||
- **[Changelog](CHANGELOG.md)**
|
## A Preview
|
||||||
|
|
||||||
|
Here's a screencast of Org-roam. The `org-roam-buffer` (window on the
|
||||||
|
right) shows backlinks for the active Org-roam buffer (window on the
|
||||||
|
left), 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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@ -39,7 +51,7 @@ You can install `org-roam` using `package.el`:
|
|||||||
M-x package-install RET org-roam RET
|
M-x package-install RET org-roam RET
|
||||||
```
|
```
|
||||||
|
|
||||||
Here's a sample configuration with `use-package`:
|
Here's a sample configuration with using `use-package`:
|
||||||
|
|
||||||
```emacs-lisp
|
```emacs-lisp
|
||||||
(use-package org-roam
|
(use-package org-roam
|
||||||
@ -51,35 +63,49 @@ Here's a sample configuration with `use-package`:
|
|||||||
:bind (:map org-roam-mode-map
|
:bind (:map org-roam-mode-map
|
||||||
(("C-c n l" . org-roam)
|
(("C-c n l" . org-roam)
|
||||||
("C-c n f" . org-roam-find-file)
|
("C-c n f" . org-roam-find-file)
|
||||||
("C-c n g" . org-roam-graph))
|
("C-c n g" . org-roam-graph-show))
|
||||||
:map org-mode-map
|
:map org-mode-map
|
||||||
(("C-c n i" . org-roam-insert))))
|
(("C-c n i" . org-roam-insert))
|
||||||
|
(("C-c n I" . org-roam-insert-immediate))))
|
||||||
```
|
```
|
||||||
|
|
||||||
Org-roam requires sqlite to function. Org-roam optionally uses Graphviz for
|
`org-roam-graph` by default expects to find the `dot` executable
|
||||||
graph-related functionality. It is recommended to install PCRE-enabled ripgrep
|
from the `graphviz` package in the `exec-path`.
|
||||||
for better performance and extended functionality.
|
Ensure `graphviz` is installed and found if you want to use this
|
||||||
|
feature or customize your configuration for `org-roam-graph` to use a
|
||||||
|
different tool.
|
||||||
|
|
||||||
|
For more detailed installation and configuration instructions (including for
|
||||||
|
Doom and Spacemacs users), please see [the
|
||||||
|
documentation][docs].
|
||||||
|
|
||||||
|
## Frequently-asked Questions
|
||||||
|
|
||||||
|
Q: How do I create a note whose title already matches one of the candidates (e.g. creating `bar` when `barricade` already exists)?
|
||||||
|
|
||||||
|
A: With `ivy`, you need to press `C-M-j` to use the current input instead of the nearest candidate. (Source: [`ivy`’s
|
||||||
|
FAQ](https://github.com/abo-abo/swiper#frequently-asked-questions))
|
||||||
|
|
||||||
## Getting Help
|
## Getting Help
|
||||||
|
|
||||||
Before creating a new topic/issue, please be mindful of our time and ensure that
|
Before creating a new topic/issue, please be mindful of our time and ensure
|
||||||
it has not already been addressed on [GitHub][issues] or on
|
that it has not already been addressed on
|
||||||
|
[GitHub][issues] or on
|
||||||
[Discourse][discourse].
|
[Discourse][discourse].
|
||||||
|
|
||||||
- If you are new to Emacs and have problem setting up Org-roam, please ask your
|
- If you are new to Emacs and have problem setting up Org-roam, please ask your question on [Slack, channel #how-do-i][slack].
|
||||||
question on [Slack, channel #how-do-i][slack].
|
- For quick questions, please ask them on [Slack, channel #troubleshooting][slack].
|
||||||
- For quick questions, please ask them on [Slack, channel
|
- If something is not working as it should, or if you would like to suggest a new feature, please [create a new issue][issues].
|
||||||
#troubleshooting][slack].
|
- 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.
|
||||||
- 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
|
## Knowledge Bases using Org-roam
|
||||||
|
|
||||||
- [Jethro Kuan](https://braindump.jethro.dev/)
|
- [Jethro Kuan](https://braindump.jethro.dev/)
|
||||||
([Source](https://github.com/jethrokuan/braindump/tree/master/org))
|
([Source](https://github.com/jethrokuan/braindump/tree/master/org))
|
||||||
- [Alexey Shmalko](https://braindump.rasen.dev/)
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
A changelog is being maintained [here](CHANGELOG.md)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
@ -90,18 +116,12 @@ request. Please also see [CONTRIBUTING.md](.github/CONTRIBUTING.md).
|
|||||||
## License
|
## License
|
||||||
|
|
||||||
Copyright © Jethro Kuan and contributors. Distributed under the GNU
|
Copyright © Jethro Kuan and contributors. Distributed under the GNU
|
||||||
General Public License, Version 3.
|
General Public License, Version 3
|
||||||
|
|
||||||
[roamresearch]: https://www.roamresearch.com/
|
[roamresearch]: https://www.roamresearch.com/
|
||||||
[org]: https://orgmode.org/
|
[org]: https://orgmode.org/
|
||||||
[gpl3-badge]: https://img.shields.io/badge/license-GPL_3-green.svg
|
[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
|
||||||
[gpl3]: http://www.gnu.org/licenses/gpl-3.0.txt
|
[docs]: https://www.orgroam.com/manual/
|
||||||
[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/
|
[discourse]: https://org-roam.discourse.group/
|
||||||
[slack]: https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg
|
[slack]: https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg
|
||||||
[issues]: https://github.com/org-roam/org-roam/issues
|
[issues]: https://github.com/org-roam/org-roam/issues
|
||||||
[faq]: https://www.orgroam.com/manual.html#FAQ
|
|
||||||
|
@ -34,4 +34,4 @@ Contributors
|
|||||||
- Rafael Accácio Nogueira <raccacio@poli.ufrj.br>
|
- Rafael Accácio Nogueira <raccacio@poli.ufrj.br>
|
||||||
- Roland Coeurjoly <rolandcoeurjoly@gmail.com>
|
- Roland Coeurjoly <rolandcoeurjoly@gmail.com>
|
||||||
- Sayan <dit7ya@users.noreply.github.com>
|
- Sayan <dit7ya@users.noreply.github.com>
|
||||||
- Tim Quelch <tim@tquelch.com>
|
- Tim Quelch <tim@quelch.name>
|
||||||
|
@ -28,8 +28,11 @@ dir: org-roam.info
|
|||||||
@$(MAKEINFO) --html --no-split $(MANUAL_HTML_ARGS) $<
|
@$(MAKEINFO) --html --no-split $(MANUAL_HTML_ARGS) $<
|
||||||
|
|
||||||
html-dir:
|
html-dir:
|
||||||
@$(MAKEINFO) --html --no-split $(MANUAL_HTML_ARGS) org-roam.texi
|
@printf "Generating org-roam/*.html\n"
|
||||||
mv org-roam.html manual.html
|
@$(MAKEINFO) --html $(MANUAL_HTML_ARGS) org-roam.texi
|
||||||
|
mv org-roam manual
|
||||||
|
cp -r assets manual
|
||||||
|
cp -r images manual
|
||||||
|
|
||||||
%.pdf: %.texi
|
%.pdf: %.texi
|
||||||
@printf "Generating $@\n"
|
@printf "Generating $@\n"
|
||||||
|
@ -1,68 +1,442 @@
|
|||||||
|
/* Import Inter font */
|
||||||
|
/* More info at https://github.com/xz/fonts */
|
||||||
|
@import url("https://fonts.xz.style/serve/inter.css");
|
||||||
|
|
||||||
:root {
|
:root {
|
||||||
--border: #526980;
|
--nc-font-sans: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
|
||||||
--code: #007;
|
Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif,
|
||||||
|
"Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
|
||||||
|
--nc-font-mono: "Courier New", Courier, "Ubuntu Mono", "Liberation Mono",
|
||||||
|
monospace;
|
||||||
|
--nc-tx-1: #000000;
|
||||||
|
--nc-tx-2: #1a1a1a;
|
||||||
|
--nc-bg-1: #ffffff;
|
||||||
|
--nc-bg-2: #f6f8fa;
|
||||||
|
--nc-bg-3: #e5e7eb;
|
||||||
|
--nc-lk-1: #0070f3;
|
||||||
|
--nc-lk-2: #0366d6;
|
||||||
|
--nc-lk-tx: #ffffff;
|
||||||
|
--nc-ac-1: #79ffe1;
|
||||||
|
--nc-ac-tx: #0c4047;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
:root {
|
||||||
|
--nc-tx-1: #ffffff;
|
||||||
|
--nc-tx-2: #eeeeee;
|
||||||
|
--nc-bg-1: #000000;
|
||||||
|
--nc-bg-2: #111111;
|
||||||
|
--nc-bg-3: #222222;
|
||||||
|
--nc-lk-1: #3291ff;
|
||||||
|
--nc-lk-2: #0070f3;
|
||||||
|
--nc-lk-tx: #ffffff;
|
||||||
|
--nc-ac-1: #7928ca;
|
||||||
|
--nc-ac-tx: #ffffff;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
* {
|
||||||
|
/* Reset margins and padding */
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
address,
|
||||||
|
area,
|
||||||
|
article,
|
||||||
|
aside,
|
||||||
|
audio,
|
||||||
|
blockquote,
|
||||||
|
datalist,
|
||||||
|
details,
|
||||||
|
dl,
|
||||||
|
fieldset,
|
||||||
|
figure,
|
||||||
|
form,
|
||||||
|
input,
|
||||||
|
iframe,
|
||||||
|
img,
|
||||||
|
meter,
|
||||||
|
nav,
|
||||||
|
ol,
|
||||||
|
optgroup,
|
||||||
|
option,
|
||||||
|
output,
|
||||||
|
p,
|
||||||
|
pre,
|
||||||
|
progress,
|
||||||
|
ruby,
|
||||||
|
section,
|
||||||
|
table,
|
||||||
|
textarea,
|
||||||
|
ul,
|
||||||
|
video {
|
||||||
|
/* Margins for most elements */
|
||||||
|
margin-bottom: 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
html,
|
||||||
|
input,
|
||||||
|
select,
|
||||||
|
button {
|
||||||
|
/* Set body font family and some finicky elements */
|
||||||
|
font-family: var(--nc-font-sans);
|
||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
margin: 5ex 10ex;
|
/* Center body in page */
|
||||||
max-width: 80ex;
|
margin: 0 auto;
|
||||||
line-height: 1.5;
|
max-width: 750px;
|
||||||
font-family: sans-serif;
|
padding: 2rem;
|
||||||
|
border-radius: 6px;
|
||||||
|
overflow-x: hidden;
|
||||||
|
background: var(--nc-bg-1);
|
||||||
|
|
||||||
|
/* Main body text */
|
||||||
|
color: var(--nc-tx-2);
|
||||||
|
font-size: 1.03rem;
|
||||||
|
line-height: 1.5;
|
||||||
}
|
}
|
||||||
|
|
||||||
h1, h2, h3 {
|
::selection {
|
||||||
font-weight: normal;
|
/* Set background color for selected text */
|
||||||
|
background: var(--nc-ac-1);
|
||||||
|
color: var(--nc-ac-tx);
|
||||||
}
|
}
|
||||||
|
|
||||||
pre, code {
|
p {
|
||||||
font-family: x, monospace;
|
margin-bottom: 1rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
pre {
|
h1,
|
||||||
padding: 1ex;
|
h2,
|
||||||
background: #eee;
|
h3,
|
||||||
border: solid 1px #ddd;
|
h4,
|
||||||
min-width: 0;
|
h5,
|
||||||
font-size: 80%;
|
h6 {
|
||||||
overflow: auto;
|
line-height: 1;
|
||||||
|
color: var(--nc-tx-1);
|
||||||
|
padding-top: 0.875rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
code {
|
h1,
|
||||||
color: var(--code);
|
h2,
|
||||||
|
h3 {
|
||||||
|
color: var(--nc-tx-1);
|
||||||
|
padding-bottom: 2px;
|
||||||
|
margin-bottom: 8px;
|
||||||
|
border-bottom: 1px solid var(--nc-bg-2);
|
||||||
}
|
}
|
||||||
|
|
||||||
img {
|
h4,
|
||||||
max-width: 100%;
|
h5,
|
||||||
|
h6 {
|
||||||
|
margin-bottom: 0.3rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
table {
|
h1 {
|
||||||
border-collapse: collapse;
|
font-size: 2.25rem;
|
||||||
width: 100%;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pre.menu-comment {
|
h2 {
|
||||||
background: none;
|
font-size: 1.85rem;
|
||||||
border: none;
|
|
||||||
font-family: sans-serif;
|
|
||||||
padding: 0;
|
|
||||||
margin: 0;
|
|
||||||
font-size: 100%;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
thead {
|
h3 {
|
||||||
border-bottom: 1px solid var(--border);
|
font-size: 1.55rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
tfoot {
|
h4 {
|
||||||
border-top: 1px solid var(--border);
|
font-size: 1.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
h5 {
|
||||||
|
font-size: 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
h6 {
|
||||||
|
font-size: 0.875rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
a {
|
||||||
|
color: var(--nc-lk-1);
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
color: var(--nc-lk-2);
|
||||||
|
}
|
||||||
|
|
||||||
|
abbr:hover {
|
||||||
|
/* Set the '?' cursor while hovering an abbreviation */
|
||||||
|
cursor: help;
|
||||||
}
|
}
|
||||||
|
|
||||||
blockquote {
|
blockquote {
|
||||||
margin-left: 1rem;
|
padding: 1.5rem;
|
||||||
font-style: italic;
|
background: var(--nc-bg-2);
|
||||||
font-family: serif;
|
border-left: 5px solid var(--nc-bg-3);
|
||||||
border-left: 3px solid;
|
}
|
||||||
border-left-color: currentcolor;
|
|
||||||
border-color: var(--text-color);
|
abbr {
|
||||||
padding-left: 1em;
|
cursor: help;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote *:last-child {
|
||||||
|
padding-bottom: 0;
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
header {
|
||||||
|
background: var(--nc-bg-2);
|
||||||
|
border-bottom: 1px solid var(--nc-bg-3);
|
||||||
|
padding: 2rem 1.5rem;
|
||||||
|
|
||||||
|
/* This sets the right and left margins to cancel out the body's margins. It's width is still the same, but the background stretches across the page's width. */
|
||||||
|
|
||||||
|
margin: -2rem calc(0px - (50vw - 50%)) 2rem;
|
||||||
|
|
||||||
|
/* Shorthand for:
|
||||||
|
|
||||||
|
margin-top: -2rem;
|
||||||
|
margin-bottom: 2rem;
|
||||||
|
|
||||||
|
margin-left: calc(0px - (50vw - 50%));
|
||||||
|
margin-right: calc(0px - (50vw - 50%)); */
|
||||||
|
|
||||||
|
padding-left: calc(50vw - 50%);
|
||||||
|
padding-right: calc(50vw - 50%);
|
||||||
|
}
|
||||||
|
|
||||||
|
header h1,
|
||||||
|
header h2,
|
||||||
|
header h3 {
|
||||||
|
padding-bottom: 0;
|
||||||
|
border-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
header > *:first-child {
|
||||||
|
margin-top: 0;
|
||||||
|
padding-top: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
header > *:last-child {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.button,
|
||||||
|
button,
|
||||||
|
input[type="submit"],
|
||||||
|
input[type="reset"],
|
||||||
|
input[type="button"] {
|
||||||
|
font-size: 1rem;
|
||||||
|
display: inline-block;
|
||||||
|
padding: 6px 12px;
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
white-space: nowrap;
|
||||||
|
background: var(--nc-lk-1);
|
||||||
|
color: var(--nc-lk-tx);
|
||||||
|
border: 0;
|
||||||
|
border-radius: 4px;
|
||||||
|
box-sizing: border-box;
|
||||||
|
cursor: pointer;
|
||||||
|
color: var(--nc-lk-tx);
|
||||||
|
}
|
||||||
|
|
||||||
|
.button[disabled],
|
||||||
|
button[disabled],
|
||||||
|
input[type="submit"][disabled],
|
||||||
|
input[type="reset"][disabled],
|
||||||
|
input[type="button"][disabled] {
|
||||||
|
cursor: default;
|
||||||
|
opacity: 0.5;
|
||||||
|
|
||||||
|
/* Set the [X] cursor while hovering a disabled link */
|
||||||
|
cursor: not-allowed;
|
||||||
|
}
|
||||||
|
|
||||||
|
.button:focus,
|
||||||
|
.button:hover,
|
||||||
|
button:focus,
|
||||||
|
button:hover,
|
||||||
|
input[type="submit"]:focus,
|
||||||
|
input[type="submit"]:hover,
|
||||||
|
input[type="reset"]:focus,
|
||||||
|
input[type="reset"]:hover,
|
||||||
|
input[type="button"]:focus,
|
||||||
|
input[type="button"]:hover {
|
||||||
|
background: var(--nc-lk-2);
|
||||||
|
}
|
||||||
|
|
||||||
|
code,
|
||||||
|
pre,
|
||||||
|
kbd,
|
||||||
|
samp {
|
||||||
|
/* Set the font family for monospaced elements */
|
||||||
|
font-family: var(--nc-font-mono);
|
||||||
|
}
|
||||||
|
|
||||||
|
code,
|
||||||
|
samp,
|
||||||
|
kbd,
|
||||||
|
pre {
|
||||||
|
/* The main preformatted style. This is changed slightly across different cases. */
|
||||||
|
background: var(--nc-bg-2);
|
||||||
|
border: 1px solid var(--nc-bg-3);
|
||||||
|
border-radius: 4px;
|
||||||
|
padding: 3px 6px;
|
||||||
|
font-size: 0.9rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
kbd {
|
||||||
|
/* Makes the kbd element look like a keyboard key */
|
||||||
|
border-bottom: 3px solid var(--nc-bg-3);
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
padding: 1rem 1.4rem;
|
||||||
|
max-width: 100%;
|
||||||
|
overflow: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre code {
|
||||||
|
/* When <code> is in a <pre>, reset it's formatting to blend in */
|
||||||
|
background: inherit;
|
||||||
|
font-size: inherit;
|
||||||
|
color: inherit;
|
||||||
|
border: 0;
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
code pre {
|
||||||
|
/* When <pre> is in a <code>, reset it's formatting to blend in */
|
||||||
|
display: inline;
|
||||||
|
background: inherit;
|
||||||
|
font-size: inherit;
|
||||||
|
color: inherit;
|
||||||
|
border: 0;
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
details {
|
||||||
|
/* Make the <details> look more "clickable" */
|
||||||
|
padding: 0.6rem 1rem;
|
||||||
|
background: var(--nc-bg-2);
|
||||||
|
border: 1px solid var(--nc-bg-3);
|
||||||
|
border-radius: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
summary {
|
||||||
|
/* Makes the <summary> look more like a "clickable" link with the pointer cursor */
|
||||||
|
cursor: pointer;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
details[open] {
|
||||||
|
/* Adjust the <details> padding while open */
|
||||||
|
padding-bottom: 0.75rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
details[open] summary {
|
||||||
|
/* Adjust the <details> padding while open */
|
||||||
|
margin-bottom: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
details[open] > *:last-child {
|
||||||
|
/* Resets the bottom margin of the last element in the <details> while <details> is opened. This prevents double margins/paddings. */
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
dt {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
dd::before {
|
||||||
|
/* Add an arrow to data table definitions */
|
||||||
|
content: "→ ";
|
||||||
|
}
|
||||||
|
|
||||||
|
hr {
|
||||||
|
/* Reset the border of the <hr> separator, then set a better line */
|
||||||
|
border: 0;
|
||||||
|
border-bottom: 1px solid var(--nc-bg-3);
|
||||||
|
margin: 1rem auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
fieldset {
|
||||||
|
margin-top: 1rem;
|
||||||
|
padding: 2rem;
|
||||||
|
border: 1px solid var(--nc-bg-3);
|
||||||
|
border-radius: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
legend {
|
||||||
|
padding: auto 0.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
textarea {
|
||||||
|
/* Don't let the <textarea> extend off the screen naturally or when dragged by the user */
|
||||||
|
max-width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol,
|
||||||
|
ul {
|
||||||
|
/* Replace the browser default padding */
|
||||||
|
padding-left: 2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
li {
|
||||||
|
margin-top: 0.4rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul ul,
|
||||||
|
ol ul,
|
||||||
|
ul ol,
|
||||||
|
ol ol {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
mark {
|
||||||
|
padding: 3px 6px;
|
||||||
|
background: var(--nc-ac-1);
|
||||||
|
color: var(--nc-ac-tx);
|
||||||
|
}
|
||||||
|
|
||||||
|
textarea,
|
||||||
|
select,
|
||||||
|
input {
|
||||||
|
padding: 6px 12px;
|
||||||
|
margin-bottom: 0.5rem;
|
||||||
|
background: var(--nc-bg-2);
|
||||||
|
color: var(--nc-tx-2);
|
||||||
|
|
||||||
|
/* Set a border of the same color as the main background. It isn't visible on idle, but prevents the cell from growing in size when a darker border is set on focus. */
|
||||||
|
border: 1px solid var(--nc-bg-2);
|
||||||
|
border-radius: 4px;
|
||||||
|
box-shadow: none;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
|
||||||
|
textarea:focus,
|
||||||
|
select:focus,
|
||||||
|
input[type]:focus {
|
||||||
|
border: 1px solid var(--nc-bg-3);
|
||||||
|
|
||||||
|
/* Reset any browser default outlines */
|
||||||
|
outline: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
img {
|
||||||
|
max-width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Customizations */
|
||||||
|
.menu-comment {
|
||||||
|
font-weight: bold;
|
||||||
|
border: 0;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
font-size: 1.2rem;
|
||||||
}
|
}
|
||||||
|
@ -93,7 +93,7 @@
|
|||||||
You can find us on Discourse and Slack.
|
You can find us on Discourse and Slack.
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>Read our documentation within Emacs, or on the <a href="https://www.orgroam.com/manual.html">Online Manual</a></li>
|
<li>Read our documentation within Emacs, or on the <a href="https://www.orgroam.com/manual/">Online Manual</a></li>
|
||||||
<li>Participate in our forum discussions on <a href="https://org-roam.discourse.group">Discourse</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>
|
<li>Chat with us on <a href="https://join.slack.com/t/orgroam/shared_invite/zt-deoqamys-043YQ~s5Tay3iJ5QRI~Lxg">Slack</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -120,6 +120,13 @@
|
|||||||
>org-roam-server</a
|
>org-roam-server</a
|
||||||
>
|
>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="row">
|
||||||
|
<a
|
||||||
|
class="content footer-links"
|
||||||
|
href="https://github.com/org-roam/company-org-roam"
|
||||||
|
>company-org-roam</a
|
||||||
|
>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="col">
|
<div class="col">
|
||||||
|
1280
doc/org-roam.org
1280
doc/org-roam.org
File diff suppressed because it is too large
Load Diff
1570
doc/org-roam.texi
1570
doc/org-roam.texi
File diff suppressed because it is too large
Load Diff
302
org-roam-buffer.el
Normal file
302
org-roam-buffer.el
Normal file
@ -0,0 +1,302 @@
|
|||||||
|
;;; org-roam-buffer.el --- Metadata buffer -*- 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: 1.2.1
|
||||||
|
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "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)
|
||||||
|
(defvar org-ref-cite-types) ;; in org-ref-core.el
|
||||||
|
(defvar org-roam-mode)
|
||||||
|
|
||||||
|
(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")
|
||||||
|
(declare-function org-roam-mode "org-roam")
|
||||||
|
(declare-function org-roam--find-file "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-ref-links)
|
||||||
|
"Hook run in the `org-roam-buffer' before it is displayed."
|
||||||
|
:type 'hook
|
||||||
|
:group 'org-roam)
|
||||||
|
|
||||||
|
(defcustom org-roam-buffer-window-parameters nil
|
||||||
|
"Additional window parameters for the `org-roam-buffer' side window.
|
||||||
|
For example: (setq org-roam-buffer-window-parameters '((no-other-window . t)))"
|
||||||
|
:type '(alist)
|
||||||
|
:group 'org-roam)
|
||||||
|
|
||||||
|
(defvar org-roam-buffer--current nil
|
||||||
|
"Currently displayed file in `org-roam' buffer.")
|
||||||
|
|
||||||
|
(defun org-roam-buffer--find-file (file)
|
||||||
|
"Open FILE in the window `org-roam' was called from."
|
||||||
|
(if (and org-roam-last-window (window-valid-p org-roam-last-window))
|
||||||
|
(progn (with-selected-window org-roam-last-window
|
||||||
|
(org-roam--find-file file))
|
||||||
|
(select-window org-roam-last-window))
|
||||||
|
(org-roam--find-file file)))
|
||||||
|
|
||||||
|
(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--pluralize (string number)
|
||||||
|
"Conditionally pluralize STRING if NUMBER is above 1."
|
||||||
|
(let ((l (pcase number
|
||||||
|
((pred (listp)) (length number))
|
||||||
|
((pred (integerp)) number)
|
||||||
|
(wrong-type (signal 'wrong-type-argument
|
||||||
|
`((listp integerp)
|
||||||
|
,wrong-type))))))
|
||||||
|
(concat string (when (> l 1) "s"))))
|
||||||
|
|
||||||
|
(defun org-roam-buffer--insert-ref-links ()
|
||||||
|
"Insert ref backlinks for the current buffer."
|
||||||
|
(when-let ((ref (cdr (with-temp-buffer
|
||||||
|
(insert-buffer-substring org-roam-buffer--current)
|
||||||
|
(org-roam--extract-ref)))))
|
||||||
|
(if-let* ((key-backlinks (org-roam--get-backlinks ref))
|
||||||
|
(grouped-backlinks (--group-by (nth 0 it) key-backlinks)))
|
||||||
|
(progn
|
||||||
|
(insert (let ((l (length key-backlinks)))
|
||||||
|
(format "\n\n* %d %s\n"
|
||||||
|
l (org-roam-buffer--pluralize "Ref Backlink" l))))
|
||||||
|
(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 (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 ref 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 (let ((l (length backlinks)))
|
||||||
|
(format "\n\n* %d %s\n"
|
||||||
|
l (org-roam-buffer--pluralize "Backlink" l))))
|
||||||
|
(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 "*** "
|
||||||
|
(if-let ((outline (plist-get props :outline)))
|
||||||
|
(string-join outline " > ")
|
||||||
|
"Top")
|
||||||
|
"\n"
|
||||||
|
(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))
|
||||||
|
"\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 ((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)))
|
||||||
|
(save-selected-window
|
||||||
|
(-> (get-buffer-create org-roam-buffer)
|
||||||
|
(display-buffer-in-side-window
|
||||||
|
`((side . ,position)
|
||||||
|
(window-parameters . ,org-roam-buffer-window-parameters)))
|
||||||
|
(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))))))))
|
||||||
|
|
||||||
|
(defun org-roam-buffer-activate ()
|
||||||
|
"Activate display of the `org-roam-buffer'."
|
||||||
|
(interactive)
|
||||||
|
(unless org-roam-mode (org-roam-mode))
|
||||||
|
(setq org-roam-last-window (get-buffer-window))
|
||||||
|
(org-roam-buffer--get-create))
|
||||||
|
|
||||||
|
(defun org-roam-buffer-deactivate ()
|
||||||
|
"Deactivate display of the `org-roam-buffer'."
|
||||||
|
(interactive)
|
||||||
|
(setq org-roam-last-window (get-buffer-window))
|
||||||
|
(delete-window (get-buffer-window org-roam-buffer)))
|
||||||
|
|
||||||
|
(defun org-roam-buffer-toggle-display ()
|
||||||
|
"Toggle display of the `org-roam-buffer'."
|
||||||
|
(interactive)
|
||||||
|
(pcase (org-roam-buffer--visibility)
|
||||||
|
('visible (org-roam-buffer-deactivate))
|
||||||
|
((or 'exists 'none) (org-roam-buffer-activate))))
|
||||||
|
|
||||||
|
(provide 'org-roam-buffer)
|
||||||
|
|
||||||
|
;;; org-roam-buffer.el ends here
|
File diff suppressed because it is too large
Load Diff
@ -5,8 +5,8 @@
|
|||||||
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
||||||
;; URL: https://github.com/org-roam/org-roam
|
;; URL: https://github.com/org-roam/org-roam
|
||||||
;; Keywords: org-mode, roam, convenience
|
;; Keywords: org-mode, roam, convenience
|
||||||
;; Version: 2.0.0
|
;; Version: 1.2.1
|
||||||
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2") (magit-section "2.90.1"))
|
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.0"))
|
||||||
|
|
||||||
;; This file is NOT part of GNU Emacs.
|
;; This file is NOT part of GNU Emacs.
|
||||||
|
|
||||||
@ -34,7 +34,74 @@
|
|||||||
;;;; Library Requires
|
;;;; Library Requires
|
||||||
|
|
||||||
;;; Obsolete aliases (remove after next major release)
|
;;; Obsolete aliases (remove after next major release)
|
||||||
;;; Obsolete functions
|
;;;; Functions
|
||||||
|
(define-obsolete-function-alias 'org-roam--capture-get-point 'org-roam-capture--get-point
|
||||||
|
"org-roam 1.0.0")
|
||||||
|
(define-obsolete-function-alias 'org-roam-build-cache 'org-roam-db-build-cache
|
||||||
|
"org-roam 1.0.0")
|
||||||
|
(define-obsolete-function-alias 'org-roam-sql 'org-roam-db-query
|
||||||
|
"org-roam 1.0.0")
|
||||||
|
(define-obsolete-function-alias 'org-roam--get-db 'org-roam-db--get
|
||||||
|
"org-roam 1.0.0")
|
||||||
|
(define-obsolete-function-alias 'org-roam--db-clear 'org-roam-db--clear
|
||||||
|
"org-roam 1.0.0")
|
||||||
|
(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")
|
||||||
|
(define-obsolete-function-alias 'org-roam-find-index 'org-roam-jump-to-index
|
||||||
|
"org-roam 1.1.0")
|
||||||
|
(define-obsolete-function-alias 'org-roam--pluralize 'org-roam-buffer--pluralize
|
||||||
|
"org-roam 1.1.0")
|
||||||
|
(define-obsolete-function-alias 'org-roam--capture 'org-roam-capture--capture
|
||||||
|
"org-roam 1.1.0")
|
||||||
|
(define-obsolete-function-alias 'org-roam-db--maybe-update 'org-roam-db--update-maybe
|
||||||
|
"org-roam 1.1.0")
|
||||||
|
(define-obsolete-function-alias 'org-roam-db--clear 'org-roam-db-clear
|
||||||
|
"org-roam 1.2.0")
|
||||||
|
|
||||||
|
(when (version< (org-version) "9.3")
|
||||||
|
(defalias 'org-link-make-string 'org-make-link-string))
|
||||||
|
|
||||||
|
;;;; Variables
|
||||||
|
(define-obsolete-variable-alias 'org-roam-graphviz-extra-options
|
||||||
|
'org-roam-graph-extra-config "org-roam 1.0.0")
|
||||||
|
(define-obsolete-variable-alias 'org-roam-grapher-extra-options
|
||||||
|
'org-roam-graph-extra-config "org-roam 1.0.0")
|
||||||
|
(define-obsolete-variable-alias 'org-roam-graph-node-shape
|
||||||
|
'org-roam-graph-node-extra-config "org-roam 1.0.0")
|
||||||
|
(define-obsolete-variable-alias 'org-roam--db-connection
|
||||||
|
'org-roam-db--connection "org-roam 1.0.0")
|
||||||
|
(define-obsolete-variable-alias 'org-roam--current-buffer
|
||||||
|
'org-roam-buffer--current "org-roam 1.0.0")
|
||||||
|
(define-obsolete-variable-alias 'org-roam-date-title-format
|
||||||
|
'org-roam-dailies-capture-templates "org-roam 1.0.0")
|
||||||
|
(define-obsolete-variable-alias 'org-roam-date-filename-format
|
||||||
|
'org-roam-dailies-capture-templates "org-roam 1.0.0")
|
||||||
|
(make-obsolete-variable 'org-roam-buffer-no-delete-other-windows
|
||||||
|
'org-roam-buffer-window-parameters "org-roam 1.1.1")
|
||||||
|
|
||||||
(provide 'org-roam-compat)
|
(provide 'org-roam-compat)
|
||||||
|
|
||||||
|
@ -5,8 +5,9 @@
|
|||||||
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
||||||
;; URL: https://github.com/org-roam/org-roam
|
;; URL: https://github.com/org-roam/org-roam
|
||||||
;; Keywords: org-mode, roam, convenience
|
;; Keywords: org-mode, roam, convenience
|
||||||
;; Version: 2.0.0
|
;; Version: 1.2.1
|
||||||
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2") (magit-section "2.90.1"))
|
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.0"))
|
||||||
|
|
||||||
;; This file is NOT part of GNU Emacs.
|
;; This file is NOT part of GNU Emacs.
|
||||||
|
|
||||||
;; This program is free software; you can redistribute it and/or modify
|
;; This program is free software; you can redistribute it and/or modify
|
||||||
@ -26,107 +27,84 @@
|
|||||||
|
|
||||||
;;; Commentary:
|
;;; Commentary:
|
||||||
;;
|
;;
|
||||||
;; This library provides completion-at-point functions for Org-roam.
|
;; This library provides completion 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:
|
;;; Code:
|
||||||
|
;;;; Library Requires
|
||||||
(require 'cl-lib)
|
(require 'cl-lib)
|
||||||
(require 'org-element)
|
(require 's)
|
||||||
|
|
||||||
(declare-function org-roam--get-titles "org-roam")
|
(defvar helm-pattern)
|
||||||
|
(declare-function helm "ext:helm")
|
||||||
|
(declare-function helm-make-source "ext:helm-source" (name class &rest args) t)
|
||||||
|
|
||||||
(defcustom org-roam-completion-ignore-case t
|
(defcustom org-roam-completion-system 'default
|
||||||
"Whether to ignore case in Org-roam `completion-at-point' completions."
|
"The completion system to be used by `org-roam'."
|
||||||
:group 'org-roam
|
:type '(radio
|
||||||
:type 'boolean)
|
(const :tag "Default" default)
|
||||||
|
(const :tag "Ido" ido)
|
||||||
|
(const :tag "Ivy" ivy)
|
||||||
|
(const :tag "Helm" helm)
|
||||||
|
(function :tag "Custom function"))
|
||||||
|
:group 'org-roam)
|
||||||
|
|
||||||
(defcustom org-roam-completion-everywhere nil
|
(defun org-roam-completion--helm-candidate-transformer (candidates _source)
|
||||||
"When non-nil, provide link completion matching outside of Org links."
|
"Transforms CANDIDATES for Helm-based completing read.
|
||||||
:group 'org-roam
|
SOURCE is not used."
|
||||||
:type 'boolean)
|
(let ((prefix (propertize "[?] "
|
||||||
|
'face 'helm-ff-prefix)))
|
||||||
|
(cons (propertize helm-pattern
|
||||||
|
'display (concat prefix helm-pattern))
|
||||||
|
candidates)))
|
||||||
|
|
||||||
(defvar org-roam-completion-functions (list #'org-roam-complete-link-at-point
|
(cl-defun org-roam-completion--completing-read (prompt choices &key
|
||||||
#'org-roam-complete-everywhere)
|
require-match initial-input
|
||||||
"List of functions to be used with `completion-at-point' for Org-roam.")
|
action)
|
||||||
|
"Present a PROMPT with CHOICES and optional INITIAL-INPUT.
|
||||||
(defun org-roam-complete-everywhere ()
|
If REQUIRE-MATCH is t, the user must select one of the CHOICES.
|
||||||
"Provides completions for links for any word at point.
|
Return user choice."
|
||||||
This is a `completion-at-point' function, and is active when
|
(let (res)
|
||||||
`org-roam-completion-everywhere' is non-nil."
|
(setq res
|
||||||
(let ((end (point))
|
(cond
|
||||||
(start (point))
|
((eq org-roam-completion-system 'ido)
|
||||||
(exit-fn (lambda (&rest _) nil))
|
(let ((candidates (mapcar #'car choices)))
|
||||||
collection)
|
(ido-completing-read prompt candidates nil require-match initial-input)))
|
||||||
(when (and org-roam-completion-everywhere
|
((eq org-roam-completion-system 'default)
|
||||||
(thing-at-point 'word)
|
(completing-read prompt choices nil require-match initial-input))
|
||||||
(not (save-match-data (org-in-regexp org-link-any-re))))
|
((eq org-roam-completion-system 'ivy)
|
||||||
(let ((bounds (bounds-of-thing-at-point 'word)))
|
(if (fboundp 'ivy-read)
|
||||||
(setq start (car bounds)
|
(ivy-read prompt choices
|
||||||
end (cdr bounds)
|
:initial-input initial-input
|
||||||
collection #'org-roam--get-titles
|
:require-match require-match
|
||||||
exit-fn (lambda (str _status)
|
:action (prog1 action
|
||||||
(delete-char (- (length str)))
|
(setq action nil))
|
||||||
(insert "[[roam:" str "]]")))))
|
:caller 'org-roam--completing-read)
|
||||||
(when collection
|
(user-error "Please install ivy from \
|
||||||
(let ((prefix (buffer-substring-no-properties start end)))
|
https://github.com/abo-abo/swiper")))
|
||||||
(list start end
|
((eq org-roam-completion-system 'helm)
|
||||||
(if (functionp collection)
|
(unless (and (fboundp 'helm)
|
||||||
(completion-table-case-fold
|
(fboundp 'helm-make-source))
|
||||||
(completion-table-dynamic
|
(user-error "Please install helm from \
|
||||||
(lambda (_)
|
https://github.com/emacs-helm/helm"))
|
||||||
(cl-remove-if (apply-partially #'string= prefix)
|
(let ((source (helm-make-source prompt 'helm-source-sync
|
||||||
(funcall collection))))
|
:candidates (mapcar #'car choices)
|
||||||
(not org-roam-completion-ignore-case))
|
:filtered-candidate-transformer
|
||||||
collection)
|
(and (not require-match)
|
||||||
:exit-function exit-fn)))))
|
#'org-roam-completion--helm-candidate-transformer)))
|
||||||
|
(buf (concat "*org-roam "
|
||||||
(defun org-roam-complete-link-at-point ()
|
(s-downcase (s-chop-suffix ":" (s-trim prompt)))
|
||||||
"Do appropriate completion for the link at point."
|
"*")))
|
||||||
(let ((end (point))
|
(or (helm :sources source
|
||||||
(start (point))
|
:action (if action
|
||||||
collection link-type)
|
(prog1 action
|
||||||
(when (org-in-regexp org-link-bracket-re 1)
|
(setq action nil))
|
||||||
(setq start (match-beginning 1)
|
#'identity)
|
||||||
end (match-end 1))
|
:prompt prompt
|
||||||
(let ((context (org-element-context)))
|
:input initial-input
|
||||||
(pcase (org-element-lineage context '(link) t)
|
:buffer buf)
|
||||||
(`nil nil)
|
(keyboard-quit))))))
|
||||||
(link
|
(if action
|
||||||
(setq link-type (org-element-property :type link))
|
(funcall action res)
|
||||||
(when (member link-type '("roam" "fuzzy"))
|
res)))
|
||||||
(when (string= link-type "roam") (setq start (+ start (length "roam:"))))
|
|
||||||
(setq collection #'org-roam--get-titles))))))
|
|
||||||
(when collection
|
|
||||||
(let ((prefix (buffer-substring-no-properties start end)))
|
|
||||||
(list start end
|
|
||||||
(if (functionp collection)
|
|
||||||
(completion-table-case-fold
|
|
||||||
(completion-table-dynamic
|
|
||||||
(lambda (_)
|
|
||||||
(cl-remove-if (apply-partially #'string= prefix)
|
|
||||||
(funcall collection))))
|
|
||||||
(not org-roam-completion-ignore-case))
|
|
||||||
collection)
|
|
||||||
:exit-function
|
|
||||||
(lambda (str &rest _)
|
|
||||||
(delete-char (- 0 (length str)))
|
|
||||||
(insert (concat (unless (string= link-type "roam") "roam:")
|
|
||||||
str))
|
|
||||||
(forward-char 2)))))))
|
|
||||||
|
|
||||||
(defun org-roam--register-completion-functions ()
|
|
||||||
"."
|
|
||||||
(dolist (fn org-roam-completion-functions)
|
|
||||||
(add-hook 'completion-at-point-functions fn nil t)))
|
|
||||||
|
|
||||||
(add-hook 'org-roam-find-file-hook #'org-roam--register-completion-functions)
|
|
||||||
|
|
||||||
(provide 'org-roam-completion)
|
(provide 'org-roam-completion)
|
||||||
|
|
||||||
|
@ -1,14 +1,12 @@
|
|||||||
;;; org-roam-dailies.el --- Daily-notes for Org-roam -*- 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 Jethro Kuan <jethrokuan95@gmail.com>
|
||||||
;; Copyright © 2020 Leo Vivier <leo.vivier+dev@gmail.com>
|
|
||||||
|
|
||||||
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
||||||
;; Leo Vivier <leo.vivier+dev@gmail.com>
|
|
||||||
;; URL: https://github.com/org-roam/org-roam
|
;; URL: https://github.com/org-roam/org-roam
|
||||||
;; Keywords: org-mode, roam, convenience
|
;; Keywords: org-mode, roam, convenience
|
||||||
;; Version: 2.0.0
|
;; Version: 1.2.1
|
||||||
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2") (magit-section "2.90.1"))
|
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.0"))
|
||||||
|
|
||||||
;; This file is NOT part of GNU Emacs.
|
;; This file is NOT part of GNU Emacs.
|
||||||
|
|
||||||
@ -29,318 +27,111 @@
|
|||||||
|
|
||||||
;;; Commentary:
|
;;; 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.
|
;; concept borrowed from Roam Research.
|
||||||
;;
|
;;
|
||||||
;;; Code:
|
;;; Code:
|
||||||
;;; Library Requires
|
;;; Library Requires
|
||||||
(require 'org-capture)
|
(require 'org-capture)
|
||||||
(require 'org-roam-capture)
|
(require 'org-roam-capture)
|
||||||
(require 'f)
|
(require 'org-roam-macs)
|
||||||
|
|
||||||
;;;; Declarations
|
|
||||||
(defvar org-roam-directory)
|
|
||||||
(defvar org-roam-file-extensions)
|
|
||||||
(declare-function org-roam--org-file-p "org-roam")
|
|
||||||
|
|
||||||
;;;; Faces
|
|
||||||
(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)
|
|
||||||
|
|
||||||
;;;; Customizable variables
|
|
||||||
(defcustom org-roam-dailies-directory "daily/"
|
|
||||||
"Path to daily-notes."
|
|
||||||
:group 'org-roam
|
|
||||||
:type 'string)
|
|
||||||
|
|
||||||
(defcustom org-roam-dailies-find-file-hook nil
|
|
||||||
"Hook that is run right after navigating to a daily-note."
|
|
||||||
:group 'org-roam
|
|
||||||
:type 'hook)
|
|
||||||
|
|
||||||
(defcustom org-roam-dailies-capture-templates
|
(defcustom org-roam-dailies-capture-templates
|
||||||
'(("d" "default" entry
|
'(("d" "daily" plain (function org-roam-capture--get-point)
|
||||||
"* %?"
|
""
|
||||||
:if-new `(file+head ,(concat org-roam-dailies-directory "%<%Y-%m-%d>.org")
|
:immediate-finish t
|
||||||
"#+title: %<%Y-%m-%d>\n")))
|
:file-name "%<%Y-%m-%d>"
|
||||||
"Capture templates for daily-notes in Org-roam.
|
:head "#+title: %<%Y-%m-%d>"))
|
||||||
See `org-roam-capture-templates' for the template documentation."
|
"Capture templates for daily notes in Org-roam."
|
||||||
:group 'org-roam
|
:group 'org-roam
|
||||||
:type '(repeat
|
;; Adapted from `org-capture-templates'
|
||||||
(choice (list :tag "Multikey description"
|
:type
|
||||||
(string :tag "Keys ")
|
'(repeat
|
||||||
(string :tag "Description"))
|
(choice :value ("d" "daily" plain (function org-roam-capture--get-point)
|
||||||
(list :tag "Template entry"
|
""
|
||||||
(string :tag "Keys ")
|
:immediate-finish t
|
||||||
(string :tag "Description ")
|
:file-name "%<%Y-%m-%d>"
|
||||||
(choice :tag "Capture Type " :value entry
|
:head "#+title: %<%Y-%m-%d>")
|
||||||
(const :tag "Org entry" entry)
|
(list :tag "Multikey description"
|
||||||
(const :tag "Plain list item" item)
|
(string :tag "Keys ")
|
||||||
(const :tag "Checkbox item" checkitem)
|
(string :tag "Description"))
|
||||||
(const :tag "Plain text" plain)
|
(list :tag "Template entry"
|
||||||
(const :tag "Table line" table-line))
|
(string :tag "Keys ")
|
||||||
(choice :tag "Template "
|
(string :tag "Description ")
|
||||||
(string)
|
(const :format "" plain)
|
||||||
(list :tag "File"
|
(const :format "" (function org-roam-capture--get-point))
|
||||||
(const :format "" file)
|
(choice :tag "Template "
|
||||||
(file :tag "Template file"))
|
(string :tag "String"
|
||||||
(list :tag "Function"
|
:format "String:\n \
|
||||||
(const :format "" function)
|
Template string :\n%v")
|
||||||
(function :tag "Template function")))
|
(list :tag "File"
|
||||||
(plist :inline t
|
(const :format "" file)
|
||||||
;; Give the most common options as checkboxes
|
(file :tag "Template file "))
|
||||||
:options (((const :format "%v " :if-new)
|
(list :tag "Function"
|
||||||
(choice :tag "Node location"
|
(const :format "" function)
|
||||||
(list :tag "File"
|
(function :tag "Template function ")))
|
||||||
(const :format "" file)
|
(const :format "" :immediate-finish) (const :format "" t)
|
||||||
(string :tag " File"))
|
(const :format "File name format :" :file-name)
|
||||||
(list :tag "File & Head Content"
|
(string :format " %v" :value "#+title: ${title}\n")
|
||||||
(const :format "" file+head)
|
(const :format "Header format :" :head)
|
||||||
(string :tag " File")
|
(string :format "\n%v" :value "%<%Y%m%d%H%M%S>-${slug}")
|
||||||
(string :tag " Head Content"))
|
(plist :inline t
|
||||||
(list :tag "File & Outline path"
|
:tag "Options"
|
||||||
(const :format "" file+olp)
|
;; Give the most common options as checkboxes
|
||||||
(string :tag " File")
|
:options
|
||||||
(list :tag "Outline path"
|
(((const :format "%v " :prepend) (const t))
|
||||||
(repeat string :tag "Headline")))
|
((const :format "%v " :jump-to-captured) (const t))
|
||||||
(list :tag "File & Head Content & Outline path"
|
((const :format "%v " :empty-lines) (const 1))
|
||||||
(const :format "" file+head+olp)
|
((const :format "%v " :empty-lines-before) (const 1))
|
||||||
(string :tag " File")
|
((const :format "%v " :empty-lines-after) (const 1))
|
||||||
(string :tag " Head Content")
|
((const :format "%v " :clock-in) (const t))
|
||||||
(list :tag "Outline path"
|
((const :format "%v " :clock-keep) (const t))
|
||||||
(repeat string :tag "Headline")))))
|
((const :format "%v " :clock-resume) (const t))
|
||||||
((const :format "%v " :prepend) (const t))
|
((const :format "%v " :time-prompt) (const t))
|
||||||
((const :format "%v " :immediate-finish) (const t))
|
((const :format "%v " :tree-type) (const week))
|
||||||
((const :format "%v " :jump-to-captured) (const t))
|
((const :format "%v " :table-line-pos) (string))
|
||||||
((const :format "%v " :empty-lines) (const 1))
|
((const :format "%v " :kill-buffer) (const t))
|
||||||
((const :format "%v " :empty-lines-before) (const 1))
|
((const :format "%v " :unnarrowed) (const t))))))))
|
||||||
((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))))))))
|
|
||||||
|
|
||||||
;;;; Utilities
|
;; Declarations
|
||||||
(defun org-roam-dailies-directory--get-absolute-path ()
|
(defvar org-roam-mode)
|
||||||
"Get absolute path to `org-roam-dailies-directory'."
|
(declare-function org-roam--file-path-from-id "org-roam")
|
||||||
(expand-file-name org-roam-dailies-directory org-roam-directory))
|
(declare-function org-roam-mode "org-roam")
|
||||||
|
|
||||||
(defun org-roam-dailies-find-directory ()
|
(defun org-roam-dailies--file-for-time (time)
|
||||||
"Find and open `org-roam-dailies-directory'."
|
"Create and find file for TIME."
|
||||||
|
(let ((org-roam-capture-templates org-roam-dailies-capture-templates)
|
||||||
|
(org-roam-capture--info (list (cons 'time time)))
|
||||||
|
(org-roam-capture--context 'dailies))
|
||||||
|
(setq org-roam-capture-additional-template-props (list :finalize 'find-file))
|
||||||
|
(org-roam--with-template-error 'org-roam-dailies-capture-templates
|
||||||
|
(org-roam-capture--capture))))
|
||||||
|
|
||||||
|
(defun org-roam-dailies-today ()
|
||||||
|
"Create and find the daily note for today."
|
||||||
(interactive)
|
(interactive)
|
||||||
(find-file (org-roam-dailies-directory--get-absolute-path)))
|
(unless org-roam-mode (org-roam-mode))
|
||||||
|
(org-roam-dailies--file-for-time (current-time)))
|
||||||
|
|
||||||
(defun org-roam-dailies--daily-note-p (&optional file)
|
(defun org-roam-dailies-tomorrow (n)
|
||||||
"Return t if FILE is an Org-roam daily-note, nil otherwise.
|
"Create and find the daily note for tomorrow.
|
||||||
|
With numeric argument N, use N days in the future."
|
||||||
|
(interactive "p")
|
||||||
|
(unless org-roam-mode (org-roam-mode))
|
||||||
|
(org-roam-dailies--file-for-time (time-add (* n 86400) (current-time))))
|
||||||
|
|
||||||
If FILE is not specified, use the current buffer's file-path."
|
(defun org-roam-dailies-yesterday (n)
|
||||||
(when-let ((path (or file
|
"Create and find the file for yesterday.
|
||||||
(buffer-base-buffer (buffer-file-name))))
|
With numeric argument N, use N days in the past."
|
||||||
(directory (org-roam-dailies-directory--get-absolute-path)))
|
(interactive "p")
|
||||||
(setq path (expand-file-name path))
|
(unless org-roam-mode (org-roam-mode))
|
||||||
(save-match-data
|
(org-roam-dailies-tomorrow (- n)))
|
||||||
(and
|
|
||||||
(org-roam--org-file-p path)
|
|
||||||
(f-descendant-of-p path directory)))))
|
|
||||||
|
|
||||||
(defun org-roam-dailies--capture (time &optional goto)
|
(defun org-roam-dailies-date ()
|
||||||
"Capture an entry in a daily-note for TIME, creating it if necessary.
|
"Create the file for any date using the calendar interface."
|
||||||
|
|
||||||
When GOTO is non-nil, go the note without creating an entry."
|
|
||||||
(org-roam-capture- :goto (when goto '(4))
|
|
||||||
:node (org-roam-node-create)
|
|
||||||
:templates org-roam-dailies-capture-templates
|
|
||||||
:props (list :default-time time)))
|
|
||||||
|
|
||||||
;;;; Commands
|
|
||||||
;;; Today
|
|
||||||
(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)
|
|
||||||
(when goto
|
|
||||||
(run-hooks 'org-roam-dailies-find-file-hook)))
|
|
||||||
|
|
||||||
(defun org-roam-dailies-find-today ()
|
|
||||||
"Find the daily-note for today, creating it if necessary."
|
|
||||||
(interactive)
|
(interactive)
|
||||||
(org-roam-dailies-capture-today t))
|
(let ((time (org-read-date nil 'to-time nil "Date: ")))
|
||||||
|
(org-roam-dailies--file-for-time time)))
|
||||||
;;; Tomorrow
|
|
||||||
(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))
|
|
||||||
|
|
||||||
(defun org-roam-dailies-find-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
|
|
||||||
(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))
|
|
||||||
|
|
||||||
(defun org-roam-dailies-find-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
|
|
||||||
(defvar org-roam-dailies-calendar-hook (list 'org-roam-dailies-calendar-mark-entries)
|
|
||||||
"Hooks to run when showing the `org-roam-dailies-calendar'.")
|
|
||||||
|
|
||||||
(defun org-roam-dailies-calendar--install-hook ()
|
|
||||||
"Install Org-roam-dailies hooks to calendar."
|
|
||||||
(add-hook 'calendar-today-visible-hook #'org-roam-dailies-calendar--run-hook)
|
|
||||||
(add-hook 'calendar-today-invisible-hook #'org-roam-dailies-calendar--run-hook))
|
|
||||||
|
|
||||||
(defun org-roam-dailies-calendar--run-hook ()
|
|
||||||
"Run Org-roam-dailies hooks to calendar."
|
|
||||||
(run-hooks 'org-roam-dailies-calendar-hook)
|
|
||||||
(remove-hook 'calendar-today-visible-hook #'org-roam-dailies-calendar--run-hook)
|
|
||||||
(remove-hook 'calendar-today-invisible-hook #'org-roam-dailies-calendar--run-hook))
|
|
||||||
|
|
||||||
(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 the 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 (org-roam-dailies-directory--get-absolute-path))
|
|
||||||
(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
|
|
||||||
(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")
|
|
||||||
(org-roam-dailies-calendar--install-hook)
|
|
||||||
(let* ((time-str (let ((org-read-date-prefer-future prefer-future))
|
|
||||||
(org-read-date nil nil nil (if goto
|
|
||||||
"Find daily-note: "
|
|
||||||
"Capture to daily-note: "))))
|
|
||||||
(time (org-read-date nil t time-str)))
|
|
||||||
(org-roam-dailies--capture time goto)
|
|
||||||
(when goto
|
|
||||||
(run-hooks 'org-roam-dailies-find-file-hook))))
|
|
||||||
|
|
||||||
(defun org-roam-dailies-find-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 (org-roam-dailies-directory--get-absolute-path))
|
|
||||||
(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-find-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-find-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-find-next-note n)))
|
|
||||||
|
|
||||||
;;;; 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-find-today)
|
|
||||||
(define-key org-roam-dailies-map (kbd "y") #'org-roam-dailies-find-yesterday)
|
|
||||||
(define-key org-roam-dailies-map (kbd "t") #'org-roam-dailies-find-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-find-next-note)
|
|
||||||
(define-key org-roam-dailies-map (kbd "b") #'org-roam-dailies-find-previous-note)
|
|
||||||
(define-key org-roam-dailies-map (kbd "c") #'org-roam-dailies-find-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)
|
(provide 'org-roam-dailies)
|
||||||
|
|
||||||
|
685
org-roam-db.el
685
org-roam-db.el
@ -5,8 +5,8 @@
|
|||||||
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
||||||
;; URL: https://github.com/org-roam/org-roam
|
;; URL: https://github.com/org-roam/org-roam
|
||||||
;; Keywords: org-mode, roam, convenience
|
;; Keywords: org-mode, roam, convenience
|
||||||
;; Version: 2.0.0
|
;; Version: 1.2.1
|
||||||
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2") (magit-section "2.90.1"))
|
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.0"))
|
||||||
|
|
||||||
;; This file is NOT part of GNU Emacs.
|
;; This file is NOT part of GNU Emacs.
|
||||||
|
|
||||||
@ -27,7 +27,7 @@
|
|||||||
|
|
||||||
;;; Commentary:
|
;;; Commentary:
|
||||||
;;
|
;;
|
||||||
;; This library provides the underlying database api to org-roam.
|
;; This library is provides the underlying database api to org-roam
|
||||||
;;
|
;;
|
||||||
;;; Code:
|
;;; Code:
|
||||||
;;;; Library Requires
|
;;;; Library Requires
|
||||||
@ -35,27 +35,25 @@
|
|||||||
(require 'emacsql)
|
(require 'emacsql)
|
||||||
(require 'emacsql-sqlite3)
|
(require 'emacsql-sqlite3)
|
||||||
(require 'seq)
|
(require 'seq)
|
||||||
|
(require 'org-roam-macs)
|
||||||
|
|
||||||
(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-directory)
|
||||||
(defvar org-roam-verbose)
|
(defvar org-roam-verbose)
|
||||||
(defvar org-agenda-files)
|
(defvar org-roam-file-name)
|
||||||
|
|
||||||
(declare-function org-roam-id-at-point "org-roam")
|
(declare-function org-roam--org-roam-file-p "org-roam")
|
||||||
(declare-function org-roam--org-roam-file-p "org-roam")
|
(declare-function org-roam--extract-titles "org-roam")
|
||||||
(declare-function org-roam--list-all-files "org-roam")
|
(declare-function org-roam--extract-ref "org-roam")
|
||||||
(declare-function org-roam-node-at-point "org-roam")
|
(declare-function org-roam--extract-tags "org-roam")
|
||||||
|
(declare-function org-roam--extract-headlines "org-roam")
|
||||||
|
(declare-function org-roam--extract-links "org-roam")
|
||||||
|
(declare-function org-roam--list-all-files "org-roam")
|
||||||
|
(declare-function org-roam--path-to-slug "org-roam")
|
||||||
|
(declare-function org-roam--file-name-extension "org-roam")
|
||||||
|
(declare-function org-roam-buffer--update-maybe "org-roam-buffer")
|
||||||
|
|
||||||
;;;; Options
|
;;;; Options
|
||||||
(defcustom org-roam-db-location (expand-file-name "org-roam.db" user-emacs-directory)
|
(defcustom org-roam-db-location nil
|
||||||
"The full path to file where the Org-roam database is stored.
|
"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.
|
If this is non-nil, the Org-roam sqlite database is saved here.
|
||||||
|
|
||||||
@ -66,7 +64,7 @@ when used with multiple Org-roam instances."
|
|||||||
|
|
||||||
(defcustom org-roam-db-gc-threshold gc-cons-threshold
|
(defcustom org-roam-db-gc-threshold gc-cons-threshold
|
||||||
"The value to temporarily set the `gc-cons-threshold' threshold to.
|
"The value to temporarily set the `gc-cons-threshold' threshold to.
|
||||||
During large, heavy operations like `org-roam-db-sync',
|
During large, heavy operations like `org-roam-db-build-cache',
|
||||||
many GC operations happen because of the large number of
|
many GC operations happen because of the large number of
|
||||||
temporary structures generated (e.g. parsed ASTs). Temporarily
|
temporary structures generated (e.g. parsed ASTs). Temporarily
|
||||||
increasing `gc-cons-threshold' will help reduce the number of GC
|
increasing `gc-cons-threshold' will help reduce the number of GC
|
||||||
@ -79,16 +77,20 @@ value like `most-positive-fixnum'."
|
|||||||
:type 'int
|
:type 'int
|
||||||
:group 'org-roam)
|
:group 'org-roam)
|
||||||
|
|
||||||
(defconst org-roam-db--version 12)
|
(defconst org-roam-db--version 7)
|
||||||
|
|
||||||
(defvar org-roam-db--connection (make-hash-table :test #'equal)
|
(defvar org-roam-db--connection (make-hash-table :test #'equal)
|
||||||
"Database connection to Org-roam database.")
|
"Database connection to Org-roam database.")
|
||||||
|
|
||||||
;;;; Core Functions
|
;;;; Core Functions
|
||||||
|
(defun org-roam-db--get ()
|
||||||
|
"Return the sqlite db file."
|
||||||
|
(or org-roam-db-location
|
||||||
|
(expand-file-name "org-roam.db" org-roam-directory)))
|
||||||
|
|
||||||
(defun org-roam-db--get-connection ()
|
(defun org-roam-db--get-connection ()
|
||||||
"Return the database connection, if any."
|
"Return the database connection, if any."
|
||||||
(gethash (expand-file-name org-roam-directory)
|
(gethash (file-truename org-roam-directory)
|
||||||
org-roam-db--connection))
|
org-roam-db--connection))
|
||||||
|
|
||||||
(defun org-roam-db ()
|
(defun org-roam-db ()
|
||||||
@ -97,17 +99,18 @@ Initializes and stores the database, and the database connection.
|
|||||||
Performs a database upgrade when required."
|
Performs a database upgrade when required."
|
||||||
(unless (and (org-roam-db--get-connection)
|
(unless (and (org-roam-db--get-connection)
|
||||||
(emacsql-live-p (org-roam-db--get-connection)))
|
(emacsql-live-p (org-roam-db--get-connection)))
|
||||||
(let ((init-db (not (file-exists-p org-roam-db-location))))
|
(let* ((db-file (org-roam-db--get))
|
||||||
(make-directory (file-name-directory org-roam-db-location) t)
|
(init-db (not (file-exists-p db-file))))
|
||||||
(let ((conn (emacsql-sqlite3 org-roam-db-location)))
|
(make-directory (file-name-directory db-file) t)
|
||||||
|
(let ((conn (emacsql-sqlite3 db-file)))
|
||||||
(set-process-query-on-exit-flag (emacsql-process conn) nil)
|
(set-process-query-on-exit-flag (emacsql-process conn) nil)
|
||||||
(puthash (expand-file-name org-roam-directory)
|
(puthash (file-truename org-roam-directory)
|
||||||
conn
|
conn
|
||||||
org-roam-db--connection)
|
org-roam-db--connection)
|
||||||
(when init-db
|
(when init-db
|
||||||
(org-roam-db--init conn))
|
(org-roam-db--init conn))
|
||||||
(let* ((version (caar (emacsql conn "PRAGMA user_version")))
|
(let* ((version (caar (emacsql conn "PRAGMA user_version")))
|
||||||
(version (org-roam-db--upgrade-maybe conn version)))
|
(version (org-roam-db--update-maybe conn version)))
|
||||||
(cond
|
(cond
|
||||||
((> version org-roam-db--version)
|
((> version org-roam-db--version)
|
||||||
(emacsql-close conn)
|
(emacsql-close conn)
|
||||||
@ -129,61 +132,43 @@ SQL can be either the emacsql vector representation, or a string."
|
|||||||
(apply #'emacsql (org-roam-db) sql args)))
|
(apply #'emacsql (org-roam-db) sql args)))
|
||||||
|
|
||||||
;;;; Schemata
|
;;;; Schemata
|
||||||
;; NOTE: Foreign key somehow doesn't work! Adding a file column to every table as a workaround.
|
|
||||||
(defconst org-roam-db--table-schemata
|
(defconst org-roam-db--table-schemata
|
||||||
'((files
|
'((files
|
||||||
[(file :unique :primary-key)
|
[(file :unique :primary-key)
|
||||||
(hash :not-null)])
|
(hash :not-null)
|
||||||
|
(meta :not-null)])
|
||||||
|
|
||||||
(nodes
|
(headlines
|
||||||
[(id :primary-key :not-null)
|
[(id :unique :primary-key)
|
||||||
(file :not-null)
|
(file :not-null)])
|
||||||
(level :not-null)
|
|
||||||
(pos :not-null)
|
|
||||||
todo
|
|
||||||
priority
|
|
||||||
(scheduled text)
|
|
||||||
(deadline text)
|
|
||||||
title]
|
|
||||||
(:foreign-key [file] :references files [file] :on-delete :cascade))
|
|
||||||
|
|
||||||
(aliases
|
|
||||||
[(file :not-null)
|
|
||||||
(node-id :not-null)
|
|
||||||
alias]
|
|
||||||
(:foreign-key [node-id] :references nodes [id] :on-delete :cascade))
|
|
||||||
|
|
||||||
(refs
|
|
||||||
([(file :not-null)
|
|
||||||
(node-id :not-null)
|
|
||||||
(ref :not-null)
|
|
||||||
(type :not-null)]
|
|
||||||
(:foreign-key [node-id] :references nodes [id] :on-delete :cascade)))
|
|
||||||
|
|
||||||
(tags
|
|
||||||
[(file :not-null)
|
|
||||||
(node-id :not-null)
|
|
||||||
tag]
|
|
||||||
(:foreign-key [node-id] :references nodes [id] :on-delete :cascade))
|
|
||||||
|
|
||||||
(links
|
(links
|
||||||
[(file :not-null)
|
[(from :not-null)
|
||||||
(pos :not-null)
|
(to :not-null)
|
||||||
(source :not-null)
|
|
||||||
(dest :not-null)
|
|
||||||
(type :not-null)
|
(type :not-null)
|
||||||
(properties :not-null)]
|
(properties :not-null)])
|
||||||
(:foreign-key [file] :references files [file] :on-delete :cascade))))
|
|
||||||
|
(tags
|
||||||
|
[(file :unique :primary-key)
|
||||||
|
(tags)])
|
||||||
|
|
||||||
|
(titles
|
||||||
|
[(file :not-null)
|
||||||
|
title])
|
||||||
|
|
||||||
|
(refs
|
||||||
|
[(ref :unique :not-null)
|
||||||
|
(file :not-null)
|
||||||
|
(type :not-null)])))
|
||||||
|
|
||||||
(defun org-roam-db--init (db)
|
(defun org-roam-db--init (db)
|
||||||
"Initialize database DB with the correct schema and user version."
|
"Initialize database DB with the correct schema and user version."
|
||||||
(emacsql-with-transaction db
|
(emacsql-with-transaction db
|
||||||
(emacsql db "PRAGMA foreign_keys = ON")
|
(pcase-dolist (`(,table . ,schema) org-roam-db--table-schemata)
|
||||||
(pcase-dolist (`(,table ,schema) org-roam-db--table-schemata)
|
|
||||||
(emacsql db [:create-table $i1 $S2] table schema))
|
(emacsql db [:create-table $i1 $S2] table schema))
|
||||||
(emacsql db (format "PRAGMA user_version = %s" org-roam-db--version))))
|
(emacsql db (format "PRAGMA user_version = %s" org-roam-db--version))))
|
||||||
|
|
||||||
(defun org-roam-db--upgrade-maybe (db version)
|
(defun org-roam-db--update-maybe (db version)
|
||||||
"Upgrades the database schema for DB, if VERSION is old."
|
"Upgrades the database schema for DB, if VERSION is old."
|
||||||
(emacsql-with-transaction db
|
(emacsql-with-transaction db
|
||||||
'ignore
|
'ignore
|
||||||
@ -191,7 +176,7 @@ SQL can be either the emacsql vector representation, or a string."
|
|||||||
(progn
|
(progn
|
||||||
(org-roam-message (format "Upgrading the Org-roam database from version %d to version %d"
|
(org-roam-message (format "Upgrading the Org-roam database from version %d to version %d"
|
||||||
version org-roam-db--version))
|
version org-roam-db--version))
|
||||||
(org-roam-db-sync t))))
|
(org-roam-db-build-cache t))))
|
||||||
version)
|
version)
|
||||||
|
|
||||||
(defun org-roam-db--close (&optional db)
|
(defun org-roam-db--close (&optional db)
|
||||||
@ -209,280 +194,358 @@ the current `org-roam-directory'."
|
|||||||
(org-roam-db--close conn)))
|
(org-roam-db--close conn)))
|
||||||
|
|
||||||
;;;; Database API
|
;;;; Database API
|
||||||
|
;;;;; Initialization
|
||||||
|
(defun org-roam-db--initialized-p ()
|
||||||
|
"Whether the Org-roam 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
|
;;;;; Clearing
|
||||||
(defun org-roam-db-clear-all ()
|
(defun org-roam-db-clear ()
|
||||||
"Clears all entries in the Org-roam cache."
|
"Clears all entries in the Org-roam cache."
|
||||||
(interactive)
|
(interactive)
|
||||||
(when (file-exists-p org-roam-db-location)
|
(when (file-exists-p (org-roam-db--get))
|
||||||
(dolist (table (mapcar #'car org-roam-db--table-schemata))
|
(dolist (table (mapcar #'car org-roam-db--table-schemata))
|
||||||
(org-roam-db-query `[:delete :from ,table]))))
|
(org-roam-db-query `[:delete :from ,table]))))
|
||||||
|
|
||||||
(defun org-roam-db-clear-file (&optional file)
|
(defun org-roam-db--clear-file (&optional filepath)
|
||||||
"Remove any related links to the FILE.
|
"Remove any related links to the file at FILEPATH.
|
||||||
This is equivalent to removing the node from the graph.
|
This is equivalent to removing the node from the graph."
|
||||||
If FILE is nil, clear the current buffer."
|
(let ((file (file-truename (or filepath
|
||||||
(setq file (or file (buffer-file-name (buffer-base-buffer))))
|
(buffer-file-name (buffer-base-buffer))))))
|
||||||
(dolist (table (mapcar #'car org-roam-db--table-schemata))
|
(dolist (table (mapcar #'car org-roam-db--table-schemata))
|
||||||
(org-roam-db-query `[:delete :from ,table
|
(org-roam-db-query `[:delete :from ,table
|
||||||
:where (= file $s1)]
|
:where (= ,(if (eq table 'links) 'from 'file) $s1)]
|
||||||
file)))
|
file))))
|
||||||
|
|
||||||
;;;;; Updating tables
|
;;;;; Insertion
|
||||||
(defun org-roam-db-insert-file ()
|
(defun org-roam-db--insert-meta (file hash meta)
|
||||||
"Update the files table for the current buffer.
|
"Insert HASH and META for a FILE into the Org-roam cache."
|
||||||
If UPDATE-P is non-nil, first remove the file in the database."
|
(org-roam-db-query
|
||||||
(let* ((file (buffer-file-name))
|
[:insert :into files
|
||||||
(hash (org-roam-db--file-hash)))
|
:values $v1]
|
||||||
(org-roam-db-query
|
(list (vector file hash meta))))
|
||||||
[:insert :into files
|
|
||||||
:values $v1]
|
|
||||||
(list (vector file hash)))))
|
|
||||||
|
|
||||||
(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-get-deadline-time ()
|
(defun org-roam-db--insert-titles (file titles)
|
||||||
"Return the deadline time at point in ISO8601 format."
|
"Insert TITLES for a FILE into the Org-roam cache."
|
||||||
(when-let ((time (org-get-deadline-time (point))))
|
(org-roam-db-query
|
||||||
(org-format-time-string "%FT%T%z" time)))
|
[:insert :into titles
|
||||||
|
:values $v1]
|
||||||
|
(mapcar (lambda (title)
|
||||||
|
(vector file title)) titles)))
|
||||||
|
|
||||||
(defun org-roam-db-map-headlines (fns)
|
(defun org-roam-db--insert-headlines (headlines)
|
||||||
"Run FNS over all headlines in the current buffer."
|
"Insert HEADLINES into the Org-roam cache.
|
||||||
(org-with-point-at 1
|
Returns t if the insertion was successful, nil otherwise.
|
||||||
(org-map-entries
|
Insertions can fail when there is an ID conflict."
|
||||||
(lambda ()
|
(condition-case nil
|
||||||
(dolist (fn fns)
|
(progn
|
||||||
(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 (= (org-outline-level) 0)
|
|
||||||
(when-let ((id (org-id-get)))
|
|
||||||
(let* ((file (buffer-file-name (buffer-base-buffer)))
|
|
||||||
(title (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")))
|
|
||||||
(condition-case nil
|
|
||||||
(progn
|
|
||||||
(org-roam-db-query
|
|
||||||
[:insert :into nodes
|
|
||||||
:values $v1]
|
|
||||||
(vector id file level pos todo priority
|
|
||||||
scheduled deadline title))
|
|
||||||
(when tags
|
|
||||||
(org-roam-db-query
|
|
||||||
[:insert :into tags
|
|
||||||
:values $v1]
|
|
||||||
(mapcar (lambda (tag)
|
|
||||||
(vector file id (substring-no-properties tag)))
|
|
||||||
tags)))
|
|
||||||
(when aliases
|
|
||||||
(org-roam-db-query
|
|
||||||
[:insert :into aliases
|
|
||||||
:values $v1]
|
|
||||||
(mapcar (lambda (alias)
|
|
||||||
(vector file 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 file 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)))))
|
|
||||||
(t
|
|
||||||
(lwarn '(org-roam) :error "Duplicate ID %s, skipping..." id))))))))
|
|
||||||
|
|
||||||
(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 (nth 4 heading-components)))
|
|
||||||
(condition-case nil
|
|
||||||
(org-roam-db-query
|
|
||||||
[:insert :into nodes
|
|
||||||
:values $v1]
|
|
||||||
(vector id file level pos todo priority
|
|
||||||
scheduled deadline title))
|
|
||||||
(t
|
|
||||||
(lwarn '(org-roam) :error
|
|
||||||
"Duplicate ID %s, skipping..." id))))))
|
|
||||||
|
|
||||||
(defun org-roam-db-insert-aliases ()
|
|
||||||
"Insert aliases for node at point into Org-roam cache."
|
|
||||||
(when-let ((file (buffer-file-name (buffer-base-buffer)))
|
|
||||||
(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 file 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 ((file (buffer-file-name (buffer-base-buffer)))
|
|
||||||
(node-id (org-id-get))
|
|
||||||
(tags (org-get-tags)))
|
|
||||||
(org-roam-db-query [:insert :into tags
|
|
||||||
:values $v1]
|
|
||||||
(mapcar (lambda (tag)
|
|
||||||
(vector file node-id tag)) tags))))
|
|
||||||
|
|
||||||
(defun org-roam-db-insert-refs ()
|
|
||||||
"Insert refs for node at point into Org-roam cache."
|
|
||||||
(when-let* ((file (buffer-file-name (buffer-base-buffer)))
|
|
||||||
(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 file 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 ((file (buffer-file-name (buffer-base-buffer)))
|
|
||||||
(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
|
(org-roam-db-query
|
||||||
[:insert :into links
|
[:insert :into headlines
|
||||||
:values $v1]
|
:values $v1]
|
||||||
(vector file (point) source dest type properties))))))
|
headlines)
|
||||||
|
t)
|
||||||
|
(error
|
||||||
|
(unless (listp headlines)
|
||||||
|
(setq headlines (list headlines)))
|
||||||
|
(lwarn '(org-roam) :error
|
||||||
|
(format "Duplicate IDs in %s, one of:\n\n%s\n\nskipping..."
|
||||||
|
(aref (car headlines) 1)
|
||||||
|
(string-join (mapcar (lambda (hl)
|
||||||
|
(aref hl 0)) headlines) "\n")))
|
||||||
|
nil)))
|
||||||
|
|
||||||
|
(defun org-roam-db--insert-tags (file tags)
|
||||||
|
"Insert TAGS for a FILE into the Org-roam cache."
|
||||||
|
(org-roam-db-query
|
||||||
|
[:insert :into tags
|
||||||
|
:values $v1]
|
||||||
|
(list (vector file tags))))
|
||||||
|
|
||||||
|
(defun org-roam-db--insert-ref (file ref)
|
||||||
|
"Insert REF for FILE into the Org-roam cache.
|
||||||
|
Returns t if successful, and nil otherwise.
|
||||||
|
Insertions can fail if the key is already in the database."
|
||||||
|
(let ((key (cdr ref))
|
||||||
|
(type (car ref)))
|
||||||
|
(condition-case nil
|
||||||
|
(progn
|
||||||
|
(org-roam-db-query
|
||||||
|
[:insert :into refs :values $v1]
|
||||||
|
(list (vector key file type)))
|
||||||
|
t)
|
||||||
|
(error
|
||||||
|
(lwarn '(org-roam) :error
|
||||||
|
(format "Duplicate ref %s in:\n\nA: %s\nB: %s\n\nskipping..."
|
||||||
|
key
|
||||||
|
file
|
||||||
|
(caar (org-roam-db-query
|
||||||
|
[:select file :from refs
|
||||||
|
:where (= ref $v1)]
|
||||||
|
(vector key)))))
|
||||||
|
nil))))
|
||||||
|
|
||||||
;;;;; Fetching
|
;;;;; Fetching
|
||||||
(defun org-roam-db--get-current-files ()
|
(defun org-roam-db--get-current-files ()
|
||||||
"Return a hash-table of file to the hash of its file contents."
|
"Return a hash-table of file to the hash of its file contents."
|
||||||
(let ((current-files (org-roam-db-query [:select [file hash] :from files]))
|
(let* ((current-files (org-roam-db-query [:select * :from files]))
|
||||||
(ht (make-hash-table :test #'equal)))
|
(ht (make-hash-table :test #'equal)))
|
||||||
(dolist (row current-files)
|
(dolist (row current-files)
|
||||||
(puthash (car row) (cadr row) ht))
|
(puthash (car row) (cadr row) ht))
|
||||||
ht))
|
ht))
|
||||||
|
|
||||||
|
(defun org-roam-db--get-titles (file)
|
||||||
|
"Return the titles of FILE from the cache."
|
||||||
|
(caar (org-roam-db-query [:select [title] :from titles
|
||||||
|
:where (= file $s1)
|
||||||
|
:limit 1]
|
||||||
|
file)))
|
||||||
|
|
||||||
|
(defun org-roam-db--connected-component (file)
|
||||||
|
"Return all files reachable from/connected to FILE, 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 filelinks AS (SELECT * FROM links WHERE \"type\" = '\"file\"'),
|
||||||
|
citelinks AS (SELECT * FROM links
|
||||||
|
JOIN refs ON links.\"to\" = refs.\"ref\"
|
||||||
|
AND links.\"type\" = '\"cite\"')
|
||||||
|
SELECT \"from\", \"to\" FROM filelinks UNION
|
||||||
|
SELECT \"to\", \"from\" FROM filelinks 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 connected to FILE in at most MAX-DISTANCE steps.
|
||||||
|
This includes the file itself. If the file does not have any
|
||||||
|
connections, nil is returned."
|
||||||
|
(let* ((query "WITH RECURSIVE
|
||||||
|
links_of(file, link) AS
|
||||||
|
(WITH filelinks AS (SELECT * FROM links WHERE \"type\" = '\"file\"'),
|
||||||
|
citelinks AS (SELECT * FROM links
|
||||||
|
JOIN refs ON links.\"to\" = refs.\"ref\"
|
||||||
|
AND links.\"type\" = '\"cite\"')
|
||||||
|
SELECT \"from\", \"to\" FROM filelinks UNION
|
||||||
|
SELECT \"to\", \"from\" FROM filelinks 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))
|
||||||
|
|
||||||
(defun org-roam-db--file-hash (&optional file-path)
|
(defun org-roam-db--file-hash (&optional file-path)
|
||||||
"Compute the hash of FILE-PATH, a file or current buffer."
|
"Compute the hash of FILE-PATH, a file or current buffer."
|
||||||
(if file-path
|
(let* ((file-p (and file-path))
|
||||||
(with-temp-buffer
|
(file-path (or file-path
|
||||||
(set-buffer-multibyte nil)
|
(buffer-file-name (current-buffer))))
|
||||||
(insert-file-contents-literally file-path)
|
(encrypted-p (and file-path
|
||||||
(secure-hash 'sha1 (current-buffer)))
|
(string= (org-roam--file-name-extension file-path)
|
||||||
(org-with-wide-buffer
|
"gpg"))))
|
||||||
(secure-hash 'sha1 (current-buffer)))))
|
(cond ((and encrypted-p file-p)
|
||||||
|
(with-temp-buffer
|
||||||
|
(set-buffer-multibyte nil)
|
||||||
|
(insert-file-contents-literally file-path)
|
||||||
|
(secure-hash 'sha1 (current-buffer))))
|
||||||
|
(file-p
|
||||||
|
(with-temp-buffer
|
||||||
|
(insert-file-contents file-path)
|
||||||
|
(secure-hash 'sha1 (current-buffer))))
|
||||||
|
(t
|
||||||
|
(secure-hash 'sha1 (current-buffer))))))
|
||||||
|
|
||||||
;;;;; Updating
|
;;;;; Updating
|
||||||
(defun org-roam-db-sync (&optional force)
|
(defun org-roam-db--update-meta ()
|
||||||
"Synchronize the cache state with the current Org files on-disk.
|
"Update the metadata of the current buffer into the cache."
|
||||||
|
(let* ((file (file-truename (buffer-file-name)))
|
||||||
|
(attr (file-attributes file))
|
||||||
|
(atime (file-attribute-access-time attr))
|
||||||
|
(mtime (file-attribute-modification-time attr))
|
||||||
|
(hash (org-roam-db--file-hash)))
|
||||||
|
(org-roam-db-query [:delete :from files
|
||||||
|
:where (= file $s1)]
|
||||||
|
file)
|
||||||
|
(org-roam-db--insert-meta file hash (list :atime atime :mtime mtime))))
|
||||||
|
|
||||||
|
(defun org-roam-db--update-titles ()
|
||||||
|
"Update the title of the current buffer into the cache."
|
||||||
|
(let* ((file (file-truename (buffer-file-name)))
|
||||||
|
(titles (or (org-roam--extract-titles)
|
||||||
|
(list (org-roam--path-to-slug file)))))
|
||||||
|
(org-roam-db-query [:delete :from titles
|
||||||
|
:where (= file $s1)]
|
||||||
|
file)
|
||||||
|
(org-roam-db--insert-titles file titles)))
|
||||||
|
|
||||||
|
(defun org-roam-db--update-tags ()
|
||||||
|
"Update the tags of the current buffer into the cache."
|
||||||
|
(let ((file (file-truename (buffer-file-name)))
|
||||||
|
(tags (org-roam--extract-tags)))
|
||||||
|
(org-roam-db-query [:delete :from tags
|
||||||
|
:where (= file $s1)]
|
||||||
|
file)
|
||||||
|
(when tags
|
||||||
|
(org-roam-db--insert-tags file tags))))
|
||||||
|
|
||||||
|
(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-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-headlines ()
|
||||||
|
"Update the file headlines of the current buffer into the cache."
|
||||||
|
(let* ((file (file-truename (buffer-file-name))))
|
||||||
|
(org-roam-db-query [:delete :from headlines
|
||||||
|
:where (= file $s1)]
|
||||||
|
file)
|
||||||
|
(when-let ((headlines (org-roam--extract-headlines)))
|
||||||
|
(org-roam-db--insert-headlines headlines))))
|
||||||
|
|
||||||
|
(defun org-roam-db--update-file (&optional file-path)
|
||||||
|
"Update Org-roam cache for FILE-PATH."
|
||||||
|
(when (org-roam--org-roam-file-p file-path)
|
||||||
|
(let ((buf (or (and file-path
|
||||||
|
(find-file-noselect file-path t))
|
||||||
|
(current-buffer))))
|
||||||
|
(with-current-buffer buf
|
||||||
|
(save-excursion
|
||||||
|
(emacsql-with-transaction (org-roam-db)
|
||||||
|
(org-roam-db--update-meta)
|
||||||
|
(org-roam-db--update-tags)
|
||||||
|
(org-roam-db--update-titles)
|
||||||
|
(org-roam-db--update-refs)
|
||||||
|
(org-roam-db--update-headlines)
|
||||||
|
(org-roam-db--update-links))
|
||||||
|
(org-roam-buffer--update-maybe :redisplay t))))))
|
||||||
|
|
||||||
|
(defun org-roam-db-build-cache (&optional force)
|
||||||
|
"Build the cache for `org-roam-directory'.
|
||||||
If FORCE, force a rebuild of the cache from scratch."
|
If FORCE, force a rebuild of the cache from scratch."
|
||||||
(interactive "P")
|
(interactive "P")
|
||||||
(when force (delete-file org-roam-db-location))
|
(when force (delete-file (org-roam-db--get)))
|
||||||
(org-roam-db--close) ;; Force a reconnect
|
(org-roam-db--close) ;; Force a reconnect
|
||||||
(org-roam-db) ;; To initialize the database, no-op if already initialized
|
(org-roam-db) ;; To initialize the database, no-op if already initialized
|
||||||
(let* ((gc-cons-threshold org-roam-db-gc-threshold)
|
(let* ((gc-cons-threshold org-roam-db-gc-threshold)
|
||||||
(org-agenda-files nil)
|
|
||||||
(org-roam-files (org-roam--list-all-files))
|
(org-roam-files (org-roam--list-all-files))
|
||||||
(current-files (org-roam-db--get-current-files))
|
(current-files (org-roam-db--get-current-files))
|
||||||
(modified-files nil))
|
(file-count 0)
|
||||||
(dolist (file org-roam-files)
|
(headline-count 0)
|
||||||
(let ((contents-hash (org-roam-db--file-hash file)))
|
(link-count 0)
|
||||||
(unless (string= (gethash file current-files)
|
(tag-count 0)
|
||||||
contents-hash)
|
(title-count 0)
|
||||||
(push file modified-files)))
|
(ref-count 0)
|
||||||
(remhash file current-files))
|
(deleted-count 0))
|
||||||
(if (fboundp 'dolist-with-progress-reporter)
|
(emacsql-with-transaction (org-roam-db)
|
||||||
(dolist-with-progress-reporter (file (hash-table-keys current-files))
|
;; Two-step building
|
||||||
"Clearing removed files..."
|
;; First step: Rebuild files and headlines
|
||||||
(org-roam-db-clear-file file))
|
(dolist (file org-roam-files)
|
||||||
|
(let* ((attr (file-attributes file))
|
||||||
|
(atime (file-attribute-access-time attr))
|
||||||
|
(mtime (file-attribute-modification-time attr)))
|
||||||
|
(let ((contents-hash (org-roam-db--file-hash file)))
|
||||||
|
(unless (string= (gethash file current-files)
|
||||||
|
contents-hash)
|
||||||
|
(condition-case nil
|
||||||
|
(org-roam--with-temp-buffer file
|
||||||
|
(org-roam-db--clear-file file)
|
||||||
|
(org-roam-db-query
|
||||||
|
[:insert :into files
|
||||||
|
:values $v1]
|
||||||
|
(vector file contents-hash (list :atime atime :mtime mtime)))
|
||||||
|
(setq file-count (1+ file-count))
|
||||||
|
(when-let ((headlines (org-roam--extract-headlines file)))
|
||||||
|
(when (org-roam-db--insert-headlines headlines)
|
||||||
|
(setq headline-count (1+ headline-count)))))
|
||||||
|
(file-error
|
||||||
|
(setq org-roam-files (remove file org-roam-files))
|
||||||
|
(org-roam-db--clear-file file)
|
||||||
|
(lwarn '(org-roam) :warning
|
||||||
|
"Skipping unreadable file while building cache: %s" file)))))))
|
||||||
|
;; Second step: Rebuild the rest
|
||||||
|
(dolist (file org-roam-files)
|
||||||
|
(let ((contents-hash (org-roam-db--file-hash file)))
|
||||||
|
(unless (string= (gethash file current-files)
|
||||||
|
contents-hash)
|
||||||
|
(org-roam--with-temp-buffer file
|
||||||
|
(when-let (links (org-roam--extract-links file))
|
||||||
|
(org-roam-db-query
|
||||||
|
[:insert :into links
|
||||||
|
:values $v1]
|
||||||
|
links)
|
||||||
|
(setq link-count (1+ link-count)))
|
||||||
|
(when-let (tags (org-roam--extract-tags file))
|
||||||
|
(org-roam-db-query
|
||||||
|
[:insert :into tags
|
||||||
|
:values $v1]
|
||||||
|
(vector file tags))
|
||||||
|
(setq tag-count (1+ tag-count)))
|
||||||
|
(let ((titles (or (org-roam--extract-titles)
|
||||||
|
(list (org-roam--path-to-slug file)))))
|
||||||
|
(org-roam-db--insert-titles file titles)
|
||||||
|
(setq title-count (+ title-count (length titles))))
|
||||||
|
(when-let* ((ref (org-roam--extract-ref)))
|
||||||
|
(when (org-roam-db--insert-ref file ref)
|
||||||
|
(setq ref-count (1+ ref-count))))))
|
||||||
|
(remhash file current-files)))
|
||||||
(dolist (file (hash-table-keys current-files))
|
(dolist (file (hash-table-keys current-files))
|
||||||
(org-roam-db-clear-file file)))
|
;; These files are no longer around, remove from cache...
|
||||||
(if (fboundp 'dolist-with-progress-reporter)
|
(org-roam-db--clear-file file)
|
||||||
(dolist-with-progress-reporter (file modified-files)
|
(setq deleted-count (1+ deleted-count))))
|
||||||
"Processing modified files..."
|
(org-roam-message "files: Δ%s, headlines: Δ%s, links: Δ%s, tags: Δ%s, titles: Δ%s, refs: Δ%s, deleted: Δ%s"
|
||||||
(org-roam-db-update-file file))
|
file-count
|
||||||
(dolist (file modified-files)
|
headline-count
|
||||||
(org-roam-db-update-file file)))))
|
link-count
|
||||||
|
tag-count
|
||||||
(defun org-roam-db-update-file (&optional file-path)
|
title-count
|
||||||
"Update Org-roam cache for FILE-PATH.
|
ref-count
|
||||||
If the file does not exist anymore, remove it from the cache.
|
deleted-count)))
|
||||||
If the file exists, update the cache with information."
|
|
||||||
(setq file-path (or file-path (buffer-file-name (buffer-base-buffer))))
|
|
||||||
(let ((content-hash (org-roam-db--file-hash file-path))
|
|
||||||
(db-hash (caar (org-roam-db-query [:select hash :from files
|
|
||||||
:where (= file $s1)] file-path))))
|
|
||||||
(unless (string= content-hash db-hash)
|
|
||||||
(org-roam-with-file file-path nil
|
|
||||||
(save-excursion
|
|
||||||
(org-set-regexps-and-options 'tags-only)
|
|
||||||
(org-roam-db-clear-file)
|
|
||||||
(org-roam-db-insert-file)
|
|
||||||
(org-roam-db-insert-file-node)
|
|
||||||
(org-roam-db-map-headlines
|
|
||||||
(list #'org-roam-db-insert-node-data
|
|
||||||
#'org-roam-db-insert-aliases
|
|
||||||
#'org-roam-db-insert-tags
|
|
||||||
#'org-roam-db-insert-refs))
|
|
||||||
(org-roam-db-map-links
|
|
||||||
(list #'org-roam-db-insert-link)))))))
|
|
||||||
|
|
||||||
(defun org-roam-db--update-on-save-h ()
|
|
||||||
"."
|
|
||||||
(add-hook 'after-save-hook #'org-roam-db-update-file nil t))
|
|
||||||
|
|
||||||
(add-to-list 'org-roam-find-file-hook #'org-roam-db--update-on-save-h)
|
|
||||||
|
|
||||||
;; Diagnostic Interactives
|
|
||||||
(defun org-roam-db-diagnose-node ()
|
|
||||||
"Print information about node at point."
|
|
||||||
(interactive)
|
|
||||||
(prin1 (org-roam-node-at-point)))
|
|
||||||
|
|
||||||
(provide 'org-roam-db)
|
(provide 'org-roam-db)
|
||||||
|
|
||||||
|
46
org-roam-dev.el
Normal file
46
org-roam-dev.el
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
;;; org-roam-dev.el --- Org-roam development code -mode -*- 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: 1.2.1
|
||||||
|
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "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 code for org-roam developers.
|
||||||
|
;; It is intended to be loaded before editing org-roam source files.
|
||||||
|
;; It ensures consistent application of various developer settings.
|
||||||
|
;;
|
||||||
|
;;; Code:
|
||||||
|
(require 'emacsql)
|
||||||
|
|
||||||
|
;;;###autoload
|
||||||
|
(define-minor-mode org-roam-dev-mode
|
||||||
|
"Minor mode for setting the dev environment of Org-roam."
|
||||||
|
:lighter " ORD"
|
||||||
|
(when org-roam-dev-mode
|
||||||
|
(emacsql-fix-vector-indentation)
|
||||||
|
(setq-local sentence-end-double-space nil)))
|
||||||
|
|
||||||
|
(provide 'org-roam-dev)
|
||||||
|
;;; org-roam-dev.el ends here
|
@ -5,8 +5,8 @@
|
|||||||
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
||||||
;; URL: https://github.com/jethrokuan/org-roam
|
;; URL: https://github.com/jethrokuan/org-roam
|
||||||
;; Keywords: org-mode, roam, convenience
|
;; Keywords: org-mode, roam, convenience
|
||||||
;; Version: 2.0.0
|
;; Version: 1.2.1
|
||||||
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2") (magit-section "2.90.1"))
|
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.0"))
|
||||||
|
|
||||||
;; This file is NOT part of GNU Emacs.
|
;; This file is NOT part of GNU Emacs.
|
||||||
|
|
||||||
@ -45,27 +45,19 @@
|
|||||||
(require 'cl-lib)
|
(require 'cl-lib)
|
||||||
(require 'org)
|
(require 'org)
|
||||||
(require 'org-element)
|
(require 'org-element)
|
||||||
|
(require 's)
|
||||||
(require 'dash)
|
(require 'dash)
|
||||||
(eval-when-compile
|
(require 'org-roam-macs)
|
||||||
(require 'org-roam-macs))
|
|
||||||
(require 'org-roam)
|
|
||||||
|
|
||||||
(defvar org-roam-mode-map)
|
|
||||||
|
|
||||||
|
(declare-function org-roam-insert "org-roam")
|
||||||
(declare-function org-roam--get-roam-buffers "org-roam")
|
(declare-function org-roam--get-roam-buffers "org-roam")
|
||||||
(declare-function org-roam--list-all-files "org-roam")
|
(declare-function org-roam--list-all-files "org-roam")
|
||||||
(declare-function org-roam--org-roam-file-p "org-roam")
|
(declare-function org-roam--org-roam-file-p "org-roam")
|
||||||
|
(declare-function org-roam--str-to-list "org-roam")
|
||||||
|
(declare-function org-roam-mode "org-roam")
|
||||||
|
|
||||||
(defvar org-roam-verbose)
|
(defvar org-roam-verbose)
|
||||||
|
(defvar org-roam-mode)
|
||||||
(defcustom org-roam-doctor-inhibit-startup t
|
|
||||||
"Inhibit `org-mode' startup when processing files with `org-doctor'.
|
|
||||||
When non-nil, images and LaTeX preview will not be generated,
|
|
||||||
tables will not be aligned, and headlines will not respect
|
|
||||||
startup visability. This significantly improves performance when
|
|
||||||
processing multiple files"
|
|
||||||
:type 'boolean
|
|
||||||
:group 'org-roam)
|
|
||||||
|
|
||||||
(cl-defstruct (org-roam-doctor-checker (:copier nil))
|
(cl-defstruct (org-roam-doctor-checker (:copier nil))
|
||||||
(name 'missing-checker-name)
|
(name 'missing-checker-name)
|
||||||
@ -78,7 +70,79 @@ processing multiple files"
|
|||||||
:name 'org-roam-doctor-broken-links
|
:name 'org-roam-doctor-broken-links
|
||||||
:description "Fix broken links."
|
:description "Fix broken links."
|
||||||
:actions '(("d" . ("Unlink" . org-roam-doctor--remove-link))
|
:actions '(("d" . ("Unlink" . org-roam-doctor--remove-link))
|
||||||
("r" . ("Replace link" . org-roam-doctor--replace-link))))))
|
("r" . ("Replace link" . org-roam-doctor--replace-link))
|
||||||
|
("R" . ("Replace link (keep label)" . org-roam-doctor--replace-link-keep-label))))
|
||||||
|
(make-org-roam-doctor-checker
|
||||||
|
:name 'org-roam-doctor-check-roam-props
|
||||||
|
:description "Check #+roam_* properties.")
|
||||||
|
(make-org-roam-doctor-checker
|
||||||
|
:name 'org-roam-doctor-check-tags
|
||||||
|
:description "Check #+roam_tags.")
|
||||||
|
(make-org-roam-doctor-checker
|
||||||
|
:name 'org-roam-doctor-check-alias
|
||||||
|
:description "Check #+roam_alias.")))
|
||||||
|
|
||||||
|
(defconst org-roam-doctor--supported-roam-properties
|
||||||
|
'("roam_tags" "roam_alias" "roam_key")
|
||||||
|
"List of supported Org-roam properties.")
|
||||||
|
|
||||||
|
(defun org-roam-doctor-check-roam-props (ast)
|
||||||
|
"Checker for detecting invalid #+roam_* properties.
|
||||||
|
AST is the org-element parse tree."
|
||||||
|
(let (reports)
|
||||||
|
(org-element-map ast 'keyword
|
||||||
|
(lambda (kw)
|
||||||
|
(let ((key (org-element-property :key kw)))
|
||||||
|
(when (and (string-prefix-p "ROAM_" key t)
|
||||||
|
(not (member (downcase key) org-roam-doctor--supported-roam-properties)))
|
||||||
|
(push
|
||||||
|
`(,(org-element-property :begin kw)
|
||||||
|
,(concat "Possible mispelled key: "
|
||||||
|
(prin1-to-string key)
|
||||||
|
"\nOrg-roam supports the following keys: "
|
||||||
|
(s-join ", " org-roam-doctor--supported-roam-properties)))
|
||||||
|
reports)))))
|
||||||
|
reports))
|
||||||
|
|
||||||
|
(defun org-roam-doctor-check-tags (ast)
|
||||||
|
"Checker for detecting invalid #+roam_tags.
|
||||||
|
AST is the org-element parse tree."
|
||||||
|
(let (reports)
|
||||||
|
(org-element-map ast 'keyword
|
||||||
|
(lambda (kw)
|
||||||
|
(when (string-collate-equalp (org-element-property :key kw) "roam_tags" nil t)
|
||||||
|
(let ((tags (org-element-property :value kw)))
|
||||||
|
(condition-case nil
|
||||||
|
(org-roam--str-to-list tags)
|
||||||
|
(error
|
||||||
|
(push
|
||||||
|
`(,(org-element-property :begin kw)
|
||||||
|
,(concat "Unable to parse tags: "
|
||||||
|
tags
|
||||||
|
(when (s-contains? "," tags)
|
||||||
|
"\nCheck that your tags are not comma-separated.")))
|
||||||
|
reports)))))))
|
||||||
|
reports))
|
||||||
|
|
||||||
|
(defun org-roam-doctor-check-alias (ast)
|
||||||
|
"Checker for detecting invalid #+roam_alias.
|
||||||
|
AST is the org-element parse tree."
|
||||||
|
(let (reports)
|
||||||
|
(org-element-map ast 'keyword
|
||||||
|
(lambda (kw)
|
||||||
|
(when (string-collate-equalp (org-element-property :key kw) "roam_alias" nil t)
|
||||||
|
(let ((aliases (org-element-property :value kw)))
|
||||||
|
(condition-case nil
|
||||||
|
(org-roam--str-to-list aliases)
|
||||||
|
(error
|
||||||
|
(push
|
||||||
|
`(,(org-element-property :begin kw)
|
||||||
|
,(concat "Unable to parse aliases: "
|
||||||
|
aliases
|
||||||
|
(when (s-contains? "," aliases)
|
||||||
|
"\nCheck that your aliases are not comma-separated.")))
|
||||||
|
reports)))))))
|
||||||
|
reports))
|
||||||
|
|
||||||
(defun org-roam-doctor-broken-links (ast)
|
(defun org-roam-doctor-broken-links (ast)
|
||||||
"Checker for detecting broken links.
|
"Checker for detecting broken links.
|
||||||
@ -86,12 +150,18 @@ AST is the org-element parse tree."
|
|||||||
(let (reports)
|
(let (reports)
|
||||||
(org-element-map ast 'link
|
(org-element-map ast 'link
|
||||||
(lambda (l)
|
(lambda (l)
|
||||||
(when (equal "id" (org-element-property :type l))
|
(when (equal "file" (org-element-property :type l))
|
||||||
(let ((id (org-element-property :path l)))
|
(let ((file (org-element-property :path l)))
|
||||||
(unless (org-id-find id)
|
(or (file-exists-p file)
|
||||||
(push `(,(org-element-property :begin l)
|
(file-remote-p file)
|
||||||
,(format "Broken id link \"%s\"" id))
|
(push
|
||||||
reports))))))
|
`(,(org-element-property :begin l)
|
||||||
|
,(format (if (org-element-lineage l '(link))
|
||||||
|
"Link to non-existent image file \"%s\"\
|
||||||
|
in link description"
|
||||||
|
"Link to non-existent local file \"%s\"")
|
||||||
|
file))
|
||||||
|
reports))))))
|
||||||
reports))
|
reports))
|
||||||
|
|
||||||
(defun org-roam-doctor--check (buffer checkers)
|
(defun org-roam-doctor--check (buffer checkers)
|
||||||
@ -143,7 +213,25 @@ CHECKERS is the list of checkers used."
|
|||||||
(condition-case nil
|
(condition-case nil
|
||||||
(save-excursion
|
(save-excursion
|
||||||
(replace-match "")
|
(replace-match "")
|
||||||
(org-roam-node-insert))
|
(org-roam-insert))
|
||||||
|
(quit (progn
|
||||||
|
(replace-buffer-contents orig)
|
||||||
|
(goto-char p)))))))
|
||||||
|
|
||||||
|
(defun org-roam-doctor--replace-link-keep-label ()
|
||||||
|
"Replace the current link with a new link, keeping the current link's label."
|
||||||
|
(save-match-data
|
||||||
|
(unless (org-in-regexp org-link-bracket-re 1)
|
||||||
|
(user-error "No link at point"))
|
||||||
|
(let ((orig (buffer-string))
|
||||||
|
(p (point)))
|
||||||
|
(condition-case nil
|
||||||
|
(save-excursion
|
||||||
|
(let ((label (if (match-end 2)
|
||||||
|
(match-string-no-properties 2)
|
||||||
|
(org-link-unescape (match-string-no-properties 1)))))
|
||||||
|
(replace-match "")
|
||||||
|
(org-roam-insert nil nil label)))
|
||||||
(quit (progn
|
(quit (progn
|
||||||
(replace-buffer-contents orig)
|
(replace-buffer-contents orig)
|
||||||
(goto-char p)))))))
|
(goto-char p)))))))
|
||||||
@ -162,7 +250,7 @@ CHECKERS is the list of checkers used."
|
|||||||
(defun org-roam-doctor--resolve (msg checker)
|
(defun org-roam-doctor--resolve (msg checker)
|
||||||
"Resolve an error.
|
"Resolve an error.
|
||||||
MSG is the error that was found, which is displayed in a help buffer.
|
MSG is the error that was found, which is displayed in a help buffer.
|
||||||
CHECKER is a `org-roam-doctor' checker instance."
|
CHECKER is a org-roam-doctor checker instance."
|
||||||
(let ((actions (org-roam-doctor-checker-actions checker))
|
(let ((actions (org-roam-doctor-checker-actions checker))
|
||||||
c)
|
c)
|
||||||
(push '("e" . ("Edit" . org-roam-doctor--recursive-edit)) actions)
|
(push '("e" . ("Edit" . org-roam-doctor--recursive-edit)) actions)
|
||||||
@ -195,19 +283,18 @@ CHECKER is a `org-roam-doctor' checker instance."
|
|||||||
"Perform a check on the current buffer to ensure cleanliness.
|
"Perform a check on the current buffer to ensure cleanliness.
|
||||||
If CHECKALL, run the check for all Org-roam files."
|
If CHECKALL, run the check for all Org-roam files."
|
||||||
(interactive "P")
|
(interactive "P")
|
||||||
|
(unless org-roam-mode (org-roam-mode))
|
||||||
(let ((files (if checkall
|
(let ((files (if checkall
|
||||||
(org-roam--list-all-files)
|
(org-roam--list-all-files)
|
||||||
(unless (org-roam--org-roam-file-p)
|
(unless (org-roam--org-roam-file-p)
|
||||||
(user-error "Not in an org-roam file"))
|
(user-error "Not in an org-roam file"))
|
||||||
`(,(buffer-file-name)))))
|
`(,(buffer-file-name)))))
|
||||||
(org-roam-doctor-start files org-roam-doctor--checkers)))
|
(org-roam-doctor-start files org-roam-doctor--checkers)))
|
||||||
|
|
||||||
(defun org-roam-doctor-start (files checkers)
|
(defun org-roam-doctor-start (files checkers)
|
||||||
"Lint FILES using CHECKERS."
|
"Lint FILES using CHECKERS."
|
||||||
(save-window-excursion
|
(save-window-excursion
|
||||||
(let ((existing-buffers (org-roam--get-roam-buffers))
|
(let ((existing-buffers (org-roam--get-roam-buffers)))
|
||||||
(org-inhibit-startup org-roam-doctor-inhibit-startup))
|
|
||||||
(org-id-update-id-locations)
|
|
||||||
(dolist (f files)
|
(dolist (f files)
|
||||||
(let ((buf (find-file-noselect f)))
|
(let ((buf (find-file-noselect f)))
|
||||||
(org-roam-doctor--check buf checkers)
|
(org-roam-doctor--check buf checkers)
|
||||||
|
67
org-roam-faces.el
Normal file
67
org-roam-faces.el
Normal file
@ -0,0 +1,67 @@
|
|||||||
|
;;; org-roam-faces.el --- Face definitions -*- 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: 1.2.1
|
||||||
|
;; Package-Requires: ((emacs "26.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 file contains the face definitions for Org-roam.
|
||||||
|
|
||||||
|
;;; Code:
|
||||||
|
|
||||||
|
(defgroup org-roam-faces nil
|
||||||
|
"Faces used by Org-roam."
|
||||||
|
:group 'org-roam
|
||||||
|
:group 'faces)
|
||||||
|
|
||||||
|
;;; Definitions
|
||||||
|
(defface org-roam-link
|
||||||
|
'((t :inherit org-link))
|
||||||
|
"Face for Org-roam links."
|
||||||
|
:group 'org-roam-faces)
|
||||||
|
|
||||||
|
(defface org-roam-link-current
|
||||||
|
'((t :inherit org-link))
|
||||||
|
"Face for Org-roam links pointing to the current buffer."
|
||||||
|
:group 'org-roam-faces)
|
||||||
|
|
||||||
|
(defface org-roam-link-invalid
|
||||||
|
'((t :inherit (error org-link)))
|
||||||
|
"Face for Org-roam links that are not valid.
|
||||||
|
This face is used for links without a destination."
|
||||||
|
:group 'org-roam-faces)
|
||||||
|
|
||||||
|
(defface org-roam-link-shielded
|
||||||
|
'((t :inherit (warning org-link)))
|
||||||
|
"Face for Org-roam links that are shielded.
|
||||||
|
This face is used on the region target by `org-roam-insertion'
|
||||||
|
during an `org-roam-capture'."
|
||||||
|
:group 'org-roam-faces)
|
||||||
|
|
||||||
|
;;; _
|
||||||
|
|
||||||
|
(provide 'org-roam-faces)
|
||||||
|
|
||||||
|
;;; org-roam-faces.el ends here
|
0
org-roam-flow.el
Normal file
0
org-roam-flow.el
Normal file
308
org-roam-graph.el
Normal file
308
org-roam-graph.el
Normal file
@ -0,0 +1,308 @@
|
|||||||
|
;;; org-roam-graph.el --- Graphing API -*- 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: 1.2.1
|
||||||
|
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "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 graphing functionality for org-roam.
|
||||||
|
;;
|
||||||
|
;;; Code:
|
||||||
|
(require 'xml) ;xml-escape-string
|
||||||
|
(require 's) ;s-truncate, s-replace
|
||||||
|
(require 'org-roam-macs)
|
||||||
|
(require 'org-roam-db)
|
||||||
|
|
||||||
|
;;;; Declarations
|
||||||
|
(defvar org-roam-directory)
|
||||||
|
(defvar org-roam-mode)
|
||||||
|
(declare-function org-roam--org-roam-file-p "org-roam")
|
||||||
|
(declare-function org-roam--path-to-slug "org-roam")
|
||||||
|
(declare-function org-roam-mode "org-roam")
|
||||||
|
|
||||||
|
;;;; Options
|
||||||
|
(defcustom org-roam-graph-viewer (executable-find "firefox")
|
||||||
|
"Method to view the org-roam graph.
|
||||||
|
It may be one of the following:
|
||||||
|
- a string representing the path to the executable for viewing the graph.
|
||||||
|
- a function accepting a single argument: the graph file path.
|
||||||
|
- nil uses `view-file' to view the graph."
|
||||||
|
:type '(choice
|
||||||
|
(string :tag "Path to executable")
|
||||||
|
(function :tag "Function to display graph" eww-open-file)
|
||||||
|
(const :tag "view-file"))
|
||||||
|
:group 'org-roam)
|
||||||
|
|
||||||
|
(defcustom org-roam-graph-executable "dot"
|
||||||
|
"Path to graphing executable, or its name."
|
||||||
|
:type 'string
|
||||||
|
:group 'org-roam)
|
||||||
|
|
||||||
|
(defcustom org-roam-graph-extra-config nil
|
||||||
|
"Extra options passed to graphviz.
|
||||||
|
Example:
|
||||||
|
'((\"rankdir\" . \"LR\"))"
|
||||||
|
:type '(alist)
|
||||||
|
:group 'org-roam)
|
||||||
|
|
||||||
|
(defcustom org-roam-graph-node-extra-config
|
||||||
|
'(("shape" . "underline")
|
||||||
|
("style" . "rounded,filled")
|
||||||
|
("fillcolor" . "#EEEEEE")
|
||||||
|
("color" . "#C9C9C9")
|
||||||
|
("fontcolor" . "#111111"))
|
||||||
|
"Extra options for graphviz nodes.
|
||||||
|
Example:
|
||||||
|
'((\"color\" . \"skyblue\"))"
|
||||||
|
:type '(alist)
|
||||||
|
:group 'org-roam)
|
||||||
|
|
||||||
|
(defcustom org-roam-graph-edge-extra-config
|
||||||
|
'(("color" . "#333333"))
|
||||||
|
"Extra options for graphviz edges.
|
||||||
|
Example:
|
||||||
|
'((\"dir\" . \"back\"))"
|
||||||
|
:type '(alist)
|
||||||
|
:group 'org-roam)
|
||||||
|
|
||||||
|
(defcustom org-roam-graph-edge-cites-extra-config '(("color" . "red"))
|
||||||
|
"Extra options for graphviz edges for citation links.
|
||||||
|
Example:
|
||||||
|
'((\"dir\" . \"back\"))"
|
||||||
|
:type '(alist)
|
||||||
|
: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-shorten-titles 'truncate
|
||||||
|
"Determines how long titles appear in graph nodes.
|
||||||
|
Recognized values are the symbols `truncate' and `wrap', in which
|
||||||
|
cases the title will be truncated or wrapped, respectively, if it
|
||||||
|
is longer than `org-roam-graph-max-title-length'.
|
||||||
|
|
||||||
|
All other values including nil will have no effect."
|
||||||
|
:type '(choice
|
||||||
|
(const :tag "truncate" truncate)
|
||||||
|
(const :tag "wrap" wrap)
|
||||||
|
(const :tag "no" nil))
|
||||||
|
:group 'org-roam)
|
||||||
|
|
||||||
|
(defcustom org-roam-graph-exclude-matcher nil
|
||||||
|
"Matcher for excluding nodes from the generated graph.
|
||||||
|
Any nodes and links for file paths matching this string is
|
||||||
|
excluded from the graph.
|
||||||
|
|
||||||
|
If value is a string, the string is the only matcher.
|
||||||
|
|
||||||
|
If value is a list, all file paths matching any of the strings
|
||||||
|
are excluded."
|
||||||
|
:type '(choice
|
||||||
|
(string :tag "Matcher")
|
||||||
|
(list :tag "Matchers"))
|
||||||
|
: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.
|
||||||
|
If WRAP-VAL is non-nil it wraps the VAL."
|
||||||
|
(concat wrap-key (car option) wrap-key
|
||||||
|
"="
|
||||||
|
wrap-val (cdr option) wrap-val))
|
||||||
|
|
||||||
|
(defun org-roam-graph--dot (node-query)
|
||||||
|
"Build the graphviz dot string for NODE-QUERY.
|
||||||
|
The Org-roam database titles table is read, to obtain the list of titles.
|
||||||
|
The links table is then read to obtain all directed links, and formatted
|
||||||
|
into a digraph."
|
||||||
|
(org-roam-db--ensure-built)
|
||||||
|
(org-roam--with-temp-buffer nil
|
||||||
|
(let* ((nodes (org-roam-db-query node-query))
|
||||||
|
(edges-query
|
||||||
|
`[:with selected :as [:select [file] :from ,node-query]
|
||||||
|
:select :distinct [to from] :from links
|
||||||
|
:where (and (in to selected) (in from selected))])
|
||||||
|
(edges-cites-query
|
||||||
|
`[:with selected :as [:select [file] :from ,node-query]
|
||||||
|
:select :distinct [file from]
|
||||||
|
:from links :inner :join refs :on (and (= links:to refs:ref)
|
||||||
|
(= links:type "cite")
|
||||||
|
(= refs:type "cite"))
|
||||||
|
:where (and (in file selected) (in from selected))])
|
||||||
|
(edges (org-roam-db-query edges-query))
|
||||||
|
(edges-cites (org-roam-db-query edges-cites-query)))
|
||||||
|
(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 " %s [%s];\n" attribute
|
||||||
|
(mapconcat (lambda (var)
|
||||||
|
(org-roam-graph--dot-option var nil "\""))
|
||||||
|
(symbol-value
|
||||||
|
(intern (concat "org-roam-graph-" attribute "-extra-config")))
|
||||||
|
","))))
|
||||||
|
(dolist (node nodes)
|
||||||
|
(let* ((file (xml-escape-string (car node)))
|
||||||
|
(title (or (cadr node)
|
||||||
|
(org-roam--path-to-slug file)))
|
||||||
|
(shortened-title (pcase org-roam-graph-shorten-titles
|
||||||
|
(`truncate (s-truncate org-roam-graph-max-title-length title))
|
||||||
|
(`wrap (s-word-wrap org-roam-graph-max-title-length title))
|
||||||
|
(_ title)))
|
||||||
|
(shortened-title (org-roam-string-quote shortened-title))
|
||||||
|
(title (org-roam-string-quote title))
|
||||||
|
(node-properties
|
||||||
|
`(("label" . ,shortened-title)
|
||||||
|
("URL" . ,(concat "org-protocol://roam-file?file=" (url-hexify-string file)))
|
||||||
|
("tooltip" . ,(xml-escape-string title)))))
|
||||||
|
(insert
|
||||||
|
(format " \"%s\" [%s];\n" file
|
||||||
|
(mapconcat (lambda (n)
|
||||||
|
(org-roam-graph--dot-option n nil "\""))
|
||||||
|
node-properties ",")))))
|
||||||
|
(dolist (edge edges)
|
||||||
|
(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 callback)
|
||||||
|
"Generate a graph showing the relations between nodes in NODE-QUERY.
|
||||||
|
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
|
||||||
|
`[:select [file title] :from titles
|
||||||
|
,@(org-roam-graph--expand-matcher 'file t)
|
||||||
|
:group :by file]))
|
||||||
|
(graph (org-roam-graph--dot node-query))
|
||||||
|
(temp-dot (make-temp-file "graph." nil ".dot" graph))
|
||||||
|
(temp-graph (make-temp-file "graph." nil ".svg")))
|
||||||
|
(org-roam-message "building graph")
|
||||||
|
(make-process
|
||||||
|
:name "*org-roam-graph--build-process*"
|
||||||
|
:buffer "*org-roam-graph--build-process*"
|
||||||
|
:command `(,org-roam-graph-executable ,temp-dot "-Tsvg" "-o" ,temp-graph)
|
||||||
|
:sentinel (when callback
|
||||||
|
(lambda (process _event)
|
||||||
|
(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."
|
||||||
|
(pcase org-roam-graph-viewer
|
||||||
|
((pred stringp)
|
||||||
|
(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)))
|
||||||
|
(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 callback)
|
||||||
|
"Build a graph of nodes connected to FILE.
|
||||||
|
If MAX-DISTANCE is non-nil, limit nodes to MAX-DISTANCE steps.
|
||||||
|
CALLBACK is passed to `org-roam-graph--build'."
|
||||||
|
(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 title]
|
||||||
|
:from titles
|
||||||
|
:where (in file [,@files])]))
|
||||||
|
(org-roam-graph--build query callback)))
|
||||||
|
|
||||||
|
;;;; Commands
|
||||||
|
;;;###autoload
|
||||||
|
(defun org-roam-graph (&optional arg file node-query)
|
||||||
|
"Build and possibly display a graph for FILE from NODE-QUERY.
|
||||||
|
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]' N show the graph for FILE limiting nodes to N steps.
|
||||||
|
- `\\[universal-argument] \\[universal-argument]' build the graph.
|
||||||
|
- `\\[universal-argument]' - build the graph for FILE.
|
||||||
|
- `\\[universal-argument]' -N build the graph for FILE limiting nodes to N steps."
|
||||||
|
(interactive "P")
|
||||||
|
(unless org-roam-mode (org-roam-mode))
|
||||||
|
(let ((file (or file (buffer-file-name (buffer-base-buffer)))))
|
||||||
|
(unless (or (not arg) (equal arg '(16)))
|
||||||
|
(unless file
|
||||||
|
(user-error "Cannot build graph for nil file. Is current buffer visiting a file?"))
|
||||||
|
(unless (org-roam--org-roam-file-p file)
|
||||||
|
(user-error "\"%s\" is not an org-roam file" file)))
|
||||||
|
(pcase arg
|
||||||
|
('nil (org-roam-graph--build node-query #'org-roam-graph--open))
|
||||||
|
('(4) (org-roam-graph--build-connected-component file nil #'org-roam-graph--open))
|
||||||
|
((pred integerp) (org-roam-graph--build-connected-component file (abs arg) (when (>= arg 0) #'org-roam-graph--open)))
|
||||||
|
('(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-graph.el ends here
|
102
org-roam-macs.el
102
org-roam-macs.el
@ -5,8 +5,8 @@
|
|||||||
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
||||||
;; URL: https://github.com/org-roam/org-roam
|
;; URL: https://github.com/org-roam/org-roam
|
||||||
;; Keywords: org-mode, roam, convenience
|
;; Keywords: org-mode, roam, convenience
|
||||||
;; Version: 2.0.0
|
;; Version: 1.2.1
|
||||||
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2") (magit-section "2.90.1"))
|
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.3") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.0"))
|
||||||
|
|
||||||
;; This file is NOT part of GNU Emacs.
|
;; This file is NOT part of GNU Emacs.
|
||||||
|
|
||||||
@ -27,60 +27,78 @@
|
|||||||
|
|
||||||
;;; Commentary:
|
;;; Commentary:
|
||||||
;;
|
;;
|
||||||
;; This library implements macros used throughout org-roam.
|
;; This library implements macros and utility functions used throughout
|
||||||
|
;; org-roam.
|
||||||
|
;;
|
||||||
;;
|
;;
|
||||||
;;; Code:
|
;;; Code:
|
||||||
(defmacro org-roam-plist-map! (fn plist)
|
;;;; Library Requires
|
||||||
"Map FN over PLIST, modifying it in-place."
|
(require 'dash)
|
||||||
(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-file (file keep-buf-p &rest body)
|
(defvar org-roam-verbose)
|
||||||
"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
|
|
||||||
(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 (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)
|
(defmacro org-roam--with-temp-buffer (file &rest body)
|
||||||
"Execute BODY within a temp buffer.
|
"Execute BODY within a temp buffer.
|
||||||
Like `with-temp-buffer', but propagates `org-roam-directory'.
|
Like `with-temp-buffer', but propagates `org-roam-directory'.
|
||||||
If FILE, set `default-directory' to FILE's directory and insert its contents."
|
If FILE, set `org-roam-temp-file-name' to file and insert its contents."
|
||||||
(declare (indent 1) (debug t))
|
(declare (indent 1) (debug t))
|
||||||
(let ((current-org-roam-directory (make-symbol "current-org-roam-directory")))
|
(let ((current-org-roam-directory (make-symbol "current-org-roam-directory")))
|
||||||
`(let ((,current-org-roam-directory org-roam-directory))
|
`(let ((,current-org-roam-directory org-roam-directory))
|
||||||
(with-temp-buffer
|
(with-temp-buffer
|
||||||
(let ((org-roam-directory ,current-org-roam-directory))
|
(let ((org-roam-directory ,current-org-roam-directory)
|
||||||
(delay-mode-hooks (org-mode))
|
(org-mode-hook nil))
|
||||||
|
(org-mode)
|
||||||
(when ,file
|
(when ,file
|
||||||
(insert-file-contents ,file)
|
(insert-file-contents ,file)
|
||||||
(setq-local default-directory (file-name-directory ,file)))
|
(setq-local org-roam-file-name ,file))
|
||||||
,@body)))))
|
,@body)))))
|
||||||
|
|
||||||
|
(defmacro org-roam--with-template-error (templates &rest body)
|
||||||
|
"Eval BODY, and point to TEMPLATES on error.
|
||||||
|
Provides more informative error messages so that users know where
|
||||||
|
to look.
|
||||||
|
|
||||||
|
\(fn TEMPLATES BODY...)"
|
||||||
|
(declare (debug (form body)) (indent 1))
|
||||||
|
`(condition-case err
|
||||||
|
,@body
|
||||||
|
(error (user-error "%s. Please adjust `%s'"
|
||||||
|
(error-message-string err)
|
||||||
|
,templates))))
|
||||||
|
|
||||||
|
(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))))
|
||||||
|
|
||||||
|
(defun org-roam-string-quote (str)
|
||||||
|
"Quote STR."
|
||||||
|
(->> str
|
||||||
|
(s-replace "\\" "\\\\")
|
||||||
|
(s-replace "\"" "\\\"")))
|
||||||
|
|
||||||
|
;;; Shielding regions
|
||||||
|
(defun org-roam-shield-region (beg end)
|
||||||
|
"Shield REGION against modifications.
|
||||||
|
REGION must be a cons-cell containing the marker to the region
|
||||||
|
beginning and maximum values."
|
||||||
|
(when (and beg end)
|
||||||
|
(add-text-properties beg end
|
||||||
|
'(font-lock-face org-roam-link-shielded
|
||||||
|
read-only t)
|
||||||
|
(marker-buffer beg))
|
||||||
|
(cons beg end)))
|
||||||
|
|
||||||
|
(defun org-roam-unshield-region (beg end)
|
||||||
|
"Unshield the shielded REGION."
|
||||||
|
(when (and beg end)
|
||||||
|
(let ((inhibit-read-only t))
|
||||||
|
(remove-text-properties beg end
|
||||||
|
'(font-lock-face org-roam-link-shielded
|
||||||
|
read-only t)
|
||||||
|
(marker-buffer beg)))
|
||||||
|
(cons beg end)))
|
||||||
|
|
||||||
(provide 'org-roam-macs)
|
(provide 'org-roam-macs)
|
||||||
|
|
||||||
;;; org-roam-macs.el ends here
|
;;; org-roam-macs.el ends here
|
||||||
|
458
org-roam-mode.el
458
org-roam-mode.el
@ -1,458 +0,0 @@
|
|||||||
;;; 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-sqlite3 "1.0.2") (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--org-file-p "org-roam")
|
|
||||||
(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.")
|
|
||||||
|
|
||||||
(defcustom org-roam-mode-sections (list #'org-roam-backlinks-section
|
|
||||||
#'org-roam-reflinks-section)
|
|
||||||
"List of functions that insert sections for Org-roam."
|
|
||||||
:group 'org-roam
|
|
||||||
:type '(repeat function))
|
|
||||||
|
|
||||||
;;; 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)
|
|
||||||
(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-sections)
|
|
||||||
(funcall fn 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)))
|
|
||||||
(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)
|
|
||||||
(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)
|
|
||||||
(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
|
|
||||||
(display-buffer (get-buffer-create org-roam-buffer))
|
|
||||||
(setq org-roam-current-node (org-roam-node-at-point))
|
|
||||||
(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)
|
|
||||||
(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-sections)
|
|
||||||
(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 "
|
|
||||||
(string-join (mapcar (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
|
|
@ -4,8 +4,8 @@
|
|||||||
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
||||||
;; URL: https://github.com/org-roam/org-roam
|
;; URL: https://github.com/org-roam/org-roam
|
||||||
;; Keywords: org-mode, roam, convenience
|
;; Keywords: org-mode, roam, convenience
|
||||||
;; Version: 2.0.0
|
;; Version: 1.2.1
|
||||||
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2") (magit-section "2.90.1"))
|
;; Package-Requires: ((emacs "26.1") (org "9.3"))
|
||||||
|
|
||||||
;; This file is NOT part of GNU Emacs.
|
;; This file is NOT part of GNU Emacs.
|
||||||
|
|
||||||
@ -37,14 +37,6 @@
|
|||||||
;;; Code:
|
;;; Code:
|
||||||
(require 'org-protocol)
|
(require 'org-protocol)
|
||||||
(require 'org-roam)
|
(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
|
;;;; Functions
|
||||||
(defun org-roam-protocol-open-ref (info)
|
(defun org-roam-protocol-open-ref (info)
|
||||||
@ -53,34 +45,26 @@
|
|||||||
It opens or creates a note with the given ref.
|
It opens or creates a note with the given ref.
|
||||||
|
|
||||||
javascript:location.href = \\='org-protocol://roam-ref?template=r&ref=\\='+ \\
|
javascript:location.href = \\='org-protocol://roam-ref?template=r&ref=\\='+ \\
|
||||||
encodeURIComponent(location.href) + \\='&title=\\=' + \\
|
encodeURIComponent(location.href) + \\='&title=\\=' \\
|
||||||
encodeURIComponent(document.title) + \\='&body=\\=' + \\
|
encodeURIComponent(document.title) + \\='&body=\\=' + \\
|
||||||
encodeURIComponent(window.getSelection())"
|
encodeURIComponent(window.getSelection())"
|
||||||
(unless (plist-get info :ref)
|
(when-let* ((alist (org-roam--plist-to-alist info))
|
||||||
(user-error "No ref key provided"))
|
(decoded-alist (mapcar (lambda (k.v)
|
||||||
(org-roam-plist-map! (lambda (k v)
|
(let ((key (car k.v))
|
||||||
(org-link-decode
|
(val (cdr k.v)))
|
||||||
(if (equal k :ref)
|
(cons key (org-link-decode val)))) alist)))
|
||||||
(org-protocol-sanitize-uri v)
|
(unless (assoc 'ref decoded-alist)
|
||||||
v))) info)
|
(error "No ref key provided"))
|
||||||
(when org-roam-protocol-store-links
|
(when-let ((title (cdr (assoc 'title decoded-alist))))
|
||||||
(push (list (plist-get info :ref)
|
(push (cons 'slug (funcall org-roam-title-to-slug-function title)) decoded-alist))
|
||||||
(plist-get info :title)) org-stored-links))
|
(let* ((org-roam-capture-templates org-roam-capture-ref-templates)
|
||||||
(org-link-store-props :type (and (string-match org-link-plain-re
|
(org-roam-capture--context 'ref)
|
||||||
(plist-get info :ref))
|
(org-roam-capture--info decoded-alist)
|
||||||
(match-string 1 (plist-get info :ref)))
|
(template (cdr (assoc 'template decoded-alist))))
|
||||||
:link (plist-get info :ref)
|
(raise-frame)
|
||||||
:annotation (org-link-make-string (plist-get info :ref)
|
(org-roam--with-template-error 'org-roam-capture-ref-templates
|
||||||
(or (plist-get info :title)
|
(org-roam-capture--capture nil template))
|
||||||
(plist-get info :ref)))
|
(org-roam-message "Item captured.")))
|
||||||
: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)
|
nil)
|
||||||
|
|
||||||
(defun org-roam-protocol-open-file (info)
|
(defun org-roam-protocol-open-file (info)
|
||||||
@ -94,7 +78,7 @@ It should contain the FILE key, pointing to the path of the file to open.
|
|||||||
org-protocol://roam-file?file=/path/to/file.org"
|
org-protocol://roam-file?file=/path/to/file.org"
|
||||||
(when-let ((file (plist-get info :file)))
|
(when-let ((file (plist-get info :file)))
|
||||||
(raise-frame)
|
(raise-frame)
|
||||||
(find-file file))
|
(org-roam--find-file file))
|
||||||
nil)
|
nil)
|
||||||
|
|
||||||
(push '("org-roam-ref" :protocol "roam-ref" :function org-roam-protocol-open-ref)
|
(push '("org-roam-ref" :protocol "roam-ref" :function org-roam-protocol-open-ref)
|
||||||
|
@ -1,77 +0,0 @@
|
|||||||
;;; org-roam-refile.el --- Refile Org-roam Notes -*- 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-sqlite3 "1.0.2") (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:
|
|
||||||
;;
|
|
||||||
;; Org-roam refile allows you to refile notes to your nodes.
|
|
||||||
;;
|
|
||||||
;;; Code:
|
|
||||||
(defvar org-auto-align-tags)
|
|
||||||
(defvar org-loop-over-headlines-in-active-region)
|
|
||||||
|
|
||||||
(defun org-roam-refile ()
|
|
||||||
"Refile to node."
|
|
||||||
(interactive)
|
|
||||||
(let* ((regionp (org-region-active-p))
|
|
||||||
(region-start (and regionp (region-beginning)))
|
|
||||||
(region-end (and regionp (region-end)))
|
|
||||||
(node (org-roam-node-read nil nil 'require-match))
|
|
||||||
(file (org-roam-node-file node))
|
|
||||||
(nbuf (or (find-buffer-visiting file)
|
|
||||||
(find-file-noselect file)))
|
|
||||||
level reversed)
|
|
||||||
(if regionp
|
|
||||||
(progn
|
|
||||||
(org-kill-new (buffer-substring region-start region-end))
|
|
||||||
(org-save-markers-in-region region-start region-end))
|
|
||||||
(org-copy-subtree 1 nil t))
|
|
||||||
(with-current-buffer nbuf
|
|
||||||
(org-with-wide-buffer
|
|
||||||
(goto-char (org-roam-node-point node))
|
|
||||||
(setq level (org-get-valid-level (funcall outline-level) 1)
|
|
||||||
reversed (org-notes-order-reversed-p))
|
|
||||||
(goto-char
|
|
||||||
(if reversed
|
|
||||||
(or (outline-next-heading) (point-max))
|
|
||||||
(or (save-excursion (org-get-next-sibling))
|
|
||||||
(org-end-of-subtree t t)
|
|
||||||
(point-max))))
|
|
||||||
(unless (bolp) (newline))
|
|
||||||
(org-paste-subtree level nil nil t)
|
|
||||||
(and org-auto-align-tags
|
|
||||||
(let ((org-loop-over-headlines-in-active-region nil))
|
|
||||||
(org-align-tags)))
|
|
||||||
(when (fboundp 'deactivate-mark) (deactivate-mark))))
|
|
||||||
(if regionp
|
|
||||||
(delete-region (point) (+ (point) (- region-end region-start)))
|
|
||||||
(org-preserve-local-variables
|
|
||||||
(delete-region
|
|
||||||
(and (org-back-to-heading t) (point))
|
|
||||||
(min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))))
|
|
||||||
|
|
||||||
(provide 'org-roam-refile)
|
|
||||||
;;; org-roam-refile.el ends here
|
|
@ -1,209 +0,0 @@
|
|||||||
;;; 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-sqlite3 "1.0.2") (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)
|
|
||||||
(require 's)
|
|
||||||
|
|
||||||
(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)
|
|
||||||
|
|
||||||
;;;; 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)))
|
|
||||||
|
|
||||||
;;; 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))))
|
|
||||||
|
|
||||||
(defun org-roam--process-display-format (format)
|
|
||||||
"Pre-calculate minimal widths needed by the FORMAT string."
|
|
||||||
(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))))
|
|
||||||
|
|
||||||
;;; 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
|
|
1921
org-roam.el
1921
org-roam.el
File diff suppressed because it is too large
Load Diff
2
tests/roam-files/alias.org
Normal file
2
tests/roam-files/alias.org
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
#+roam_alias: "a1" "a 2"
|
||||||
|
#+title: t1
|
@ -1,6 +1,3 @@
|
|||||||
:PROPERTIES:
|
|
||||||
:ID: 440795d0-70c1-4165-993d-aebd5eef7a24
|
|
||||||
:END:
|
|
||||||
#+title: Bar
|
#+title: Bar
|
||||||
|
|
||||||
[[id:884b2341-b7fe-434d-848c-5282c0727861][Foo]]
|
This is file bar. Bar links to [[file:nested/bar.org][Nested Bar]].
|
||||||
|
1
tests/roam-files/base.org
Normal file
1
tests/roam-files/base.org
Normal file
@ -0,0 +1 @@
|
|||||||
|
#+title: Base
|
@ -1,4 +1,8 @@
|
|||||||
:PROPERTIES:
|
|
||||||
:ID: 884b2341-b7fe-434d-848c-5282c0727861
|
|
||||||
:END:
|
|
||||||
#+title: Foo
|
#+title: Foo
|
||||||
|
|
||||||
|
This is the foo file. It contains a link to [[file:bar.org][Bar]].
|
||||||
|
|
||||||
|
To make the tests more robust, here are some arbitrary links:
|
||||||
|
|
||||||
|
- [[https:google.com][Google]]
|
||||||
|
- [[mailto:foo@john.com][mail to foo]]
|
||||||
|
14
tests/roam-files/headlines/headline.org
Normal file
14
tests/roam-files/headlines/headline.org
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
#+TITLE: Headline
|
||||||
|
|
||||||
|
* Headline 1
|
||||||
|
:PROPERTIES:
|
||||||
|
:ID: e84d0630-efad-4017-9059-5ef917908823
|
||||||
|
:END:
|
||||||
|
|
||||||
|
* No headline here
|
||||||
|
Oops.
|
||||||
|
|
||||||
|
* Headline 2
|
||||||
|
:PROPERTIES:
|
||||||
|
:ID: 801b58eb-97e2-435f-a33e-ff59a2f0c213
|
||||||
|
:END:
|
3
tests/roam-files/nested/bar.org
Normal file
3
tests/roam-files/nested/bar.org
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
#+title: Nested Bar
|
||||||
|
|
||||||
|
This file is nested, 1 level deeper. It links to both [[file:../foo.org][Foo]] and [[file:foo.org][Nested Foo]].
|
1
tests/roam-files/nested/deeply/deeply_nested_file.org
Normal file
1
tests/roam-files/nested/deeply/deeply_nested_file.org
Normal file
@ -0,0 +1 @@
|
|||||||
|
#+title: Deeply Nested File
|
3
tests/roam-files/nested/foo.org
Normal file
3
tests/roam-files/nested/foo.org
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
#+title: Nested Foo
|
||||||
|
|
||||||
|
This file has no links.
|
5
tests/roam-files/no-title.org
Normal file
5
tests/roam-files/no-title.org
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
no title in this file :O
|
||||||
|
|
||||||
|
links to itself, with no title: [[file:no-title.org][no-title]]
|
||||||
|
|
||||||
|
* Headline title
|
3
tests/roam-files/tags/no_tag.org
Normal file
3
tests/roam-files/tags/no_tag.org
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
#+title: Tagless File
|
||||||
|
|
||||||
|
This file has no tags, and should not yield any tags on extracting via ~#+roam_tags~.
|
4
tests/roam-files/tags/tag.org
Normal file
4
tests/roam-files/tags/tag.org
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
#+roam_tags: "t1" "t2 with space" t3
|
||||||
|
#+title: Tags
|
||||||
|
|
||||||
|
This file is used to test functionality for =(org-roam--extract-tags)=
|
1
tests/roam-files/titles/aliases.org
Normal file
1
tests/roam-files/titles/aliases.org
Normal file
@ -0,0 +1 @@
|
|||||||
|
#+roam_alias: "roam" "alias"
|
4
tests/roam-files/titles/combination.org
Normal file
4
tests/roam-files/titles/combination.org
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
#+title: TITLE PROP
|
||||||
|
#+roam_alias: "roam" "alias"
|
||||||
|
|
||||||
|
* Headline
|
1
tests/roam-files/titles/headline.org
Normal file
1
tests/roam-files/titles/headline.org
Normal file
@ -0,0 +1 @@
|
|||||||
|
* Headline
|
1
tests/roam-files/titles/title.org
Normal file
1
tests/roam-files/titles/title.org
Normal file
@ -0,0 +1 @@
|
|||||||
|
#+title: Title
|
3
tests/roam-files/unlinked.org
Normal file
3
tests/roam-files/unlinked.org
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
#+title: Unlinked
|
||||||
|
|
||||||
|
Nothing links here :(
|
1
tests/roam-files/web_ref.org
Normal file
1
tests/roam-files/web_ref.org
Normal file
@ -0,0 +1 @@
|
|||||||
|
#+roam_key: https://google.com/
|
53
tests/test-org-roam-perf.el
Normal file
53
tests/test-org-roam-perf.el
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
;;; test-org-roam-perf.el --- Performance Tests for Org-roam -*- lexical-binding: t; -*-
|
||||||
|
|
||||||
|
;; Copyright (C) 2020 Jethro Kuan
|
||||||
|
|
||||||
|
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
||||||
|
;; 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
|
||||||
|
;; the Free Software Foundation, either version 3 of the License, 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
;;; Commentary:
|
||||||
|
;;; Code:
|
||||||
|
|
||||||
|
(require 'buttercup)
|
||||||
|
(require 'org-roam)
|
||||||
|
|
||||||
|
(defconst test-org-roam-perf-zip-url "https://github.com/org-roam/test-org-files/archive/master.zip"
|
||||||
|
"Path to zip for test org-roam files.")
|
||||||
|
|
||||||
|
(defun test-org-roam-perf--abs-path (file-path)
|
||||||
|
"Get absolute FILE-PATH from `org-roam-directory'."
|
||||||
|
(file-truename (expand-file-name file-path org-roam-directory)))
|
||||||
|
|
||||||
|
(defun test-org-roam-perf--init ()
|
||||||
|
"."
|
||||||
|
(let* ((temp-loc (expand-file-name (make-temp-name "test-org-files-") temporary-file-directory))
|
||||||
|
(zip-file-loc (concat temp-loc ".zip"))
|
||||||
|
(_ (url-copy-file test-org-roam-perf-zip-url zip-file-loc))
|
||||||
|
(_ (shell-command (format "mkdir -p %s && unzip -j -qq %s -d %s" temp-loc zip-file-loc temp-loc))))
|
||||||
|
(setq org-roam-directory temp-loc)))
|
||||||
|
|
||||||
|
(describe "Cache Build"
|
||||||
|
(it "cache build from scratch time to be acceptable"
|
||||||
|
(test-org-roam-perf--init)
|
||||||
|
(pcase (benchmark-run 1 (org-roam-db-build-cache t))
|
||||||
|
(`(,time ,gcs ,time-in-gc)
|
||||||
|
(message "Elapsed time: %fs (%fs in %d GCs)" time time-in-gc gcs)
|
||||||
|
(expect time :to-be-less-than 100))))
|
||||||
|
(it "builds quickly without change"
|
||||||
|
(pcase (benchmark-run 1 (org-roam-db-build-cache))
|
||||||
|
(`(,time ,gcs ,time-in-gc)
|
||||||
|
(message "Elapsed time: %fs (%fs in %d GCs)" time time-in-gc gcs)
|
||||||
|
(expect time :to-be-less-than 5)))))
|
@ -23,31 +23,304 @@
|
|||||||
|
|
||||||
(require 'buttercup)
|
(require 'buttercup)
|
||||||
(require 'org-roam)
|
(require 'org-roam)
|
||||||
|
(require 'dash)
|
||||||
|
|
||||||
(describe "org-roam-db-sync"
|
(defun test-org-roam--abs-path (file-path)
|
||||||
|
"Get absolute FILE-PATH from `org-roam-directory'."
|
||||||
|
(file-truename (expand-file-name file-path org-roam-directory)))
|
||||||
|
|
||||||
|
(defun test-org-roam--find-file (path)
|
||||||
|
"PATH."
|
||||||
|
(let ((path (test-org-roam--abs-path path)))
|
||||||
|
(make-directory (file-name-directory path) t)
|
||||||
|
(find-file path)))
|
||||||
|
|
||||||
|
(defvar test-org-roam-directory (file-truename (concat default-directory "tests/roam-files"))
|
||||||
|
"Directory containing org-roam test org files.")
|
||||||
|
|
||||||
|
(defun test-org-roam--init ()
|
||||||
|
"."
|
||||||
|
(let ((original-dir test-org-roam-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)
|
||||||
|
(sleep-for 2)))
|
||||||
|
|
||||||
|
(defun test-org-roam--teardown ()
|
||||||
|
(org-roam-mode -1)
|
||||||
|
(delete-file (org-roam-db--get))
|
||||||
|
(org-roam-db--close))
|
||||||
|
|
||||||
|
(describe "org-roam--str-to-list"
|
||||||
|
(it "nil"
|
||||||
|
(expect (org-roam--str-to-list nil)
|
||||||
|
:to-be
|
||||||
|
nil))
|
||||||
|
(it "\"multi word\" prop 123"
|
||||||
|
(expect (org-roam--str-to-list "\"multi word\" prop 123")
|
||||||
|
:to-equal
|
||||||
|
'("multi word" "prop" "123")))
|
||||||
|
(it "prop \"multi word\" 123"
|
||||||
|
(expect (org-roam--str-to-list "\"multi word\" prop 123")
|
||||||
|
:to-equal
|
||||||
|
'("multi word" "prop" "123")))
|
||||||
|
(it "errors on bad input"
|
||||||
|
(expect (org-roam--str-to-list 1)
|
||||||
|
:to-throw)
|
||||||
|
(expect (org-roam--str-to-list "\"hello")
|
||||||
|
:to-throw)))
|
||||||
|
|
||||||
|
(describe "Title extraction"
|
||||||
|
:var (org-roam-title-sources)
|
||||||
(before-all
|
(before-all
|
||||||
(setq org-roam-directory (expand-file-name "tests/roam-files")
|
(test-org-roam--init))
|
||||||
org-roam-db-location (expand-file-name "org-roam.db" temporary-file-directory))
|
|
||||||
(org-roam-setup))
|
|
||||||
|
|
||||||
(after-all
|
(after-all
|
||||||
(org-roam-teardown)
|
(test-org-roam--teardown))
|
||||||
(delete-file org-roam-db-location))
|
|
||||||
|
|
||||||
(it "has the correct number of files"
|
(cl-flet
|
||||||
(expect (caar (org-roam-db-query [:select (funcall count) :from files]))
|
((test (fn file)
|
||||||
:to-equal
|
(let ((buf (find-file-noselect
|
||||||
2))
|
(test-org-roam--abs-path file))))
|
||||||
|
(with-current-buffer buf
|
||||||
|
(funcall fn)))))
|
||||||
|
(it "extracts title from title property"
|
||||||
|
(expect (test #'org-roam--extract-titles-title
|
||||||
|
"titles/title.org")
|
||||||
|
:to-equal
|
||||||
|
'("Title"))
|
||||||
|
(expect (test #'org-roam--extract-titles-title
|
||||||
|
"titles/aliases.org")
|
||||||
|
:to-equal
|
||||||
|
nil)
|
||||||
|
(expect (test #'org-roam--extract-titles-title
|
||||||
|
"titles/headline.org")
|
||||||
|
:to-equal
|
||||||
|
nil)
|
||||||
|
(expect (test #'org-roam--extract-titles-title
|
||||||
|
"titles/combination.org")
|
||||||
|
:to-equal
|
||||||
|
'("TITLE PROP")))
|
||||||
|
|
||||||
(it "has the correct number of nodes"
|
(it "extracts alias"
|
||||||
(expect (caar (org-roam-db-query [:select (funcall count) :from nodes]))
|
(expect (test #'org-roam--extract-titles-alias
|
||||||
:to-equal
|
"titles/title.org")
|
||||||
2))
|
:to-equal
|
||||||
|
nil)
|
||||||
|
(expect (test #'org-roam--extract-titles-alias
|
||||||
|
"titles/aliases.org")
|
||||||
|
:to-equal
|
||||||
|
'("roam" "alias"))
|
||||||
|
(expect (test #'org-roam--extract-titles-alias
|
||||||
|
"titles/headline.org")
|
||||||
|
:to-equal
|
||||||
|
nil)
|
||||||
|
(expect (test #'org-roam--extract-titles-alias
|
||||||
|
"titles/combination.org")
|
||||||
|
:to-equal
|
||||||
|
'("roam" "alias")))
|
||||||
|
|
||||||
(it "has the correct number of links"
|
(it "extracts headlines"
|
||||||
(expect (caar (org-roam-db-query [:select (funcall count) :from links]))
|
(expect (test #'org-roam--extract-titles-alias
|
||||||
|
"titles/title.org")
|
||||||
|
:to-equal
|
||||||
|
nil)
|
||||||
|
(expect (test #'org-roam--extract-titles-headline
|
||||||
|
"titles/aliases.org")
|
||||||
|
:to-equal
|
||||||
|
nil)
|
||||||
|
(expect (test #'org-roam--extract-titles-headline
|
||||||
|
"titles/headline.org")
|
||||||
|
:to-equal
|
||||||
|
'("Headline"))
|
||||||
|
(expect (test #'org-roam--extract-titles-headline
|
||||||
|
"titles/combination.org")
|
||||||
|
:to-equal
|
||||||
|
'("Headline")))
|
||||||
|
|
||||||
|
(describe "uses org-roam-title-sources correctly"
|
||||||
|
(it "'((title headline) alias)"
|
||||||
|
(expect (let ((org-roam-title-sources '((title headline) alias)))
|
||||||
|
(test #'org-roam--extract-titles
|
||||||
|
"titles/combination.org"))
|
||||||
|
:to-equal
|
||||||
|
'("TITLE PROP" "roam" "alias")))
|
||||||
|
(it "'((headline title) alias)"
|
||||||
|
(expect (let ((org-roam-title-sources '((headline title) alias)))
|
||||||
|
(test #'org-roam--extract-titles
|
||||||
|
"titles/combination.org"))
|
||||||
|
:to-equal
|
||||||
|
'("Headline" "roam" "alias")))
|
||||||
|
(it "'(headline alias title)"
|
||||||
|
(expect (let ((org-roam-title-sources '(headline alias title)))
|
||||||
|
(test #'org-roam--extract-titles
|
||||||
|
"titles/combination.org"))
|
||||||
|
:to-equal
|
||||||
|
'("Headline" "roam" "alias" "TITLE PROP"))))))
|
||||||
|
|
||||||
|
(describe "Tag extraction"
|
||||||
|
:var (org-roam-tag-sources)
|
||||||
|
(before-all
|
||||||
|
(test-org-roam--init))
|
||||||
|
|
||||||
|
(after-all
|
||||||
|
(test-org-roam--teardown))
|
||||||
|
|
||||||
|
(cl-flet
|
||||||
|
((test (fn file)
|
||||||
|
(let* ((fname (test-org-roam--abs-path file))
|
||||||
|
(buf (find-file-noselect fname)))
|
||||||
|
(with-current-buffer buf
|
||||||
|
(funcall fn fname)))))
|
||||||
|
(it "extracts from prop"
|
||||||
|
(expect (test #'org-roam--extract-tags-prop
|
||||||
|
"tags/tag.org")
|
||||||
|
:to-equal
|
||||||
|
'("t1" "t2 with space" "t3"))
|
||||||
|
(expect (test #'org-roam--extract-tags-prop
|
||||||
|
"tags/no_tag.org")
|
||||||
|
:to-equal
|
||||||
|
nil))
|
||||||
|
|
||||||
|
(it "extracts from all directories"
|
||||||
|
(expect (test #'org-roam--extract-tags-all-directories
|
||||||
|
"base.org")
|
||||||
|
:to-equal
|
||||||
|
nil)
|
||||||
|
(expect (test #'org-roam--extract-tags-all-directories
|
||||||
|
"tags/tag.org")
|
||||||
|
:to-equal
|
||||||
|
'("tags"))
|
||||||
|
(expect (test #'org-roam--extract-tags-all-directories
|
||||||
|
"nested/deeply/deeply_nested_file.org")
|
||||||
|
:to-equal
|
||||||
|
'("nested" "deeply")))
|
||||||
|
|
||||||
|
(it "extracts from last directory"
|
||||||
|
(expect (test #'org-roam--extract-tags-last-directory
|
||||||
|
"base.org")
|
||||||
|
:to-equal
|
||||||
|
nil)
|
||||||
|
(expect (test #'org-roam--extract-tags-last-directory
|
||||||
|
"tags/tag.org")
|
||||||
|
:to-equal
|
||||||
|
'("tags"))
|
||||||
|
(expect (test #'org-roam--extract-tags-last-directory
|
||||||
|
"nested/deeply/deeply_nested_file.org")
|
||||||
|
:to-equal
|
||||||
|
'("deeply")))
|
||||||
|
|
||||||
|
(it "extracts from first directory"
|
||||||
|
(expect (test #'org-roam--extract-tags-first-directory
|
||||||
|
"base.org")
|
||||||
|
:to-equal
|
||||||
|
nil)
|
||||||
|
(expect (test #'org-roam--extract-tags-first-directory
|
||||||
|
"tags/tag.org")
|
||||||
|
:to-equal
|
||||||
|
'("tags"))
|
||||||
|
(expect (test #'org-roam--extract-tags-first-directory
|
||||||
|
"nested/deeply/deeply_nested_file.org")
|
||||||
|
:to-equal
|
||||||
|
'("nested")))
|
||||||
|
|
||||||
|
(describe "uses org-roam-tag-sources correctly"
|
||||||
|
(it "'(prop)"
|
||||||
|
(expect (let ((org-roam-tag-sources '(prop)))
|
||||||
|
(test #'org-roam--extract-tags
|
||||||
|
"tags/tag.org"))
|
||||||
|
:to-equal
|
||||||
|
'("t1" "t2 with space" "t3")))
|
||||||
|
(it "'(prop all-directories)"
|
||||||
|
(expect (let ((org-roam-tag-sources '(prop all-directories)))
|
||||||
|
(test #'org-roam--extract-tags
|
||||||
|
"tags/tag.org"))
|
||||||
|
:to-equal
|
||||||
|
'("t1" "t2 with space" "t3" "tags"))))))
|
||||||
|
|
||||||
|
(describe "Headline extraction"
|
||||||
|
(before-all
|
||||||
|
(test-org-roam--init))
|
||||||
|
|
||||||
|
(after-all
|
||||||
|
(test-org-roam--teardown))
|
||||||
|
|
||||||
|
(cl-flet
|
||||||
|
((test (fn file)
|
||||||
|
(let* ((fname (test-org-roam--abs-path file))
|
||||||
|
(buf (find-file-noselect fname)))
|
||||||
|
(with-current-buffer buf
|
||||||
|
(funcall fn fname)))))
|
||||||
|
(it "extracts headlines"
|
||||||
|
(expect (test #'org-roam--extract-headlines
|
||||||
|
"headlines/headline.org")
|
||||||
|
:to-equal
|
||||||
|
`(["e84d0630-efad-4017-9059-5ef917908823" ,(test-org-roam--abs-path "headlines/headline.org")]
|
||||||
|
["801b58eb-97e2-435f-a33e-ff59a2f0c213" ,(test-org-roam--abs-path "headlines/headline.org")])))))
|
||||||
|
|
||||||
|
;;; Tests
|
||||||
|
(xdescribe "org-roam-db-build-cache"
|
||||||
|
(before-each
|
||||||
|
(test-org-roam--init))
|
||||||
|
|
||||||
|
(after-each
|
||||||
|
(test-org-roam--teardown))
|
||||||
|
|
||||||
|
(it "initializes correctly"
|
||||||
|
;; 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 1)
|
||||||
|
(expect (caar (org-roam-db-query [:select (funcall count) :from refs])) :to-be 1)
|
||||||
|
|
||||||
|
;; Links
|
||||||
|
(expect (caar (org-roam-db-query [:select (funcall count) :from links
|
||||||
|
:where (= from $s1)]
|
||||||
|
(test-org-roam--abs-path "foo.org"))) :to-be 1)
|
||||||
|
(expect (caar (org-roam-db-query [:select (funcall count) :from links
|
||||||
|
:where (= from $s1)]
|
||||||
|
(test-org-roam--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)]
|
||||||
|
(test-org-roam--abs-path "nested/foo.org"))) :to-be 1)
|
||||||
|
(expect (caar (org-roam-db-query [:select (funcall count) :from links
|
||||||
|
:where (= to $s1)]
|
||||||
|
(test-org-roam--abs-path "nested/bar.org"))) :to-be 1)
|
||||||
|
(expect (caar (org-roam-db-query [:select (funcall count) :from links
|
||||||
|
:where (= to $s1)]
|
||||||
|
(test-org-roam--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 (test-org-roam--abs-path "alias.org")
|
||||||
|
(list "t1" "a1" "a 2"))
|
||||||
|
(list (test-org-roam--abs-path "bar.org")
|
||||||
|
(list "Bar"))
|
||||||
|
(list (test-org-roam--abs-path "foo.org")
|
||||||
|
(list "Foo"))
|
||||||
|
(list (test-org-roam--abs-path "nested/bar.org")
|
||||||
|
(list "Nested Bar"))
|
||||||
|
(list (test-org-roam--abs-path "nested/foo.org")
|
||||||
|
(list "Nested Foo"))
|
||||||
|
(list (test-org-roam--abs-path "no-title.org")
|
||||||
|
(list "Headline title"))
|
||||||
|
(list (test-org-roam--abs-path "web_ref.org") nil)
|
||||||
|
(list (test-org-roam--abs-path "unlinked.org")
|
||||||
|
(list "Unlinked"))))
|
||||||
|
|
||||||
|
(expect (org-roam-db-query [:select * :from refs])
|
||||||
|
:to-have-same-items-as
|
||||||
|
(list (list "https://google.com/" (test-org-roam--abs-path "web_ref.org") "website")))
|
||||||
|
|
||||||
|
;; Expect rebuilds to be really quick (nothing changed)
|
||||||
|
(expect (org-roam-db-build-cache)
|
||||||
:to-equal
|
:to-equal
|
||||||
1)))
|
(list :files 0 :links 0 :tags 0 :titles 0 :refs 0 :deleted 0))))
|
||||||
|
|
||||||
(provide 'test-org-roam)
|
(provide 'test-org-roam)
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user