Description

Emacs Code Report is something like a JavaDoc assembler, scanning given Emacs files and developing an assemblage of various useful information in a condensed, easily browsable form.

Currently, it scans for require, provide, defgroup, defcustom, command, defun, defmacro, defadvice, defalias, define-key, set-key, set-chord, forms and a Commentary section. For each form, the relevant parameters are listed as well as any doc string.

The output is formated in org-mode, a foldable, outline mode (to say the least) for Emacs.

Usage

Simply list emacs files as arguments:

emacs-code-report.pl elpa/**/*.el

or

zargs -- prelude/**/*.el -- emacs-code-report.pl 

Example output

Included herein is an example of the output, example-output-for-prelude.org, which was generated from a bbatsov/prelude installation. Github renders it as a Markdown document, which rather defeats the usefulness of the foldable outline capabilities of org-mode. It is best experienced with that tool.

Motivation

I built this to make it easier to grok large installations like prelude and, in particular, to further manage config and key bindings after installing umpteen new packages from melpa.

Todo

• more comments
• error checking
• change so the script will recurse directories and find files itself
• refactor common code out of get_* functions
• should it have been written in elisp?