Организовать содержимое ~ / .emacs.d / init.el и ~ / emacs.d?

1. Когда мы добавляем все больше и больше строк ~/.emacs.d/init.elдля различных целей (для режима python, для emacs-eclim, для ...), файл становится длинным и менее читаемым. Есть ли способ помочь организовать его содержание?

2. Мой нынешний ~/.emacs.dвыглядит так

   $ ls *
   init.el
   
   auto-save-list:
   
   elisp:
   python-mode.el-6.1.3
   
   elpa:
   archives        auctex-readme.txt         s-20140910.334
   auctex-11.87.7  emacs-eclim-20140809.207
   
   eshell:
   history
   

   python-mode.el-6.1.3был установлен вручную, в то время как emacs-eclim-20140809.207был установлен elpa, и я не уверен на 100%, что другие вещи под elpa/были elpa. Как я могу организовать содержание ~/.emacs.d/?

Люди, использующие меньшие редакторы, любят разбивать свой код на несколько файлов. Если вы используете Emacs, для этого нет причин: просто используйте один большой файл, который вы разбили на разделы.

Каждый раздел должен начинаться с

^L
;;; title of the section

где вы вставляете ^Lсимвол, печатая C-q C-l. Затем вы можете использовать такие команды, как C-x ]( forward-page) или C-x n p( narrow-to-page) для навигации по файлу. См. Раздел 25.4 (Страницы) руководства Emacs для более подробной информации.

Классический способ сделать это - разделить ваши .emacsфайлы на отдельные. Например, вы можете переместить все свои веб-материалы ~/.emacs.d/web-config.elи затем загрузить их внутрь init.el:

(load "~/.emacs.d/web-config.el")

Если вы хотите, чтобы ваша работа ~/.emacs.dбыла более организованной, вы также можете переместить эти файлы конфигурации в их собственный каталог:

(load "~/.emacs.d/config/web.el")

Теперь вы можете просто перейти к соответствующему файлу при внесении изменений в вашу конфигурацию.

Единственное, чего здесь не хватает - это переменные, установленные через систему настройки. Они все еще будут в вашем главном init.el. По-видимому, есть небольшая утилита под названием init split, которая позволяет вам создавать правила, в которых указываются настройки, но я никогда не использовал ее сам. Кроме того, система «Настройка» может быть настроена на использование отдельного файла для своих настроек. Задайте custom-fileпеременную, чтобы указать, куда следует читать и записывать настройки «настройки» .

Что касается самого каталога, я всегда был доволен макетом по умолчанию. Основным изменением, которое я сделал, было создание каталога для всех моих собственных пользовательских пакетов и библиотек, которые не управляются package.el. Это дает один дом для моего пользовательского elisp, который не связан с конфигурацией.

Если вам нравится Org-режим, вы можете использовать его, чтобы организовать, .emacsне разбивая его. В моей текущей конфигурации мой .emacsфайл просто загружает файл init.org, который находится под~/.emacs.d/init/init.org

(require 'org)

;; Load the actual configuration file
(org-babel-load-file
  (expand-file-name (concat user-emacs-directory "init/init.org")))

Используя разные файлы, вам нужно grepвместо простого C-sчто-то искать и так далее. Кроме того, проще добавить несколько уровней в вашу организацию.

Просто перенесите фрагменты кода из init.elотдельных файлов (библиотек), которые вы потом require. (Используйте provideв библиотеках required.) Поместите эти файлы куда хотите, и обновите load-pathсоответственно.

Я использую предложение от targzeta, найденное в каталоге Emacs Wiki: Load .

В основном у меня есть ~ / .emacs.d / load-directory.el:

;;;; ~/.emacs.d/load-directory.el

;; Handy function to load recursively all '.el' files in a given directory
(defun load-directory (directory)
  "Load recursively all '.el' files in DIRECTORY."
  (dolist (element (directory-files-and-attributes directory nil nil nil))
    (let* ((path (car element))
           (fullpath (concat directory "/" path))
           (isdir (car (cdr element)))
           (ignore-dir (or (string= path ".") (string= path ".."))))
      (cond
       ((and (eq isdir t) (not ignore-dir))
        (load-directory fullpath))
       ((and (eq isdir nil) (string= (substring path -3) ".el"))
        (load (file-name-sans-extension fullpath)))))))

Затем я просто помещаю отдельные файлы в мой ~ / .emacs.d / config:

~/.emacs.d/config ls
01-packages.el  02-style.el  03-modes.el  04-keybindings.el  05-functions.el

И, наконец, у меня есть это в моем ~ / .emacs.d / init.el:

;; Load all ".el" files under ~/.emacs.d/config directory.
(load "~/.emacs.d/load-directory")
(load-directory "~/.emacs.d/config")

Очевидно, есть несколько способов снять кожу с этой конкретной кошки. Мой текущий фаворит - использовать outline-minor-modeс outshine . Выдержка:

;; * This here is my emacs init file
;; ** Many subsections with headlines like this one omitted
;; ** Customising modes
;; […] more lines omitted
;; *** Org and outline modes
(autoload 'outshine-hook-function "outshine")
(add-hook 'outline-minor-mode-hook 'outshine-hook-function)
;; […] and more
;; * Emacs Magic
;;; Local Variables:
;;; mode: emacs-lisp
;;; coding: utf-8
;;; mode: outline-minor
;;; fill-column: 79
;;; End:

Обратите внимание, что вам нужно получить затмение из вашего любимого хранилища пакетов.

Я использую следующую структуру для отслеживания пакетов и файлов

~/.emacs.d
|-- elpa            ;; Package.el packages
|-- hack            ;; Development versions of packages (e.g. org, personal packages)
|-- single-lisp     ;; Individual lisp files from outside sources (e.g. EmacsWiki)
|-- site-lisp       ;; Lisp packages not managed by package.el (directories)
|-- user-config     ;; Machine/situation specific customization (work vs home)
|   `-- custom.el   ;; Customization settings
|-- lisp            ;; Individual .el files to keep init.el clean
|   `-- defaults.el ;; Default configuration settings
`-- init.el

Затем я использую use-packageдля управления, какие пакеты загружены и какие настройки установлены для каждого пакета. Только в большинстве случаев hackи elpaтребуют обновления, остальные папки часто предназначены для одноразовых пакетов, которые я хочу протестировать или использовать кратко, но не нужно загружать (даже праздно).

custom.el предназначен для настройки параметров, которые я предпочитаю не использовать (и не версию, даже если я использую).

defaults.elпредназначен для общей конфигурации (строка меню, шрифт, кодировка и т. д.), которая затем может быть перезаписана в любом файле .el, user-config/чтобы обеспечить систему, которая будет работать, как я ожидаю, но ее можно настроить в соответствии с окружающей средой.

Ранее я пытался сохранить functions, macros, adviceв отдельных упаковках , чтобы обеспечить разграничение между содержанием, но натолкнулся на определение / требуют вопросы , поэтому поставили их обратно в init.el. В конечном итоге они могут быть возвращены в ~/.emacs.d/lisp/.

Я стараюсь поддерживать init.elпорядок, сортирую контент по функциям и целям, чтобы найти его снова было несложно. У меня был монолитный init.elфайл, и я продолжал добавлять новый контент в конце (или там, где я думал, что он мог бы подойти), и в конечном итоге не знал, что я добавил или где я его добавил, когда я пошел искать его (и иногда поиск с помощью isearchне помог, так как я не мог вспомнить, как я назвал вещи в то время).

Во всех существующих ответах приведены рекомендации по организации созданных вручную файлов, например, init.elдрузей. Не менее важна организация всех автоматически создаваемых файлов из различных пакетов, и для этого пакет no-litteringпревосходен.

я добавил

  (when (string= (buffer-name) "init.el")
    (setq imenu-generic-expression
      '((nil "^;; \\[ \\(.*\\)" 1))))

в emacs-lisp-mode-hook. Затем добавьте в файл разделы «Ясниппет», «Упаковка», «Режим Java» и т. Д. Это хорошо работает для моих 1000 строк кода (включая комментарии).

РЕДАКТИРОВАТЬ: Наконец я переключаюсь между разделами с helm-imenu. На самом деле руль автоматически подключается к обычной функции имен, так что все, что мне нужно, это

       (local-set-key (kbd "C-*") 'imenu)

Я разделил мой относительно маленький .emacsфайл на три части:

• emacs-custom.el для настроек, вырывающих много громоздких и бесполезных данных; файл автоматически перезаписывается, не затрагивая основной файл .emacs , предотвращая ложные изменения.

  (setq custom-file "~/.emacs-custom.el")
  (load custom-file)
  

• lg-lib.el для кода, а не для конфигурации: загрузка моих собственных библиотек из нестандартных исходных расположений, а не из каталога пакетов и определение различных функций (в основном копируются и взламываются при отсутствии подходящего пакета); это еще одно значительное сокращение числа строк .emacs .

  (load "~/lg-lib")
  

• Основной файл .emacs : без громоздкого кода и громоздких переменных настройки, он содержит requireвызовы для пакетов, переменные, которые не являются частью системы настройки, и различные вызовы функций для загрузки и инициализации пакетов. Я «организовал» его, тщательно собрав все строки, относящиеся к одному и тому же пакету или функции, и дополнительно отделив загрузку пакета и параметры, связанные с пакетом, от «основной» функциональности. Довольно представительный отрывок:

  (require 'ido)
  (ido-mode t)
  
  (require 'auto-complete)
  (add-to-list 'ac-dictionary-directories "~/.emacs.d/ac-dict")
  
  (require 'auto-complete-config)
  (ac-config-default)
  (global-auto-complete-mode t)
  

  Эти разделы крошечные, но они останутся управляемыми с большим количеством строк конфигурации для каждого пакета.

Следуйте настройке мастера Emacs, например, https://github.com/purcell/emacs.d

Например, в отношении того, как организовать вручную установленные пакеты и пакеты, установленные из ELPA, в настройках Стивена Пурселла есть

a place for 3rd party code which isn't available in MELPA or other
package repositories. This directory and its immediate
subdirectories will be added to load-path at start-up time.

Notably, in Emacs 23.x, a backported package.el is automatically
downloaded and installed here

Зачем следовать за мастером? Основной момент моих «Основных emacs за один год» заключается в том, что новички могут эффективно избежать накладных расходов на установку и «ошибок».

Я понимаю, что многие люди не согласны со мной, но вот мой случай (подробно в моей статье ):

Я начал использовать Emacs, используя уважаемую стабильную (5 лет в разработке) конфигурацию Purcell ( 1403 звезды GitHub по состоянию на ноябрь 2014 года!). Несмотря на это, у меня все еще было много проблем . Стив Перселл помог мне решить все эти проблемы. (Я фактически стал его падаваном более года.) Используя его настройки и используя проблемы его репо для сообщения о проблемах, и используя его опыт, я избегал тратить много времени. Даже сегодня я все еще наблюдаю, как многие люди используют git submoduleсторонние плагины. И Стив, и я прекратили использовать git submoduleэто, потому что это может быть такой PITA .

Но если вы очень уверены в своих навыках или предпочитаете самообучаться, это не путь для вас.

Инновационный и простой способ очистить вашу .emacs.dпапку - использовать org-modeи обрисовывать все, используя исходные блоки. Затем в вашем .emacsфайле укажите на свой config.org.

Замечательный ресурс об этом - Гарри Шварц. У него есть видео на YouTube, которое затрагивает, и пост в блоге, который объясняет детали . Я был в состоянии следовать за ним как за emacs noob и получить все настройки. Работает как шарм. 1 файл для всего моего init.