Eask

CLI for building, running, testing, and managing your Emacs Lisp dependencies

Eask was built to use as a package development tool in your Elisp packages. But now, Eask supports various types of Emacs Lisp tasks. It can be used in three major ways:

1. Dev tool for Elisp packages
2. Dependency management for your configuration
3. Run elisp programs for all other purposes

So what are the major differences between Eask and other build tools like Cask, makem.sh, and Eldev, other than the things above?

Good question! Eask is more than a build tool now, it can be used for various purposes! But here are Eask aims to be:

• Consistent enough to sandbox across all systems
• General enough to have Emacsers frequently used commands (byte-compile, checkdoc, etc)
• Robust enough to provide useful results even in the presence of user errors
• Dependency-free so that the tool can be run on any platform

P.S. See Why Eask? for more detailed information.

🔗 Links

💡 node is not required to use Eask!

• Documentation
• Installation
• Command-line interface
• Examples
• FAQ

🧪 Testing

We have incorporated a range of tests to ensure Eask remains stable throughout its release cycle.

Documentation

| Description | Done | Status | |----------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------| | Keep the documentation page up to date | ✔ | |

Development

| Description | Done | Status | |--------------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | Compile source and check redefined | ✔ | | | Compatibility check for each Emacs version | ✔ | | | Build executables | ✔ | |

Commands

| 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 | ✔ | |

Options

| Description | Done | Status | |----------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | Test option switches | ✔ | |

Test

| Description | Done | Status | |---------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Test ert command | ✔ | | | Test ert-runner command | ✔ | | | Test buttercup command | ✔ | | | Test ecukes command | ✔ | |

Others

| Description | Done | Status | |-------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Webinstall | ✔ | |

⚜️ 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 https://www.gnu.org/licenses/.

See COPYING for details.