chore(plugin-monorepo-readmes): fix styling, fix readmes searches & validation

Author: GerkinDev

packages/plugin-monorepo-readmes/src/find-readme-file.spec.ts

@@ -30,14 +30,14 @@ describe( 'Readme file location', () => {
 				},
 				'package.json': '',
 				'README.md': 'hello',
-				'OTHER.md': 'yellow'
+				'OTHER.md': 'yellow',
 			},
 		} );
 		expect( findReadmeFile( [ 'package.json' ], buildMapping( 'foo/src/index.ts' ), [] ) ).toEqual( {
 			relative: 'README.md',
 			absolute: resolve( rootDir, 'foo/README.md' ),
 		} );
-		expect( findReadmeFile( [ 'package.json' ], buildMapping( 'foo/src/index.ts' ), ['OTHER.md'] ) ).toEqual( {
+		expect( findReadmeFile( [ 'package.json' ], buildMapping( 'foo/src/index.ts' ), [ 'OTHER.md' ] ) ).toEqual( {
 			relative: 'OTHER.md',
 			absolute: resolve( rootDir, 'foo/OTHER.md' ),
 		} );
@@ -53,7 +53,7 @@ describe( 'Readme file location', () => {
 			},
 		} );
 		expect( findReadmeFile( [ 'package.json' ], buildMapping( 'foo/src/index.ts' ), [] ) ).toEqual( undefined );
-		expect( findReadmeFile( [ 'package.json' ], buildMapping( 'foo/src/index.ts' ), ['OTHER.md'] ) ).toEqual( undefined );
+		expect( findReadmeFile( [ 'package.json' ], buildMapping( 'foo/src/index.ts' ), [ 'OTHER.md' ] ) ).toEqual( undefined );
 	} );
 	it( 'should fallback on each readme targets', () => {
 		setVirtualFs( {
@@ -67,14 +67,14 @@ describe( 'Readme file location', () => {
 				},
 				'project.json': '',
 				'readme.md': '',
-				'other.md': ''
+				'other.md': '',
 			},
 		} );
 		expect( findReadmeFile( [ 'package.json', 'project.json' ], buildMapping( 'foo/bar/src/index.ts' ), [] ) ).toEqual( {
 			relative: 'readme.md',
 			absolute: resolve( rootDir, 'foo/readme.md' ),
 		} );
-		expect( findReadmeFile( [ 'package.json', 'project.json' ], buildMapping( 'foo/bar/src/index.ts' ), ['other.md'] ) ).toEqual( {
+		expect( findReadmeFile( [ 'package.json', 'project.json' ], buildMapping( 'foo/bar/src/index.ts' ), [ 'other.md' ] ) ).toEqual( {
 			relative: 'other.md',
 			absolute: resolve( rootDir, 'foo/other.md' ),
 		} );

packages/plugin-monorepo-readmes/src/find-readme-file.ts

@@ -1,5 +1,5 @@
-import { readdirSync, existsSync } from 'fs';
-import { dirname, resolve, join } from 'path';
+import { readdirSync } from 'fs';
+import { dirname, resolve } from 'path';
 
 import { sync as findUpSync } from 'find-up';
 import { DeclarationReflection, UrlMapping } from 'typedoc';
@@ -13,14 +13,24 @@ const getModuleReflectionSource = ( reflection: DeclarationReflection ) => {
 	return undefined;
 };
 
+const findReadmeInDir = ( dir: string, readmeFile: string[] ) => readdirSync( dir ).find( f => readmeFile.includes( f.toLowerCase() ) );
+
 /**
  * Try to resoluve the README file in the directory of the module's `package.json`.
  *
  * @param readmeTargets - A list of file names to look up to locate packages root.
  * @param moduleMapping - The module URL mapping.
+ * @param readmeCandidates - A list of files to use as readme. The first found is used. File names are NOT case sensitive. Example: `["readme-typedoc.md", "readme.md"]`. Defaults to `["readme.md"]`.
  * @returns the relative & absolute path of the readme.
  */
-export const findReadmeFile = ( readmeTargets: string[], moduleMapping: UrlMapping<DeclarationReflection>, readme: string[] ) => {
+export const findReadmeFile = ( readmeTargets: string[], moduleMapping: UrlMapping<DeclarationReflection>, readmeCandidates?: string[] ) => {
+	if( !readmeCandidates ){
+		readmeCandidates = [];
+	}
+	if( readmeCandidates.length === 0 ) {
+		readmeCandidates.push( 'readme.md' );
+	}
+	readmeCandidates = readmeCandidates.map( r => r.toLowerCase() );
 	const src = getModuleReflectionSource( moduleMapping.model );
 	if( !src ){
 		return;
@@ -32,16 +42,7 @@ export const findReadmeFile = ( readmeTargets: string[], moduleMapping: UrlMappi
 			continue;
 		}
 		const pkgDir = dirname( targetFile );
-		const readmeFile = (() => {
-			if (readme?.length) { 
-				for (const name of readme) {
-					if (existsSync(join(pkgDir, name)))
-						return name;
-				}
-				return;
-			}
-			return readdirSync( pkgDir ).find( f => f.toLowerCase() === 'readme.md' );
-		})();
+		const readmeFile = findReadmeInDir( pkgDir, readmeCandidates );
 
 		if( readmeFile ){
 			const absReadmeFile = resolve( pkgDir, readmeFile );

packages/plugin-monorepo-readmes/src/options/types.ts

@@ -20,7 +20,7 @@ export interface IPluginOptions {
 
 	/**
 	 * The name of the readme files
-	 * 
+	 *
 	 * @default `[]`
 	 */
 	readme: string[];