Skip to content

Commit f1f3789

Browse files
JeanMechethePunderWoman
authored andcommitted
docs(docs-infra): display CLI enum values for enums (angular#61521)
fixes angular#61516 PR Close angular#61521
1 parent 69de729 commit f1f3789

File tree

3 files changed

+20
-3
lines changed

3 files changed

+20
-3
lines changed

adev/shared-docs/pipeline/api-gen/rendering/cli-entities.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ export interface CliCommand {
2323
export interface CliOption {
2424
name: string;
2525
type: 'boolean' | 'string' | 'number';
26+
enum: string[] | undefined;
2627
default: string;
2728
description: string;
2829
positional?: number;

adev/shared-docs/pipeline/api-gen/rendering/templates/cli-card.tsx

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,25 @@ export function CliCard(props: {card: CliCardRenderable}) {
3131
<div dangerouslySetInnerHTML={{__html: item.description}}></div>
3232
</div>
3333
<div class="docs-reference-type-and-default">
34-
<span>Value Type</span>
35-
<code>{item.type}</code>
34+
{/* Display the enum values if there are some, else the type expected for the option */}
35+
{item.enum ? (
36+
<>
37+
<span>Allowed Values</span>
38+
<span>
39+
{item.enum.map((val, i, items) => (
40+
<>
41+
<code>{val}</code>
42+
{i < items.length - 1 && ', '}
43+
</>
44+
))}
45+
</span>
46+
</>
47+
) : (
48+
<>
49+
<span>Value Type</span>
50+
<code>{item.type}</code>
51+
</>
52+
)}
3653
{/* Default Value */}
3754
{item.default !== undefined ? <span>Default</span> : <></>}
3855
{props.card.type === 'Options' && item.default !== undefined ? (

adev/shared-docs/styles/_reference.scss

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,6 @@
381381
}
382382

383383
.docs-reference-type-and-default {
384-
width: 4.375rem;
385384
flex-shrink: 0;
386385

387386
span {

0 commit comments

Comments
 (0)