Skip to content

Commit 759e267

Browse files
committed
build: update API generator
1 parent 78fe80c commit 759e267

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

packages/docs/build/.eslintrc.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
},
99
"extends": "./../../../.eslintrc.js",
1010
"rules": {
11+
"@typescript-eslint/no-var-requires": "off",
1112
"no-console": "off",
1213
"strict": "error"
14+
1315
}
1416
}

packages/docs/build/api.js

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
#!/usr/bin/env node
2-
/* eslint-disable @typescript-eslint/no-var-requires */
32
'use strict'
43

54
const docgen = require('react-docgen-typescript')
@@ -46,12 +45,8 @@ import ${name} from '@coreui${relativeFilename.replace('.tsx', '')}'
4645
typeof value.tags.ignore === 'undefined'
4746
) {
4847
let name = value.name || ''
49-
const since = value.tags.since
50-
? ` <br/><div class="badge bg-primary">${value.tags.since}+</div>`
51-
: ''
52-
const deprecated = value.tags.deprecated
53-
? ` <br/><div class="badge bg-warning">Deprecated ${value.tags.deprecated}+</div>`
54-
: ''
48+
const since = value.tags.since ? ` **_${value.tags.since}+_**` : ''
49+
const deprecated = value.tags.deprecated ? ` **_Deprecated ${value.tags.deprecated}+_**` : ''
5550
const description =
5651
value.description.replaceAll('\n', '<br/>').replaceAll(' [docs]', '') || '-'
5752
const type = value.type
@@ -67,9 +62,18 @@ import ${name} from '@coreui${relativeFilename.replace('.tsx', '')}'
6762
types.push(`\`${element.replace(/"/g, "'")}\``)
6863
})
6964

70-
content += `| **${name}**${since}${deprecated} | ${description} | ${types.join(
65+
const replace = (text) =>
66+
text
67+
.replaceAll('\n', '<br/>')
68+
.replaceAll('{', '{')
69+
.replaceAll('}', '}')
70+
.replaceAll('(', '(')
71+
.replaceAll(')', ')')
72+
.replaceAll('@', '@')
73+
74+
content += `| **${name}**${since}${deprecated} | ${replace(description)} | ${types.join(
7175
' \\| ',
72-
)} | ${defaultValue.replaceAll('\n', '<br/>')} |\n`
76+
)} | ${replace(defaultValue)} |\n`
7377
console.log(`${filename} - ${key}`)
7478
}
7579
}

packages/docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
"gatsby-source-filesystem": "^5.4.0",
4848
"gatsby-transformer-sharp": "^5.4.0",
4949
"glob": "^7.2.0",
50-
"globby": "^11.0.4",
50+
"globby": "^11.1.0",
5151
"prism-react-renderer": "^1.3.5",
5252
"prismjs": "^1.27.0",
5353
"prop-types": "^15.8.1",

0 commit comments

Comments
 (0)