feat: use consola for output formatting

Author: pi0

LICENSE

@@ -34,14 +34,3 @@ The above copyright notice and this permission notice shall be included in all c
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
----
-
-Colorette dependency is bundled (https://github.com/jorgebucaran/colorette)
-
-Copyright © Jorge Bucaran <https://jorgebucaran.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -65,7 +65,7 @@ const main = defineCommand({
     },
   },
   run({ args }) {
-    console.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
+    consol.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
   },
 });
 

package.json

@@ -29,11 +29,13 @@
     "release": "pnpm test && changelogen --release --push && npm publish",
     "test": "pnpm lint && vitest run --coverage"
   },
+  "dependencies": {
+    "consola": "^3.2.3"
+  },
   "devDependencies": {
     "@types/node": "^20.4.0",
     "@vitest/coverage-v8": "^0.32.4",
     "changelogen": "^0.5.4",
-    "colorette": "^2.0.20",
     "eslint": "^8.44.0",
     "eslint-config-unjs": "^0.2.1",
     "jiti": "^1.19.1",
@@ -43,5 +45,5 @@
     "unbuild": "^1.2.1",
     "vitest": "^0.32.4"
   },
-  "packageManager": "pnpm@8.6.5"
+  "packageManager": "pnpm@8.6.6"
 }

playground/commands/build.ts

@@ -1,3 +1,4 @@
+import consola from 'consola'
 import { defineCommand } from "../../src";
 
 export default defineCommand({
@@ -37,7 +38,7 @@ export default defineCommand({
     },
   },
   run({ args }) {
-    console.log("Build");
-    console.log("Parsed args:", args);
+    consola.log("Build");
+    consola.log("Parsed args:", args);
   },
 });

playground/commands/deploy.ts

@@ -1,3 +1,4 @@
+import consola from 'consola'
 import { defineCommand } from "../../src";
 
 export default defineCommand({
@@ -53,7 +54,7 @@ export default defineCommand({
     },
   },
   run({ args }) {
-    console.log("Build");
-    console.log("Parsed args:", args);
+    consola.log("Build");
+    consola.log("Parsed args:", args);
   },
 });

playground/hello.ts

@@ -1,3 +1,4 @@
+import consola from 'consola'
 import { defineCommand, runMain } from "../src";
 
 const main = defineCommand({
@@ -18,7 +19,7 @@ const main = defineCommand({
     },
   },
   run({ args }) {
-    console.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
+    consola.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
   },
 });
 

pnpm-lock.yaml

@@ -39,15 +39,12 @@ export async function runCommand<T extends ArgsDef = ArgsDef>(
     );
     const subCommandName = opts.rawArgs[subCommandArgIndex];
     if (!subCommandName && !cmd.run) {
-      throw new CLIError(
-        `Missing sub command. Use --help to see available sub commands.`,
-        "ESUBCOMMAND",
-      );
+      throw new CLIError(`No command specified.`, "E_NO_COMMAND");
     }
     if (!subCommands[subCommandName]) {
       throw new CLIError(
-        `Unknown sub command: ${subCommandName}`,
-        "ESUBCOMMAND",
+        `Unknown command \`${subCommandName}\``,
+        "E_UNKOWN_COMMAND",
       );
     }
     const subCommand = await resolveValue(subCommands[subCommandName]);

src/command.ts

@@ -1,4 +1,4 @@
-import { bgRed } from "colorette";
+import consola from "consola";
 import type { ArgsDef, CommandDef } from "./types";
 import { resolveSubCommand, runCommand } from "./command";
 import { CLIError } from "./_utils";
@@ -23,14 +23,12 @@ export async function runMain<T extends ArgsDef = ArgsDef>(
   } catch (error: any) {
     const isCLIError = error instanceof CLIError;
     if (!isCLIError) {
-      console.error(error, "\n");
+      consola.error(error, "\n");
     }
-    console.error(
-      `\n${bgRed(` ${error.code || error.name} `)} ${error.message}\n`,
-    );
     if (isCLIError) {
       await showUsage(...(await resolveSubCommand(cmd, rawArgs)));
     }
+    consola.error(error.message);
     process.exit(1);
   }
 }

src/main.ts

@@ -1,3 +1,5 @@
+import consola from "consola";
+import { colors } from 'consola/utils'
 import { formatLineColumns, resolveValue } from "./_utils";
 import type { ArgsDef, CommandDef } from "./types";
 import { resolveArgs } from "./args";
@@ -7,9 +9,9 @@ export async function showUsage<T extends ArgsDef = ArgsDef>(
   parent?: CommandDef<T>,
 ) {
   try {
-    console.log((await renderUsage(cmd, parent)) + "\n");
+    consola.log((await renderUsage(cmd, parent)) + "\n");
   } catch (error) {
-    console.error(error);
+    consola.error(error);
   }
 }
 
@@ -36,7 +38,7 @@ export async function renderUsage<T extends ArgsDef = ArgsDef>(
       const isRequired = arg.required !== false && arg.default === undefined;
       // (isRequired ? " (required)" : " (optional)"
       const usageHint = arg.default ? `="${arg.default}"` : "";
-      posLines.push([name + usageHint, arg.description || ""]);
+      posLines.push(["`" + name + usageHint + "`", arg.description || ""]);
       usageLine.push(isRequired ? `<${name}>` : `[${name}]`);
     } else {
       const isRequired = arg.required === true && arg.default === undefined;
@@ -55,7 +57,7 @@ export async function renderUsage<T extends ArgsDef = ArgsDef>(
             }`
           : "");
       argLines.push([
-        argStr + (isRequired ? " (required)" : ""),
+        "`" + argStr + (isRequired ? " (required)" : "") + "`",
         arg.description || "",
       ]);
       if (isRequired) {
@@ -70,7 +72,7 @@ export async function renderUsage<T extends ArgsDef = ArgsDef>(
     for (const [name, sub] of Object.entries(subCommands)) {
       const subCmd = await resolveValue(sub);
       const meta = await resolveValue(subCmd?.meta);
-      commandsLines.push([name, meta?.description || ""]);
+      commandsLines.push([`\`${name}\``, meta?.description || ""]);
       commandNames.push(name);
     }
     usageLine.push(commandNames.join("|"));
@@ -79,34 +81,34 @@ export async function renderUsage<T extends ArgsDef = ArgsDef>(
   const usageLines: (string | undefined)[] = [];
 
   const version = cmdMeta.version || parentMeta.version;
+
   usageLines.push(
-    commandName + (version ? ` v${version}` : ""),
-    cmdMeta.description,
+    colors.gray(`${cmdMeta.description} (${commandName + (version ? ` v${version}` : "")})`),
     "",
   );
 
   const hasOptions = argLines.length > 0 || posLines.length > 0;
   usageLines.push(
-    `USAGE: ${commandName}${hasOptions ? " [OPTIONS]" : ""} ${usageLine.join(
+    `${colors.underline(colors.bold('USAGE'))} \`${commandName}${hasOptions ? " [OPTIONS]" : ""} ${usageLine.join(
       " ",
-    )}`,
+    )}\``,
     "",
   );
 
   if (posLines.length > 0) {
-    usageLines.push("ARGUMENTS:", "");
+    usageLines.push(colors.underline(colors.bold("ARGUMENTS")), "");
     usageLines.push(formatLineColumns(posLines, "  "));
     usageLines.push("");
   }
 
   if (argLines.length > 0) {
-    usageLines.push("OPTIONS:", "");
+    usageLines.push(colors.underline(colors.bold("OPTIONS")), "");
     usageLines.push(formatLineColumns(argLines, "  "));
     usageLines.push("");
   }
 
   if (commandsLines.length > 0) {
-    usageLines.push("COMMANDS:", "");
+    usageLines.push(colors.underline(colors.bold("COMMANDS")), "");
     usageLines.push(formatLineColumns(commandsLines, "  "));
     usageLines.push(
       "",