flycheck-package-0.13/ 0000755 0001750 0001750 00000000000 13624134071 014451 5 ustar dogsleg dogsleg flycheck-package-0.13/Makefile 0000644 0001750 0001750 00000001407 13624134071 016113 0 ustar dogsleg dogsleg EMACS ?= emacs
# A space-separated list of required package names
NEEDED_PACKAGES = package-lint flycheck
INIT_PACKAGES="(progn \
(require 'package) \
(push '(\"melpa\" . \"https://melpa.org/packages/\") package-archives) \
(package-initialize) \
(dolist (pkg '(${NEEDED_PACKAGES})) \
(unless (package-installed-p pkg) \
(unless (assoc pkg package-archive-contents) \
(package-refresh-contents)) \
(package-install pkg))) \
)"
all: compile package-lint clean-elc
package-lint:
${EMACS} -Q --eval ${INIT_PACKAGES} -batch -f package-lint-batch-and-exit flycheck-package.el
compile: clean-elc
${EMACS} -Q --eval ${INIT_PACKAGES} -L . -batch -f batch-byte-compile *.el
clean-elc:
rm -f f.elc
.PHONY: all compile clean-elc package-lint
flycheck-package-0.13/README.md 0000644 0001750 0001750 00000006013 13624134071 015730 0 ustar dogsleg dogsleg [](http://melpa.org/#/flycheck-package)
[](http://stable.melpa.org/#/flycheck-package)
[](https://github.com/purcell/flycheck-package/actions)
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](https://github.com/purcell/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][melpa]
repository. The version of `flycheck-package` there will always be
up-to-date. There are also packages in [MELPA Stable][melpa-stable], which
track the [latest numbered tag][tags].
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`:
```elisp
(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](https://github.com/purcell/flycheck-package/blob/master/COPYING)
for details.
Credits
-------
`flycheck-package` was written by
[Steve Purcell](https://github.com/purcell) with significant
contributions from [Fanael Linithien](https://github.com/Fanael).
Author links:
[](http://coderwall.com/purcell)
[](http://uk.linkedin.com/in/stevepurcell)
[Steve Purcell's blog](http://www.sanityinc.com/) // [@sanityinc on Twitter](https://twitter.com/sanityinc)
[flycheck]: https://github.com/flycheck/flycheck
[tags]: https://github.com/purcell/flycheck-package/tags
[ledger]: https://ledger-cli.org/
[melpa-stable]: http://stable.melpa.org
[melpa]: http://melpa.org
flycheck-package-0.13/flycheck-package.el 0000644 0001750 0001750 00000005253 13624134071 020161 0 ustar dogsleg dogsleg ;;; flycheck-package.el --- A Flycheck checker for elisp package authors
;; Copyright (C) 2014-2016 Steve Purcell, Fanael Linithien
;; Author: Steve Purcell
;; Fanael Linithien
;; Keywords: lisp
;; Version: 0
;; URL: https://github.com/purcell/flycheck-package
;; Package-Requires: ((flycheck "0.22") (package-lint "0.2"))
;; 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 .
;;; Commentary:
;; Provides feedback via flycheck about issues with the package metadata
;; of a file, e.g. the package dependencies it requires.
;; To enable, use something like this:
;; (eval-after-load 'flycheck
;; '(flycheck-package-setup))
;; Checks will currently be enabled only if a "Package-Requires:" or
;; "Package-Version:" header is present in the file.
;;; Code:
(require 'flycheck)
(require 'package-lint)
(defun flycheck-package--start (checker callback)
"Flycheck start function for CHECKER, invoking CALLBACK."
(funcall callback
'finished
(flycheck-increment-error-columns
(mapcar (lambda (x)
(apply #'flycheck-error-new-at `(,@x :checker ,checker)))
(condition-case err
(when (package-lint-looks-like-a-package-p)
(package-lint-buffer (current-buffer)))
(error
(funcall callback 'errored (error-message-string err))
(signal (car err) (cdr err))))))))
;;; Checker definition
(flycheck-define-generic-checker 'emacs-lisp-package
"A checker for \"Package-Requires\" headers and other packaging issues."
:start #'flycheck-package--start
:modes '(emacs-lisp-mode))
;;;###autoload
(defun flycheck-package-setup ()
"Setup flycheck-package.
Add `flycheck-emacs-lisp-package' to `flycheck-checkers'."
(interactive)
(add-to-list 'flycheck-checkers 'emacs-lisp-package t)
(flycheck-add-next-checker 'emacs-lisp 'emacs-lisp-package t)
(flycheck-add-next-checker 'emacs-lisp-checkdoc 'emacs-lisp-package t))
(provide 'flycheck-package)
;;; flycheck-package.el ends here