Update fileProcessors jsdoc

Author: yoktav

src/fileProcessors.ts

@@ -12,12 +12,25 @@ export interface ExtractedData {
   path: string;
 }
 
-// Generic function to read file content
+/**
+ * Reads the content of a file
+ *
+ * @param {string} filePath - The path to the file
+ * @returns {string} The content of the file
+ */
 function readFileContent(filePath: string): string {
   return fs.readFileSync(filePath, 'utf8');
 }
 
-// Generic function to process files
+/**
+ * Processes files using the provided extractor function and data processor
+ *
+ * @template T
+ * @param {FileInfo[]} files - Array of file information objects
+ * @param {(content: string) => string[]} extractorFn - Function to extract data from file content
+ * @param {(data: string[]) => T['data']} dataProcessor - Function to process extracted data
+ * @returns {T[]} Array of processed data objects
+ */
 function processFiles<T extends ExtractedData>(
   files: FileInfo[],
   extractorFn: (content: string) => string[],
@@ -40,7 +53,12 @@ function processFiles<T extends ExtractedData>(
     .filter((item): item is T => item !== null && item.data.length > 0);
 }
 
-// Process template files
+/**
+ * Processes template files to extract classes
+ *
+ * @param {FileInfo[]} templateFiles - Array of template file information objects
+ * @returns {ExtractedData[]} Array of extracted class data
+ */
 export function processTemplateFilesToExtractClasses(templateFiles: FileInfo[]): ExtractedData[] {
   return processFiles<ExtractedData>(
     templateFiles,
@@ -49,7 +67,12 @@ export function processTemplateFilesToExtractClasses(templateFiles: FileInfo[]):
   );
 }
 
-// Process CSS files
+/**
+ * Processes CSS files to extract classes
+ *
+ * @param {FileInfo[]} cssFiles - Array of CSS file information objects
+ * @returns {ExtractedData[]} Array of extracted CSS selector data
+ */
 export function processCssFilesToExtractClasses(cssFiles: FileInfo[]): ExtractedData[] {
   return processFiles<ExtractedData>(
     cssFiles,
@@ -58,18 +81,36 @@ export function processCssFilesToExtractClasses(cssFiles: FileInfo[]): Extracted
   );
 }
 
-// Generic function to write data to file
+/**
+ * Writes data to a file in the specified directory
+ *
+ * @param {ExtractedData[]} data - Array of extracted data objects
+ * @param {string} fileName - Name of the output file
+ * @param {string} uncssTempDir - Path to the temporary directory
+ */
 function writeDataToFile(data: ExtractedData[], fileName: string, uncssTempDir: string): void {
   const outputPath = path.join(uncssTempDir, fileName);
   fs.writeFileSync(outputPath, JSON.stringify(data, null, 2));
 }
 
-// Write template classes to file
+/**
+ * Writes extracted template classes to a file
+ *
+ * @param {ExtractedData[]} templateClasses - Array of extracted template class data
+ * @param {string} fileName - Name of the output file
+ * @param {string} uncssTempDir - Path to the temporary directory
+ */
 export function writeTemplateClassesToFile(templateClasses: ExtractedData[], fileName: string, uncssTempDir: string): void {
   writeDataToFile(templateClasses, fileName, uncssTempDir);
 }
 
-// Write CSS selectors to file
+/**
+ * Writes extracted CSS selectors to a file
+ *
+ * @param {ExtractedData[]} cssSelectors - Array of extracted CSS selector data
+ * @param {string} fileName - Name of the output file
+ * @param {string} uncssTempDir - Path to the temporary directory
+ */
 export function writeCssSelectorsToFile(cssSelectors: ExtractedData[], fileName: string, uncssTempDir: string): void {
   writeDataToFile(cssSelectors, fileName, uncssTempDir);
 }