TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
spacemacs/core/core-load-paths.el

129 lines
4.0 KiB
EmacsLisp
Raw Normal View History

[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;;; core-load-paths.el --- Spacemacs Core File -*- no-byte-compile: t; lexical-binding: t -*-
Setup a test framework Load paths are now registered in `core/load-paths.el` Libraries are in `core/lib` Move `ht.el` to `lib` Add `mocker.el` to `lib` Tests are in test, - unit tests files suffix is `utest.el` - functional tests files suffix is `ftest.el`
2015-01-23 03:26:56 +00:00
;;
chore: update copyright headers to 2022 The script used to identify and update the change is added into the GitHub workflows script directory. A workflow action can be created to trigger the script to update the headers on the first of every new year. Possibly a task for a consequent PR.
2022-05-31 16:12:58 +00:00
;; Copyright (c) 2012-2022 Sylvain Benner & Contributors
Setup a test framework Load paths are now registered in `core/load-paths.el` Libraries are in `core/lib` Move `ht.el` to `lib` Add `mocker.el` to `lib` Tests are in test, - unit tests files suffix is `utest.el` - functional tests files suffix is `ftest.el`
2015-01-23 03:26:56 +00:00
;;
;; Author: Sylvain Benner <sylvain.benner@gmail.com>
;; URL: https://github.com/syl20bnr/spacemacs
;;
;; This file is not part of GNU Emacs.
;;
Apply GPLv3 terms explicitly to all elisp files
2021-03-24 03:31:44 +00:00
;; 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 <http://www.gnu.org/licenses/>.
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;;; Commentary:
;;
;; Define various PATH variables, and set up load path.
Setup a test framework Load paths are now registered in `core/load-paths.el` Libraries are in `core/lib` Move `ht.el` to `lib` Add `mocker.el` to `lib` Tests are in test, - unit tests files suffix is `utest.el` - functional tests files suffix is `ftest.el`
2015-01-23 03:26:56 +00:00
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;;; Code:
;;;; PATH variables/constants
(defconst user-home-directory
(expand-file-name "~/")
"User home directory (default ~/).")
Add Dropbox directory to load-path only if exists
2016-07-06 00:28:37 +00:00
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;; ~/.emacs.d
Fix spacemacs-start-directory variable definition Should use defvar so that user can override the default value.
2016-06-23 13:35:21 +00:00
(defvar spacemacs-start-directory
core/core-load-path.el: auto locate spacemacs-start-directory
2022-08-11 00:00:05 +00:00
(concat (file-name-directory (or load-file-name buffer-file-name)) "../")
Fix spacemacs-start-directory variable definition Should use defvar so that user can override the default value.
2016-06-23 13:35:21 +00:00
"Spacemacs start directory.")
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;; ~/.emacs.d/assets
(defconst spacemacs-assets-directory
(concat spacemacs-start-directory "assets/")
"Spacemacs assets directory.")
;; ~/.emacs.d/core
Move declaration of paths from spacemacs-mode.el to load-paths.el
2015-01-25 04:58:24 +00:00
(defconst spacemacs-core-directory
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(concat spacemacs-start-directory "core/")
Move declaration of paths from spacemacs-mode.el to load-paths.el
2015-01-25 04:58:24 +00:00
"Spacemacs core directory.")
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;; ~/.emacs.d/core/banners
Move declaration of paths from spacemacs-mode.el to load-paths.el
2015-01-25 04:58:24 +00:00
(defconst spacemacs-banner-directory
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(concat spacemacs-core-directory "banners/")
Move declaration of paths from spacemacs-mode.el to load-paths.el
2015-01-25 04:58:24 +00:00
"Spacemacs banners directory.")
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
Add official logo to startup page
2015-03-13 03:55:38 +00:00
(defconst spacemacs-banner-official-png
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(concat spacemacs-banner-directory "img/spacemacs.png")
Add official logo to startup page
2015-03-13 03:55:38 +00:00
"Spacemacs official banner image.")
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
core: add footer in home buffer
2016-06-05 04:04:53 +00:00
(defconst spacemacs-badge-official-png
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(concat spacemacs-banner-directory "img/spacemacs-badge.png")
core: add footer in home buffer
2016-06-05 04:04:53 +00:00
"Spacemacs official badge image.")
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
[home] Add GPLv3 badge in footer
2021-03-24 20:03:04 +00:00
(defconst spacemacs-gplv3-official-png
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(concat spacemacs-banner-directory "img/gplv3.png")
[home] Add GPLv3 badge in footer
2021-03-24 20:03:04 +00:00
"GPLv3 official badge image.")
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;; ~/.emacs.d/core/info
(defconst spacemacs-info-directory
(concat spacemacs-core-directory "info/")
"Spacemacs info files directory.")
;; ~/.emacs.d/core/info/release-notes
(defconst spacemacs-release-notes-directory
(concat spacemacs-info-directory "release-notes/")
"Spacemacs release notes directory.")
;; ~/.emacs.d/doc
Add link to vim migration guide in quickhelp.
2015-06-06 17:24:26 +00:00
(defconst spacemacs-docs-directory
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(concat spacemacs-start-directory "doc/")
Add link to vim migration guide in quickhelp.
2015-06-06 17:24:26 +00:00
"Spacemacs documentation directory.")
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;; ~/.emacs.d/news
Add newsletter 01
2016-10-03 02:39:22 +00:00
(defconst spacemacs-news-directory
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(concat spacemacs-start-directory "news/")
Add newsletter 01
2016-10-03 02:39:22 +00:00
"Spacemacs News directory.")
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;; ~/.emacs.d/private
(defconst spacemacs-private-directory
(concat spacemacs-start-directory "private/")
"Spacemacs private directory.")
;; ~/.emacs.d/tests
Refactor test system Should allow easier testing of layers, not just core
2015-07-31 08:30:42 +00:00
(defconst spacemacs-test-directory
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(concat spacemacs-start-directory "tests/")
Refactor test system Should allow easier testing of layers, not just core
2015-07-31 08:30:42 +00:00
"Spacemacs tests directory.")
Add rollback support
2015-02-04 04:56:38 +00:00
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;; ~/.emacs.d/.cache
(defconst spacemacs-cache-directory
(concat user-emacs-directory ".cache/")
"Spacemacs storage area for persistent files.")
;; ~/.emacs.d/.cache/auto-save
(defconst spacemacs-auto-save-directory
(concat spacemacs-cache-directory "auto-save/")
"Spacemacs auto-save directory.")
;;;; Setup cache directories
;; TODO: Should also catch any IO error such as permission error (Apr 25 2021 Lucius)
Move declaration of paths from spacemacs-mode.el to load-paths.el
2015-01-25 04:58:24 +00:00
(unless (file-exists-p spacemacs-cache-directory)
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(make-directory spacemacs-cache-directory))
(setq pcache-directory (concat spacemacs-cache-directory "pcache/"))
;;;; Load Paths
Refactor core-load-paths to an in-lined form - Remove the two functions that add directories to the load path. - Inline the body forms of the functions to be removed. - Rename the variables to be more explicit. Fix let varlist in core-load-path.el
2022-03-21 03:13:37 +00:00
(dolist (subdirectory '(nil "libs/" "libs/spacemacs-theme/" "libs/forks/"))
(let ((path (concat spacemacs-core-directory subdirectory)))
(if (file-exists-p path)
(add-to-list 'load-path path)
(error "The directory %s does not exist and cannot be added to the `load-path'." path))))
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
;;;; Themes
core: import spacemacs-theme into libs Distribute spacemacs-theme with Spacemacs so we don't need to download the package of the theme at startup. It was delaying the display of the home buffer. Now Spacemacs fallback to spacemacs-dark theme if the user theme cannot be applied. Spacemacs then tries to install and reapply the user theme. If successful, at the subsequent startups the user theme is applied right away instead of spacemacs-dark. If the installation failed then we display a warning informing the user and suggesting some actions. There is now no package left to be installed manually at the start of Spacemacs.
2017-01-25 05:30:31 +00:00
(add-to-list 'custom-theme-load-path (concat spacemacs-core-directory
"libs/spacemacs-theme/"))
[documentation]: Improved core-load-paths and core-versions (#14707) - Conform to standard ELISP file practice. - Rearranged the top-level forms s.t. Variables and constants are declared at top. - Added section markers and documentations. - Use three or more `;` as a section header. They work well with built-in outline-mode. `M-j` and `M-k` is the binding to quickly navigate between them. - Optionally use `^L` (form-feed) as a divider for the ELISP file. It's rendered as a horizontal divider. And it works with `backward-page` (`C-x [`) and `forward-page` (`C-x ]`)
2021-04-30 05:36:23 +00:00
(provide 'core-load-paths)
;;; core-load-paths.el ends here