https://github.com/purcell/flycheck-package

Flycheck checker for elisp package metadata
https://github.com/purcell/flycheck-package

Last synced: 3 days ago
JSON representation

Flycheck checker for elisp package metadata

• Host: GitHub
• URL: https://github.com/purcell/flycheck-package
• Owner: purcell
• Created: 2016-10-16T00:33:31.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T07:35:18.000Z (3 months ago)
• Last Synced: 2024-12-02T18:04:19.512Z (2 months ago)
• Language: Emacs Lisp
• Size: 89.8 KB
• Stars: 40
• Watchers: 4
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
[![Melpa Status](http://melpa.org/packages/flycheck-package-badge.svg)](http://melpa.org/#/flycheck-package)

[![Melpa Stable Status](http://stable.melpa.org/packages/flycheck-package-badge.svg)](http://stable.melpa.org/#/flycheck-package)

[![Build Status](https://github.com/purcell/flycheck-package/actions/workflows/test.yml/badge.svg)](https://github.com/purcell/flycheck-package/actions/workflows/test.yml)



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 the checker is only activated if a `;; Package-Requires:`,

`;; Version:` or `;; Package-Version:` header is present in the current

buffer.

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).



[💝 Support this project and my other Open Source work via Patreon](https://www.patreon.com/sanityinc)

[💼 LinkedIn profile](https://uk.linkedin.com/in/stevepurcell)

[✍ sanityinc.com](http://www.sanityinc.com/)

[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