Skip to content

Commit ea6a4f5

Browse files
batchu5batchu5
committed
format type parameters as code blocks
1 parent a9be50e commit ea6a4f5

File tree

3 files changed

+90
-84
lines changed

3 files changed

+90
-84
lines changed

‎packages/components/docs/API.md‎

Lines changed: 79 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -114,14 +114,14 @@ Renders a WebSocket close connection method with optional pre- and post-executio
114114

115115
| Name | Type | Description |
116116
|------|------|-------------|
117-
| props | Object | Component props. |
118-
| props.language | Language | Programming language used for method formatting. |
119-
| props.framework | string | Framework used, if any (e.g., 'quarkus' for Java). |
120-
| props.methodName | string | Name of the method to generate. |
121-
| props.methodParams | Array.<string> | List of parameters for the method. |
122-
| props.preExecutionCode | string | Code to insert before the main function logic. |
123-
| props.postExecutionCode | string | Code to insert after the main function logic. |
124-
| props.indent | number | Indentation level for the method block. |
117+
| props | <code>Object</code> | Component props. |
118+
| props.language | <code>Language</code> | Programming language used for method formatting. |
119+
| props.framework | <code>string</code> | Framework used, if any (e.g., &#x27;quarkus&#x27; for Java). |
120+
| props.methodName | <code>string</code> | Name of the method to generate. |
121+
| props.methodParams | <code>Array.&lt;string&gt;</code> | List of parameters for the method. |
122+
| props.preExecutionCode | <code>string</code> | Code to insert before the main function logic. |
123+
| props.postExecutionCode | <code>string</code> | Code to insert after the main function logic. |
124+
| props.indent | <code>number</code> | Indentation level for the method block. |
125125

126126

127127

@@ -158,9 +158,9 @@ Component that renders WebSocket connection method for the specified programming
158158

159159
| Name | Type | Description |
160160
|------|------|-------------|
161-
| props | Object | Component properties. |
162-
| props.language | Language | The programming language for which to generate connection code. |
163-
| props.title | string | The title of the WebSocket server. |
161+
| props | <code>Object</code> | Component properties. |
162+
| props.language | <code>Language</code> | The programming language for which to generate connection code. |
163+
| props.title | <code>string</code> | The title of the WebSocket server. |
164164

165165

166166

@@ -187,11 +187,11 @@ Renders the top-of-file dependency statements for the selected programming langu
187187

188188
| Name | Type | Description |
189189
|------|------|-------------|
190-
| props | Object | Component props. |
191-
| props.language | Language | The programming language for which to render dependency statements. |
192-
| props.framework | string | The framework (e.g., &#x27;quarkus&#x27; for Java). |
193-
| props.role | string | The role (e.g., &#x27;client&#x27;, &#x27;connector&#x27; for Java). |
194-
| props.additionalDependencies | Array.<string> | Optional additional dependencies to include. |
190+
| props | <code>Object</code> | Component props. |
191+
| props.language | <code>Language</code> | The programming language for which to render dependency statements. |
192+
| props.framework | <code>string</code> | The framework (e.g., &#x27;quarkus&#x27; for Java). |
193+
| props.role | <code>string</code> | The role (e.g., &#x27;client&#x27;, &#x27;connector&#x27; for Java). |
194+
| props.additionalDependencies | <code>Array.&lt;string&gt;</code> | Optional additional dependencies to include. |
195195

196196

197197

@@ -225,10 +225,10 @@ Renders a file header with metadata information such as title, version, protocol
225225

226226
| Name | Type | Description |
227227
|------|------|-------------|
228-
| props | Object | Component props. |
229-
| props.info | object | Info object from the AsyncAPI document. |
230-
| props.server | object | Server object from the AsyncAPI document. |
231-
| props.language | Language | Programming language used for comment formatting. |
228+
| props | <code>Object</code> | Component props. |
229+
| props.info | <code>object</code> | Info object from the AsyncAPI document. |
230+
| props.server | <code>object</code> | Server object from the AsyncAPI document. |
231+
| props.language | <code>Language</code> | Programming language used for comment formatting. |
232232

233233

234234

@@ -268,13 +268,13 @@ Renders a WebSocket message handler method with optional pre- and post-execution
268268

269269
| Name | Type | Description |
270270
|------|------|-------------|
271-
| props | Object | Component props. |
272-
| props.language | Language | Programming language used for method formatting. |
273-
| props.methodName | string | Name of the method to generate. |
274-
| props.methodParams | Array.<string> | List of parameters for the method. |
275-
| props.preExecutionCode | string | Code to insert before the main function logic. |
276-
| props.postExecutionCode | string | Code to insert after the main function logic. |
277-
| props.customMethodConfig | Object | Optional overrides for default method configuration. |
271+
| props | <code>Object</code> | Component props. |
272+
| props.language | <code>Language</code> | Programming language used for method formatting. |
273+
| props.methodName | <code>string</code> | Name of the method to generate. |
274+
| props.methodParams | <code>Array.&lt;string&gt;</code> | List of parameters for the method. |
275+
| props.preExecutionCode | <code>string</code> | Code to insert before the main function logic. |
276+
| props.postExecutionCode | <code>string</code> | Code to insert after the main function logic. |
277+
| props.customMethodConfig | <code>Object</code> | Optional overrides for default method configuration. |
278278

279279

280280

@@ -314,19 +314,19 @@ Generic Method rendering component.
314314

315315
| Name | Type | Description |
316316
|------|------|-------------|
317-
| props | Object | Component props. |
318-
| props.language | Language | Programming language used for method formatting. |
319-
| props.methodName | string | Name of the method. |
320-
| props.methodParams | Array.<string> | Method parameters. |
321-
| props.methodDocs | string | Optional documentation string. |
322-
| props.methodLogic | string | Core method logic. |
323-
| props.preExecutionCode | string | Code before main logic. |
324-
| props.postExecutionCode | string | Code after main logic. |
325-
| props.indent | number | Indentation for the method block. |
326-
| props.newLines | number | Number of new lines after method. |
327-
| props.customMethodConfig | Object | Optional custom syntax configuration for the current language. |
328-
| props.methodConfig | Record.<Language, ({methodDocs: (string&#124;undefined), methodLogic: (string&#124;undefined)}&#124;Record.<string, {methodDocs: (string&#124;undefined), methodLogic: (string&#124;undefined)}>)> | Language-level or framework-level configuration. |
329-
| props.framework | string | Framework name for nested configurations (e.g., &#x27;quarkus&#x27; for Java). |
317+
| props | <code>Object</code> | Component props. |
318+
| props.language | <code>Language</code> | Programming language used for method formatting. |
319+
| props.methodName | <code>string</code> | Name of the method. |
320+
| props.methodParams | <code>Array.&lt;string&gt;</code> | Method parameters. |
321+
| props.methodDocs | <code>string</code> | Optional documentation string. |
322+
| props.methodLogic | <code>string</code> | Core method logic. |
323+
| props.preExecutionCode | <code>string</code> | Code before main logic. |
324+
| props.postExecutionCode | <code>string</code> | Code after main logic. |
325+
| props.indent | <code>number</code> | Indentation for the method block. |
326+
| props.newLines | <code>number</code> | Number of new lines after method. |
327+
| props.customMethodConfig | <code>Object</code> | Optional custom syntax configuration for the current language. |
328+
| props.methodConfig | <code>Record.&lt;Language, ({methodDocs: (string&#124;undefined), methodLogic: (string&#124;undefined)}&#124;Record.&lt;string, {methodDocs: (string&#124;undefined), methodLogic: (string&#124;undefined)}&gt;)&gt;</code> | Language-level or framework-level configuration. |
329+
| props.framework | <code>string</code> | Framework name for nested configurations (e.g., &#x27;quarkus&#x27; for Java). |
330330

331331

332332

@@ -361,12 +361,12 @@ Generates and returns an array of model files based on the AsyncAPI document.
361361

362362
| Name | Type | Description |
363363
|------|------|-------------|
364-
| params | Object | The parameters for the function. |
365-
| params.asyncapi | AsyncAPIDocumentInterface | Parsed AsyncAPI document object. |
366-
| params.language | Language | Target programming language for the generated models. |
367-
| params.format | Format | Naming format for generated files. |
368-
| params.presets | object | Custom presets for the generator instance. |
369-
| params.constraints | object | Custom constraints for the generator instance. |
364+
| params | <code>Object</code> | The parameters for the function. |
365+
| params.asyncapi | <code>AsyncAPIDocumentInterface</code> | Parsed AsyncAPI document object. |
366+
| params.language | <code>Language</code> | Target programming language for the generated models. |
367+
| params.format | <code>Format</code> | Naming format for generated files. |
368+
| params.presets | <code>object</code> | Custom presets for the generator instance. |
369+
| params.constraints | <code>object</code> | Custom constraints for the generator instance. |
370370

371371

372372

@@ -407,10 +407,10 @@ Component that renders WebSocket onClose event handler for the specified program
407407

408408
| Name | Type | Description |
409409
|------|------|-------------|
410-
| props | Object | Component properties. |
411-
| props.language | Language | The programming language for which to generate onClose handler code. |
412-
| props.framework | string | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
413-
| props.title | string | The title of the WebSocket server. |
410+
| props | <code>Object</code> | Component properties. |
411+
| props.language | <code>Language</code> | The programming language for which to generate onClose handler code. |
412+
| props.framework | <code>string</code> | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
413+
| props.title | <code>string</code> | The title of the WebSocket server. |
414414

415415

416416

@@ -443,8 +443,8 @@ Component that renders WebSocket onError event handler for the specified program
443443

444444
| Name | Type | Description |
445445
|------|------|-------------|
446-
| props | Object | Component properties. |
447-
| props.language | Language | The programming language for which to generate onError handler code. |
446+
| props | <code>Object</code> | Component properties. |
447+
| props.language | <code>Language</code> | The programming language for which to generate onError handler code. |
448448

449449

450450

@@ -469,8 +469,8 @@ Component that renders WebSocket onMessage event handler for the specified progr
469469

470470
| Name | Type | Description |
471471
|------|------|-------------|
472-
| props | Object | Component properties. |
473-
| props.language | Language | The programming language for which to generate onMessage handler code. |
472+
| props | <code>Object</code> | Component properties. |
473+
| props.language | <code>Language</code> | The programming language for which to generate onMessage handler code. |
474474

475475

476476

@@ -495,10 +495,10 @@ Component that renders WebSocket onOpen event handler for the specified programm
495495

496496
| Name | Type | Description |
497497
|------|------|-------------|
498-
| props | Object | Component properties. |
499-
| props.language | Language | The programming language for which to generate onOpen handler code. |
500-
| props.framework | string | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
501-
| props.title | string | The title of the WebSocket server. |
498+
| props | <code>Object</code> | Component properties. |
499+
| props.language | <code>Language</code> | The programming language for which to generate onOpen handler code. |
500+
| props.framework | <code>string</code> | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
501+
| props.title | <code>string</code> | The title of the WebSocket server. |
502502

503503

504504

@@ -526,10 +526,10 @@ Component for rendering query parameter variables code.
526526

527527
| Name | Type | Description |
528528
|------|------|-------------|
529-
| props | Object | Component props. |
530-
| props.language | Language | The target programming language. |
531-
| props.framework | string | Optional framework for the language. |
532-
| props.queryParams | Array.<Array.<string>> | Array of query parameters, each represented as [paramName, paramType?]. |
529+
| props | <code>Object</code> | Component props. |
530+
| props.language | <code>Language</code> | The target programming language. |
531+
| props.framework | <code>string</code> | Optional framework for the language. |
532+
| props.queryParams | <code>Array.&lt;Array.&lt;string&gt;&gt;</code> | Array of query parameters, each represented as [paramName, paramType?]. |
533533

534534

535535

@@ -576,13 +576,13 @@ Renders a WebSocket error handler registration method with optional pre- and pos
576576

577577
| Name | Type | Description |
578578
|------|------|-------------|
579-
| props | Object | Component props. |
580-
| props.language | Language | Programming language used for method formatting. |
581-
| props.methodName | string | Name of the method to generate. |
582-
| props.methodParams | Array.<string> | List of parameters for the method. |
583-
| props.preExecutionCode | string | Code to insert before the main function logic. |
584-
| props.postExecutionCode | string | Code to insert after the main function logic. |
585-
| props.customMethodConfig | Object | Optional overrides for default method configuration. |
579+
| props | <code>Object</code> | Component props. |
580+
| props.language | <code>Language</code> | Programming language used for method formatting. |
581+
| props.methodName | <code>string</code> | Name of the method to generate. |
582+
| props.methodParams | <code>Array.&lt;string&gt;</code> | List of parameters for the method. |
583+
| props.preExecutionCode | <code>string</code> | Code to insert before the main function logic. |
584+
| props.postExecutionCode | <code>string</code> | Code to insert after the main function logic. |
585+
| props.customMethodConfig | <code>Object</code> | Optional overrides for default method configuration. |
586586

587587

588588

@@ -618,12 +618,12 @@ Renders a WebSocket message handler registration method with optional pre- and p
618618

619619
| Name | Type | Description |
620620
|------|------|-------------|
621-
| props | Object | Component props. |
622-
| props.language | Language | Programming language used for method formatting. |
623-
| props.methodName | string | Name of the method to generate. |
624-
| props.methodParams | Array.<string> | List of parameters for the method. |
625-
| props.preExecutionCode | string | Code to insert before the main function logic. |
626-
| props.postExecutionCode | string | Code to insert after the main function logic. |
621+
| props | <code>Object</code> | Component props. |
622+
| props.language | <code>Language</code> | Programming language used for method formatting. |
623+
| props.methodName | <code>string</code> | Name of the method to generate. |
624+
| props.methodParams | <code>Array.&lt;string&gt;</code> | List of parameters for the method. |
625+
| props.preExecutionCode | <code>string</code> | Code to insert before the main function logic. |
626+
| props.postExecutionCode | <code>string</code> | Code to insert after the main function logic. |
627627

628628

629629

@@ -659,10 +659,10 @@ Generates both static and instance methods for sending messages through WebSocke
659659

660660
| Name | Type | Description |
661661
|------|------|-------------|
662-
| props | Object | Component props. |
663-
| props.language | Language | The target programming language. |
664-
| props.sendOperations | Array.<Object> | Array of send operations from AsyncAPI document. |
665-
| props.clientName | string | The name of the client class. |
662+
| props | <code>Object</code> | Component props. |
663+
| props.language | <code>Language</code> | The target programming language. |
664+
| props.sendOperations | <code>Array.&lt;Object&gt;</code> | Array of send operations from AsyncAPI document. |
665+
| props.clientName | <code>string</code> | The name of the client class. |
666666

667667

668668

‎packages/components/jsdoc2md-handlebars/api.hbs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
| Name | Type | Description |
2929
|------|------|-------------|
3030
{{#each params}}
31-
| {{name}} | {{{escapeType type.names.[0]}}} | {{description}} |
31+
| {{name}} | <code>{{{escapeType type.names.[0]}}}</code> | {{description}} |
3232
{{/each}}
3333

3434
{{/if}}
@@ -38,7 +38,7 @@
3838
### Returns
3939

4040
{{#each returns}}
41-
- **{{escapeType type.names.[0]}}**{{#if description}} - {{description}}{{/if}}
41+
- **{{{escapeType type.names.[0]}}}**{{#if description}} - {{description}}{{/if}}
4242
{{/each}}
4343

4444
{{/if}}

‎packages/components/jsdoc2md-helpers/jsdoc-helper.js‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
module.exports = {
22
/**
33
* Escapes pipe characters in a JSDoc type string for Markdown output.
4-
* `@param` {string | null | undefined} type
5-
* `@returns` {string | null | undefined}
4+
* @param {string|null|undefined} type - Raw JSDoc type string.
5+
* @returns {string|null|undefined} Escaped string or original falsy value.
66
*/
77
escapeType: function(type) {
8-
return type ? type.replace(/\|/g, '&#124;') : type;
8+
if (!type) return type;
9+
10+
return type
11+
.replace(/&/g, '&amp;')
12+
.replace(/</g, '&lt;')
13+
.replace(/>/g, '&gt;')
14+
.replace(/\|/g, '&#124;');
915
}
1016
};

0 commit comments

Comments
 (0)