Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/flycheck/flycheck

On the fly syntax checking for GNU Emacs
https://github.com/flycheck/flycheck

emacs flycheck syntax-checking

Last synced: 29 days ago
JSON representation

On the fly syntax checking for GNU Emacs

Host: GitHub
URL: https://github.com/flycheck/flycheck
Owner: flycheck
License: gpl-3.0
Created: 2012-10-10T14:45:13.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2024-05-19T09:57:47.000Z (6 months ago)
Last Synced: 2024-05-23T02:27:49.051Z (6 months ago)
Topics: emacs, flycheck, syntax-checking
Language: Emacs Lisp
Homepage: https://www.flycheck.org
Size: 20.3 MB
Stars: 2,386
Watchers: 56
Forks: 445
Open Issues: 167
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.old
- Contributing: .github/CONTRIBUTING.rst
- Funding: .github/FUNDING.yml
- License: COPYING

Awesome Lists containing this project

awesome-rust-cn - Flycheck
awesome-starred - flycheck - On the fly syntax checking for GNU Emacs (Emacs Lisp)
awesome-stylelint - flycheck - Emacs extension. (Editor integrations)

README

        # [![Flycheck][logo]](https://www.flycheck.org) #

[![License GPL 3](https://img.shields.io/github/license/flycheck/flycheck.svg)][COPYING]

[![Join the chat](https://img.shields.io/gitter/room/flycheck/flycheck.svg)](https://gitter.im/flycheck/flycheck)

[![MELPA](https://melpa.org/packages/flycheck-badge.svg)](https://melpa.org/#/flycheck)

[![MELPA stable version](http://stable.melpa.org/packages/flycheck-badge.svg)](https://stable.melpa.org/#/flycheck)

[![NonGNU ELPA](https://elpa.nongnu.org/nongnu/flycheck.svg)](https://elpa.nongnu.org/nongnu/flycheck.html)

[![CI](https://github.com/flycheck/flycheck/actions/workflows/test.yml/badge.svg)](https://github.com/flycheck/flycheck/actions/workflows/test.yml)

[![Docs](https://github.com/flycheck/flycheck/actions/workflows/docs.yml/badge.svg)](https://github.com/flycheck/flycheck/actions/workflows/docs.yml)

[![Lint Python](https://github.com/flycheck/flycheck/actions/workflows/lint-python.yml/badge.svg)](https://github.com/flycheck/flycheck/actions/workflows/lint-python.yml)

Modern on-the-fly syntax checking extension for GNU Emacs.  [Try it][]!

![](https://raw.githubusercontent.com/flycheck/flycheck/master/doc/images/flycheck-annotated.png)

## Getting Started

Flycheck is available for installation with `package.el` on [NonGNU

ELPA](https://elpa.nongnu.org/nongnu), [MELPA

Stable](http://stable.melpa.org) and [MELPA](http://melpa.org).

You can install Flycheck with the following command:

M-x `package-install` [RET] `flycheck` [RET]

Finally add this to your Emacs config:

```elisp

(global-flycheck-mode +1)

```

Alternatively, if you're into `use-package` you can do the following:

``` emacs-lisp

(use-package flycheck

  :ensure t

  :config

  (add-hook 'after-init-hook #'global-flycheck-mode))

```

Now you can start using any of the [bundled checkers](https://www.flycheck.org/en/latest/languages.html) or install additional checkers.

For a more gentle introduction read the [Installation][] instructions and go

through [Quickstart][] guide.

## Getting Help

Please ask questions about Flycheck on [Stack Exchange][sx] or in our

[Gitter chat][gitter], and report bugs to our [issue tracker][].

## Contributing

We welcome all kinds of contributions, whether you write patches, open pull

requests, write documentation, help others with Flycheck issues, or just tell

other people about your experiences with Flycheck.  Please take a look at our

[Contributor’s Guide][contrib] for help and guidance about contributing to

Flycheck.

## Sponsoring

You can support financially the development of Flycheck and related packages

via:

- [Open Collective](https://opencollective.com/flycheck)

- [GitHub Sponsors](https://github.com/sponsors/bbatsov)

- [Patreon](https://www.patreon.com/bbatsov)

- [PayPal](https://www.paypal.me/bbatsov)

### Open Collective Backers





























































### Open Collective Sponsors

Become a sponsor and get your logo on our README on Github with a link to your

site. [[Become a sponsor](https://opencollective.com/flycheck#sponsor)]





























































## Code of Conduct

We strive to create a safe, friendly and welcoming environment in the Flycheck

community and have a [Code of Conduct][coc] that defines acceptable and welcome

behaviour as well as sanctions for violations.  All contributors and all

participants are expected to follow it, on Github, Gitter, Emacs.SX or any other

place that’s part of Flycheck’s broader community.

## License

Flycheck is free software: you can redistribute it and/or modify it under the

terms of the [GNU General Public License][copying] as published by the Free

Software Foundation, either version 3 of the License, or (at your option) any

later version.

Flycheck 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][copying] for more

details.

[COPYING]: https://github.com/flycheck/flycheck/blob/master/COPYING

[manual]: https://www.flycheck.org/en/latest/index.html#the-user-guide

[logo]: https://raw.githubusercontent.com/flycheck/flycheck/master/doc/_static/logo.png

[try it]: https://www.flycheck.org/en/latest/#try-out

[Installation]: https://www.flycheck.org/en/latest/user/installation.html

[Quickstart]: https://www.flycheck.org/en/latest/user/quickstart.html

[sx]: https://emacs.stackexchange.com/questions/tagged/flycheck

[gitter]: https://gitter.im/flycheck/flycheck

[Issue Tracker]: https://github.com/flycheck/flycheck/issues

[contrib]: https://www.flycheck.org/en/latest/contributor/contributing.html

[coc]: https://www.flycheck.org/en/latest/community/conduct.html