fix: replace paths with glob (#26)

src/main.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-import { globSync } from 'fast-glob';
+import { glob } from 'fast-glob';
 import { getProjectCompiledSources } from './utils';
 import { Processor } from './processor';
 import { Config } from './types';
@@ -10,8 +10,10 @@ import { Validator } from './validator';
 (async () => {
   const config: Config = getArguments();
 
-  const excludedPaths = config.exclude.map((path) => globSync(path, { cwd: config.root })).flat();
-  const sourceUnits = await getProjectCompiledSources(config.root, config.include, excludedPaths);
+  const includedPaths = await glob(config.include, { cwd: config.root });
+  const excludedPaths = await glob(config.exclude, { cwd: config.root });
+
+  const sourceUnits = await getProjectCompiledSources(config.root, includedPaths, excludedPaths);
   if (!sourceUnits.length) return console.error('No solidity files found in the specified directory');
 
   const validator = new Validator(config);
@@ -42,10 +44,9 @@ function getArguments(): Config {
         required: true,
       },
       exclude: {
-        type: 'array',
+        type: 'string',
         description: 'Glob patterns of files to exclude.',
-        default: [],
-        string: true,
+        default: '',
       },
       root: {
         type: 'string',

src/types.ts

@@ -10,7 +10,7 @@ import {
 
 export interface Config {
   include: string; // Required: Glob pattern of files to process.
-  exclude: string[]; // Optional: Glob patterns of files to exclude.
+  exclude: string; // Optional: Glob pattern of files to exclude.
   root: string; // Optional: Project root directory.
   enforceInheritdoc: boolean; // Optional: True if all external and public functions should have @inheritdoc.
   constructorNatspec: boolean; // Optional: True if the constructor should have natspec.

src/utils.ts

@@ -3,25 +3,13 @@ import path from 'path';
 import { ASTKind, ASTReader, SourceUnit, compileSol, FunctionDefinition } from 'solc-typed-ast';
 import { Natspec, NatspecDefinition, NodeToProcess } from './types';
 
-export async function getSolidityFiles(dir: string): Promise<string[]> {
-  let files = await fs.readdir(dir, { withFileTypes: true });
-  let solidityFiles: string[] = [];
-
-  for (const file of files) {
-    const res = path.resolve(dir, file.name);
-    if (file.isDirectory()) {
-      solidityFiles = solidityFiles.concat(await getSolidityFiles(res));
-    } else if (file.isFile() && file.name.endsWith('.sol')) {
-      solidityFiles.push(res);
-    }
-  }
-
-  return solidityFiles;
+export async function getSolidityFilesAbsolutePaths(files: string[]): Promise<string[]> {
+  return files.filter((file) => file.endsWith('.sol')).map((file) => path.resolve(file));
 }
 
-export async function getProjectCompiledSources(rootPath: string, includedPath: string, excludedPaths: string[]): Promise<SourceUnit[]> {
+export async function getProjectCompiledSources(rootPath: string, includedPaths: string[], excludedPaths: string[]): Promise<SourceUnit[]> {
   // Fetch Solidity files from the specified directory
-  const solidityFiles: string[] = await getSolidityFiles(includedPath);
+  const solidityFiles: string[] = await getSolidityFilesAbsolutePaths(includedPaths);
   const remappings: string[] = await getRemappings(rootPath);
 
   const compiledFiles = await compileSol(solidityFiles, 'auto', {
@@ -34,9 +22,9 @@ export async function getProjectCompiledSources(rootPath: string, includedPath:
     new ASTReader()
       .read(compiledFiles.data, ASTKind.Any, compiledFiles.files)
       // avoid processing files that are not in the specified directory, e.g. node modules or other imported files
-      .filter((sourceUnit) => isFileInDirectory(includedPath, sourceUnit.absolutePath))
+      .filter((sourceUnit) => includedPaths.includes(sourceUnit.absolutePath))
       // avoid processing files from excluded directories
-      .filter((sourceUnit) => !excludedPaths.some((excludedPath) => excludedPath === sourceUnit.absolutePath))
+      .filter((sourceUnit) => !excludedPaths.includes(sourceUnit.absolutePath))
   );
 }
 

test/processor.test.ts

@@ -11,7 +11,7 @@ describe('Processor', () => {
     const config: Config = {
       root: '.',
       include: './sample-data',
-      exclude: [],
+      exclude: '',
       enforceInheritdoc: false,
       constructorNatspec: false,
     };

test/validator.test.ts

@@ -11,7 +11,7 @@ describe('Validator', () => {
   let config: Config = {
     root: '.',
     include: './sample-data',
-    exclude: [],
+    exclude: '',
     enforceInheritdoc: false,
     constructorNatspec: false,
   };
@@ -355,7 +355,7 @@ describe('Validator', () => {
       config = {
         root: '.',
         include: './sample-data',
-        exclude: [],
+        exclude: '',
         enforceInheritdoc: true,
         constructorNatspec: false,
       };