feat: support multiple source directories in configuration

Author: Shukaaa

ROADMAP.md

@@ -2,12 +2,13 @@
 - Add github action for versioning and releasing
 - implement unit tests for converters
 
-# 1.1 Refinement
+# ✅ 1.1 Refinement
 - Alternative config path via `--config` flag
 - `--force` flag to overwrite existing output files
 - `@error` tag should not be required in JSDoc comments with default config
   - You can change this behavior via config if needed
   - `sourceFile.requireErrorTag` config option
+- `inputDir` should be an array to support multiple source directories
 
 # 1.2 Easy Setup
 - `swerr init` interactive command to create a `swerr.config.js` based on user input
@@ -19,7 +20,7 @@
 
 # 2.0 Polish & CI-ready
 - Config Overrides via CLI flags, for example:
-    - `--set sourceFile.inputDir=src` to override input directory
+    - `--set sourceFile.inputDirs=src` to override input directories
     - `--set converter[0].config.fileName=errors.html` to override converter configurations
 - `--dry-run` flag to simulate the generation process without creating files
 - Custom scan rules for source files

bin/commands/init.command.ts

@@ -8,7 +8,7 @@ const initConfigTemplate = `import {markdownConverter, htmlConverter} from "@swe
 // See more configuration options at https://swerr.apidocumentation.com/guide/introduction/config
 export default {
     sourceFile: {
-        inputDir: "./src", // Directory to scan for error definitions
+        inputDirs: ["./src"], // Directories to scan for error definitions
         meta: {
             projectName: "Your Application Name",
             description: "The Application description",

bin/commands/run.command.ts

@@ -9,28 +9,30 @@ import {LogUtils, SwerrConfig, SwerrScheme} from "@swerr/core";
 
 export const runCommand = async (configPath: string | undefined) => {
 	const swerrConfig = await config(configPath);
-	const sourceDir = swerrConfig?.sourceFile?.inputDir || null
+	const sourceDirs = swerrConfig?.sourceFile?.inputDirs || null
 	const outputDir = swerrConfig?.sourceFile?.export?.outputDir || null
 
 	if (!swerrConfig) {
 		LogUtils.error(`Swerr configuration file not found. Please create a ${SWERR_CONFIG_FILE} file in the current directory or specify a custom path using --config option.`);
 		process.exit(1);
 	}
 
-	if (!sourceDir || !outputDir) {
+	if (!sourceDirs || sourceDirs.length === 0 || !outputDir) {
 		LogUtils.error("Source and output directories must be specified either via configuration file.");
 		process.exit(1);
 	}
 
 	LogUtils.success("Swerr Configuration loaded.");
 
-	const absoluteSourceDir = path.resolve(process.cwd(), sourceDir);
 	const absoluteOutputDir = path.resolve(process.cwd(), outputDir);
 
-	const sourceExists = fs.existsSync(absoluteSourceDir);
-	if (!sourceExists) {
-		LogUtils.error(`Source directory "${absoluteSourceDir}" does not exist.`);
-		process.exit(1);
+	for (const sourceDir of sourceDirs) {
+		const absoluteSourceDir = path.resolve(process.cwd(), sourceDir);
+		const sourceExists = fs.existsSync(absoluteSourceDir);
+		if (!sourceExists) {
+			LogUtils.error(`Source directory "${absoluteSourceDir}" does not exist.`);
+			process.exit(1);
+		}
 	}
 
 	try {
@@ -40,15 +42,26 @@ export const runCommand = async (configPath: string | undefined) => {
 		process.exit(1);
 	}
 
-	scanJsdocs(absoluteSourceDir, swerrConfig?.sourceFile.options || {}).then(async result => {
-		LogUtils.info(`Scanned ${result.blocks.length} JSDocs block(s) from ${result.scannedFiles} file(s).`);
-		const scheme = translateToSourceScheme(result, swerrConfig)
+	try {
+		const scanOptions = swerrConfig?.sourceFile.options || {};
+		const mergedResult = { rootDir: sourceDirs[0], blocks: [] as any[], scannedFiles: 0, skippedFiles: 0 };
+		
+		for (const sourceDir of sourceDirs) {
+			const absoluteSourceDir = path.resolve(process.cwd(), sourceDir);
+			const result = await scanJsdocs(absoluteSourceDir, scanOptions);
+			mergedResult.blocks.push(...result.blocks);
+			mergedResult.scannedFiles += result.scannedFiles;
+			mergedResult.skippedFiles += result.skippedFiles;
+		}
+		
+		LogUtils.info(`Scanned ${mergedResult.blocks.length} JSDocs block(s) from ${mergedResult.scannedFiles} file(s).`);
+		const scheme = translateToSourceScheme(mergedResult, swerrConfig)
 		LogUtils.info(`Translated scan result to swerr Scheme with ${scheme.errors.length} error(s).`);
 		await saveSourceScheme(swerrConfig!, absoluteOutputDir, scheme);
 		await runConverter(swerrConfig!, scheme);
-	}).catch(err => {
+	} catch (err) {
 		LogUtils.error(`Error during scanning: ${err}`);
-	})
+	}
 }
 
 async function config(configPath: string | undefined): Promise<SwerrConfig | null> {

example/swerr.config.js

@@ -2,7 +2,7 @@ import {markdownConverter, htmlConverter} from "@swerr/converter"
 
 export default {
     sourceFile: {
-        inputDir: "./src/exceptions",
+        inputDirs: ["./src/exceptions"],
         meta: {
             projectName: "Muffin API",
             description: "The API description",