Stormode Terminal is a terminal dependency for Stormode that can also be used separately.
You can install Stormode Terminal using npm or pnpm:
# npm
npm install stormode-terminal
# pnpm
pnpm add stormode-terminalTo use Stormode Terminal, start by importing it into your project:
// CommonJS
const terminal = require("stormode-terminal");
// ESM
import terminal from "stormode-terminal";Once imported, you can utilize various types of terminals provided by Stormode Terminal:
terminal.info("This is a info terminal.");
// Output:
// - [info] This is a info terminal.terminal.wait("Please wait a moment...");
// Output:
// - [wait] Please wait a moment...terminal.ready("Your project is ready!");
// Output:
// - [ready] Your project is ready!terminal.warn("Warning!");
// Output:
// - [warn] Warning!terminal.error("Something went wrong!");
// Output:
// - [error] Something went wrong!terminal.cancel("Operation cancelled");
// Output:
// - [cancel] Operation cancelledYou may customize the terminal for fit your needs:
import type { Config, Logs } from "stormode-terminal";
const config: Config = {
mute: true,
time: true,
};
console.log(terminal.info("Hello!", config));
// or
const tml: Logs = terminal.withConfig({
mute: true,
time: true,
});
console.log(tml.info("Hello!"));Or you can make your own terminal log:
import { custom } from "stormode-terminal";
const ok = custom({
title: "ok",
config: {
time: true,
}
});
ok("it's ok!");In addition to the standard terminals, Stormode Terminal offers a range of color functions:
terminal.color.redLight("This is red but lighter");
terminal.color.red("This is red");
terminal.color.redDark("This is red but darker");
terminal.color.yellowLight("This is yellow but lighter");
terminal.color.yellow("This is yellow");
terminal.color.yellowDark("This is yellow but darker");
terminal.color.blueLight("This is blue but lighter");
terminal.color.blue("This is blue");
terminal.color.blueDark("This is blue but darker");
terminal.color.greenLight("This is green but lighter");
terminal.color.green("This is green");
terminal.color.greenDark("This is green but darker");
terminal.color.purpleLight("This is purple but lighter");
terminal.color.purple("This is purple");
terminal.color.purpleDark("This is purple but darker");Feel free to explore and use these color functions in your project.
This project is MIT licensed, you can find the license file here.