@theholocron/cli 1.0.0 → 1.1.0

package/src/tasks/replace/README.md

@@ -1,61 +0,0 @@
-# Find & Replace
-
-Find a string in a file and replace it with something else.
-
-## Usage
-
-```javascript
-import { findReplace } from "@/tasks";
-
-const filePaths = [
-	`/packages/developer-experience/sdk-session/src/tests/handlers.ts`,
-];
-const baseString: string = "const BAM_BROWSER_SDK_VERSION =";
-
-async function main() {
-	const [, , version] = process.argv;
-	const [major, minor] = version.split(".");
-
-	try {
-		const [err, data, duration] = await findReplace(filePaths, baseString, `${major}.${minor}`);
-
-		if (err) {
-			console.error("Error:", err);
-			process.exit(1);
-		}
-
-		console.log("Files replaced:\n");
-		console.table(data);
-		console.log(`It took ${duration} milliseconds`);
-	}
-	catch (error) {
-		console.error("Error:", error);
-	}
-}
-
-main();
-```
-
-## API
-
-### `findReplace(filePaths: string[], searchTerm: string, replacement: string)`
-
-Returns an array of file paths that were modified.
-
-#### filePaths
-
-The file paths with which to search.
-
-Type: `string[]`
-
-#### searchTerm
-
-The search term to look for and replace.
-
-Type: `string`
-
-#### replacement
-
-A string to replace with
-
-Type: `string`

package/src/tasks/replace/index.ts

@@ -1 +0,0 @@
-export * from "./replace";

package/src/tasks/replace/replace.example.ts

@@ -1,31 +0,0 @@
-import { HOME } from "@/const";
-import { find } from "@/tasks";
-
-const filePaths = [
-	`${HOME}/Code/disney/solo/apps/commerce/src/common/context/__browser-mocks__/handlers.ts`,
-	`${HOME}/Code/disney/solo/packages/developer-experience/sdk-session/src/tests/handlers.ts`,
-	`${HOME}/Code/disney/solo/packages/instrumentation/src/glimpse/hooks/use-fire-fed-purchase-event.test.tsx`,
-];
-const baseString: string = "const BAM_BROWSER_SDK_VERSION =";
-
-async function main() {
-	const [, , version] = process.argv;
-	const [major, minor] = version.split(".");
-
-	try {
-		const [err, data, duration] = await find.replace(filePaths, baseString, `${major}.${minor}`);
-
-		if (err) {
-			console.error("Error:", err);
-			process.exit(1);
-		}
-
-		console.log("Files replaced:\n");
-		console.table(data);
-		console.log(`It took ${duration} milliseconds`);
-	} catch (error) {
-		console.error("Error:", error);
-	}
-}
-
-main();

package/src/tasks/replace/replace.ts

@@ -1,95 +0,0 @@
-import { type CLIOptions } from "@/cli";
-import { type Return } from "@/types";
-import { $, log } from "@/utils";
-
-const FN = "find.replace";
-
-/**
- * Perform a case-sensitive replacement in a string, keeping the casing format of each found instance.
- *
- * @param {string} text - The text in which to perform the replacement.
- * @param {string} searchTerm - The term to search for, ignoring case.
- * @param {string} replacement - The replacement term.
- * @returns {string} - The updated text with replacements made.
- */
-function replaceWithRespectToCase(text: string, searchTerm: string, replacement: string): string {
-	// Create a regex to match search term with flexible spacing/hyphens between words
-	const words = searchTerm.split(/[- ]/).map((word) => word.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")); // Escape special chars
-	const regex = new RegExp(words.join("[- ]?"), "gi"); // Allow for spaces or hyphens between words
-
-	return text.replace(regex, (match) => {
-		// Transform replacement to match the case of the original found match
-		const replacementWords = replacement.split(/[- ]/);
-		const transformed = match
-			.split(/[- ]/)
-			.map((word, index) => {
-				const replacementWord = replacementWords[index] || ""; // Handle possible extra words in replacement
-				return /[A-Z]/.test(word[0])
-					? replacementWord.charAt(0).toUpperCase() + replacementWord.slice(1)
-					: replacementWord.toLowerCase();
-			})
-			.join(" ");
-
-		return transformed.trim();
-	});
-}
-
-/**
- * Update a specific string in multiple files.
- *
- * @param {string[]} filePaths - An array of file paths to be updated.
- * @param {string} searchTerm - The base string to match.
- * @param {string} replacement - The new string to replace with.
- * @param {CLIOptions} [options={}] - CLI options for logging and additional processing.
- * @returns {Promise<Return<string[]>>} - A promise that resolves to a tuple containing an error (if any), an object with the update status for each domain, and the time taken.
- */
-export async function findReplace(
-	filePaths: string[],
-	searchTerm: string,
-	replacement: string,
-	options: CLIOptions = {}
-): Promise<Return<string[]>> {
-	if (!filePaths || !Array.isArray(filePaths)) {
-		return [new Error("No file paths were provided!"), null, 0];
-	}
-
-	if (!searchTerm) {
-		return [new Error("No search term was provided!"), null, 0];
-	}
-
-	if (!replacement) {
-		return [new Error("No replacement was provided!"), null, 0];
-	}
-
-	const start = performance.now();
-	const output: string[] = [];
-
-	for (const filePath of filePaths) {
-		log.process(FN, `Searching ${filePath} for occurrences of "${searchTerm}"`, options);
-
-		try {
-			// Read the file content
-			const [fileErr, file] = await $.file(filePath);
-			if (fileErr || !file?.content) {
-				log.info(FN, `Cannot read file ${filePath}: skipping`, options);
-				continue;
-			}
-
-			// Perform the replacement
-			const updatedData = replaceWithRespectToCase(file.content, searchTerm, replacement);
-
-			// Write back only if the content changed
-			if (updatedData !== file.content) {
-				await $.file(filePath, updatedData, true); // Ensure this function overwrites the file content
-				output.push(filePath);
-				log.process(FN, `Updated ${filePath}`, options);
-			} else {
-				log.process(FN, `No changes in ${filePath}`, options);
-			}
-		} catch (error) {
-			log.error(FN, `Error processing file ${filePath}: ${(error as Error).message}`, options);
-		}
-	}
-
-	return [null, output, performance.now() - start];
-}

package/src/ui/README.md

@@ -1,8 +0,0 @@
-# UI
-
-A set of functions designed to be used as a UI for interacting with the client.
-
-## What's Available
-
-* [open](./open/README.md) - open an app in your `$EDITOR`
-* [prompts](./prompts/README.md) - prompt the user with various UI tools

package/src/ui/index.ts

@@ -1,2 +0,0 @@
-export { open } from "./open";
-export { prompt, type Choice } from "./prompts";

package/src/ui/open/README.md

@@ -1,58 +0,0 @@
-# Open an Application
-
-Open an application after a confirmation.
-
-## Usage
-
-```javascript
-import { open } from "@/ui";
-
-async function main () {
-	const [, , name, location] = process.argv;
-
-	try {
-		const [err, isOpened] = await open.editor(name, location);
-
-		if (err) {
-			console.error(err);
-			process.exit(1);
-		}
-
-		console.log(`${name} ${isOpened ? "was" : "was not"} opened.`);
-	}
-	catch (error) {
-		console.error('An error occurred:', error);
-		process.exit(1);
-	}
-}
-
-main();
-```
-
-## API
-
-### `editor(name: string, location: string)`
-
-Returns a Promise that resolves to a boolean.
-
-#### name
-
-A name of the application.
-
-Type: `string`
-
-#### location
-
-A path of where the application is located.
-
-Type: `string`
-
-### `browser(url: string)`
-
-Opens the URL in the users default browser.
-
-#### url
-
-The URL to open.
-
-Type: `string`

package/src/ui/open/index.ts

@@ -1,7 +0,0 @@
-import { openBrowser } from "./open-browser";
-import { openApp } from "./open-editor";
-
-export const open = {
-	browser: openBrowser,
-	editor: openApp,
-};

package/src/ui/open/open-browser.ts

@@ -1,25 +0,0 @@
-import defaultBrowser from "default-browser";
-import open, { apps } from "open";
-
-/**
- * Opens an application if the user confirms.
- *
- * @param {string} name - The name of the application.
- * @returns {Promise<void>} - A promise that resolves to a tuple containing an error (if any), a boolean indicating if the app was opened, and the time taken to perform the operation.
- */
-export async function openBrowser(url: string): Promise<void> {
-	if (!url) {
-		throw new Error("No URL was provided!");
-	}
-
-	let browser = apps.browser;
-	const { name } = await defaultBrowser();
-	const supported = ["chrome", "firefox", "edge"];
-	if (!supported.includes(name.toLowerCase())) {
-		browser = apps.chrome;
-	}
-
-	await open(url, {
-		app: { name: browser },
-	});
-}

package/src/ui/open/open-editor.example.ts

@@ -1,14 +0,0 @@
-import { open } from "@/ui";
-
-async function main() {
-	const [, , name, location] = process.argv;
-
-	try {
-		await open.editor(name, location);
-	} catch (error) {
-		console.error("An error occurred:", error);
-		process.exit(1);
-	}
-}
-
-main();

package/src/ui/open/open-editor.ts

@@ -1,30 +0,0 @@
-import openEditor from "open-editor";
-import { prompt } from "@/ui";
-
-/**
- * Opens an application if the user confirms.
- *
- * @param {string} name - The name of the application.
- * @param {string} location - The file location of the application.
- * @returns {Promise<void>}
- */
-export async function openApp(location: string, name?: string, bypass: boolean = false): Promise<void> {
-	if (!location) {
-		throw new Error("No app location was provided!");
-	}
-	const open = async () =>
-		await openEditor(
-			[
-				{
-					file: location,
-				},
-			],
-			{ wait: true }
-		);
-
-	if (!bypass) {
-		await prompt.confirm(`Do you want to open ${name}?`, open);
-	} else {
-		open();
-	}
-}

package/src/ui/prompts/README.md

@@ -1,36 +0,0 @@
-# Prompts
-
-Inquirer prompts
-
-## Usage
-
-```javascript
-import { prompt } from "@/ui";
-
-async function main() {
-	const [, , project] = process.argv;
-
-	try {
-		const filepath = await prompt.search(project, undefined, undefined, {});
-		console.log(filepath);
-	}
-	catch (error) {
-		console.error("Error:", error);
-	}
-}
-
-main();
-```
-
-## API
-
-### `project(message?: string)`
-
-Returns a string of the directory selected.
-
-#### message
-
-The message to display to the user.
-
-Type: `string`
-Default: "Enter a project:"

package/src/ui/prompts/autocomplete.prompt.ts

@@ -1,18 +0,0 @@
-import autocomplete from "inquirer-autocomplete-standalone";
-import { type Choice } from "./types";
-
-export async function autocompletePrompt(source: Choice<string>[], msg?: string): Promise<string> {
-	return await autocomplete({
-		emptyText: "No results found. Please enter a term",
-		message: msg || "Search a term",
-		source: async (input?: string) =>
-			source.filter(({ name }) => {
-				const proj = name?.toLowerCase() ?? "";
-				if (proj.length > 0) {
-					return proj.includes(input?.toLowerCase() ?? "");
-				}
-
-				return "";
-			}),
-	});
-}

package/src/ui/prompts/confirm.prompt.ts

@@ -1,21 +0,0 @@
-import { confirm } from "@inquirer/prompts";
-
-type Callback = () => void | Promise<void>;
-
-export async function confirmPrompt(
-	message: string,
-	callback: Callback,
-	error: Callback = () => {
-		/* noOp */
-	}
-): Promise<void> {
-	const should = await confirm({
-		message,
-	});
-
-	if (should) {
-		await callback();
-	} else {
-		await error();
-	}
-}

package/src/ui/prompts/index.ts

@@ -1,17 +0,0 @@
-import { autocompletePrompt } from "./autocomplete.prompt";
-import { confirmPrompt } from "./confirm.prompt";
-import { inputPrompt } from "./input.prompt";
-import { searchPrompt } from "./search.prompt";
-import { selectPrompt } from "./select.prompt";
-import { validate } from "./utils";
-
-export * from "./types";
-
-export const prompt = {
-	autocomplete: autocompletePrompt,
-	confirm: confirmPrompt,
-	input: inputPrompt,
-	search: searchPrompt,
-	select: selectPrompt,
-	validate,
-};

package/src/ui/prompts/input.prompt.ts

@@ -1,15 +0,0 @@
-import { input } from "@inquirer/prompts";
-import { validate } from "./utils";
-
-export async function inputPrompt(message: string, isRequired?: boolean = false, options): Promise<string> {
-	const opts = {
-		message,
-		...options,
-	};
-
-	if (isRequired) {
-		opts.validate = validate.isNotEmpty;
-	}
-
-	return await input(opts);
-}

package/src/ui/prompts/search.prompt.ts

@@ -1,33 +0,0 @@
-import autocomplete from "inquirer-autocomplete-standalone";
-import { type CLIOptions } from "@/cli";
-import { findProjects } from "@/tasks";
-import { $, getDirectoryByLevel } from "@/utils";
-
-export async function searchPrompt(location?: string, msg?: string, options: CLIOptions): Promise<string> {
-	const message = msg || "Choose a project:";
-
-	const dirname: string = await autocomplete({
-		emptyText: "No results found. Please enter the location",
-		message,
-		pageSize: 10,
-		source: async (input?: string) => {
-			const term = input?.toLowerCase() ?? "";
-			const [, results] = await findProjects(location, options);
-			const filtered = results
-				.map(({ name, value }) => ({ name: `${name} (${getDirectoryByLevel(value)})`, value }))
-				.filter(({ name }) => {
-					const proj = name?.toLowerCase() ?? "";
-					if (proj.length > 0) {
-						return proj.includes(term);
-					}
-
-					return "";
-				});
-
-			return filtered;
-		},
-	});
-
-	const [, dir] = await $.directory(dirname);
-	return dir?.path ?? "";
-}

package/src/ui/prompts/select.prompt.ts

@@ -1,17 +0,0 @@
-import { checkbox } from "@inquirer/prompts";
-import { type Choice } from "./types";
-
-export async function selectPrompt(
-	selected: string[] | null,
-	message: string,
-	choices: Choice<string>[]
-): Promise<string[]> {
-	if (selected) {
-		return selected;
-	}
-
-	return await checkbox({
-		message,
-		choices,
-	});
-}

package/src/ui/prompts/types.ts

@@ -1,8 +0,0 @@
-export type Choice<Value> = {
-	description?: string;
-	disabled?: boolean | string;
-	checked?: boolean;
-	name?: string;
-	type?: never;
-	value: Value;
-};

package/src/ui/prompts/utils.ts

@@ -1,11 +0,0 @@
-function isNotEmpty(val: string): boolean | string {
-	if (!val || val.trim().length === 0) {
-		return "Cannot be empty";
-	}
-
-	return true;
-}
-
-export const validate = {
-	isNotEmpty,
-};

package/src/utils/$/README.md

@@ -1,87 +0,0 @@
-# $
-
-Interact with the file system or run commands.
-
-## Usage
-
-```javascript
-import { $ } from "@/utils";
-
-async function main() {
-	const hasBrew = await $.command("brew");
-	if (hasBrew) {
-		const [err, data] = await $("brew install test");
-
-		if (err) {
-			console.error("Error:", err);
-			process.exit(1);
-		}
-
-		console.log(data);
-	}
-}
-
-main();
-```
-
-## API
-
-### `$(command: string)`
-
-Run a shell command. Returns a Promise that will resolve to either an error or the standard output.
-
-#### command
-
-The shell command to run.
-
-Type: `string`
-
-### `.command(command: string)`
-
-Checks whether a bash command exists. Returns a promise resolving to true if the command is installed, false otherwise.
-
-#### command
-
-The shell command to check.
-
-Type: `string`
-
-### `.directory(path: string, maxDepth: number)`
-
-Returns a Promise that will resolve to a tuple with either an error, or an object with `files` and the `path`.
-
-#### path
-
-The path to the file.
-
-Type: `string`
-
-#### maxDepth
-
-The maximum levels of directories to look through.
-
-Type: `number`
-Default: `Infinity`
-
-### `.file(path: string, content: string | Buffer, overwrite: boolean)`
-
-Returns a Promise that will resolve to a tuple with either an error, or an object with `content` and the `path`.
-
-#### path
-
-The path to the file.
-
-Type: `string`
-
-#### content
-
-The contents of the file to write or append.
-
-Type: `string | Buffer`
-
-#### overwrite
-
-Whether to append to the file or overwrite them completely.
-
-Type: `boolean`
-Default: `false`

package/src/utils/$/command.test.ts

@@ -1,48 +0,0 @@
-import { command, isInstalled } from "./command";
-
-describe("command", () => {
-	test("execute command and return stdout", async () => {
-		const cmd = "echo Hello, world!";
-
-		const result = await command(cmd);
-
-		expect(result).toEqual([null, "Hello, world!\n", expect.any(Number)]);
-	});
-
-	describe("errors", () => {
-		test("return error if command fails", async () => {
-			const result = await command("{}");
-
-			expect(result[0]).toBeDefined();
-			expect(result[1]).toBeNull();
-			expect(result[2]).toEqual(expect.any(Number));
-		});
-
-		test("return 'Unknown error' if error is not an instance of Error", async () => {
-			const unexpectedError = "This is not an Error object";
-
-			const result = await command("valid-command-that-will-throw-an-error", { unexpectedError });
-
-			expect(result[1]).toBeNull();
-			expect(result[2]).toEqual(expect.any(Number));
-		});
-	});
-});
-
-describe("isInstalled", () => {
-	test("return true if command is installed", async () => {
-		const cmd = "ls"; // Assuming 'ls' command is installed on your system
-
-		const result = await isInstalled(cmd);
-
-		expect(result).toBe(true);
-	});
-
-	test("return false if command is not installed", async () => {
-		const cmd = "nonexistent-command";
-
-		const result = await isInstalled(cmd);
-
-		expect(result).toBe(false);
-	});
-});

package/src/utils/$/command.ts

@@ -1,21 +0,0 @@
-import { exec } from "node:child_process";
-import { promisify } from "node:util";
-import { type Return } from "@/types";
-
-const asyncExec = promisify(exec);
-
-export async function command(cmd: string, options: object = {}): Promise<Return<string>> {
-	const start = performance.now();
-
-	try {
-		const { stdout } = await asyncExec(cmd, options);
-		return [null, stdout, performance.now() - start];
-	} catch (error) {
-		return [error as Error, null, performance.now() - start];
-	}
-}
-
-export async function isInstalled(cmd: string, options: object = {}): Promise<boolean> {
-	const [err] = await command(`command -v ${cmd}`, options);
-	return !err;
-}