Merge pull request #136 from docsbydoxdox/feature/pkg-homepage

[feat] Linked project title if homepage is defined in pkg.

Author: neogeek

packages/doxdox-cli/src/index.test.ts

@@ -36,14 +36,14 @@ describe('cli', () => {
             `./dist/src/index.js -n "testing the project name"`
         );
 
-        expect(stdout).toContain('# testing the project name');
+        expect(stdout).toContain('# [testing the project name]');
     });
     it('set name (long flag)', async () => {
         const { stdout } = await execAsync(
             `./dist/src/index.js --name "testing the project name"`
         );
 
-        expect(stdout).toContain('# testing the project name');
+        expect(stdout).toContain('# [testing the project name]');
     });
     it('set description (short flag)', async () => {
         const { stdout } = await execAsync(
@@ -74,17 +74,17 @@ describe('cli', () => {
     it('set output (no flag)', async () => {
         const { stdout } = await execAsync(`./dist/src/index.js`);
 
-        expect(stdout).toContain('# doxdox-cli');
+        expect(stdout).toContain('# [doxdox-cli]');
     });
     it('set output (no directory)', async () => {
         const { stdout } = await execAsync(`./dist/src/index.js -o temp.md`);
 
         await fs.stat('./temp.md');
 
-        expect(stdout).not.toContain('# doxdox-cli');
+        expect(stdout).not.toContain('# [doxdox-cli]');
 
         expect(await fs.readFile('./temp.md', 'utf8')).toContain(
-            '# doxdox-cli'
+            '# [doxdox-cli]'
         );
 
         await fs.unlink('./temp.md');
@@ -96,10 +96,10 @@ describe('cli', () => {
 
         await fs.stat('./src/temp.md');
 
-        expect(stdout).not.toContain('# doxdox-cli');
+        expect(stdout).not.toContain('# [doxdox-cli]');
 
         expect(await fs.readFile('./src/temp.md', 'utf8')).toContain(
-            '# doxdox-cli'
+            '# [doxdox-cli]'
         );
 
         await fs.unlink('./src/temp.md');
@@ -111,10 +111,10 @@ describe('cli', () => {
 
         await fs.stat('./temp/temp.md');
 
-        expect(stdout).not.toContain('# doxdox-cli');
+        expect(stdout).not.toContain('# [doxdox-cli]');
 
         expect(await fs.readFile('./temp/temp.md', 'utf8')).toContain(
-            '# doxdox-cli'
+            '# [doxdox-cli]'
         );
 
         await fs.unlink('./temp/temp.md');
@@ -124,10 +124,10 @@ describe('cli', () => {
 
         await fs.stat('./temp.md');
 
-        expect(stdout).not.toContain('# doxdox-cli');
+        expect(stdout).not.toContain('# [doxdox-cli]');
 
         expect(await fs.readFile('./temp.md', 'utf8')).toContain(
-            '# doxdox-cli'
+            '# [doxdox-cli]'
         );
 
         await fs.unlink('./temp.md');
@@ -139,18 +139,18 @@ describe('cli', () => {
 
         await fs.stat('./temp.md');
 
-        expect(stdout).not.toContain('# doxdox-cli');
+        expect(stdout).not.toContain('# [doxdox-cli]');
 
         expect(await fs.readFile('./temp.md', 'utf8')).toContain(
-            '# doxdox-cli'
+            '# [doxdox-cli]'
         );
 
         await fs.unlink('./temp.md');
     });
     it('set package location (no flag)', async () => {
         const { stdout } = await execAsync(`./dist/src/index.js`);
 
-        expect(stdout).toContain('# doxdox-cli');
+        expect(stdout).toContain('# [doxdox-cli]');
     });
     it('set package location (short flag)', async () => {
         const { stdout } = await execAsync(

packages/doxdox-cli/src/index.ts

@@ -140,7 +140,8 @@ const overridePackage = String(
     const output = await doxdox(cwd, paths, loadedParser, loadedRenderer, {
         name: overrideName || pkg.name || 'Untitled Project',
         description: overrideDescription || pkg.description || '',
-        version: pkg.version
+        version: pkg.version,
+        homepage: pkg.homepage
     });
 
     if (overrideOutput) {

packages/doxdox-core/src/index.ts

@@ -2,14 +2,14 @@ export * from './types.js';
 export * from './utils.js';
 export * from './loader.js';
 
-import { Doc, File } from './types.js';
+import { Doc, File, Options } from './types.js';
 
 export default async (
     cwd: string,
     paths: string[],
     parser: (cwd: string, path: string) => Promise<File>,
     renderer: (doc: Doc) => Promise<string>,
-    options: { name?: string; description?: string; version?: string } = {}
+    options: Options = {}
 ) =>
     Promise.all(paths.map(async path => await parser(cwd, path))).then(
         async files => await renderer({ ...options, files })

packages/doxdox-core/src/types.ts

@@ -1,7 +1,11 @@
-export interface Doc {
+export interface Options {
     name?: string;
     description?: string;
     version?: string;
+    homepage?: string;
+}
+
+export interface Doc extends Options {
     files: File[];
 }
 
@@ -20,10 +24,7 @@ export interface Method {
     private: boolean;
 }
 
-export interface Package {
-    name?: string;
-    description?: string;
-    version?: string;
+export interface Package extends Options {
     exports?: string;
 }
 

packages/doxdox-core/src/utils.ts

@@ -87,11 +87,11 @@ export const getProjectPackage = async (cwd: string): Promise<Package> => {
     const projectPackagePath = await findFileInPath(cwd);
 
     if (projectPackagePath) {
-        const { name, description, version, exports } = JSON.parse(
+        const { name, description, version, exports, homepage } = JSON.parse(
             await fs.readFile(projectPackagePath, 'utf8')
         );
 
-        return { name, description, version, exports };
+        return { name, description, version, exports, homepage };
     }
 
     return {};

packages/doxdox-renderer-bootstrap/src/index.ts

@@ -130,7 +130,11 @@ export default async (doc: Doc): Promise<string> => `<!DOCTYPE html>
   <body>
     <div class="bg-dark text-white">
       <div class="container p-5">
-        <h1 class="pkg-name">${doc.name}</h1>
+        ${
+            doc.homepage
+                ? `<h1 class="pkg-name"><a href="${doc.homepage}">${doc.name}</a></h1>`
+                : `<h1 class="pkg-name">${doc.name}</h1>`
+        }
 
         ${
             doc.description

packages/doxdox-renderer-markdown/src/index.ts

@@ -37,7 +37,9 @@ ${param.description}`
 const renderFile = (file: File) =>
     `${file.methods.map(method => renderMethod(method)).join('')}`;
 
-export default async (doc: Doc): Promise<string> => `# ${doc.name}
+export default async (doc: Doc): Promise<string> => `# ${
+    doc.homepage ? `[${doc.name}](${doc.homepage})` : doc.name
+}
 
 ${doc.description ? `> ${doc.description}` : ''}
 

packages/doxdox-renderer-pdf/src/index.ts

@@ -112,7 +112,11 @@ export default async (doc: Doc): Promise<Buffer> => {
           <body>
             <div class="bg-dark text-white">
               <div class="container p-5">
-                <h1 class="pkg-name">${doc.name}</h1>
+                ${
+                    doc.homepage
+                        ? `<h1 class="pkg-name"><a href="${doc.homepage}">${doc.name}</a></h1>`
+                        : `<h1 class="pkg-name">${doc.name}</h1>`
+                }
 
                 ${
                     doc.description