https://github.com/emacs-eask/eask
Core Eask APIs, for Eask CLI development
https://github.com/emacs-eask/eask
eask elisp emacs
Last synced: 4 months ago
JSON representation
Core Eask APIs, for Eask CLI development
- Host: GitHub
- URL: https://github.com/emacs-eask/eask
- Owner: emacs-eask
- License: gpl-3.0
- Created: 2022-09-13T02:56:18.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2026-01-23T20:45:00.000Z (4 months ago)
- Last Synced: 2026-01-24T02:15:26.854Z (4 months ago)
- Topics: eask, elisp, emacs
- Language: Emacs Lisp
- Homepage:
- Size: 605 KB
- Stars: 22
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://jcs-emacs.github.io/jcs-elpa/#/eask)
[](https://melpa.org/#/eask)
[](https://stable.melpa.org/#/eask)
# eask
> Core Eask APIs, for Eask CLI development
[](https://github.com/emacs-eask/eask/actions/workflows/build.yml)
[](https://github.com/emacs-eask/eask/actions/workflows/test.yml)
[](https://github.com/emacs-eask/eask/actions/workflows/system.yml)
The goal of this package is to provide function signatures so you can
develop Eask with your elisp environment. Few important feature that
this package can do:
1. Provide auto-completion with `capf` (`auto-complete`, `company`, `corfu`, etc)
2. Provide function signatures and display arglist (`eldoc`, etc)
Generally, you would not want to call any of these functions or use any of
these variables from your Emacs editor environment. Unless you are extending
Eask's core functionalities.
> [!NOTE]
>
> The core of this file (`eask-core.el`) is generated from the [emacs-eask/cli][]; therefore, please avoid directly modifying its contents in this repository!
## 🔨 Usage
Call the following whenever you need to know Eask's API.
```elisp
(require 'eask-core)
```
Or enable it when the project is a valid Eask project,
```elisp
(add-hook 'emacs-lisp-hook #'eask-api-setup)
```
## 🔧 Customization
### 🧪 Variables
- `eask-api-strict-p` - Set to nil if you want to load Eask API whenever it's possible.
## 🛠️ Contribute
[](http://makeapullrequest.com)
[](https://github.com/bbatsov/emacs-lisp-style-guide)
[](https://www.paypal.me/jcs090218)
[](https://www.patreon.com/jcs090218)
If you would like to contribute to this project, you may either
clone and make pull requests to this repository. Or you can
clone the project and establish your own branch of this tool.
Any methods are welcome!
### 🔬 Development
To run the test locally, you will need the following tools:
- [Eask](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)
Install all dependencies and development dependencies:
```sh
eask install-deps --dev
```
To test the package's installation:
```sh
eask package
eask install
```
To test compilation:
```sh
eask compile
```
**🪧 The following steps are optional, but we recommend you follow these lint results!**
The built-in `checkdoc` linter:
```sh
eask lint checkdoc
```
The standard `package` linter:
```sh
eask lint package
```
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
## ⚜️ 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 .
See [`LICENSE`](./LICENSE.txt) for details.
[emacs-eask/cli]: https://github.com/emacs-eask/cli