Skip to content

refactor: replace kleur with native Node.js styleText API #484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fraxken merged 1 commit into from
Feb 1, 2026
Merged

refactor: replace kleur with native Node.js styleText API #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions bin/commands/execute.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ import { inspect } from "node:util";

// Import Third-party Dependencies
import * as rc from "@nodesecure/rc";
import kleur from "kleur";

// Import Internal Dependencies
import { store } from "../../src/localStorage.ts";
import * as utils from "../../src/utils/index.ts";

const { formatter } = utils;

import { fetchPackagesAndRepositoriesData } from "../../src/analysis/fetch.ts";
import * as CONSTANTS from "../../src/constants.ts";
Expand All @@ -29,7 +31,7 @@ export async function execute(options: ExecuteOptions = {}) {
const { debug: debugMode } = options;

if (debugMode) {
console.log(kleur.bgMagenta().bold(" > Debug mode enabled \n"));
console.log(formatter.bgMagenta.bold(" > Debug mode enabled \n"));
}

const [configResult] = await Promise.all([
Expand All @@ -47,8 +49,8 @@ export async function execute(options: ExecuteOptions = {}) {
throw new Error("At least one reporter must be selected (either 'HTML' or 'PDF')");
}

console.log(`>> title: ${kleur.cyan().bold(report.title)}`);
console.log(`>> reporters: ${kleur.magenta().bold(report.reporters.join(","))}\n`);
console.log(`>> title: ${formatter.cyan.bold(report.title)}`);
console.log(`>> reporters: ${formatter.magenta.bold(report.reporters.join(","))}\n`);

store.run(config, async() => {
try {
Expand All @@ -57,7 +59,7 @@ export async function execute(options: ExecuteOptions = {}) {
debug(data);
}
await reporting.proceed(data);
console.log(kleur.green().bold("\n>> Security report successfully generated! Enjoy 🚀.\n"));
console.log(formatter.green.bold("\n>> Security report successfully generated! Enjoy 🚀.\n"));
}
catch (error) {
console.error(error);
Expand Down
8 changes: 6 additions & 2 deletions bin/commands/init.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
// Import Third-party Dependencies
import * as rc from "@nodesecure/rc";
import kleur from "kleur";

// Import Internal Dependencies
import * as utils from "../../src/utils/index.ts";

const { formatter } = utils;

export async function init() {
const configLocation = process.cwd();
Expand All @@ -11,7 +15,7 @@ export async function init() {
});

if (result.ok) {
console.log(kleur.green().bold(
console.log(formatter.green.bold(
"Successfully generated NodeSecure runtime configuration at current location\n"
));
}
Expand Down
6 changes: 4 additions & 2 deletions bin/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ import fs from "node:fs";

// Import Third-party Dependencies
import sade from "sade";
import kleur from "kleur";

// Import Internal Dependencies
import * as commands from "./commands/index.ts";
import * as utils from "../src/utils/index.ts";

console.log(kleur.grey().bold(`\n > Executing nreport at: ${kleur.yellow().bold(process.cwd())}\n`));
const { formatter } = utils;

console.log(formatter.gray.bold(`\n > Executing nreport at: ${formatter.yellow.bold(process.cwd())}\n`));

const { version } = JSON.parse(
fs.readFileSync(new URL("../package.json", import.meta.url), "utf-8")
Expand Down
1 change: 0 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@
"@topcli/spinner": "^4.0.0",
"esbuild": "^0.27.0",
"filenamify": "^7.0.0",
"kleur": "^4.1.5",
"puppeteer": "^24.10.1",
"sade": "^1.8.1",
"zup": "0.0.2"
Expand Down
7 changes: 4 additions & 3 deletions src/analysis/fetch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
import path from "node:path";

// Import Third-party Dependencies
import kleur from "kleur";
import * as scorecard from "@nodesecure/ossf-scorecard-sdk";
import { isHTTPError } from "@openally/httpie";

Expand All @@ -13,6 +12,8 @@ import * as localStorage from "../localStorage.ts";
import * as utils from "../utils/index.ts";
import * as CONSTANTS from "../constants.ts";

const { formatter } = utils;

// CONSTANTS
const kNotFoundStatusCode = 404;

Expand Down Expand Up @@ -59,7 +60,7 @@ async function fetchPackagesStats(
) {
const jsonFiles = await utils.runInSpinner(
{
title: `[Fetcher: ${kleur.yellow().bold("NPM")}]`,
title: `[Fetcher: ${formatter.yellow.bold("NPM")}]`,
start: "Fetching NPM packages metadata on the NPM Registry",
verbose
},
Expand All @@ -78,7 +79,7 @@ async function fetchRepositoriesStats(
) {
const jsonFiles = await utils.runInSpinner(
{
title: `[Fetcher: ${kleur.yellow().bold("GIT")}]`,
title: `[Fetcher: ${formatter.yellow.bold("GIT")}]`,
start: "Cloning GIT repositories",
verbose
},
Expand Down
9 changes: 4 additions & 5 deletions src/reporting/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
// Import Third-party Dependencies
import kleur from "kleur";

// Import Internal Dependencies
import * as utils from "../utils/index.ts";
import * as localStorage from "../localStorage.ts";

const { formatter } = utils;

// Import Reporters
import { HTML, type HTMLReportData } from "./html.ts";
import { PDF } from "./pdf.ts";
Expand All @@ -15,7 +14,7 @@ export async function proceed(
): Promise<void> {
const reportHTMLPath = await utils.runInSpinner(
{
title: `[Reporter: ${kleur.yellow().bold("HTML")}]`,
title: `[Reporter: ${formatter.yellow.bold("HTML")}]`,
start: "Building template and assets",
verbose
},
Expand All @@ -29,7 +28,7 @@ export async function proceed(

await utils.runInSpinner(
{
title: `[Reporter: ${kleur.yellow().bold("PDF")}]`,
title: `[Reporter: ${formatter.yellow.bold("PDF")}]`,
start: "Using puppeteer to convert HTML content to PDF",
verbose
},
Expand Down
28 changes: 28 additions & 0 deletions src/utils/formatter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// Import Node.js Dependencies
import {
styleText,
type InspectColorForeground,
type InspectColorBackground,
type InspectColorModifier
} from "node:util";

type StyleName = InspectColorForeground | InspectColorBackground | InspectColorModifier;

type Formatter = {
(text: string): string;
} & {
[K in StyleName]: Formatter;
};

function createFormatter(styles: StyleName[] = []): Formatter {
return new Proxy(
(text: string) => styleText(styles, text),
{
get: (_, prop: string) => createFormatter([...styles, prop as StyleName])
}
) as Formatter;
}

const formatter = createFormatter();

export { formatter };
1 change: 1 addition & 0 deletions src/utils/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ export * from "./cloneGITRepository.ts";
export * from "./runInSpinner.ts";
export * from "./formatNpmPackages.ts";
export * from "./charts.ts";
export * from "./formatter.ts";
8 changes: 5 additions & 3 deletions src/utils/runInSpinner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Import Third-party Dependencies
import { Spinner } from "@topcli/spinner";
import kleur from "kleur";

// Import Internal Dependencies
import { formatter } from "./formatter.ts";

export interface RunInSpinnerOptions {
title: string;
Expand All @@ -17,13 +19,13 @@ export async function runInSpinner<R>(
const { title, verbose = true, start = void 0 } = options;

const spinner = new Spinner({ verbose })
.start(start, { withPrefix: `${kleur.gray().bold(title)} - ` });
.start(start, { withPrefix: `${formatter.gray.bold(title)} - ` });

try {
const response = await asyncHandler(spinner);

const elapsed = `${spinner.elapsedTime.toFixed(2)}ms`;
spinner.succeed(kleur.white().bold(`successfully executed in ${kleur.green().bold(elapsed)}`));
spinner.succeed(formatter.white.bold(`successfully executed in ${formatter.green.bold(elapsed)}`));

return response;
}
Expand Down