From f206b184d2be3753ec0121cad14066ea2c039cf7 Mon Sep 17 00:00:00 2001 From: fayzzzm Date: Thu, 4 Mar 2021 11:17:47 +0500 Subject: [PATCH 1/4] Removed duplicate function --- docs/scripts/buildApi.ts | 95 +------------------ .../utils/generatePropTypeDescription.ts | 13 ++- 2 files changed, 11 insertions(+), 97 deletions(-) diff --git a/docs/scripts/buildApi.ts b/docs/scripts/buildApi.ts index 223a644258f7b9..ae48fa1a71f6c6 100644 --- a/docs/scripts/buildApi.ts +++ b/docs/scripts/buildApi.ts @@ -23,6 +23,7 @@ import muiDefaultPropsHandler from 'docs/src/modules/utils/defaultPropsHandler'; import muiFindAnnotatedComponentsResolver from 'docs/src/modules/utils/findAnnotatedComponentsResolver'; import { LANGUAGES, LANGUAGES_IN_PROGRESS } from 'docs/src/modules/constants'; import parseTest from 'docs/src/modules/utils/parseTest'; +import generatePropTypeDescription, { escapeCell, isElementTypeAcceptingRefProp, isElementAcceptingRefProp} from 'docs/src/modules/utils/generatePropTypeDescription'; import { findPages, findPagesMarkdown, findComponents } from 'docs/src/modules/utils/find'; import { getHeaders, @@ -109,100 +110,6 @@ function getChained(type: PropTypeDescriptor): false | PropDescriptor { return false; } -function escapeCell(value: string): string { - // As the pipe is use for the table structure - return value.replace(/ { - const subType = type.value[subValue]; - return `${subValue}${subType.required ? '' : '?'}: ${generatePropTypeDescription( - subType, - )}`; - }) - .join(', ')} }`; - - case 'union': - return ( - type.value - .map((type2) => { - return generatePropTypeDescription(type2); - }) - // Display one value per line as it's better for visibility. - .join('
| ') - ); - case 'enum': - return ( - type.value - .map((type2) => { - return escapeCell(type2.value); - }) - // Display one value per line as it's better for visibility. - .join('
| ') - ); - - case 'arrayOf': { - return `Array<${generatePropTypeDescription(type.value)}>`; - } - - case 'instanceOf': { - if (type.value.startsWith('typeof')) { - return /typeof (.*) ===/.exec(type.value)![1]; - } - return type.value; - } - - default: - return type.name; - } -} - /** * Returns `null` if the prop should be ignored. * Throws if it is invalid. diff --git a/docs/src/modules/utils/generatePropTypeDescription.ts b/docs/src/modules/utils/generatePropTypeDescription.ts index 28297de96f5588..a4571b04d4cdd3 100644 --- a/docs/src/modules/utils/generatePropTypeDescription.ts +++ b/docs/src/modules/utils/generatePropTypeDescription.ts @@ -47,12 +47,16 @@ function getChained(type: PropTypeDescriptor) { return false; } -function escapeCell(value: string): string { +export function escapeCell(value: string): string { // As the pipe is use for the table structure return value.replace(/ Date: Thu, 4 Mar 2021 18:47:04 +0100 Subject: [PATCH 2/4] yarn prettier --- docs/scripts/buildApi.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/scripts/buildApi.ts b/docs/scripts/buildApi.ts index ae48fa1a71f6c6..340c966e43dac9 100644 --- a/docs/scripts/buildApi.ts +++ b/docs/scripts/buildApi.ts @@ -23,7 +23,11 @@ import muiDefaultPropsHandler from 'docs/src/modules/utils/defaultPropsHandler'; import muiFindAnnotatedComponentsResolver from 'docs/src/modules/utils/findAnnotatedComponentsResolver'; import { LANGUAGES, LANGUAGES_IN_PROGRESS } from 'docs/src/modules/constants'; import parseTest from 'docs/src/modules/utils/parseTest'; -import generatePropTypeDescription, { escapeCell, isElementTypeAcceptingRefProp, isElementAcceptingRefProp} from 'docs/src/modules/utils/generatePropTypeDescription'; +import generatePropTypeDescription, { + escapeCell, + isElementTypeAcceptingRefProp, + isElementAcceptingRefProp, +} from 'docs/src/modules/utils/generatePropTypeDescription'; import { findPages, findPagesMarkdown, findComponents } from 'docs/src/modules/utils/find'; import { getHeaders, From 7b5b3ff12658a0d0ff73c0ed38d7bf7d709c7afe Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Thu, 4 Mar 2021 18:47:31 +0100 Subject: [PATCH 3/4] these changes are off-topic --- docs/src/modules/utils/generatePropTypeDescription.ts | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/src/modules/utils/generatePropTypeDescription.ts b/docs/src/modules/utils/generatePropTypeDescription.ts index a4571b04d4cdd3..dab7581776cb1a 100644 --- a/docs/src/modules/utils/generatePropTypeDescription.ts +++ b/docs/src/modules/utils/generatePropTypeDescription.ts @@ -52,10 +52,6 @@ export function escapeCell(value: string): string { return value.replace(/ Date: Thu, 4 Mar 2021 18:52:59 +0100 Subject: [PATCH 4/4] simple quote --- docs/src/modules/utils/generatePropTypeDescription.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/modules/utils/generatePropTypeDescription.ts b/docs/src/modules/utils/generatePropTypeDescription.ts index dab7581776cb1a..2a60c985ab927c 100644 --- a/docs/src/modules/utils/generatePropTypeDescription.ts +++ b/docs/src/modules/utils/generatePropTypeDescription.ts @@ -68,16 +68,16 @@ export default function generatePropTypeDescription(type: PropTypeDescriptor): s switch (type.name) { case 'custom': { if (isElementTypeAcceptingRefProp(type)) { - return `element type`; + return 'element type'; } if (isElementAcceptingRefProp(type)) { - return `element`; + return 'element'; } if (isRefType(type)) { - return `ref`; + return 'ref'; } if (type.raw === 'HTMLElementType') { - return `HTML element`; + return 'HTML element'; } const deprecatedInfo = getDeprecatedInfo(type);