Skip to content

Commit 7a548eb

Browse files
MichelSimonottmcw
MichelSimonot
authored and
tmcw
committed
fix(html): Display all levels of parameter properties. (#933)
Fix default_theme to render all parameter properties. - Split the parameter property template portion into its own partial. - Have the new partial recursively call itself if there are sub-properties.
1 parent e203df5 commit 7a548eb

File tree

8 files changed

+284
-34
lines changed

8 files changed

+284
-34
lines changed

‎__tests__/__snapshots__/bin.js.snap‎

Lines changed: 119 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,12 @@ exports[`--config 1`] = `
9797
#withOptions
9898
</a></li>
9999
100+
<li><a
101+
href='#klasswithdeepoptions'
102+
class='regular pre-open'>
103+
#withDeepOptions
104+
</a></li>
105+
100106
</ul>
101107
102108
@@ -773,16 +779,20 @@ k.isArrayOfBuffers();</pre>
773779
<tbody class='mt1'>
774780
775781
<tr>
776-
<td class='break-word'><span class='code bold'>options.foo</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\\">string</a></code>
777-
</td>
778-
<td class='break-word'><span></span></td>
779-
</tr>
782+
<td class='break-word'><span class='code bold'>options.foo</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\\">string</a></code>
783+
</td>
784+
<td class='break-word'><span></span></td>
785+
</tr>
786+
787+
780788
781789
<tr>
782-
<td class='break-word'><span class='code bold'>options.bar</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number\\">number</a></code>
783-
</td>
784-
<td class='break-word'><span></span></td>
785-
</tr>
790+
<td class='break-word'><span class='code bold'>options.bar</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number\\">number</a></code>
791+
</td>
792+
<td class='break-word'><span></span></td>
793+
</tr>
794+
795+
786796
787797
</tbody>
788798
</table>
@@ -813,6 +823,107 @@ k.isArrayOfBuffers();</pre>
813823
814824
815825
826+
</section>
827+
828+
</div>
829+
</div>
830+
831+
<div class='border-bottom' id='klasswithdeepoptions'>
832+
<div class=\\"clearfix small pointer toggle-sibling\\">
833+
<div class=\\"py1 contain\\">
834+
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
835+
<span class='code strong strong truncate'>withDeepOptions(options)</span>
836+
</div>
837+
</div>
838+
<div class=\\"clearfix display-none toggle-target\\">
839+
<section class='p2 mb2 clearfix bg-white minishadow'>
840+
841+
842+
843+
<p>A function with a deep options parameter</p>
844+
845+
846+
<div class='pre p1 fill-light mt0'>withDeepOptions(options: <a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\\">Object</a>)</div>
847+
848+
849+
850+
851+
852+
853+
854+
855+
856+
857+
858+
<div class='py1 quiet mt1 prose-big'>Parameters</div>
859+
<div class='prose'>
860+
861+
<div class='space-bottom0'>
862+
<div>
863+
<span class='code bold'>options</span> <code class='quiet'>(<a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\\">Object</a>)</code>
864+
865+
</div>
866+
867+
<table class='mt1 mb2 fixed-table h5 col-12'>
868+
<colgroup>
869+
<col width='30%' />
870+
<col width='70%' />
871+
</colgroup>
872+
<thead>
873+
<tr class='bold fill-light'>
874+
<th>Name</th>
875+
<th>Description</th>
876+
</tr>
877+
</thead>
878+
<tbody class='mt1'>
879+
880+
<tr>
881+
<td class='break-word'><span class='code bold'>options.foo</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\\">string</a></code>
882+
</td>
883+
<td class='break-word'><span></span></td>
884+
</tr>
885+
886+
887+
888+
<tr>
889+
<td class='break-word'><span class='code bold'>options.bar</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\\">Object</a></code>
890+
</td>
891+
<td class='break-word'><span></span></td>
892+
</tr>
893+
894+
895+
<tr>
896+
<td class='break-word'><span class='code bold'>options.bar.buz</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\\">string</a></code>
897+
</td>
898+
<td class='break-word'><span></span></td>
899+
</tr>
900+
901+
902+
903+
904+
905+
906+
</tbody>
907+
</table>
908+
909+
</div>
910+
911+
</div>
912+
913+
914+
915+
916+
917+
918+
919+
920+
921+
922+
923+
924+
925+
926+
816927
</section>
817928
818929
</div>

‎__tests__/__snapshots__/test.js.snap‎

Lines changed: 119 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -890,6 +890,12 @@ exports[`html nested.input.js 1`] = `
890890
#withOptions
891891
</a></li>
892892

893+
<li><a
894+
href='#klasswithdeepoptions'
895+
class='regular pre-open'>
896+
#withDeepOptions
897+
</a></li>
898+
893899
</ul>
894900

895901

@@ -1538,16 +1544,20 @@ k.isArrayOfBuffers();</pre>
15381544
<tbody class='mt1'>
15391545

15401546
<tr>
1541-
<td class='break-word'><span class='code bold'>options.foo</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\\">string</a></code>
1542-
</td>
1543-
<td class='break-word'><span></span></td>
1544-
</tr>
1547+
<td class='break-word'><span class='code bold'>options.foo</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\\">string</a></code>
1548+
</td>
1549+
<td class='break-word'><span></span></td>
1550+
</tr>
1551+
1552+
15451553

15461554
<tr>
1547-
<td class='break-word'><span class='code bold'>options.bar</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number\\">number</a></code>
1548-
</td>
1549-
<td class='break-word'><span></span></td>
1550-
</tr>
1555+
<td class='break-word'><span class='code bold'>options.bar</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number\\">number</a></code>
1556+
</td>
1557+
<td class='break-word'><span></span></td>
1558+
</tr>
1559+
1560+
15511561

15521562
</tbody>
15531563
</table>
@@ -1578,6 +1588,107 @@ k.isArrayOfBuffers();</pre>
15781588

15791589

15801590

1591+
</section>
1592+
1593+
</div>
1594+
</div>
1595+
1596+
<div class='border-bottom' id='klasswithdeepoptions'>
1597+
<div class=\\"clearfix small pointer toggle-sibling\\">
1598+
<div class=\\"py1 contain\\">
1599+
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
1600+
<span class='code strong strong truncate'>withDeepOptions(options)</span>
1601+
</div>
1602+
</div>
1603+
<div class=\\"clearfix display-none toggle-target\\">
1604+
<section class='p2 mb2 clearfix bg-white minishadow'>
1605+
1606+
1607+
1608+
<p>A function with a deep options parameter</p>
1609+
1610+
1611+
<div class='pre p1 fill-light mt0'>withDeepOptions(options: <a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\\">Object</a>)</div>
1612+
1613+
1614+
1615+
1616+
1617+
1618+
1619+
1620+
1621+
1622+
1623+
<div class='py1 quiet mt1 prose-big'>Parameters</div>
1624+
<div class='prose'>
1625+
1626+
<div class='space-bottom0'>
1627+
<div>
1628+
<span class='code bold'>options</span> <code class='quiet'>(<a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\\">Object</a>)</code>
1629+
1630+
</div>
1631+
1632+
<table class='mt1 mb2 fixed-table h5 col-12'>
1633+
<colgroup>
1634+
<col width='30%' />
1635+
<col width='70%' />
1636+
</colgroup>
1637+
<thead>
1638+
<tr class='bold fill-light'>
1639+
<th>Name</th>
1640+
<th>Description</th>
1641+
</tr>
1642+
</thead>
1643+
<tbody class='mt1'>
1644+
1645+
<tr>
1646+
<td class='break-word'><span class='code bold'>options.foo</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\\">string</a></code>
1647+
</td>
1648+
<td class='break-word'><span></span></td>
1649+
</tr>
1650+
1651+
1652+
1653+
<tr>
1654+
<td class='break-word'><span class='code bold'>options.bar</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\\">Object</a></code>
1655+
</td>
1656+
<td class='break-word'><span></span></td>
1657+
</tr>
1658+
1659+
1660+
<tr>
1661+
<td class='break-word'><span class='code bold'>options.bar.buz</span> <code class='quiet'><a href=\\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\\">string</a></code>
1662+
</td>
1663+
<td class='break-word'><span></span></td>
1664+
</tr>
1665+
1666+
1667+
1668+
1669+
1670+
1671+
</tbody>
1672+
</table>
1673+
1674+
</div>
1675+
1676+
</div>
1677+
1678+
1679+
1680+
1681+
1682+
1683+
1684+
1685+
1686+
1687+
1688+
1689+
1690+
1691+
15811692
</section>
15821693

15831694
</div>

‎__tests__/fixture/html/nested.input.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ Klass.prototype.getFoo = function() {
2626
*/
2727
Klass.prototype.withOptions = function(options, otherOptions) {};
2828

29+
/**
30+
* A function with a deep options parameter
31+
* @param {Object} options
32+
* @param {string} options.foo
33+
* @param {Object} options.bar
34+
* @param {string} options.bar.buz
35+
*/
36+
Klass.prototype.withDeepOptions = function(options) {};
37+
2938
/**
3039
* @typedef CustomError
3140
* @name CustomError

‎src/default_theme/index._‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@
9797
<%= renderSection({
9898
section: s,
9999
renderSection: renderSection,
100-
renderSectionList: renderSectionList
100+
renderSectionList: renderSectionList,
101+
renderParamProperty: renderParamProperty
101102
}) %>
102103
<% } else { %>
103104
<div class='keyline-top-not py2'><%=renderNote({ note: s })%></div>

‎src/default_theme/index.js‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,13 @@ module.exports = function(
2222
comments: Array<Comment>,
2323
config: DocumentationConfig
2424
) {
25-
var linkerStack = new LinkerStack(
26-
config
27-
).namespaceResolver(comments, function(namespace) {
28-
var slugger = new GithubSlugger();
29-
return '#' + slugger.slug(namespace);
30-
});
25+
var linkerStack = new LinkerStack(config).namespaceResolver(
26+
comments,
27+
function(namespace) {
28+
var slugger = new GithubSlugger();
29+
return '#' + slugger.slug(namespace);
30+
}
31+
);
3132

3233
var formatters = createFormatters(linkerStack.link);
3334

@@ -98,6 +99,10 @@ module.exports = function(
9899
fs.readFileSync(path.join(__dirname, 'note._'), 'utf8'),
99100
sharedImports
100101
);
102+
sharedImports.imports.renderParamProperty = _.template(
103+
fs.readFileSync(path.join(__dirname, 'paramProperty._'), 'utf8'),
104+
sharedImports
105+
);
101106

102107
var pageTemplate = _.template(
103108
fs.readFileSync(path.join(__dirname, 'index._'), 'utf8'),

‎src/default_theme/paramProperty._‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<tr>
2+
<td class='break-word'><span class='code bold'><%- property.name %></span> <code class='quiet'><%= formatType(property.type) %></code>
3+
<% if (property.default) { %>
4+
(default <code><%- property.default %></code>)
5+
<% } %></td>
6+
<td class='break-word'><span><%= md(property.description, true) %></span></td>
7+
</tr>
8+
<% if(property.properties && property.properties.length) { %>
9+
<% property.properties.forEach(function(childProperty) { %>
10+
<%= renderParamProperty({
11+
property: childProperty,
12+
renderParamProperty: renderParamProperty
13+
}) %>
14+
<% }) %>
15+
<% } %>

0 commit comments

Comments
 (0)