chore: Improve command description

jcs090218 · jcs090218 · commit cff4546c8c7c · 2025-04-29T23:03:55.000-07:00
diff --git a/cmds/clean/autoloads.js b/cmds/clean/autoloads.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['autoloads'];
-exports.desc = 'Remove generated autoloads file';
+exports.desc = 'Remove the generated autoloads file';
 
 exports.handler = async (argv) => {
   await UTIL.e_call(argv, 'clean/autoloads', argv.dest);
diff --git a/cmds/clean/dist.js b/cmds/clean/dist.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['dist [destination]', 'distribution [destination]'];
-exports.desc = 'Delete dist subdirectory';
+exports.desc = 'Delete the dist directory where the build output is stored';
 exports.builder = yargs => yargs
   .positional(
     'destination', {
diff --git a/cmds/clean/pkg-file.js b/cmds/clean/pkg-file.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['pkg-file'];
-exports.desc = 'Remove generated pkg-file';
+exports.desc = 'Remove the generated pkg-file';
 
 exports.handler = async (argv) => {
   await UTIL.e_call(argv, 'clean/pkg-file');
diff --git a/cmds/clean/workspace.js b/cmds/clean/workspace.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['workspace', '.eask'];
-exports.desc = 'Clean up .eask directory';
+exports.desc = 'Clean up the .eask directory';
 
 exports.handler = async (argv) => {
   await UTIL.e_call(argv, 'clean/workspace');
diff --git a/cmds/core/list.js b/cmds/core/list.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['list'];
-exports.desc = 'List packages';
+exports.desc = 'List all installed packages in dependency tree form';
 exports.builder = yargs => yargs
   .options({
     'depth': {
diff --git a/cmds/generate/autoloads.js b/cmds/generate/autoloads.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['autoloads'];
-exports.desc = 'Generate autoloads file';
+exports.desc = 'Generate the autoloads file';
 
 exports.handler = async (argv) => {
   await UTIL.e_call(argv, 'generate/autoloads');
diff --git a/cmds/generate/ignore.js b/cmds/generate/ignore.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['ignore <name>'];
-exports.desc = 'Generate ignore file using .gitignore templates';
+exports.desc = 'Generate an ignore file using .gitignore templates';
 exports.builder = yargs => yargs
   .positional(
     '<name>', {
diff --git a/cmds/generate/license.js b/cmds/generate/license.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['license <name>'];
-exports.desc = 'Generate LICENSE file';
+exports.desc = 'Generate the LICENSE file';
 exports.builder = yargs => yargs
   .positional(
     '<name>', {
diff --git a/cmds/generate/pkg-file.js b/cmds/generate/pkg-file.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['pkg-file', 'pkg', 'pkg-el'];
-exports.desc = 'Generate pkg file';
+exports.desc = 'Generate the pkg file';
 
 exports.handler = async (argv) => {
   await UTIL.e_call(argv, 'generate/pkg-file');
diff --git a/cmds/generate/recipe.js b/cmds/generate/recipe.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['recipe [destination]'];
-exports.desc = 'Generate recipe file';
+exports.desc = 'Generate the recipe file';
 exports.builder = yargs => yargs
   .positional(
     'destination', {
diff --git a/cmds/generate/workflow.js b/cmds/generate/workflow.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['workflow <type>'];
-exports.desc = 'Generate yaml files for CI/CD';
+exports.desc = 'Generate a yaml files for CI/CD';
 exports.builder = function (yargs) {
   yargs.usage(`${exports.desc}
 
diff --git a/cmds/generate/workflow/circle-ci.js b/cmds/generate/workflow/circle-ci.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['circle-ci [file]'];
-exports.desc = 'Generate CircleCI workflow yaml file';
+exports.desc = 'Generate the CircleCI workflow yaml file';
 exports.builder = yargs => yargs
   .positional(
     '[file]', {
diff --git a/cmds/generate/workflow/github.js b/cmds/generate/workflow/github.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['github [file]', 'github-actions [file]', 'gha [file]'];
-exports.desc = 'Generate GitHub Actions workflow yaml file';
+exports.desc = 'Generate the GitHub Actions workflow yaml file';
 exports.builder = yargs => yargs
   .positional(
     '[file]', {
diff --git a/cmds/generate/workflow/gitlab.js b/cmds/generate/workflow/gitlab.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['gitlab [file]', 'gitlab-runner [file]'];
-exports.desc = 'Generate GitLab Runner workflow yaml file';
+exports.desc = 'Generate the GitLab Runner workflow yaml file';
 exports.builder = yargs => yargs
   .positional(
     '[file]', {
diff --git a/cmds/generate/workflow/travis-ci.js b/cmds/generate/workflow/travis-ci.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['travis-ci [file]'];
-exports.desc = 'Generate Travis CI workflow yaml file';
+exports.desc = 'Generate the Travis CI workflow yaml file';
 exports.builder = yargs => yargs
   .positional(
     '[file]', {
diff --git a/cmds/link/delete.js b/cmds/link/delete.js
@@ -18,7 +18,7 @@
 "use strict";
 
 exports.command = ['delete [names..]', 'remove [names..]'];
-exports.desc = 'Delete local linked packages';
+exports.desc = 'Delete locally linked packages';
 exports.builder = yargs => yargs
   .positional(
     '[names..]', {
diff --git a/docs/content/Getting-Started/Basic-Usage/_index.en.md b/docs/content/Getting-Started/Basic-Usage/_index.en.md
@@ -55,7 +55,7 @@ Commands:
   keywords                   Display the available keywords for use in the header section
   link <action>              Manage links
   lint <type>                Run linters
-  list                       List packages
+  list                       List all installed packages in dependency tree form
   load-path [patterns..]     Print the load-path from workspace
   load [files..]             Load elisp files
   outdated                   Show all outdated dependencies
diff --git a/docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md b/docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md
@@ -52,7 +52,7 @@ Commands:
   keywords                   Display the available keywords for use in the header section
   link <action>              Manage links
   lint <type>                Run linters
-  list                       List packages
+  list                       List all installed packages in dependency tree form
   load-path [patterns..]     Print the load-path from workspace
   load [files..]             Load elisp files
   outdated                   Show all outdated dependencies
diff --git a/docs/content/Getting-Started/Commands-and-options/_index.en.md b/docs/content/Getting-Started/Commands-and-options/_index.en.md
@@ -462,7 +462,7 @@ eask [GLOBAL-OPTIONS] upgrade
 
 ## 🔍 eask list
 
-List packages.
+List all installed packages in dependency tree form.
 
 ```sh
 eask [GLOBAL-OPTIONS] list [--depth]
@@ -490,7 +490,7 @@ Generate files that are used for the development.
 
 ## 🔍 eask generate autoloads
 
-Generate autoload file.
+Generate the autoload file.
 
 Write a package autoloads to `project-autoloads.el` in the project root.
 
@@ -504,7 +504,7 @@ for details.
 
 ## 🔍 eask generate pkg-file
 
-Generate pkg file.
+Generate the pkg file.
 
 Write a package descriptor file to `project-pkg.el` in the project root.
 
@@ -520,7 +520,7 @@ for details.
 
 ## 🔍 eask generate recipe
 
-Generate recipe file.
+Generate the recipe file.
 
 ```sh
 eask [GLOBAL-OPTIONS] generate recipe [DESTINATION]
@@ -531,7 +531,7 @@ by default.
 
 ## 🔍 eask generate license
 
-Generate LICENSE file.
+Generate a LICENSE file.
 
 ```sh
 eask [GLOBAL-OPTIONS] generate license <name>
@@ -547,7 +547,7 @@ to generate ignore file.
 
 ## 🔍 eask generate ignore
 
-Generate ignore file.
+Generate an ignore file.
 
 ```sh
 eask [GLOBAL-OPTIONS] generate ignore <name>
@@ -592,7 +592,7 @@ eask [GLOBAL-OPTIONS] generate test ecukes
 
 ## 🔍 eask generate workflow circle-ci
 
-Generate [CircleCI][] workflow yaml file.
+Generate the [CircleCI][] workflow yaml file.
 
 The default filename is `config.yml`.
 
@@ -604,7 +604,7 @@ This will generate the yaml file under `.circleci/`!
 
 ## 🔍 eask generate workflow github
 
-Generate [GitHub Actions][] workflow yaml file.
+Generate the [GitHub Actions][] workflow yaml file.
 
 The default filename is `test.yml`.
 
@@ -616,7 +616,7 @@ This will generate the yaml file under `.github/workflow/`!
 
 ## 🔍 eask generate workflow gitlab
 
-Generate [GitLab Runner][] workflow yaml file.
+Generate the [GitLab Runner][] workflow yaml file.
 
 The default filename is `.gitlab-ci.yml`.
 
@@ -626,7 +626,7 @@ eask [GLOBAL-OPTIONS] generate workflow gitlab [--file]
 
 ## 🔍 eask generate workflow travis-ci
 
-Generate [Travis CI][] workflow yaml file.
+Generate the [Travis CI][] workflow yaml file.
 
 The default filename is `.travis.yml`.
 
@@ -651,7 +651,7 @@ eask [GLOBAL-OPTIONS] link add <NAME> <PATH>
 
 ## 🔍 eask link delete
 
-Deletes the link for the given packages.
+Delete locally linked packages.
 
 Alias: `remove`
 
diff --git a/docs/content/Getting-Started/Commands-and-options/_index.zh-tw.md b/docs/content/Getting-Started/Commands-and-options/_index.zh-tw.md
@@ -456,7 +456,7 @@ eask [GLOBAL-OPTIONS] upgrade
 
 ## 🔍 eask list
 
-列出包。
+使用樹狀依賴圖列出所有已安裝的包。
 
 ```sh
 eask [GLOBAL-OPTIONS] list [--depth]
@@ -484,7 +484,7 @@ eask [GLOBAL-OPTIONS] refresh
 
 ## 🔍 eask generate autoloads
 
-生成 autoload 文件。
+生成一個 autoloads 文件。
 
 將包自動加載到項目根目錄中的 `project-autoloads.el`。
 
@@ -497,7 +497,7 @@ eask [GLOBAL-OPTIONS] generate autoloads
 
 ## 🔍 eask generate pkg-file
 
-生成 pkg 文件。
+生成一個 pkg 文件。
 
 將包描述符文件寫入項目根目錄中的 `project-pkg.el`。
 
