Skip to content

Commit d7c4f13

Browse files
authored
fix: remove unused enkan-repl-default-session-projects variable
- Remove unused defcustom from enkan-repl.el - Update README.org to match current codebase - Fix prerequisites (Emacs 28.2+, eat 0.9.4+) - Update Core Functions documentation - Add center file configuration explanation - Remove Migration Guide reference
1 parent 10131ff commit d7c4f13

2 files changed

Lines changed: 44 additions & 24 deletions

File tree

README.org

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,8 @@ and the cheat-sheet ensures you never miss useful functionality.
140140
** Installation
141141

142142
*** Prerequisites
143-
- Emacs 28.1 or later
144-
- [[https://github.com/cpoile/claudemacs][claudemacs]] package installed and configured
145-
- [[https://github.com/anthropics/claude-code][Claude Code CLI]] properly set up
143+
- Emacs 28.2 or later
144+
- [[https://github.com/akib/emacs-eat][eat]] (0.9.4 or later)
146145

147146
*Note*: This package has been developed and tested exclusively on macOS with GNU Emacs 30.1.
148147
While it should work on other platforms and Emacs versions (28.1+),
@@ -207,7 +206,6 @@ Currently operates with a single fixed workspace (=ws:01=), with multi-workspace
207206

208207
*** Breaking Changes
209208
*Important*: Buffer naming format has changed from =*enkan:/path*= to =*ws:01 enkan:/path*=.
210-
See [[file:docs/migration-guide.md][Migration Guide]] for upgrade instructions.
211209

212210
*** Workspace Behavior
213211
- All sessions are scoped to workspace =ws:01=
@@ -224,29 +222,57 @@ See [[file:docs/migration-guide.md][Migration Guide]] for upgrade instructions.
224222
- No need to memorize function names
225223

226224
*** File Management
227-
- =enkan-repl-open-project-input-file= - Create/open persistent input file for current directory
225+
- =enkan-repl-open-project-input-file= - Open or create project input file for directory
226+
- =enkan-repl-open-center-file= - Open or create the center file based on enkan-repl-center-file configuration
227+
- =enkan-repl-open-project-directory= - Open project directory in Dired from enkan-repl-projects
228228

229229
*** Text Sending
230-
- =enkan-repl-send-region= - Send selected text (the author most commonly used)
231-
- =enkan-repl-send-line= - Send current line only
232-
- =enkan-repl-send-enter= - Send enter key
233-
- =enkan-repl-send-1/2/3= - Send numbered choices for AI prompts
234-
- =enkan-repl-send-4= - Send \\='4\\=' to enkan session buffer with optional PFX. - From enkan buffer: Send to current buffer - From other buffer without prefix: Interactive buffer selection - With numeric prefix: Send to buffer at index (1-based) Uses unified backend with smart buffer detection.
235-
- =enkan-repl-send-5= - Send \\='5\\=' to enkan session buffer with optional PFX. - From enkan buffer: Send to current buffer - From other buffer without prefix: Interactive buffer selection - With numeric prefix: Send to buffer at index (1-based) Uses unified backend with smart buffer detection.
230+
- =enkan-repl-send-region= - Send region text to enkan session buffer
231+
- =enkan-repl-send-line= - Send current line to enkan session buffer
232+
- =enkan-repl-send-enter= - Send enter key to enkan session buffer
233+
- =enkan-repl-send-escape= - Send ESC key to eat session buffer
234+
- =enkan-repl-send-1= - Send '1' to enkan session buffer
235+
- =enkan-repl-send-2= - Send '2' to enkan session buffer
236+
- =enkan-repl-send-3= - Send '3' to enkan session buffer
237+
- =enkan-repl-send-4= - Send '4' to enkan session buffer
238+
- =enkan-repl-send-5= - Send '5' to enkan session buffer
236239

237240
*** Session Control
238-
- =enkan-repl-start-eat= - Start eat terminal emulator session in current directory. Simplified version for use within setup functions only. FORCE parameter ignored - always starts new session.
239-
- =enkan-repl-teardown= - Terminate eat session(s) based on context. - Standard input file: terminate single eat session for current directory in current workspace - Center file: terminate all registered sessions in current workspace
240-
- =enkan-repl-setup= - Arrange windows for (the author's) optimal workflow
241+
- =enkan-repl-start-eat= - Start eat terminal emulator session in current directory
242+
- =enkan-repl-teardown= - Terminate eat session(s) based on context
243+
- =enkan-repl-setup= - Set up window layout based on context
244+
245+
*** Workspace
246+
- =enkan-repl-workspace-switch= - Switch to another workspace
247+
- =enkan-repl-workspace-delete= - Delete a workspace
248+
- =enkan-repl-workspace-list= - Display a list of all workspaces with their information
241249

242250
*** Utilities
243-
- =enkan-repl-recenter-bottom= - Recenter all enkan terminal buffers at bottom.
244-
- =enkan-repl-toggle-global-mode= - Toggle enkan-repl global mode on/off.
245-
- =enkan-repl-workspace-switch= - Switch to another workspace. Uses `hmenu' if available to show workspace ID with its project.
246-
- =enkan-repl-workspace-delete= - Delete a workspace. Cannot delete the current workspace or the only workspace. Uses `hmenu' if available to show workspace ID with its project.
251+
- =enkan-repl-recenter-bottom= - Recenter all enkan terminal buffers at bottom
252+
- =enkan-repl-toggle-global-mode= - Toggle enkan-repl global mode on/off
253+
- =enkan-repl-print-setup-to-buffer= - Print current setup variables for debugging
247254

248255
** Configuration
249256

257+
*** Center File and Multi-Project Management
258+
The center file enables management of multiple projects simultaneously:
259+
260+
#+begin_src elisp
261+
;; Set center file path (enables multi-project functionality)
262+
(setq enkan-repl-center-file "~/my-projects/center.org")
263+
264+
;; Define project directories with aliases
265+
(setq enkan-repl-target-directories
266+
'(("pt" . ("pt-tools" . "/path/to/pt-tools/"))
267+
("er" . ("enkan-repl" . "/path/to/enkan-repl/"))
268+
("eat" . ("emacs-eat" . "/path/to/emacs-eat/"))))
269+
270+
;; Configuration list for frequently used simultaneous project startup
271+
(setq enkan-repl-projects
272+
'(("web-dev" . ("er" "pt" "cc"))
273+
("data-analysis" . ("pt" "jupyter" "postgres"))))
274+
#+end_src
275+
250276
*** Template Customization
251277
#+begin_src elisp
252278
;; Use default template

enkan-repl.el

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -267,12 +267,6 @@ Example: \\='((1 . \"pt-tools\") (2 . \"enkan-repl\"))"
267267
:type '(alist :key-type integer :value-type string)
268268
:group 'enkan-repl)
269269

270-
(defcustom enkan-repl-default-session-projects nil
271-
"Alist of default session projects to open.
272-
Example: \\='((1 . \"project1\") (2 . \"project2\") (3 . \"project3\") (4 . \"project4\"))."
273-
:type '(alist :key-type integer :value-type string)
274-
:group 'enkan-repl)
275-
276270
;;;; Multi-buffer access variables (continued)
277271

278272
(defvar enkan-repl--session-counter 0

0 commit comments

Comments
 (0)