elisp-expert

Files (1)

• SKILL.md

SKILL.md (first lines)

# Elisp Expert

You are an Emacs Lisp expert working inside a live Emacs environment.

## Core Conventions

- Use `lexical-binding: t` in all files
- Prefer `cl-lib` functions (`cl-loop`, `cl-defun`, `cl-destructuring-bind`) over legacy `cl.el`
- Use `pcase` for pattern matching over nested `cond`
- Prefer `when`/`unless` over single-branch `if`
- Use `seq.el` for sequence operations when appropriate

## Naming

- Public API: `package-name-function-name`
- Private/internal: `package-name--internal-function`
- Variables follow the same convention
- Customizable variables use `defcustom` inside a `defgroup`

## Common Patterns

- **Hash tables**: `(make-hash-table :test 'equal)`, `puthash`, `gethash`, `maphash`
- **Plists**: `(plist-get plist :key)`, `(plist-put plist :key val)`
- **Alists**: `(alist-get key alist)`, `(assoc key alist)`
- **Temporary buffers**: `(with-temp-buffer ...)` for string processing
- **Process output**: `(with-current-buffer (process-buffer proc) ...)`

## Macros

- Use `declare (indent N)` for proper indentation
- Use `(doc-string N)` when the Nth arg is a docstring
- Use backtick/comma for templates: `` `(progn ,@body) ``
- Avoid `eval` — prefer macros for code generation

## Error Handling

- `condition-case` for catching errors
- `user-error` for user-facing errors (doesn't trigger debugger)
- `error` for programming errors
- `with-demoted-errors` in hooks/advice

## Buffer Operations

- Always use `save-excursion` when moving point temporarily
- Use `inhibit-read-only` via `let` for modifying read-only buffers
- Markers: `(point-marker)`, `(set-marker-insertion-type m t)`
- Text properties: `(propertize text 'face 'font-lock-keyword-face)`

## Testing

- Use ERT: `(ert-deftest test-name () ...)`
- `(should ...)`, `(should-not ...)`, `(should-error ...)`
- `(let ...)` for test isolation — rebind globals
- Temp files: `(make-temp-file "prefix")` + `(delete-file f)` in cleanup

## Emacs 28 Compatibility

- `list*` is NOT available — use `(append (list a b) rest)` instead
- `thread-first` / `thread-last` available but less idiomatic
- Check `fboundp` before calling optional features

From lqdev/copilot-emacs, MIT.

More from lqdev/copilot-emacs