Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redesign structure of org-roam-bibtex package #58

Merged
merged 1 commit into from
May 23, 2020
Merged

Conversation

myshevchuk
Copy link
Member

A continuation of thoughts expressed in #13

  1. orb-core.el as a central dependency point. It requires org-roam and bibtex-completion. It is supposed to be required by user interface libraries. It contains defgroup definitions and general utility functions that depend on org-roam, bibtex-completion and other packages not included in Emacs. It itself does not require any user interface libraries but may require utility libraries.
  2. orb-utils.el - general purpose utilities that do not depend on extra packages, only built-in Emacs libraries (an exception can be made for general purpose extra libraries such as dash, f, s). If a function requires anything from org-roam, bibtex-comletion or other specialized libraries, it should go into orb-core.el or a specialized utility library.
  3. user interface libraries - multiple entry points into the package. They depend on orb-core, orb-utils and perhaps on other user interface libraries. However, if such a library depends on another user interface library, then that code should probably be refactored into orb-core or orb-utils or yet another utility library.

@myshevchuk myshevchuk merged commit b750738 into master May 23, 2020
@myshevchuk myshevchuk deleted the package-design branch May 23, 2020 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant