Flycheck checker for elisp package metadata
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
README.md
flycheck-package.el

README.md

Melpa Status Melpa Stable Status Support me

flycheck-package

This library provides a flycheck checker for the metadata in Emacs Lisp files which are intended to be packages. That metadata includes the package description, its dependencies and more. The checks are performed by the separate package-lint library.

Currently these checks are only activated if a Package-Requires or Package-Version header is present in the file, and checks center on the validity of the data in that header.

Installation

You'll need Emacs 24 for flycheck, so the recommended way to get flycheck-package is as a package from the MELPA repository. The version of flycheck-package there will always be up-to-date. There are also packages in MELPA Stable, which track the latest numbered tag.

If you insist on doing things the hard way, first ensure flycheck and package-lint are installed, then download this code and add the directory to your Emacs load-path.

Then, in your init.el:

(eval-after-load 'flycheck
  '(flycheck-package-setup))

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

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


Author links:

Steve Purcell's blog // @sanityinc on Twitter