@emacs-eask/eask

A set of command-line tools to build Emacs packages


Keywords
emacs, package, management, cli, tool
License
GPL-3.0
Install
npm install @emacs-eask/eask@0.1.27

Documentation

Eask

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

License: GPL v3 Emacs Version Release Discord

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!

๐Ÿงช 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 โœ” Docs
Development
Description Done Status
Compile source and check redefined โœ” Compile
Compatibility check for each Emacs version โœ” Compat
Build executables โœ” Build
Commands
Description Done Status
Test commands in global (~/.eask/) mode โœ” Global
Test commands in config (~/.emacs.d/) mode โœ” Confg
Test commands in development (./) mode โœ” Local
Test install packages โœ” Install
Test link packages โœ” Link
Test analyze command / Eask-file checker โœ” Analyze
Test docker command โœ” Docker
Test exec command โœ” Exec
Test emacs command โœ” Emacs
Test search packages โœ” Search
Test upgrade and check outdated packages โœ” Outdated_Upgrade
Options
Description Done Status
Test option switches โœ” Options
Test
Description Done Status
Test ert command โœ” Test ert
Test ert-runner command โœ” Test ert-runner
Test buttercup command โœ” Test buttercup
Test ecukes command โœ” Test ecukes
Others
Description Done Status
Webinstall โœ” 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.