feat(install): Add commands install-file and install-vc (#317)

* feat(install): Add commands install-file and install-vc

* fix: Revert some mistake changes

* docs: add doc

* changelog

* test: Try set higher timeout

* fix: split spec

* ci: Try one recipe instead

* test: Inhibit vc install

* chore: increase timeout even further

* ci: further increase timeout

* ci: Still avoid timeout on local archive

* ci: try using a real timer

* ci: Just increase it since no idea why it fails

* ci: test skip for now

* avoid vc install for now

* feat: Handle force flag on package installation

* changelog

Author: jcs090218

CHANGELOG.md

@@ -20,6 +20,8 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 * ci(build.yml): Try forked pkg to fix `arm64` build 2 (#292 and #294)
 * feat: Set error status when help is printed (#307)
 * feat: Add exit code specification (c49f53caa1f6ac94a9c8c884d70d0860f55728c1)
+* feat(install): Add commands `install-file` and `install-vc` (#317)
+* feat(install): Handle `--force` flag to overwrite installed packages (#317)
 
 ## 0.10.x
 > Released Jun 13, 2024

cmds/core/install-file.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (C) 2025 the Eask authors.
+ *
+ * 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, 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/>.
+ */
+
+"use strict";
+
+exports.command = ['install-file [files..]'];
+exports.desc = 'Install packages from files, .tar files, or directories';
+exports.builder = yargs => yargs
+  .positional(
+    '[files..]', {
+      description: 'files to install as packages',
+      type: 'array',
+    });
+
+exports.handler = async (argv) => {
+  await UTIL.e_call(argv, 'core/install-file', argv.files);
+};

cmds/core/install-vc.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (C) 2025 the Eask authors.
+ *
+ * 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, 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/>.
+ */
+
+"use strict";
+
+exports.command = ['install-vc [specs..]'];
+exports.desc = 'Install packages directly from the version control';
+exports.builder = yargs => yargs
+  .positional(
+    '[specs..]', {
+      description: 'vc specification to install as packages',
+      type: 'array',
+    });
+
+exports.handler = async (argv) => {
+  await UTIL.e_call(argv, 'core/install-vc', argv.specs);
+};

docs/content/DSL/_index.en.md

@@ -56,7 +56,7 @@ Declare package's author.
 
 ## 🔍 **package-file** (`file` `version` `description`)
 
-Define this package and its runtime dependencies from the package headers 
+Define this package and its runtime dependencies from the package headers
 of a file (used only for package development).
 
 ```elisp
@@ -65,7 +65,7 @@ of a file (used only for package development).
 
 ## 🔍 **package-descriptor** (`pkg-file`)
 
-Declare all package metadata directly by specifying a package descriptor 
+Declare all package metadata directly by specifying a package descriptor
 contained in file with name given by file.
 
 ```elisp
@@ -149,14 +149,30 @@ Specify dependencies that are listed in **archives**:
 (depends-on "company")
 ```
 
+Specify dependencies in **file** format:
+
+```elisp
+(depends-on "auto-rename-tag" :file "/path/to/auto-rename-tag")
+
+(depends-on "lsp-ui" :file "/path/to/lsp-ui")
+```
+
+Specify dependencies in **vc** format:
+
+```elisp
+(depends-on "auto-rename-tag" :vc "jcs-elpa/auto-rename-tag")
+
+(depends-on "lsp-ui" :vc "emacs-lsp/lsp-ui")
+```
+
 Specify dependencies in **recipe** format:
 
 ```elisp
-(depends-on "auto-rename-tag" 
-            :repo "jcs-elpa/auto-rename-tag" 
+(depends-on "auto-rename-tag"
+            :repo "jcs-elpa/auto-rename-tag"
             :fetcher 'github)
 
-(depends-on "lsp-ui" 
+(depends-on "lsp-ui"
             :repo "emacs-lsp/lsp-ui"
             :fetcher 'github
             :files '(:defaults "lsp-ui-doc.html" "resources"))

docs/content/DSL/_index.zh-tw.md

@@ -145,14 +145,30 @@ weight: 200
 (depends-on "company")
 ```
 
+以 **file** 格式指定依賴項：
+
+```elisp
+(depends-on "auto-rename-tag" :file "/path/to/auto-rename-tag")
+
+(depends-on "lsp-ui" :file "/path/to/lsp-ui")
+```
+
+以 **vc** 格式指定依賴項：
+
+```elisp
+(depends-on "auto-rename-tag" :vc "jcs-elpa/auto-rename-tag")
+
+(depends-on "lsp-ui" :vc "emacs-lsp/lsp-ui")
+```
+
 以 **recipe** 格式指定依賴項：
 
 ```elisp
-(depends-on "auto-rename-tag" 
-            :repo "jcs-elpa/auto-rename-tag" 
+(depends-on "auto-rename-tag"
+            :repo "jcs-elpa/auto-rename-tag"
             :fetcher 'github)
 
-(depends-on "lsp-ui" 
+(depends-on "lsp-ui"
             :repo "emacs-lsp/lsp-ui"
             :fetcher 'github
             :files '(:defaults "lsp-ui-doc.html" "resources"))

docs/content/Development-API/_index.en.md

@@ -129,6 +129,16 @@ then,
 (message "%s" (eask-command))  ; init
 ```
 
+## 🔍 Function: eask-command-check (`version`)
+
+Report error if the current command requires minimum `version`.
+
+```elisp
+(eask-start
+  (eask-command-check "27.1")  ; The command requires 27.1 and above!
+  ...
+```
+
 ## 🔍 Function: eask-command-p (`commands`)
 
 Return t if COMMANDS is the current command.

docs/content/Development-API/_index.zh-tw.md

@@ -128,6 +128,16 @@ eask init
 (message "%s" (eask-command))  ; init
 ```
 
+## 🔍 函式: eask-command-check (`version`)
+
+如果目前的指令需要最低的 `version` 就會報錯。
+
+```elisp
+(eask-start
+  (eask-command-check "27.1")  ; 此指令需要 27.1 及以上版本！
+  ...
+```
+
 ## 🔍 函式: eask-command-p (`commands`)
 
 如果 COMMANDS 是目前命令，則傳回 `t`。

docs/content/Getting-Started/Basic-Usage/_index.en.md

@@ -49,6 +49,8 @@ Commands:
   info                       Display information about the current package
   init [files..]             Initialize project to use Eask
   install-deps               Automatically install package dependencies                                                                                                  [aliases: install-dependencies, prepare]
+  install-file [files..]     Install packages from files, .tar files, or directories
+  install-vc [specs..]       Install packages directly from the version control
   install [names..]          Install packages
   keywords                   List available keywords that can be used in the header section
   link <action>              Manage links

docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md

@@ -46,6 +46,8 @@ Commands:
   info                       Display information about the current package
   init [files..]             Initialize project to use Eask
   install-deps               Automatically install package dependencies                                                                                                  [aliases: install-dependencies, prepare]
+  install-file [files..]     Install packages from files, .tar files, or directories
+  install-vc [specs..]       Install packages directly from the version control
   install [names..]          Install packages
   keywords                   List available keywords that can be used in the header section
   link <action>              Manage links

docs/content/Getting-Started/Commands-and-options/_index.en.md

@@ -114,6 +114,26 @@ Display the state of the workspace.
 eask [GLOBAL-OPTIONS] status
 ```
 
+## 🔍 eask install
+
+To install packages.
+
+```sh
+eask [GLOBAL-OPTIONS] install [PACKAGES..]
+```
+
+Install packages by specifying arguments:
+
+```sh
+eask install auto-complete helm magit
+```
+
+Or else, it will install the package from the current development:
+
+```sh
+eask install
+```
+
 ## 🔍 eask install-deps
 
 To install all dependencies.
@@ -128,24 +148,20 @@ eask [GLOBAL-OPTIONS] install-deps [--dev]
 💡 Specify option [--dev] to install dependencies from the development scope.
 {{< /hint >}}
 
-## 🔍 eask install
+## 🔍 eask install-file
 
-To install packages.
+Install packages from files, `.tar` files, or directories.
 
 ```sh
-eask [GLOBAL-OPTIONS] install [PACKAGES..]
+eask [GLOBAL-OPTIONS] install-file [FILES..]
 ```
 
-Install packages by specifying arguments:
+## 🔍 eask install-vc
 
-```sh
-eask install auto-complete helm magit
-```
-
-Or else, it will install the package from the current development:
+Install packages directly from the version control.
 
 ```sh
-eask install
+eask [GLOBAL-OPTIONS] install-vc [SPECS..]
 ```
 
 ## 🔍 eask uninstall