จัดระเบียบเนื้อหาของ ~ / .emacs.d / init.el และ ~ / emacs.d หรือไม่

1. เมื่อเราเพิ่มบรรทัดมากขึ้นเรื่อย~/.emacs.d/init.elๆ เพื่อวัตถุประสงค์ต่าง ๆ (สำหรับ python-mode, สำหรับ 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-mode คุณสามารถใช้มันเพื่อจัดระเบียบของคุณ.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 วิกิพีเดีย: ไดเรกทอรีโหลด

โดยทั่วไปฉันมี ~ / .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 จากนั้นเพิ่มไปยังส่วนของไฟล์ "yasnippet", "packaging", "โหมด java" ฯลฯ ใช้งานได้ดีสำหรับรหัสบรรทัด 1,000 บรรทัดของฉัน (รวมถึงความคิดเห็น)

แก้ไข: ในที่สุดฉันสลับระหว่างส่วนด้วย helm-imenu จริงๆแล้วหางเสือขอเกี่ยวกับฟังก์ชั่น 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 master เช่น https://github.com/purcell/emacs.d

ตัวอย่างเช่นเกี่ยวกับวิธีจัดระเบียบแพ็คเกจที่ติดตั้งด้วยตนเองและแพ็คเกจที่ติดตั้งจาก ELPA การตั้งค่าของ Steven Purcell มี

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ของฉันในหนึ่งปี"คือมือใหม่สามารถหลีกเลี่ยงค่าใช้จ่ายในการติดตั้งและ "gotchas" ได้อย่างมีประสิทธิภาพ

ฉันเข้าใจว่าหลายคนไม่เห็นด้วยกับฉัน แต่นี่คือกรณีของฉัน (รายละเอียดในบทความของฉัน ):

ฉันเริ่มใช้ Emacs โดยใช้ดาวที่มีชื่อเสียงของ Purcell ( 1403 GitHub ดาว ณ เดือนพฤศจิกายน 2014!) การกำหนดค่าที่มั่นคง (5 ปีในการพัฒนา) แม้จะเริ่มต้นจากนั้นฉันยังคงมีปัญหามากมาย Steve Purcell ช่วยฉันแก้ปัญหาทั้งหมด (จริง ๆ แล้วฉันกลายเป็นPadawanมานานกว่าหนึ่งปี) โดยใช้การตั้งค่าของเขาและใช้ปัญหาของ repo เพื่อรายงานปัญหาและการใช้ประโยชน์จากประสบการณ์ของเขาฉันหลีกเลี่ยงการเสียเวลามาก แม้วันนี้ฉันยังคงสังเกตเห็นคนจำนวนมากที่ใช้git submoduleเพื่อจัดการปลั๊กอินของบุคคลที่สาม ทั้ง Steve และฉันเลิกใช้git submoduleเพราะสิ่งนี้อาจเป็นPITA PITA

แต่ถ้าคุณมีความมั่นใจในทักษะของคุณหรือชอบเรียนรู้ด้วยตนเองมากนี่ไม่ใช่เส้นทางสำหรับคุณ

วิธีที่เป็นนวัตกรรมและเรียบง่ายในการล้าง.emacs.dโฟลเดอร์ของคุณคือการใช้org-modeและจัดเค้าร่างทุกอย่างโดยใช้บล็อกแหล่งที่มา จากนั้นใน.emacsไฟล์ของคุณให้ชี้ไปที่ของคุณconfig.orgแฟ้มชี้ไปที่ของคุณ

ทรัพยากรที่ยอดเยี่ยมสำหรับสิ่งนี้คือ Harry Schwartz เขามีวิดีโอ youtubeที่สัมผัสและโพสต์บล็อกที่อธิบายรายละเอียด ฉันสามารถติดตามได้ในฐานะ emacs noob และรับการตั้งค่าทั้งหมด ทำงานเหมือนจับใจ 1 initไฟล์ทั้งหมดของฉัน