chore: Add function description and change parameter name

src/bootstrap/index.ts

@@ -8,7 +8,7 @@ import { resolve } from 'pathe';
 export function bootstrapProject(
   options: Partial<TypeDocAndTSOptions>,
   filteringGlob?: string,
-  nodeModulesInputFilePaths?: string[]
+  additionalInputFilePaths?: string[]
 ): ProjectReflection {
   const app = new Application();
   app.options.addReader(new TSConfigReader());
@@ -18,8 +18,8 @@ export function bootstrapProject(
     throw new Error('Errors during parsing configuration');
   }
 
-  if (nodeModulesInputFilePaths?.length) {
-    inputFiles.push(...nodeModulesInputFilePaths);
+  if (additionalInputFilePaths?.length) {
+    inputFiles.push(...additionalInputFilePaths);
   }
 
   const filteredInputFiles = filterFiles(inputFiles, filteringGlob);

src/components/index.ts

@@ -5,20 +5,26 @@ import { ComponentDefinition } from './interfaces';
 import extractComponents from './components-extractor';
 import { bootstrapProject } from '../bootstrap';
 
+/**
+ * @param tsconfigPath Path to tsconfig file
+ * @param publicFilesGlob Filter to obtain public files
+ * @param nodeModulesDependencyFilePaths node_modules paths of libraries to include in documentation e.g.["dir/node_modules/@cloudscape-design/components/icon/interfaces.d.ts"]
+ * @returns Component definitions
+ */
 export function documentComponents(
   tsconfigPath: string,
   publicFilesGlob: string,
-  nodeModulesInputFilePaths?: string[]
+  nodeModulesDependencyFilePaths?: string[]
 ): ComponentDefinition[] {
-  const includeNodeModulePaths = Boolean(nodeModulesInputFilePaths?.length);
+  const includeNodeModulePaths = Boolean(nodeModulesDependencyFilePaths?.length);
   const project = bootstrapProject(
     {
       tsconfig: tsconfigPath,
       includeDeclarations: includeNodeModulePaths,
       excludeExternals: includeNodeModulePaths,
     },
     undefined,
-    nodeModulesInputFilePaths
+    nodeModulesDependencyFilePaths
   );
   return extractComponents(publicFilesGlob, project);
 }

test/components/test-helpers.ts

@@ -7,11 +7,11 @@ import { TestUtilsDoc } from '../../src/test-utils/interfaces';
 
 // TODO: Move this file into common location, improve naming
 
-export function buildProject(name: string, nodeModulesInputFilePaths?: string[]): ComponentDefinition[] {
+export function buildProject(name: string, nodeModulesDependencyFilePaths?: string[]): ComponentDefinition[] {
   return documentComponents(
     require.resolve(`../../fixtures/components/${name}/tsconfig.json`),
     `fixtures/components/${name}/*/index.tsx`,
-    nodeModulesInputFilePaths
+    nodeModulesDependencyFilePaths
   );
 }
 

test/components/third-party-import-types.test.ts

@@ -45,7 +45,7 @@ test('should resolve object type to string', () => {
   ]);
 });
 
-test('passing nodeModulesInputFilePaths should enable includeDeclarations and excludeExternals', () => {
+test('passing nodeModulesDependencyFilePaths should enable includeDeclarations and excludeExternals', () => {
   const bootstrapProjectSpy = jest.spyOn(bootstrap, 'bootstrapProject');
   buildProject('third-party-import-types', [nodeModulesPath]);