Flycheck has been one of my favorite Emacs packages ever since it was released almost 12 years ago. I love writing clean idiomatic code, I love the help that lint tools provide with this, and I wasn’t particularly happy with the “tried and true” Flymake back in the day. When I came across the Flycheck I was really impressed by its feature set, amazing documentation, very clean codebase and excellent test coverage. All of this was somewhat uncommon for Emacs packages circa 2014.
Unfortunately, after the departure of the original Flycheck author Sebastian Wiesner, the project lost some of its early momentum. Sebastian was a great Emacs hacker and a great maintainer and it’s not easy to fill in his shoes.
Regardless of his departure, however, the project continued to thrive for several years under the maintenance of Clément Pit-Claudel and @fmdkdd. That’s part of the beauty of OSS - a good project will continue regardless of maintainer changes. And as long a project is useful, there will always be someone willing to improve and maintain it.
Lately, however, the current maintainers didn’t have much time for Flycheck and this resulted in a pretty big backlog of open issues and pull requests. Some people even asked whether the project is dead…
Well, I’m writing this article to inform all of you that Flycheck is alive and kicking! Recently I’ve joined the maintenance team myself, as I wanted to help my beloved project grow and evolve. There were a lot of low-hanging fruits and this resulted in making some quick progress early on. So far I’ve:
- Cut one new release (33.0)
- Merged a couple dozens of PRs and left some feedback on a bunch more, that I hope to merge soon
- Fixed the broken deployment pipeline for the project’s website (it hadn’t been updated in quite a while, which resulted in the docs being out of sync with reality)
- Removed a lot of legacy cruft that’s no longer needed now that we target Emacs 26+
- Removed the
dashdependency in favor of using the built-in
- Cleaned up the testing and packaging infrastructure of the project
That’s just the beginning, of course. I expect that Flycheck 34 will be around sooner rather than later and that it’d be the first Flycheck release that’s self-contained (without any third-party dependencies). Down the road I plan to submit the package to NonGNU ELPA and that would certainly help a bit. In general I’m aiming for smaller, but more frequent releases.
Note: Flycheck has a somewhat weird versioning scheme - only major and minor versions (Major.Minor). That’s legacy of the fact that after version 0.25 the project went to version 26, but opted to stay with major versions signifying new features & changes. I’m more fond of SemVer myself, but that ship has sailed and I’ll stick to the existing version scheme.
What are the plans for the future? I don’t have anything grand in mind right now - mostly working through the backlog of issues and PRs. I don’t think the project has any serious shortcomings that need to be addressed and I think that the codebase is pretty healthy overall.
At some point I might rework the project’s website (I normally use Antora in my projects), but I found it refreshing to work with reStructured Text (RST) and Sphinx for a change, so I definitely am not in a hurry to make changes there. Some items that I’ve been thinking about:
- Complete transition of the project’s tests from ERT to Buttercup
- Update the docs to reflect modern developments (e.g. the changes that happened to our main “competitor” Flymake after Emacs 26)
- Review the list of bundled checkers and trim those that are no longer relevant
- I noticed there’s a bit of demand for TRAMP support, which shouldn’t be too hard to add (but I’m always somewhat wary of TRAMP and the added complexity support for it brings)
- I noticed there are no Flycheck checkers for Java. I’m guessing the reason is that there are no Java CLI linters with fast startup time, but perhaps something has changed in recent years. (e.g. there might be some linter that can be compiled with GraalVM)
- It seems that many people were forced to move to Flymake, because they wanted to use Eglot and its maintainer didn’t want to provide Flycheck integration for it. It’d be great if we can do something about this, as Eglot is quite popular (like most built-in packages). This episode is also a great reminder about how hard it is to compete with built-in packages.1
If you have any ideas about improvements - feel free to share those in the comments or over at GitHub!
I know that in the Emacs community there are many people who believe that if some feature is bundled in Emacs it doesn’t make much sense to develop alternative solutions, but I’m fairly certain that those alternative solutions are driving progress in the long run. E.g. Flycheck likely inspired the big revamp of Flymake in Emacs 26, Projectile probably inspired the creation of
project.el and so on. So having alternatives is a good thing in my book!2
Given the massive list of packages that I maintain, I can’t promise any miracles, but I can promise you I’ll do my best to ensure that Flycheck is in a good shape for many years to come. The power of OSS is you, the community around projects, so I’m hoping that some of you will help out on the journey of making Flycheck better. Emacs hackers together strong!
And that’s all I have for you today. Keep hacking!