jsrepo 1.0.0

package/src/utils/language-support.ts

@@ -0,0 +1,198 @@
+import fs from 'node:fs';
+import { builtinModules } from 'node:module';
+import path from 'node:path';
+import { walk } from 'estree-walker';
+import * as sv from 'svelte/compiler';
+import { Project } from 'ts-morph';
+import validatePackageName from 'validate-npm-package-name';
+import { Err, Ok, type Result } from '../blocks/types/result';
+import { findNearestPackageJson } from './package';
+
+export type ResolvedDependencies = {
+	local: string[];
+	devDependencies: string[];
+	dependencies: string[];
+};
+
+export type Lang = {
+	/** Matches the supported file types */
+	matches: (fileName: string) => boolean;
+	/** Reads the file and gets any dependencies from its imports */
+	resolveDependencies: (
+		filePath: string,
+		category: string,
+		isSubDir: boolean
+	) => Result<ResolvedDependencies, string>;
+	/** Returns a multiline comment containing the content */
+	comment: (content: string) => string;
+};
+
+const typescript: Lang = {
+	matches: (fileName) =>
+		fileName.endsWith('.ts') ||
+		fileName.endsWith('.js') ||
+		fileName.endsWith('.tsx') ||
+		fileName.endsWith('.jsx'),
+	resolveDependencies: (filePath, category, isSubDir) => {
+		const project = new Project();
+
+		const blockFile = project.addSourceFileAtPath(filePath);
+
+		const imports = blockFile.getImportDeclarations();
+
+		const relativeImports = imports.filter((declaration) =>
+			declaration.getModuleSpecifierValue().startsWith('.')
+		);
+
+		const localDeps = new Set<string>();
+
+		for (const relativeImport of relativeImports) {
+			const mod = relativeImport.getModuleSpecifierValue();
+
+			const localDep = resolveLocalImport(mod, category, isSubDir);
+
+			if (localDep) localDeps.add(localDep);
+		}
+
+		const deps = imports
+			.filter((declaration) => !declaration.getModuleSpecifierValue().startsWith('.'))
+			.map((declaration) => declaration.getModuleSpecifierValue());
+
+		const { devDependencies, dependencies } = resolveRemoteDeps(Array.from(deps), filePath);
+
+		return Ok({
+			local: Array.from(localDeps),
+			dependencies,
+			devDependencies,
+		} satisfies ResolvedDependencies);
+	},
+	comment: (content) => `/*\n${content}\n*/`,
+};
+
+const svelte: Lang = {
+	matches: (fileName) => fileName.endsWith('.svelte'),
+	resolveDependencies: (filePath, category, isSubDir) => {
+		const sourceCode = fs.readFileSync(filePath).toString();
+
+		const root = sv.parse(sourceCode, { modern: true });
+
+		// if no script tag then no dependencies
+		if (!root.instance) return Ok({ dependencies: [], devDependencies: [], local: [] });
+
+		const localDeps = new Set<string>();
+		const deps = new Set<string>();
+
+		// biome-ignore lint/suspicious/noExplicitAny: The root instance is just missing the `id` prop
+		walk(root.instance as any, {
+			enter: (node) => {
+				if (node.type === 'ImportDeclaration') {
+					if (typeof node.source.value === 'string') {
+						if (node.source.value.startsWith('.')) {
+							const localDep = resolveLocalImport(
+								node.source.value,
+								category,
+								isSubDir
+							);
+
+							if (localDep) localDeps.add(localDep);
+						} else {
+							deps.add(node.source.value);
+						}
+					}
+				}
+			},
+		});
+
+		const { devDependencies, dependencies } = resolveRemoteDeps(Array.from(deps), filePath);
+
+		return Ok({
+			dependencies,
+			devDependencies,
+			local: Array.from(localDeps),
+		} satisfies ResolvedDependencies);
+	},
+	comment: (content) => `<!--\n${content}\n-->`,
+};
+
+const resolveLocalImport = (
+	mod: string,
+	category: string,
+	isSubDir: boolean
+): string | undefined => {
+	// do not add local deps that are within the same folder
+	if (isSubDir && mod.startsWith('./')) return undefined;
+
+	if (mod.startsWith('./')) {
+		return `${category}/${path.parse(path.basename(mod)).name}`;
+	}
+
+	if (isSubDir && mod.startsWith('../') && !mod.startsWith('../.')) {
+		return `${category}/${path.parse(path.basename(mod)).name}`;
+	}
+
+	const segments = mod.replaceAll('../', '').split('/');
+
+	// invalid path
+	if (segments.length !== 2) return undefined;
+
+	return `${segments[0]}/${segments[1]}`;
+};
+
+/** Iterates over the dependency and resolves each one using the nearest package.json file.
+ * Strips node APIs and pins the version of each dependency based on what is in the package.json.
+ *
+ * @param deps
+ * @param filePath
+ * @returns
+ */
+const resolveRemoteDeps = (deps: string[], filePath: string) => {
+	const filteredDeps = deps.filter(
+		(dep) =>
+			!builtinModules.includes(dep) &&
+			!dep.startsWith('node:') &&
+			validatePackageName(dep).validForNewPackages
+	);
+
+	const pkgPath = findNearestPackageJson(path.dirname(filePath), '');
+
+	const dependencies = new Set<string>();
+	const devDependencies = new Set<string>();
+
+	if (pkgPath) {
+		const { devDependencies: packageDevDependencies, dependencies: packageDependencies } =
+			JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+
+		for (const dep of filteredDeps) {
+			let version: string | undefined = undefined;
+			if (packageDependencies !== undefined) {
+				version = packageDependencies[dep];
+			}
+
+			if (version !== undefined) {
+				dependencies.add(`${dep}@${version}`);
+				continue;
+			}
+
+			if (packageDevDependencies !== undefined) {
+				version = packageDevDependencies[dep];
+			}
+
+			if (version !== undefined) {
+				devDependencies.add(`${dep}@${version}`);
+				continue;
+			}
+
+			// if no version found just add it without a version
+			dependencies.add(dep);
+		}
+	}
+
+	return {
+		dependencies: Array.from(dependencies),
+		devDependencies: Array.from(devDependencies),
+	};
+};
+
+const languages: Lang[] = [typescript, svelte];
+
+export { typescript, languages };

package/src/utils/package.ts

@@ -0,0 +1,16 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+const findNearestPackageJson = (startDir: string, until: string): string | undefined => {
+	const packagePath = path.join(startDir, 'package.json');
+
+	if (fs.existsSync(packagePath)) return packagePath;
+
+	if (startDir === until) return undefined;
+
+	const segments = startDir.split(/[\/\\]/);
+
+	return findNearestPackageJson(segments.slice(0, segments.length - 1).join('/'), until);
+};
+
+export { findNearestPackageJson };

package/src/utils/prompts.ts

@@ -0,0 +1,72 @@
+import { intro, spinner } from '@clack/prompts';
+import color from 'chalk';
+import { rightPad, rightPadMin } from '../blocks/utilities/pad';
+import { stripAsni } from '../blocks/utilities/strip-ansi';
+
+const VERTICAL_BORDER = color.gray('│');
+const HORIZONTAL_BORDER = color.gray('─');
+const TOP_RIGHT_CORNER = color.gray('┐');
+const BOTTOM_RIGHT_CORNER = color.gray('┘');
+const JUNCTION_RIGHT = color.gray('├');
+// we may need these eventually
+// const TOP_LEFT_CORNER = color.gray("┌");
+// const BOTTOM_LEFT_CORNER = color.gray("└");
+
+export type Task = {
+	loadingMessage: string;
+	completedMessage: string;
+	run: () => Promise<void>;
+};
+
+const runTasks = async (tasks: Task[], { verbose = false }) => {
+	const loading = spinner();
+
+	for (const task of tasks) {
+		// we don't want this to clear logs when in verbose mode
+		if (!verbose) loading.start(task.loadingMessage);
+
+		try {
+			await task.run();
+		} catch (err) {
+			console.error(err);
+		}
+
+		if (!verbose) loading.stop(task.completedMessage);
+	}
+};
+
+const nextSteps = (steps: string[]): string => {
+	let max = 20;
+	steps.map((val) => {
+		const reset = rightPad(stripAsni(val), 4);
+
+		if (reset.length > max) max = reset.length;
+	});
+
+	const NEXT_STEPS = 'Next Steps';
+
+	let result = `${VERTICAL_BORDER}\n`;
+
+	// top
+	result += `${JUNCTION_RIGHT}  ${NEXT_STEPS} ${HORIZONTAL_BORDER.repeat(
+		max - NEXT_STEPS.length - 1
+	)}${TOP_RIGHT_CORNER}\n`;
+
+	result += `${VERTICAL_BORDER} ${' '.repeat(max)} ${VERTICAL_BORDER}\n`;
+
+	steps.map((step) => {
+		result += `${VERTICAL_BORDER}  ${rightPadMin(step, max - 1)} ${VERTICAL_BORDER}\n`;
+	});
+
+	result += `${VERTICAL_BORDER} ${' '.repeat(max)} ${VERTICAL_BORDER}\n`;
+
+	// bottom
+	result += `${JUNCTION_RIGHT}${HORIZONTAL_BORDER.repeat(max + 2)}${BOTTOM_RIGHT_CORNER}\n`;
+
+	return result;
+};
+
+const _intro = (version: string) =>
+	intro(`${color.bgHex('#f7df1e').black(' jsrepo ')}${color.gray(` v${version} `)}`);
+
+export { runTasks, nextSteps, _intro as intro };