Make the CLI runnable

Author: michaldudak

.gitignore

@@ -1,5 +1,6 @@
 # Output folder
 dist
+out
 
 # Yarn 2
 .yarn/*

package.json

@@ -34,6 +34,7 @@
 		"@types/lodash": "^4.17.15",
 		"@types/node": "^22.13.4",
 		"@types/react": "^19.0.10",
+		"@types/yargs": "^17.0.33",
 		"fast-glob": "^3.3.3",
 		"prettier": "^3.5.1",
 		"rimraf": "^6.0.1",

pnpm-lock.yaml

@@ -1,40 +1,88 @@
+import * as fs from 'node:fs';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import * as rae from '../src';
 
-const INCLUDE_EXTERNAL = false;
-
 interface RunOptions {
-	files: string[];
+	files?: string[];
 	configPath: string;
 	includeExternal: boolean;
+	out?: string;
 }
 
 function run(options: RunOptions) {
-	const program = rae.createProgram(options.files, rae.loadConfig(options.configPath));
+	const config = rae.loadConfig(options.configPath);
+	const files = options.files ?? config.fileNames;
+
+	const program = rae.createProgram(files, config.options);
+
+	const components: any[] = [];
+	const hooks: any[] = [];
 
-	for (const file of options.files) {
-		const ast = rae.parseFromProgram(file, program);
+	let errorCounter = 0;
 
-		const translated = ast.body.map((component) => {
-			return {
-				name: component.name,
-				props: component.types
-					.map((prop) => {
+	for (const file of files) {
+		console.log(`Processing ${file}`);
+		console.group();
+		try {
+			const ast = rae.parseFromProgram(file, program);
+
+			const componentsApi = ast.body.filter(rae.isComponentNode).map((component) => {
+				return {
+					name: component.name,
+					props: component.props
+						.map((prop) => {
+							return {
+								...prop,
+								filenames: Array.from(prop.filenames),
+							};
+						})
+						.filter(
+							(prop) =>
+								options.includeExternal ||
+								!Array.from(prop.filenames).some((filename) => filename.includes('/node_modules/')),
+						),
+				};
+			});
+
+			const hooksApi = ast.body.filter(rae.isHookNode).map((hook) => {
+				return {
+					name: hook.name,
+					parameters: hook.callSignatures[0].parameters.map((parameter) => {
 						return {
-							...prop,
-							filenames: Array.from(prop.filenames),
+							...parameter,
 						};
-					})
-					.filter(
+					}),
+					/*.filter(
 						(prop) =>
 							options.includeExternal ||
 							!Array.from(prop.filenames).some((filename) => filename.includes('/node_modules/')),
-					),
-			};
-		});
+					),*/
+				};
+			});
+
+			components.push(...componentsApi);
+			hooks.push(...hooksApi);
+		} catch (e) {
+			console.error(`⛔ Error processing ${file}: ${e.message}`);
+			++errorCounter;
+		} finally {
+			console.groupEnd();
+		}
+	}
+
+	const outputJSON = JSON.stringify({ components, hooks }, null, 2);
+	if (options.out) {
+		fs.writeFileSync(options.out, outputJSON);
+		console.log(`Output written to ${options.out}`);
+	} else {
+		console.log(outputJSON);
+	}
 
-		console.log(JSON.stringify(translated, null, 2));
+	console.log(`\nProcessed ${files.length} files.`);
+	if (errorCounter > 0) {
+		console.log(`❌ Found ${errorCounter} errors.`);
+		process.exit(1);
 	}
 }
 
@@ -47,8 +95,9 @@ yargs(hideBin(process.argv))
 				.option('files', {
 					alias: 'f',
 					type: 'array',
-					demandOption: true,
-					description: 'The files to extract the API descriptions from',
+					demandOption: false,
+					description:
+						'The files to extract the API descriptions from. If not provided, all files in the tsconfig.json are used',
 				})
 				.option('configPath', {
 					alias: 'c',
@@ -61,6 +110,11 @@ yargs(hideBin(process.argv))
 					type: 'boolean',
 					default: false,
 					description: 'Include props defined outside of the project',
+				})
+				.option('out', {
+					alias: 'o',
+					type: 'string',
+					description: 'The output file. If not provided, the output is printed to the console',
 				});
 		},
 		run,

scripts/cli.ts

@@ -1,4 +1,4 @@
-import * as ts from 'typescript';
+import ts from 'typescript';
 import fs from 'fs';
 import path from 'path';
 
@@ -7,19 +7,22 @@ import path from 'path';
  * @param tsConfigPath The location for a `tsconfig.json` file
  */
 export function loadConfig(tsConfigPath: string) {
+	const resolvedConfigPath = path.resolve(tsConfigPath);
+	const projectDirectory = path.dirname(resolvedConfigPath);
+
 	const { config, error } = ts.readConfigFile(tsConfigPath, (filePath) =>
 		fs.readFileSync(filePath).toString(),
 	);
 
 	if (error) throw error;
 
-	const { options, errors } = ts.parseJsonConfigFileContent(
+	const { options, errors, fileNames } = ts.parseJsonConfigFileContent(
 		config,
 		ts.sys,
-		path.dirname(tsConfigPath),
+		projectDirectory,
 	);
 
 	if (errors.length > 0) throw errors[0];
 
-	return options;
+	return { options, fileNames };
 }

src/config.ts

@@ -504,7 +504,11 @@ export function parseFromProgram(
 				: symbolType;
 
 		if (!type) {
-			throw new Error('No types found');
+			if (symbol.name) {
+				throw new Error('No types found for symbol ' + symbol.name);
+			} else {
+				throw new Error('No types found for symbol');
+			}
 		}
 
 		// Typechecker only gives the type "any" if it's present in a union

src/parser.ts

@@ -5,7 +5,7 @@ const typeString = 'function';
 
 export interface FunctionNode {
 	nodeType: typeof typeString;
-	callSignatures?: CallSignature[];
+	callSignatures: CallSignature[];
 }
 
 export interface CallSignature {