Skip to content

Commit 0982164

Browse files
committed
build: update API generator
1 parent d3dc38d commit 0982164

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

packages/docs/build/api.js

+12-3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ const EXCLUDED_FILES = []
1919

2020
const options = {
2121
savePropValueAsString: true,
22+
shouldIncludePropTagMap: true,
2223
}
2324

2425
const PRO_COMPONENTS = []
@@ -43,9 +44,15 @@ import ${name} from '@coreui${relativeFilename.replace('.tsx', '')}'
4344
for (const [key, value] of Object.entries(props).sort()) {
4445
if (
4546
!value.parent.fileName.includes('@types/react/index.d.ts') &&
46-
!value['description'].includes('@ignore')
47+
typeof value.tags.ignore === 'undefined'
4748
) {
48-
const name = value.name || ''
49+
let name = value.name || ''
50+
const since = value.tags.since
51+
? ` <br/><div class="badge bg-primary">${value.tags.since}+</div>`
52+
: ''
53+
const deprecated = value.tags.deprecated
54+
? ` <br/><div class="badge bg-warning">Deprecated ${value.tags.deprecated}+</div>`
55+
: ''
4956
const description =
5057
value.description.replaceAll('\n', '<br/>').replaceAll(' [docs]', '') || '-'
5158
const type = value.type
@@ -61,7 +68,9 @@ import ${name} from '@coreui${relativeFilename.replace('.tsx', '')}'
6168
types.push(`\`${element.replace(/"/g, "'")}\``)
6269
})
6370

64-
content += `| **${name}** | ${description} | ${types.join(' \\| ')} | ${defaultValue.replaceAll('\n', '<br/>')} |\n`
71+
content += `| **${name}**${since}${deprecated} | ${description} | ${types.join(
72+
' \\| ',
73+
)} | ${defaultValue.replaceAll('\n', '<br/>')} |\n`
6574
console.log(`${filename} - ${key}`)
6675
}
6776
}

0 commit comments

Comments
 (0)