Add new command indent

Author: jcs090218

cmds/lint/indent.js

@@ -0,0 +1,34 @@
+/**
+ * Copyright (C) 2022 Jen-Chieh Shen
+ *
+ * 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 GNU Emacs; see the file COPYING.  If not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+"use strict";
+
+exports.command = ['indent [files..]', 'lint-indent [files..]'];
+exports.desc = 'lint the package using package-lint';
+exports.builder = {
+  files: {
+    description: 'specify files to do package lint',
+    requiresArg: false,
+    type: 'array',
+  },
+};
+
+exports.handler = async (argv) => {
+  await UTIL.e_call(argv, 'lint/indent', argv.files);
+};

cmds/lint/lint.js

@@ -19,16 +19,16 @@
 
 "use strict";
 
-exports.command = ['lint [names..]', 'lint-package [names..]'];
+exports.command = ['lint [files..]', 'lint-package [files..]'];
 exports.desc = 'lint the package using package-lint';
 exports.builder = {
-  names: {
-    description: 'specify files to lint',
+  files: {
+    description: 'specify files to do package lint',
     requiresArg: false,
     type: 'array',
   },
 };
 
 exports.handler = async (argv) => {
-  await UTIL.e_call(argv, 'lint/lint', argv.names);
+  await UTIL.e_call(argv, 'lint/lint', argv.files);
 };

lisp/_prepare.el

@@ -950,6 +950,12 @@ Standard is, 0 (error), 1 (warning), 2 (info), 3 (log), 4 or above (debug)."
             (eask-msg (ansi-white (buffer-string)))))
       (eask-error "Help manual missig %s" help-file))))
 
+(defun eask--print-no-matching-files ()
+  "Print message for no matching files found."
+  (eask-log "")
+  (eask-log "Cannot find matching files with given pattern %s" (eask-args))
+  (eask-log ""))
+
 ;;
 ;;; Checker
 

lisp/help/checkdoc

@@ -12,6 +12,6 @@ For example,
 
     [+] (files "*.el")
 
-💡 Tip: You can use command [files] to show all selected files
+💡 Tip: You can use the command [files] to show all selected files
 
     $ eask files

lisp/help/lint

@@ -1,8 +1,13 @@
 
-💡 Use directive (package-file ..) or (files ..) to specify package files
+💡 You need to specify file(s) you want the package-lint to run
 
-    [+] (package-file "PKG-MAIN.el")
-
-Or,
+    [+] (package-file "ENTRY")         ; One argument with a string
+    [+] (files "FILE-1" "FILE-2" ...)  ; All arguments are wildcard patterns
 
+For example,
+    
     [+] (files "*.el")
+
+💡 Tip: You can use the command [files] to show all selected files
+   
+    $ eask files

lisp/lint/buttercup.el

@@ -4,12 +4,7 @@
 ;;
 ;; Command to run buttercup tests,
 ;;
-;;   $ eask buttercup [files..]
-;;
-;;
-;;  Initialization options:
-;;
-;;    [files..]     specify files to run ert tests
+;;   $ eask buttercup
 ;;
 
 ;;; Code:

lisp/lint/checkdoc.el

@@ -45,15 +45,18 @@
 
 (eask-start
   (require 'checkdoc)
-  (if-let* ((files (or (eask-expand-file-specs (eask-args))
-                       (eask-package-el-files)))
+  (if-let* ((files (if (eask-args)
+                       (eask-expand-file-specs (eask-args))
+                     (eask-package-el-files)))
             (len (length files))
             (s (eask--sinr len "" "s"))
             (have (eask--sinr len "has" "have")))
       (progn
         (mapcar #'eask--checkdoc-file files)
         (eask-info "(Total of %s file%s %s checked)" len s have))
     (eask-info "(No files have been checked (checkdoc))")
-    (eask-help 'checkdoc)))
+    (if (eask-args)
+        (eask--print-no-matching-files)
+      (eask-help 'checkdoc))))
 
 ;;; checkdoc.el ends here

lisp/lint/indent.el

@@ -0,0 +1,56 @@
+;;; indent.el --- Lint the package using `indent-lint'  -*- lexical-binding: t; -*-
+
+;;; Commentary:
+;;
+;; Command use to ,
+;;
+;;   $ eask indent [names..]
+;;
+;;
+;;  Initialization options:
+;;
+;;    [names..]     specify files to do indent lint
+;;
+
+;;; Code:
+
+(load (expand-file-name
+       "../_prepare.el"
+       (file-name-directory (nth 1 (member "-scriptload" command-line-args))))
+      nil t)
+
+(defun eask--undo-lines (undo-list)
+  "Return list of lines changed in UNDO-LIST."
+  (let ((lines))
+    (dolist (elm undo-list)
+      (when (and (consp elm) (numberp (cdr elm)))
+        (push (line-number-at-pos (abs (cdr elm))) lines)))
+    (reverse lines)))
+
+(defun eask--indent-lint-file (file)
+  "Lint indent for FILE."
+  (eask-msg "")
+  (eask-msg "`%s` with indent-lint" (ansi-green (eask-root-del file)))
+  (find-file file)
+  (let ((report-func (if (eask-strict-p) #'eask-error #'eask-warn))
+        (tick (buffer-modified-tick)))
+    (eask--silent (indent-region (point-min) (point-max)))
+    (if (/= tick (buffer-modified-tick))
+        ;; Indentation changed: warn for each line.
+        (dolist (line (eask--undo-lines buffer-undo-list))
+          (funcall report-func "%s:%s: Indentation mismatch" (buffer-name) line))
+      (eask-msg "No issues found"))))
+
+(eask-start
+  (if-let ((files (if (eask-args)
+                      (eask-expand-file-specs (eask-args))
+                    (eask-package-el-files))))
+      (progn
+        (mapcar #'eask--indent-lint-file files)
+        (eask-info "(Total of %s files linted)" (length files)))
+    (eask-info "(No files have been linted)")
+    (if (eask-args)
+        (eask--print-no-matching-files)
+      (eask-help 'indent))))
+
+;;; indent.el ends here

lisp/lint/lint.el

@@ -9,7 +9,7 @@
 ;;
 ;;  Initialization options:
 ;;
-;;    [names..]     specify files to byte-compile
+;;    [names..]     specify files to do package lint
 ;;
 
 ;;; Code:
@@ -38,18 +38,16 @@
 (eask-start
   (eask-with-archives "melpa"
     (eask-package-install 'package-lint))
-  (if-let ((files (if (eask-args) (eask-expand-file-specs (eask-args))
+  (if-let ((files (if (eask-args)
+                      (eask-expand-file-specs (eask-args))
                     (eask-package-el-files))))
       (progn
         (setq package-lint-main-file eask-package-file)
         (mapcar #'eask--package-lint-file files)
         (eask-info "(Total of %s files linted)" (length files)))
     (eask-info "(No files have been linted)")
     (if (eask-args)
-        (progn
-          (eask-log "")
-          (eask-log "Cannot find matching files with given pattern %s" (eask-args))
-          (eask-log ""))
+        (eask--print-no-matching-files)
       (eask-help 'lint))))
 
 ;;; lint.el ends here