Set default value for name and description to null.

Updated types in core.
Updated templates.
Updated tests.

Author: neogeek

packages/doxdox-core/src/types.ts

@@ -18,7 +18,7 @@ export interface Method {
     slug: string;
     name: string;
     fullName: string;
-    description: string;
+    description: string | null;
     params: Param[];
     returns: Param[];
     private: boolean;
@@ -29,7 +29,7 @@ export interface Package extends Options {
 }
 
 export interface Param {
-    name?: string;
-    description: string;
+    name: string | null;
+    description: string | null;
     types: string[];
 }

packages/doxdox-parser-jsdoc/src/index.test.ts

@@ -50,7 +50,8 @@ const getRootDirPath = (url) => {};`
                         private: false,
                         returns: expect.arrayContaining([
                             expect.objectContaining({
-                                name: undefined,
+                                name: null,
+                                description: 'Path to package.json file.',
                                 types: ['Promise.<(string|null)>']
                             })
                         ]),
@@ -68,7 +69,8 @@ const getRootDirPath = (url) => {};`
                         private: false,
                         returns: expect.arrayContaining([
                             expect.objectContaining({
-                                name: undefined,
+                                name: null,
+                                description: 'Directory path.',
                                 types: ['string']
                             })
                         ]),

packages/doxdox-parser-jsdoc/src/index.ts

@@ -46,15 +46,15 @@ const parser = async (cwd: string, path: string): Promise<File> => {
             )
             .map((jsdoc: Jsdoc) => {
                 const params = (jsdoc.params || []).map(
-                    ({ name, description = '', type = {} }) => ({
+                    ({ name = null, description = null, type = {} }) => ({
                         name,
                         description,
                         types: type.names || []
                     })
                 );
 
                 const returns = (jsdoc.returns || []).map(
-                    ({ name, description = '', type = {} }) => ({
+                    ({ name = null, description = null, type = {} }) => ({
                         name,
                         description,
                         types: type.names || []
@@ -77,7 +77,7 @@ const parser = async (cwd: string, path: string): Promise<File> => {
                         .map(param => param.name)
                         .filter(name => name && !name.match(/\./))
                         .join(', ')})`,
-                    description: jsdoc.description || '',
+                    description: jsdoc.description || null,
                     params,
                     returns,
                     private: isPrivate

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

@@ -37,6 +37,7 @@ describe('bootstrap', () => {
                                 ],
                                 returns: [
                                     {
+                                        name: null,
                                         description: 'Return description',
                                         types: ['void']
                                     }

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

@@ -41,7 +41,7 @@ ${md
             ...method.params.map(({ name, types, description }) => [
                 name,
                 `<code>${types.join('</code>, <code>')}</code>`,
-                description
+                description || ''
             ])
         ])
     )
@@ -57,7 +57,7 @@ ${
 ${method.returns.map(
     param => `<p><code>${param.types.join('</code>, <code>')}</code></p>
 
-<p>${param.description}</p>`
+${param.description ? `<p>${param.description}</p>` : ''}`
 )}`
         : ''
 }

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

@@ -64,7 +64,7 @@ ${md
             ...method.params.map(({ name, types, description }) => [
                 name,
                 `<code>${types.join('</code>, <code>')}</code>`,
-                description
+                description || ''
             ])
         ])
     )
@@ -80,7 +80,7 @@ ${
 ${method.returns.map(
     param => `<p><code>${param.types.join('</code>, <code>')}</code></p>
 
-<p>${param.description}</p>`
+${param.description ? `<p>${param.description}</p>` : ''}`
 )}`
         : ''
 }

packages/doxdox-renderer-github-wiki/src/index.ts

@@ -19,7 +19,7 @@ ${markdownTable([
     ...method.params.map(({ name, types, description }) => [
         name,
         types.join(', '),
-        description
+        description || ''
     ])
 ])}`
         : ''
@@ -31,7 +31,7 @@ ${
 
 ${method.returns.map(
     param => `${param.types.join(', ')}
-${param.description}`
+${param.description || ''}`
 )}`
         : ''
 }

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

@@ -37,6 +37,7 @@ describe('markdown', () => {
                                 ],
                                 returns: [
                                     {
+                                        name: null,
                                         description: 'Return description',
                                         types: ['void']
                                     }

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

@@ -15,7 +15,7 @@ ${markdownTable([
     ...method.params.map(({ name, types, description }) => [
         name,
         types.join(', '),
-        description
+        description || ''
     ])
 ])}`
         : ''
@@ -27,7 +27,7 @@ ${
 
 ${method.returns.map(
     param => `${param.types.join(', ')}
-${param.description}`
+${param.description || ''}`
 )}`
         : ''
 }

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

@@ -38,7 +38,7 @@ ${md
             ...method.params.map(({ name, types, description }) => [
                 name,
                 `<code>${types.join('</code>, <code>')}</code>`,
-                description
+                description || ''
             ])
         ])
     )
@@ -54,7 +54,7 @@ ${
 ${method.returns.map(
     param => `<p><code>${param.types.join('</code>, <code>')}</code></p>
 
-<p>${param.description}</p>`
+${param.description ? `<p>${param.description}</p>` : ''}`
 )}`
         : ''
 }