elisp-conventions

Enforce Emacs Lisp coding conventions for atomic functions and docstrings.

9|1|Updated Jul 19, 2022

Search Tags:#testing #coding standards #emacs #conventions #compilation #lisp #elisp

Ready to run

npx skills add https://github.com/benthamite/dotfiles --skill elisp-conventions

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: elisp-conventions
Source: https://github.com/benthamite/dotfiles/tree/main/claude/skills/elisp-conventions
Command: npx skills add https://github.com/benthamite/dotfiles --skill elisp-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive guide to writing clean, maintainable, and efficient Emacs Lisp code, ensuring consistency and reducing errors.

Core Features & Use Cases

Coding Standards: Enforces atomic functions, proper indentation, and docstring formatting.
Profile Management: Guides on resolving Elpaca profile paths dynamically.
Testing & Compilation: Details on byte-compiling and testing Elisp packages in batch mode.
Use Case: When developing new Emacs Lisp features or reviewing existing code, consult this Skill to adhere to established conventions.

Quick Start

Follow the Emacs Lisp coding conventions for writing atomic functions and proper docstrings.

Frequently Asked Questions about elisp-conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I format Emacs Lisp docstrings to follow coding conventions?▼

Emacs Lisp docstrings must follow specific formatting conventions to ensure maintainability. This Skill enforces proper docstring formatting, ensuring your Elisp codebase remains consistent, readable, and fully compliant with standard Emacs Lisp best practices.

What is the best way to byte-compile Elisp packages in batch mode?▼

Byte-compiling Elisp packages in batch mode is the best way to validate code changes without launching a full Emacs session. This Skill details batch mode byte-compilation patterns to help you catch byte-compiler warnings and errors early in your development workflow.

How do I resolve Elpaca profile paths dynamically in Emacs Lisp?▼

Resolving Elpaca profile paths dynamically requires specific Emacs Lisp conventions to ensure correct package loading across different environments. This Skill provides guidance on Elpaca profile resolution, helping you manage package configurations reliably and maintain a consistent Elisp codebase.

Can I use this to enforce atomic function design in Emacs Lisp?▼

Yes, you can use this Skill to enforce atomic function design in Emacs Lisp. It specifically addresses the need for consistent and maintainable Elisp codebases by providing coding standards that break down complex logic into focused, single-purpose functions.

How do I test Emacs Lisp packages in batch mode?▼

Testing Emacs Lisp packages in batch mode involves running automated test suites directly from the command line without an interactive Emacs instance. This Skill outlines batch mode testing patterns for Elisp packages, ensuring your code meets established conventions and functions correctly.

Why does my Emacs Lisp code fail standard coding conventions?▼

Your Emacs Lisp code may fail standard coding conventions due to improper indentation, non-atomic function design, or incorrectly formatted docstrings. This Skill enforces these Emacs Lisp best practices, addressing the need for consistent and maintainable Elisp codebases to reduce errors.