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

Author: jcs090218

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"))

lisp/_prepare.el

@@ -152,6 +152,12 @@ will return `lint/checkdoc' with a dash between two subcommands."
                                     (list script-file))
                  "/"))))
 
+(defun eask-command-check (version)
+  "Report error if the current command requires minimum VERSION."
+  (when (version< emacs-version version)
+    (eask-error "The command `%s' requires Emacs %s and above!"
+                (eask-command) version)))
+
 (defun eask-command-p (commands)
   "Return t if COMMANDS is the current command."
   (member (eask-command) (eask-listify commands)))
@@ -542,10 +548,25 @@ For arguments FUNC and DEPS, see function `mapc' for more information."
          (len (length deps))
          (fmt (eask--action-format len))
          (count 0))
-    (dolist (pkg deps)
+    (dolist (dep deps)
       (cl-incf count)
       (setq eask--action-prefix (format fmt count))
-      (funcall func pkg))))
+      (funcall func dep))))
+
+(defun eask--install-dep (dep)
+  "Custom install DEP."
+  (let ((name (car dep)))
+    (cond
+     ;; Install through the function `package-install-file'.
+     ((memq :file dep)
+      (let ((file (nth 2 dep)))
+        (eask-package-install-file name file)))
+     ;; Install through the function `package-vc-install'.
+     ((memq :vc dep)
+      (let ((spec (cdr (memq :vc dep))))
+        (eask-package-vc-install name spec)))
+     ;; Fallback to archive install.
+     (t (eask-package-install name)))))
 
 (defun eask--install-deps (dependencies msg)
   "Install DEPENDENCIES.
@@ -557,10 +578,11 @@ scope of the dependencies (it's either `production' or `development')."
          (len (length dependencies))
          (ies (eask--sinr len "y" "ies"))
          (pkg-installed (cl-remove-if #'package-installed-p names))
-         (installed (length pkg-installed)) (skipped (- len installed)))
+         (installed (length pkg-installed))
+         (skipped (- len installed)))
     (eask-log "Installing %s %s dependenc%s..." len msg ies)
     (eask-msg "")
-    (eask--package-mapc #'eask-package-install names)
+    (eask--package-mapc #'eask--install-dep dependencies)
     (eask-msg "")
     (eask-info "(Total of %s dependenc%s installed, %s skipped)"
                installed ies skipped)))
@@ -669,6 +691,38 @@ Argument BODY are forms for execution."
   "Return non-nil if package (PKG) is installable."
   (assq (eask-intern pkg) package-archive-contents))
 
+(defun eask-package-vc-install (pkg spec)
+  "To vc install the package (PKG) by argument SPEC."
+  (eask-defvc< 27 (eask-pkg-init))  ; XXX: remove this after we drop 26.x
+  (eask--pkg-process pkg
+    (cond
+     ((package-installed-p pkg)
+      (eask-msg "  - %sSkipping %s (%s)... already installed ✗"
+                eask--action-prefix
+                name version))
+     (t
+      (eask-with-progress
+        (format "  - %sInstalling %s (%s)... " eask--action-prefix name version)
+        (eask-with-verbosity 'debug
+          (apply #'package-vc-install spec))
+        "done ✓")))))
+
+(defun eask-package-install-file (pkg file)
+  "To FILE install the package (PKG)."
+  (eask-defvc< 27 (eask-pkg-init))  ; XXX: remove this after we drop 26.x
+  (eask--pkg-process pkg
+    (cond
+     ((package-installed-p pkg)
+      (eask-msg "  - %sSkipping %s (%s)... already installed ✗"
+                eask--action-prefix
+                name version))
+     (t
+      (eask-with-progress
+        (format "  - %sInstalling %s (%s)... " eask--action-prefix name version)
+        (eask-with-verbosity 'debug
+          (package-install-file (expand-file-name file)))
+        "done ✓")))))
+
 (defun eask-package-install (pkg)
   "Install the package (PKG)."
   (eask-defvc< 27 (eask-pkg-init))  ; XXX: remove this after we drop 26.x
@@ -683,18 +737,17 @@ Argument BODY are forms for execution."
         (unless (eask-package-installable-p pkg)
           (eask-error "Package not installable `%s'; make sure the package archive (source) is included" pkg))))
      (t
-      (eask--pkg-process pkg
-        (eask-with-progress
-          (format "  - %sInstalling %s (%s)... " eask--action-prefix name version)
-          (eask-with-verbosity 'debug
-            ;; XXX: Without ignore-errors guard, it will trigger error
-            ;;
-            ;;   Can't find library xxxxxxx.el
-            ;;
-            ;; But we can remove this after Emacs 28, since function `find-library-name'
-            ;; has replaced the function `signal' instead of the `error'.
-            (eask-ignore-errors (package-install pkg)))
-          "done ✓"))))))
+      (eask-with-progress
+        (format "  - %sInstalling %s (%s)... " eask--action-prefix name version)
+        (eask-with-verbosity 'debug
+          ;; XXX: Without ignore-errors guard, it will trigger error
+          ;;
+          ;;   Can't find library xxxxxxx.el
+          ;;
+          ;; But we can remove this after Emacs 28, since function `find-library-name'
+          ;; has replaced the function `signal' instead of the `error'.
+          (eask-ignore-errors (package-install pkg)))
+        "done ✓")))))
 
 (defun eask-package-delete (pkg)
   "Delete the package (PKG)."
@@ -720,13 +773,12 @@ Argument BODY are forms for execution."
       (eask-msg "  - %sSkipping %s (%s)... not installed ✗" eask--action-prefix name version))
      (t
       (eask-pkg-init)
-      (eask--pkg-process pkg
-        (eask-with-progress
-          (format "  - %sReinstalling %s (%s)... " eask--action-prefix name version)
-          (eask-with-verbosity 'debug
-            (package-delete (eask-package-desc pkg t) t)
-            (eask-ignore-errors (package-install pkg)))
-          "done ✓"))))))
+      (eask-with-progress
+        (format "  - %sReinstalling %s (%s)... " eask--action-prefix name version)
+        (eask-with-verbosity 'debug
+          (package-delete (eask-package-desc pkg t) t)
+          (eask-ignore-errors (package-install pkg)))
+        "done ✓")))))
 
 (defun eask-package-desc (name &optional current)
   "Build package description by its NAME.
@@ -1276,6 +1328,7 @@ This uses function `locate-dominating-file' to look up directory tree."
 (defvar eask-depends-on-emacs   nil)
 (defvar eask-depends-on         nil)
 (defvar eask-depends-on-dev     nil)
+(defvar eask-depends-on         nil)
 
 (defmacro eask--save-eask-file-state (&rest body)
   "Execute BODY without touching the Eask-file global variables."
@@ -1487,6 +1540,17 @@ argument COMMAND."
 
 (add-hook 'eask-file-loaded-hook #'eask--setup-dependencies)
 
+(defun eask--check-depends-on (recipe)
+  "Return non-nil if RECIPE is invalid."
+  (let ((pkg (car recipe))
+        (minimum-version (cdr recipe)))
+    (cond ((member recipe eask-depends-on)
+           (eask-error "Define dependencies with the same name `%s'" pkg))
+          ((cl-some (lambda (rcp)
+                      (string= (car rcp) pkg))
+                    eask-depends-on)
+           (eask-error "Define dependencies with the same name `%s' with different version" pkg)))))
+
 (defun eask-f-depends-on (pkg &rest args)
   "Specify a dependency (PKG) of this package.
 
@@ -1505,17 +1569,27 @@ ELPA)."
         recipe)))
    ;; No argument specify
    ((<= (length args) 1)
-    (let* ((minimum-version (or (car args) "0"))
+    (let* ((minimum-version (car args))
            (recipe (list pkg minimum-version)))
-      (if (member recipe eask-depends-on)
-          (eask-error "Define dependencies with the same name `%s'" pkg)
+      (unless (eask--check-depends-on recipe)
+        (push recipe eask-depends-on))
+      recipe))
+   ;; Local packages
+   ((memq :file args)
+    (let* ((recipe (append (list (intern pkg)) args)))
+      (unless (eask--check-depends-on recipe)
+        (push recipe eask-depends-on))
+      recipe))
+   ;; VC packages
+   ((memq :vc args)
+    (let* ((recipe (append (list (intern pkg)) args)))
+      (unless (eask--check-depends-on recipe)
         (push recipe eask-depends-on))
       recipe))
    ;; recipe are entered
    (t
     (let ((recipe (append (list (intern pkg)) args)))
-      (if (member recipe eask-depends-on)
-          (eask-error "Define dependencies with the same name `%s'" pkg)
+      (unless (eask--check-depends-on recipe)
         (push recipe eask-depends-on)
         (eask-load "extern/github-elpa")
         (eask-with-verbosity 'debug

lisp/core/info.el

@@ -27,9 +27,12 @@
             offset (eask-2str eask-info--max-offset))
       (dolist (dep dependencies)
         (let* ((target-version (cdr dep))
-               (target-version (if (= (length target-version) 1)
-                                   (nth 0 target-version)
-                                 "specified")))
+               (target-version (cond ((= (length target-version) 1)
+                                      (or (nth 0 target-version)  ; verison number
+                                          "archive"))
+                                     ((memq :file dep) "file")
+                                     ((memq :vc dep)   "vc")
+                                     (t                "recipe"))))
           (eask-println (concat "  %-" offset "s (%s)") (car dep) target-version)
           (eask-debug "    Recipe: %s" (car dep)))))))