Skip to content

Latest commit

 

History

History
116 lines (79 loc) · 4.04 KB

README.md

File metadata and controls

116 lines (79 loc) · 4.04 KB
Raw

License: GPL v3 JCS-ELPA MELPA MELPA Stable Emacs

eask

Core Eask APIs, for Eask CLI development

Build CI System

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)

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.

🔨 Usage

Call the following whenever you need to know Eask's API.

(require 'eask-core)

Or enable it when the project is a valid Eask project,

(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

PRs Welcome Elisp styleguide Donate on paypal Become a patron

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:

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

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

See LICENSE for details.