CLI for building, running, testing, and managing your Emacs Lisp dependencies
Eask was originally designed as a package development tool for Elisp projects. However, it has since expanded to support a wide range of Emacs Lisp tasks. It can now be used in three major ways:
- As a development tool for Elisp packages.
- For managing dependencies in your Emacs configuration.
- To run Elisp programs for a variety of purposes (essentially functioning as a runtime).
With these capabilities in mind, what sets Eask apart from other build tools like Cask, makem.sh, and Eldev?
Great question! Eask has evolved beyond just a build tool—it serves multiple purposes! Here’s what Eask aims to be:
- Consistent: Provides a reliable sandboxing environment across all systems.
- Versatile: Includes commonly used Emacs commands like
byte-compilation,checkdoc, and more. - Robust: Delivers useful results even when user errors occur.
- Lightweight: Runs on any platform without dependencies.
📝 P.S. See Why Eask? for more detailed information.
💡
nodeis not required to use Eask!
We have incorporated a range of tests to ensure Eask remains stable throughout its release cycle.
| Description | Done | Status |
|---|---|---|
| Keep the documentation page up to date | ✔ |  |
| Description | Done | Status |
|---|---|---|
| Compile source and check redefined | ✔ |  |
| Compatibility check for each Emacs version | ✔ |  |
| Build executables | ✔ |  |
| Description | Done | Status |
|---|---|---|
Test commands in global (~/.eask/) mode | ✔ |  |
Test commands in config (~/.emacs.d/) mode | ✔ |  |
Test commands in development (./) mode | ✔ |  |
| Test install packages | ✔ |  |
| Test link packages | ✔ |  |
Test analyze command / Eask-file checker | ✔ |  |
Test docker command | ✔ |  |
Test exec command | ✔ |  |
Test emacs command | ✔ |  |
| Test search packages | ✔ |  |
| Test upgrade and check outdated packages | ✔ |  |
Test upgrade-eask command | ✔ |  |
| Description | Done | Status |
|---|---|---|
| Test option switches | ✔ |  |
| Description | Done | Status |
|---|---|---|
Test ert command | ✔ |  |
Test ert-runner command | ✔ |  |
Test buttercup command | ✔ |  |
Test ecukes command | ✔ |  |
| Description | Done | Status |
|---|---|---|
| Webinstall | ✔ |  |
| Exit Status | ✔ |  |
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 https://www.gnu.org/licenses/.
See LICENSE for details.