Skip to content

Latest commit

 

History

History
161 lines (122 loc) · 6.12 KB

README.md

File metadata and controls

161 lines (122 loc) · 6.12 KB
Raw

elisp-lint

Basic linting for Emacs Lisp

MELPA Stable MELPA CircleCI codecov

This is a tool for finding certain problems in Emacs Lisp files. Use it on the command line like this:

emacs -Q --batch -l elisp-lint.el -f elisp-lint-files-batch *.el

You can disable individual checks by passing flags on the command line:

emacs -Q --batch -l elisp-lint.el -f elisp-lint-files-batch --no-indent *.el

You can use file variables or .dir-locals.el to disable checks completely, and also to configure certain checks as described below.

((emacs-lisp-mode . ((fill-column . 80)
                     (indent-tabs-mode . nil)
                     (elisp-lint-ignored-validators . ("byte-compile"))
                     (elisp-lint-indent-specs . ((describe . 1)
                                                 (it . 1))))))

Validators

byte-compile

Byte-compiles the file with all warnings enabled.

check-declare

Verifies all declare-function statements are legitimate.

checkdoc

Runs checkdoc on the file to enforce standards in documentation.

fill-column

Verifies that no line exceeds the number of columns in fill-column. Certain lines in the file are excluded from this check, and can have unlimited length:

  • The package summary comment line, which by definition must include the package name, a summary description (up to 60 characters), and an optional -*- lexical-binding:t -*- declaration.

  • The "Package-Requires" header, whose length is determined by the number of dependencies specified.

indent

Verifies that each line is indented according to emacs-lisp-mode. Where macros are defined with special indent metadata, use the elisp-lint-indent-specs alist to specify each symbol's required indent.

indent-character

Verifies the indentation is consistently tabs or spaces, according to the value of indent-tabs-mode.

package-lint

Use package-lint to perform checks on package metadata and elisp style.

Because this check uses the package library to validate when dependencies can be installed from an available package repository, this check will suppress any "package is not installable" errors when running in a context where the package library is not initialized. This can happen, e.g. when running Emacs on packages installed with Cask.

trailing-whitespace

Verifies the buffer has no lines with trailing whitespace.

Configuration

Use a file variable or .dir-locals.el to override the variables mentioned above.

Sample Report

test/data/example.el:0:0 (checkdoc) You should have a section marked ";;; Commentary:"
test/data/example.el:0:0 (checkdoc) The first line should be of the form: ";;; package --- Summary"
test/data/example.el:1:0 (error) Package should have a ;;; Commentary section.
test/data/example.el:1:0 (error) Package should have a Homepage or URL header.
test/data/example.el:1:0 (error) package.el cannot parse this buffer: Package lacks a file header
test/data/example.el:5:0 (checkdoc) You should have a section marked ";;; Code:"
test/data/example.el:8:0 (checkdoc) White space found at end of line
test/data/example.el:8:0 (whitespace) trailing whitespace found
test/data/example.el:9:0 (indent) !      (b y))
test/data/example.el:10:0 (indent) ! 	  (message "%s" a))  
test/data/example.el:10:0 (indent-character) tabs instead of spaces
test/data/example.el:10:0 (whitespace) trailing whitespace found
test/data/example.el:11:0 (fill-column) line length 80 exceeded
test/data/example.el:12:0 (indent) !   (setq a 3)
test/data/example.el:16:0 (error) "foo" doesn't start with package's prefix "difftest".
test/data/example.el:17:0 (checkdoc) First line should be capitalized
test/data/example.el:17:0 (checkdoc) First sentence should end with punctuation
test/data/example.el:17:0 (indent) ! "emacs is fun"
test/data/example.el:18:0 (warning) Closing parens should not be wrapped onto new lines.
test/data/example.el:18:0 (indent) ! )
test/data/example.el:21:0 (checkdoc) The footer should be: (provide 'example)\n;;; example.el ends here
test/data/example.el FAIL

Changelog

  • Version 0.5-SNAPSHOT (MELPA)
    • suppress "Package X is not installable" errors when running in a context where 'package-initialize' hasn't occurred
  • Version 0.4-SNAPSHOT (MELPA Stable, March 2020)
    • Provide a summary report of all tests [#20]
    • Integrate package-lint [#19]
    • Remove package-format, as package-lint covers the same territory
    • Make byte-compile errors and warnings more robust
    • Make the fill-column checker ignore the package summary line [#25]
    • Make 'fill-column' checker ignore the package requires header
    • Add dependency on dash.el
    • Colorized output
  • Version 0.3 (December 2019)
    • Emacs 23 support is deprecated [#13]
    • Adopt CircleCI and drop Travis CI [#9] [#14]
    • Add check-declare validator [#16]
    • Generate autoloads before bytecompile [#8]
  • Version 0.2.0 (Feb 2018)
    • Project transferred to new maintainer
    • Whitespace check permits page-delimiter (^L)
    • Indentation check prints the diff to console
    • User can specify indent specs to tell the checker about macros
    • Added checkdoc (available only Emacs 25 and newer)
    • Cleared up the console output for easier reading in CI
    • Expand Travis CI test matrix to include Emacs 25 and 26
  • Version 0.1.0 (2015)
    • Basic linting functionality implemented

Credits

The initial development of elisp-lint is Copyright 2013-2015 Nikolaj Schumacher. This project was transferred to Neil Okamoto in 2018.

Updates and ongoing development are Copyright 2018-2020 Neil Okamoto and contributors.

Contributing

Pull requests are welcome!