🔰 快速開始

使用 Eask 作為您的 Emacs 包管理工具。

安裝是跨平台的，並使用 npm。有關使用其他方法安裝 Eask 的說明，請參閱安裝部分。
需要安裝 Git 才能運行本教程。

🔍 步驟 1: 設置 NodeJS runtime 和 `npm`

請在 [此處](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and- npm) 並安裝 NodeJS 和 npm 對應你當前的操作系統

💡 如果您不喜歡 NodeJS 和 npm，您可以使用 [binary](https://emacs-eask.github.io/Getting-Started/Install-Eask/#binary-cross -platform）來自我們的 release 頁面。

🔍 步驟 2: 安裝 Eask

$ npm install -g @emacs-eask/cli

驗證您的新安裝：

$ eask --version

🔍 步驟 3: 導航到現有項目或創建新項目

如果您已有一個現有的 elisp 項目，請導航到項目根文件夾。

$ cd /path/to/project/dir/

創建一個：

$ eask create package <your-project>

它應該在您當前的工作目錄中創建一個名為 <your-project> 的文件夾。

🔍 步驟 4：創建 `Eask` 文件

如果您選擇使用 eask create 創建項目，請跳過此步驟！

否則，在現有項目中創建 Eask 文件：

$ eask init

您將被問到一些關於您將要創建的包的問題：

package name: (your-project)
version: (1.0.0)
description: Your project description!
entry point: (your-project.el)
emacs version: (26.1)
website: https://example.com/project-url/
keywords: tools example
About to write to /path/to/project/Eask:

(package "your-project"
         "1.0.0"
         "Your project description!")

(website-url "https://example.com/project-url/")
(keywords "tools" "example")

(package-file "your-project.el")

(script "test" "echo \"Error: no test specified\" && exit 1")

(source "gnu")

(depends-on "emacs" "26.1")


Is this OK? (yes) yes ⏎

您應該能夠在項目文件夾中看到一個 Eask 文件。 🎉🎊

🔍 步驟 5: 開始包開發

要檢查您的包裹信息，請運行：

$ eask info

您應該能夠看到以下信息：

your-package (1.0.0) | deps: 0 | devDeps: 0
Your project description!
https://example.com/project-url/

keywords: tools, example

entry: your-package-file.el
kind: single

dist
.total-files: 0
.unpacked-size: 0

從一開始，您就不會有任何 dependencies 和 devDependencies（默認為 0）！

🔍 步驟 6: 管理包檔案

您可以使用 Eask 文件中的 source 指令來管理包存檔。

(source "gnu")    ; 默認
(source "melpa")  ; 添加包 archive

💡 有關更多信息，請參閱 DSL/source！

🔍 步驟 7: 添加一些依賴

您可以在 Eask 文件中使用 depends-on 指令添加依賴項。

...

(depends-on "f")
(depends-on "ht")

💡 確保您添加的依賴項在包存檔中可用！
否則你會得到一個錯誤 `package-name-’ is unavailable！

🔍 步驟 8: 安裝依賴

現在我們可以安裝我們在 Eask 文件中指定的依賴項：

$ eask install-deps

您應該會看到 Eask 正確執行，輸出類似如下：

Loading package information... done ✓
Installing 2 package dependencies...

  - [1/2] Installing f (20241003.1131)... done ✓
  - [2/2] Installing ht (20230703.558)... done ✓

(Total of 2 dependencies installed, 0 skipped)