feature: Add command to clean log files (#97)

* feature: Add command to clean log files

* Add tes

Author: jcs090218

CHANGELOG.md

@@ -30,6 +30,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 * Improve Eask-file loader to search file upward (#89)
 * Move command `activate` under test subcommand (#92)
 * Add command to create ELPA project (#94)
+* Add command to clean log files (#97)
 
 ## 0.7.x
 > Released Sep 08, 2022

cmds/clean/log-file.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright (C) 2023 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 = ['log-file'];
+exports.desc = 'Remove all generated log files';
+
+exports.handler = async (argv) => {
+  await UTIL.e_call(argv, 'clean/log-file');
+};

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

@@ -356,13 +356,22 @@ $ eask [GLOBAL-OPTIONS] clean dist
 
 Alias: `distribution`
 
+## 🔍 eask clean log-file
+
+Remove all generated log files.
+
+```sh
+$ eask [GLOBAL-OPTIONS] clean log-file
+```
+
 ## 🔍 eask clean all
 
-This command is combination of all other clean commands.
+This command is the combination of all other clean commands.
 
-* `clean workspace`
-* `clean elc`
-* `clean dist`
+- `clean workspace`
+- `clean elc`
+- `clean dist`
+- `clean log-file`
 
 ```sh
 $ eask [GLOBAL-OPTIONS] clean all

lisp/clean/all.el

@@ -34,6 +34,12 @@
     (eask-with-progress
       "Cleaning dist... \n"
       (eask-call "clean/dist")
+      (if eask-no-cleaning-operation-p "skipped ✗" "done ✓")))
+  (eask-msg "")
+  (let (eask-no-cleaning-operation-p)
+    (eask-with-progress
+      "Cleaning log files... \n"
+      (eask-call "clean/log-file")
       (if eask-no-cleaning-operation-p "skipped ✗" "done ✓"))))
 
 ;;; clean/all.el ends here

lisp/clean/elc.el

@@ -1,8 +1,8 @@
-;;; clean/elc.el --- Remove byte compiled files generated by cask build  -*- lexical-binding: t; -*-
+;;; clean/elc.el --- Remove byte compiled files generated by eask compile  -*- lexical-binding: t; -*-
 
 ;;; Commentary:
 ;;
-;; Remove byte compiled files generated by cask build
+;; Remove byte compiled files generated by eask compile
 ;;
 ;;   $ eask clean elc
 ;;

lisp/clean/log-file.el

@@ -0,0 +1,44 @@
+;;; clean/log-file.el --- Remove all generated log files  -*- lexical-binding: t; -*-
+
+;;; Commentary:
+;;
+;; Remove all generated log files,
+;;
+;;   $ eask clean log-file
+;;
+
+;;; Code:
+
+(load (expand-file-name
+       "../_prepare.el"
+       (file-name-directory (nth 1 (member "-scriptload" command-line-args))))
+      nil t)
+
+(defmacro eask--log-remove (file)
+  "Remove log FILE."
+  `(ignore-errors (delete-file (expand-file-name ,file log-dir))))
+
+(defun eask--delete-log-file (file log-dir count)
+  "Delete a log FILE."
+  (when (eask-delete-file (expand-file-name file log-dir))
+    (cl-incf count))
+  count)
+
+(eask-start
+  (let ((log-dir (expand-file-name eask-log-path eask-file-root))
+        (deleted 0)
+        (log-files '("messages.log"
+                     "warnings.log"
+                     "backtrace.log"
+                     "compile-log.log")))
+    (dolist (log-file log-files)
+      (setq deleted (eask--delete-log-file log-file log-dir deleted)))
+    (eask-msg "")
+    (if (not (zerop deleted))
+        (eask-info "(Total of %s log file%s deleted, %s skipped)" deleted
+                   (eask--sinr deleted "" "s")
+                   (- (length log-files) deleted))
+      (eask-info "(No log file found in workspace)")
+      (setq eask-no-cleaning-operation-p t))))
+
+;;; clean/log-file.el ends here

test/commands/local/run.sh

@@ -71,6 +71,7 @@ eask test activate
 eask clean .eask
 eask clean elc
 eask clean dist
+eask clean log-file
 eask clean all
 
 # Util