refactor(feat): include filePath, and improve internals in that area

Author: ghostdevv

src/extractinator.ts

@@ -1,10 +1,10 @@
+import type { FileParserContext } from './files/files'
 import type { ParsedFile } from './types'
 
 import { l, b, n, o, g, r, dim } from './utils/log'
 import { parseSvelteFile } from './files/svelte'
 import { parseTSFile } from './files/typescript'
 import { createTSDocParser } from './comments'
-import { mkdir, writeFile } from 'fs/promises'
 import { basename } from 'node:path'
 import { Project } from 'ts-morph'
 import { emit_dts } from './emit'
@@ -27,16 +27,15 @@ export async function extractinator(options: ExtractinatorOptions) {
 
 	const tsdoc = createTSDocParser(options.tsdocConfigPath)
 
-	//? Map of input_file_path:file
-	const parsed_files = new Map<string, ParsedFile>()
+	const parsed_files: ParsedFile[] = []
 
 	//? Loop over all the loaded source files
-	for (const sourceFile of project.getSourceFiles()) {
+	for (const source_file of project.getSourceFiles()) {
 		//? Get the filename e.g. KitchenSink.svelte.d.ts
-		const dts_file_name = sourceFile.getBaseName()
+		const dts_file_name = source_file.getBaseName()
 
 		//? Get the input file name
-		const input_file_path = dts.dts_file_map.get(sourceFile.getFilePath())!
+		const input_file_path = dts.dts_file_map.get(source_file.getFilePath())!
 		const file_name = basename(input_file_path)
 
 		//? Work out the file extension
@@ -48,11 +47,18 @@ export async function extractinator(options: ExtractinatorOptions) {
 
 		l(`Processing File (${dim(ext)}) "${o(file_name)}"`)
 
+		const ctx: FileParserContext = {
+			file_name,
+			input_file_path,
+			file: source_file,
+			tsdoc,
+		}
+
 		switch (ext) {
 			//? Handle Svelte Files
 			case '.svelte.d.ts': {
-				const file = parseSvelteFile(file_name, sourceFile, tsdoc)
-				parsed_files.set(input_file_path, file)
+				const file = parseSvelteFile(ctx)
+				parsed_files.push(file)
 
 				l(' ⤷', o(file.componentName))
 				l('  ', dim('Props:   '), b(file.props.length))
@@ -67,8 +73,8 @@ export async function extractinator(options: ExtractinatorOptions) {
 			case '.d.ts': {
 				const basename = dts_file_name.replace(ext, '')
 
-				const file = parseTSFile(file_name, sourceFile, tsdoc)
-				parsed_files.set(input_file_path, file)
+				const file = parseTSFile(ctx)
+				parsed_files.push(file)
 
 				l(' ⤷', o(basename))
 
@@ -91,5 +97,5 @@ export async function extractinator(options: ExtractinatorOptions) {
 
 	await dts.cleanup()
 
-	return Array.from(parsed_files.values())
+	return parsed_files
 }

src/files/files.d.ts

@@ -0,0 +1,9 @@
+import type { TSDocParser } from '@microsoft/tsdoc'
+import type { SourceFile } from 'ts-morph'
+
+export interface FileParserContext {
+	file_name: string
+	input_file_path: string
+	file: SourceFile
+	tsdoc: TSDocParser
+}

src/files/svelte.ts

@@ -1,32 +1,35 @@
 import type { SlotBit, Bit, ParsedSvelteFile } from '../types'
 import type { TSDocParser } from '@microsoft/tsdoc'
+import type { FileParserContext } from './files'
 import type { SourceFile, Node } from 'ts-morph'
 
 import { getName, getType, isExported, toBit } from '../utils/nodes'
 import { parseCommentFromNode } from '../comments'
 import ts from 'typescript'
 
-export function parseSvelteFile(
-	file_name: string,
-	file: SourceFile,
-	parser: TSDocParser,
-): ParsedSvelteFile {
+export function parseSvelteFile({
+	file_name,
+	input_file_path,
+	file,
+	tsdoc,
+}: FileParserContext): ParsedSvelteFile {
 	//? Get the component name from the file name
 	const componentName = file_name.replace('.svelte', '')
 
 	//? Get the props, events, slots nodes
 	const stuff = extractSvelteTypeNodes(file)
 
 	//? Parse the props, events, slots nodes to bits
-	const slots = stuff.slots?.map<SlotBit>((n) => parseSlot(n, parser)) || []
-	const events = stuff.events?.map<Bit>((n) => toBit(n, parser)) || []
-	const props = stuff.props?.map<Bit>((n) => toBit(n, parser)) || []
+	const slots = stuff.slots?.map<SlotBit>((n) => parseSlot(n, tsdoc)) || []
+	const events = stuff.events?.map<Bit>((n) => toBit(n, tsdoc)) || []
+	const props = stuff.props?.map<Bit>((n) => toBit(n, tsdoc)) || []
 
 	//? Extract the export bits
-	const variables = extractModuleExports(componentName, file, parser)
+	const variables = extractModuleExports(componentName, file, tsdoc)
 
 	return {
 		fileName: file_name,
+		filePath: input_file_path,
 		componentName,
 		props,
 		events,
@@ -121,7 +124,7 @@ function extractSvelteTypeNodes(file: SourceFile) {
 	}
 }
 
-function parseSlot(node: Node, parser: TSDocParser): SlotBit {
+function parseSlot(node: Node, tsdoc: TSDocParser): SlotBit {
 	/**
 	 * ? Slots look like this
 	 *
@@ -146,16 +149,16 @@ function parseSlot(node: Node, parser: TSDocParser): SlotBit {
 		.getChildrenOfKind(ts.SyntaxKind.TypeLiteral)[0]
 		?.getChildSyntaxList()
 		?.getChildren()
-		?.map((node) => toBit(node, parser))
+		?.map((node) => toBit(node, tsdoc))
 
 	return {
-		comment: parseCommentFromNode(node, parser),
+		comment: parseCommentFromNode(node, tsdoc),
 		name: getName(node) || 'it broke',
 		props: props || [],
 	}
 }
 
-function extractModuleExports(componentName: string, file: SourceFile, parser: TSDocParser) {
+function extractModuleExports(componentName: string, file: SourceFile, tsdoc: TSDocParser) {
 	//? Nodes we don't care about, they are handled elsewhere
 	const ignoredNodeNames = [
 		'default',
@@ -181,14 +184,14 @@ function extractModuleExports(componentName: string, file: SourceFile, parser: T
 						)!
 
 						return {
-							comment: parseCommentFromNode(node, parser),
+							comment: parseCommentFromNode(node, tsdoc),
 							name: getName(declaration) || 'it broke ahjk',
 							type: getType(declaration),
 						}
 					}
 
 					default:
-						return toBit(node, parser)
+						return toBit(node, tsdoc)
 				}
 			})
 	)

src/files/typescript.ts

@@ -1,12 +1,16 @@
 import type { ExportBit, ParsedTSFile } from '../types'
-import type { TSDocParser } from '@microsoft/tsdoc'
-import type { SourceFile } from 'ts-morph'
+import type { FileParserContext } from './files'
 
 import { parseCommentFromNode } from '../comments'
 import { getType } from '../utils/nodes'
 import ts from 'typescript'
 
-export function parseTSFile(file_name: string, file: SourceFile, tsdoc: TSDocParser): ParsedTSFile {
+export function parseTSFile({
+	file_name,
+	input_file_path,
+	file,
+	tsdoc,
+}: FileParserContext): ParsedTSFile {
 	const export_bits: ExportBit[] = []
 
 	//? Loop over all the export declarations
@@ -38,6 +42,7 @@ export function parseTSFile(file_name: string, file: SourceFile, tsdoc: TSDocPar
 
 	return {
 		fileName: file_name,
+		filePath: input_file_path,
 		exports: export_bits,
 	}
 }

src/types.d.ts

@@ -4,7 +4,7 @@ declare global {
 
 export type ParsedFile = ParsedSvelteFile | ParsedTSFile
 
-export interface ParsedTSFile {
+export interface BaseParsedFile {
 	/**
 	 * The name of the file read
 	 *
@@ -14,13 +14,23 @@ export interface ParsedTSFile {
 	 */
 	fileName: string
 
+	/**
+	 * The absolute path to the source file used
+	 *
+	 * @example
+	 * /home/ghost/Desktop/extractinator/playground/KitchenSink.svelte
+	 */
+	filePath: string
+}
+
+export interface ParsedTSFile extends BaseParsedFile {
 	/**
 	 * The exports from the component
 	 */
 	exports: Bit[]
 }
 
-export interface ParsedSvelteFile {
+export interface ParsedSvelteFile extends BaseParsedFile {
 	/**
 	 * The name of the component
 	 *
@@ -29,15 +39,6 @@ export interface ParsedSvelteFile {
 	 */
 	componentName: string
 
-	/**
-	 * The name of the file read
-	 *
-	 * @example
-	 * KitchenSink.svelte
-	 * example.ts
-	 */
-	fileName: string
-
 	props: Bit[]
 	events: Bit[]
 	slots: SlotBit[]

src/utils/nodes.ts

@@ -34,9 +34,9 @@ export function getType(node: Node) {
 /**
  * Convert the node into a {@link Bit}
  */
-export function toBit(node: Node, parser: TSDocParser): Bit {
+export function toBit(node: Node, tsdoc: TSDocParser): Bit {
 	return {
-		comment: parseCommentFromNode(node, parser),
+		comment: parseCommentFromNode(node, tsdoc),
 		name: getName(node) || 'it broke',
 		type: getType(node),
 	}