/package-lint

A linting library for elisp package metadata
  1. Emacs Lisp 97.5%
  2. Shell 2.5%
Emacs Lisp Shell
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit ff64e11 Oct 6, 2017 @tarsius tarsius committed with Fanael "Homepage" is a valid url header keywords 
See `lm-homepage' defined in `lisp-mnt.el'.

I prefer "Homepage" over "URL" because it is more precise.
"URL" could also be something like git://foo.bar.git.
Permalink
Failed to load latest commit information.
.gitignore Ignore .elc Dec 22, 2014
.travis.yml Add Emacs 25.2 build target Jun 7, 2017
README.md Add Patreon badge Sep 9, 2017
package-lint-test.el "Homepage" is a valid url header keywords Oct 7, 2017
package-lint.el "Homepage" is a valid url header keywords Oct 7, 2017
run-tests.sh Don't promote byte compilation warnings when ignoring lint issues Nov 5, 2016

README.md

Melpa Status Melpa Stable Status Build Status Support me

package-lint

This library provides a linter for the metadata in Emacs Lisp files which are intended to be packages. You can integrate it into your build process.

See flycheck-package, which uses this code to conveniently display packaging errors while writing elisp packages. This code was extracted from flycheck-package.el. We eventually want to use it for MELPA -- it will need to learn how to check multi-file packages, which was always going to be out of scope for flycheck-package.

Installation

The recommended way to get package-lint is as a package from the MELPA repository. The version of package-lint there will always be up-to-date. There are also packages in MELPA Stable, which track the latest numbered tag.

Usage

Use the command package-lint-current-buffer interactively, or use package-lint-buffer if linting programmatically.

If you're a package author, you can include package-lint in your build process by ensuring that the package is installed, and then using the function package-lint-batch-and-exit to lint your files -- see run-tests.sh in this repo for an example.

Roadmap

Additional checks for future versions:

  • WARN: header line formatting / capitalisation
  • trailing line presence / formatting
  • WARN: library is called *-mode but doesn't provide a major mode
  • WARN: suggest cl-lib vs cl
  • non-use of standard keywords
  • checkdoc failures for interactive functions / defcustoms
  • trailing whitespace?
  • themes which aren't in a matching *-theme.el file
  • use of unsafe local variables
  • use of emacs version dependencies
  • local variable set in header line
  • (with-)eval-after-load shouldn't generally appear in packages
  • using commentary to talk about load[- ]path and installation
  • lack of autoloads
  • references to README files which won't be bundled in a package
  • use of CamelCase identifiers
  • Defining a -mode function directly instead of using define-derived-mode or define-minor-mode
  • Referring to display-graphic-p or window-system in -theme.el files

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

See COPYING for details.

Credits

package-lint was written by Steve Purcell with significant contributions from Fanael Linithien.

Author links:

Steve Purcell's blog // @sanityinc on Twitter