From 6efd2925487e7d65ca75ff38ce4f742be570e39d Mon Sep 17 00:00:00 2001 From: Daniel Leroux Date: Thu, 27 Feb 2025 16:00:20 +0100 Subject: [PATCH] migrate introduction sentances --- packages/core/component-doc.json | 2 +- .../docs/components/about-and-legal/index.mdx | 2 +- .../components/application-header/index.mdx | 2 +- .../components/application-menu/index.mdx | 2 +- .../docs/components/application/index.mdx | 2 +- .../docs/components/avatar/index.mdx | 2 +- .../components/basic-navigation/index.mdx | 2 +- .../docs/components/blind/index.mdx | 2 +- .../docs/components/breadcrumb/index.mdx | 2 +- .../docs/components/button/index.mdx | 2 +- .../docs/components/card-list/index.mdx | 2 +- .../docs/components/card/index.mdx | 2 +- .../docs/components/category-filter/index.mdx | 2 +- .../docs/components/checkbox/index.mdx | 2 +- .../docs/components/chip/index.mdx | 2 +- .../docs/components/content-header/index.mdx | 2 +- .../docs/components/content/index.mdx | 2 +- .../docs/components/custom-field/index.mdx | 2 +- .../docs/components/dropdown-button/index.mdx | 2 +- .../docs/components/dropdown/index.mdx | 2 +- .../docs/components/icon-button/index.mdx | 2 +- .../docs/components/input-date/index.mdx | 2 +- .../docs/components/input-number/index.mdx | 2 +- .../docs/components/input/index.mdx | 2 +- .../docs/components/layout-grid/index.mdx | 2 +- .../docs/components/link-button/index.mdx | 2 +- .../docs/components/map-navigation/index.mdx | 2 +- .../docs/components/panes/index.mdx | 2 +- .../docs/components/pill/index.mdx | 2 +- .../docs/components/popover-news/index.mdx | 2 +- .../docs/components/radio/index.mdx | 2 +- .../docs/components/select/index.mdx | 2 +- .../docs/components/settings/index.mdx | 2 +- .../docs/components/split-button/index.mdx | 2 +- .../docs/components/textarea/index.mdx | 2 +- .../docs/components/toggle-button/index.mdx | 2 +- .../documentation-redesign/scripts/migrate.ts | 70 ++++++++++++++----- 37 files changed, 89 insertions(+), 53 deletions(-) diff --git a/packages/core/component-doc.json b/packages/core/component-doc.json index 3d4abd52a16..38ec9ad6778 100644 --- a/packages/core/component-doc.json +++ b/packages/core/component-doc.json @@ -15459,7 +15459,7 @@ "mutable": false, "attr": "item-count", "reflectToAttr": false, - "docs": "Number of items shown at once.\nCan only be changed in advaced mode.", + "docs": "Number of items shown at once.\nCan only be changed in advanced mode.", "docsTags": [], "default": "15", "values": [ diff --git a/packages/documentation-redesign/docs/components/about-and-legal/index.mdx b/packages/documentation-redesign/docs/components/about-and-legal/index.mdx index 42d63908f8a..d2a44384d25 100644 --- a/packages/documentation-redesign/docs/components/about-and-legal/index.mdx +++ b/packages/documentation-redesign/docs/components/about-and-legal/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'The about and legal overlay displays application information, versions, license terms and other legal content.' title: 'About and legal' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/application-header/index.mdx b/packages/documentation-redesign/docs/components/application-header/index.mdx index f6b26825fbc..5258c0fe26f 100644 --- a/packages/documentation-redesign/docs/components/application-header/index.mdx +++ b/packages/documentation-redesign/docs/components/application-header/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Application headers provide a structured area for key elements like brand logo, application name and user avatar.' title: 'Application header' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/application-menu/index.mdx b/packages/documentation-redesign/docs/components/application-menu/index.mdx index 70f87f1ca15..c57f9161857 100644 --- a/packages/documentation-redesign/docs/components/application-menu/index.mdx +++ b/packages/documentation-redesign/docs/components/application-menu/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'The navigation menu provides direct access to main application parts, legal and version information, and settings.' title: 'Application menu' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/application/index.mdx b/packages/documentation-redesign/docs/components/application/index.mdx index eb61677f74c..3c88305173f 100644 --- a/packages/documentation-redesign/docs/components/application/index.mdx +++ b/packages/documentation-redesign/docs/components/application/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Applications manage the layout and theming of top-level app elements, ensuring a cohesive user experience.' title: 'Application' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/avatar/index.mdx b/packages/documentation-redesign/docs/components/avatar/index.mdx index 825304f5ff3..9b5ead1e3c0 100644 --- a/packages/documentation-redesign/docs/components/avatar/index.mdx +++ b/packages/documentation-redesign/docs/components/avatar/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Avatars visually or textually represent individual identities, typically for users logged into a system.' title: 'Avatar' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/basic-navigation/index.mdx b/packages/documentation-redesign/docs/components/basic-navigation/index.mdx index b16382268a4..d9ffbc284c0 100644 --- a/packages/documentation-redesign/docs/components/basic-navigation/index.mdx +++ b/packages/documentation-redesign/docs/components/basic-navigation/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Basic navigation combines essential infrastructure components to form the foundational layout structure of an application.' title: 'Basic navigation' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/blind/index.mdx b/packages/documentation-redesign/docs/components/blind/index.mdx index 9251e451769..139b0db90f1 100644 --- a/packages/documentation-redesign/docs/components/blind/index.mdx +++ b/packages/documentation-redesign/docs/components/blind/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Blinds enhance content organization by allowing users to toggle visibility through collapsing and expanding sections.' title: 'Blind' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/breadcrumb/index.mdx b/packages/documentation-redesign/docs/components/breadcrumb/index.mdx index 109bd44d502..470699a626a 100644 --- a/packages/documentation-redesign/docs/components/breadcrumb/index.mdx +++ b/packages/documentation-redesign/docs/components/breadcrumb/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Breadcrumbs provide a clear navigation path within an application.' title: 'Breadcrumb' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/button/index.mdx b/packages/documentation-redesign/docs/components/button/index.mdx index 04024b3bdca..ef8d8bc8867 100644 --- a/packages/documentation-redesign/docs/components/button/index.mdx +++ b/packages/documentation-redesign/docs/components/button/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Buttons facilitate user interactions by initiating actions and applying functions within an application.' title: 'Button' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/card-list/index.mdx b/packages/documentation-redesign/docs/components/card-list/index.mdx index de1a4bdad5c..c0531cfb227 100644 --- a/packages/documentation-redesign/docs/components/card-list/index.mdx +++ b/packages/documentation-redesign/docs/components/card-list/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Card lists display a large number of cards or items of the same type in a lightweight, grouped manner.' title: 'Card list' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/card/index.mdx b/packages/documentation-redesign/docs/components/card/index.mdx index fe5eab8052e..f34b16d2a47 100644 --- a/packages/documentation-redesign/docs/components/card/index.mdx +++ b/packages/documentation-redesign/docs/components/card/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Cards neatly organize and group related information about a specific subject.' title: 'Card' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/category-filter/index.mdx b/packages/documentation-redesign/docs/components/category-filter/index.mdx index 072f9876850..6862e2644a6 100644 --- a/packages/documentation-redesign/docs/components/category-filter/index.mdx +++ b/packages/documentation-redesign/docs/components/category-filter/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Category filters allow users to quickly narrow their search by selecting predefined categories.' title: 'Category filter' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/checkbox/index.mdx b/packages/documentation-redesign/docs/components/checkbox/index.mdx index f1c568cf022..074565fb949 100644 --- a/packages/documentation-redesign/docs/components/checkbox/index.mdx +++ b/packages/documentation-redesign/docs/components/checkbox/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Checkboxes are form controls that allow users to select none, one or more options.' title: 'Checkbox' deprecated: - /docs/legacy/checkbox diff --git a/packages/documentation-redesign/docs/components/chip/index.mdx b/packages/documentation-redesign/docs/components/chip/index.mdx index 81039c51100..042ae2b1f22 100644 --- a/packages/documentation-redesign/docs/components/chip/index.mdx +++ b/packages/documentation-redesign/docs/components/chip/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Chips display small pieces of information in a compact and visually appealing way.' title: 'Chip' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/content-header/index.mdx b/packages/documentation-redesign/docs/components/content-header/index.mdx index e383c6f9c74..d60aa79074e 100644 --- a/packages/documentation-redesign/docs/components/content-header/index.mdx +++ b/packages/documentation-redesign/docs/components/content-header/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Content headers provide a brief overview of the content on a page. ' title: 'Content header' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/content/index.mdx b/packages/documentation-redesign/docs/components/content/index.mdx index 4a7f70e5d56..6839a08e8e1 100644 --- a/packages/documentation-redesign/docs/components/content/index.mdx +++ b/packages/documentation-redesign/docs/components/content/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'The content component is a simple layout component made for hosting content.' title: 'Content' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/custom-field/index.mdx b/packages/documentation-redesign/docs/components/custom-field/index.mdx index 390591520cd..9ec37feb6bb 100644 --- a/packages/documentation-redesign/docs/components/custom-field/index.mdx +++ b/packages/documentation-redesign/docs/components/custom-field/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Custom fields are wrapper components that can host any form component.' title: 'Custom field' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/dropdown-button/index.mdx b/packages/documentation-redesign/docs/components/dropdown-button/index.mdx index cb578300b8e..e61fd67ca29 100644 --- a/packages/documentation-redesign/docs/components/dropdown-button/index.mdx +++ b/packages/documentation-redesign/docs/components/dropdown-button/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Dropdown buttons reveal a list of actions when selected.' title: 'Dropdown button' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/dropdown/index.mdx b/packages/documentation-redesign/docs/components/dropdown/index.mdx index cb990ac72e5..38edbbb1def 100644 --- a/packages/documentation-redesign/docs/components/dropdown/index.mdx +++ b/packages/documentation-redesign/docs/components/dropdown/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Dropdown containers display a menu with additional items when users click on the trigger element, e.g. a dropdown button.' title: 'Dropdown' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/icon-button/index.mdx b/packages/documentation-redesign/docs/components/icon-button/index.mdx index 8fc255aaa5c..1d5472cc875 100644 --- a/packages/documentation-redesign/docs/components/icon-button/index.mdx +++ b/packages/documentation-redesign/docs/components/icon-button/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Icon buttons use only icons to represent actions, making them ideal for space-constrained layouts.' title: 'Icon button' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/input-date/index.mdx b/packages/documentation-redesign/docs/components/input-date/index.mdx index ddd13922f85..85a9600dcc9 100644 --- a/packages/documentation-redesign/docs/components/input-date/index.mdx +++ b/packages/documentation-redesign/docs/components/input-date/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Date inputs allow users to enter and select dates in a standardized format, ensuring consistency and accuracy.' title: 'Input date' deprecated: - /docs/legacy/input diff --git a/packages/documentation-redesign/docs/components/input-number/index.mdx b/packages/documentation-redesign/docs/components/input-number/index.mdx index 79ac1939de3..27e6a56846c 100644 --- a/packages/documentation-redesign/docs/components/input-number/index.mdx +++ b/packages/documentation-redesign/docs/components/input-number/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Number inputs allow users to enter and adjust numerical values.' title: 'Input number' deprecated: - /docs/legacy/input diff --git a/packages/documentation-redesign/docs/components/input/index.mdx b/packages/documentation-redesign/docs/components/input/index.mdx index 9380fe505a6..58d8b7ad22e 100644 --- a/packages/documentation-redesign/docs/components/input/index.mdx +++ b/packages/documentation-redesign/docs/components/input/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Input fields allow users to enter and edit single-line text, numbers, and other character-based symbols within an application.' title: 'Input' deprecated: - /docs/legacy/input diff --git a/packages/documentation-redesign/docs/components/layout-grid/index.mdx b/packages/documentation-redesign/docs/components/layout-grid/index.mdx index 2678e1036e1..8c9b33de37d 100644 --- a/packages/documentation-redesign/docs/components/layout-grid/index.mdx +++ b/packages/documentation-redesign/docs/components/layout-grid/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Layout grids are used to structure the layout of a page or screen responsively.' title: 'Layout grid' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/link-button/index.mdx b/packages/documentation-redesign/docs/components/link-button/index.mdx index 08d2f68f67a..2478f3ecfbc 100644 --- a/packages/documentation-redesign/docs/components/link-button/index.mdx +++ b/packages/documentation-redesign/docs/components/link-button/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Link buttons take users to another location either within or outside the application and contain a chevron and a text label.' title: 'Link button' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/map-navigation/index.mdx b/packages/documentation-redesign/docs/components/map-navigation/index.mdx index e4b6275006a..7e19fee5a45 100644 --- a/packages/documentation-redesign/docs/components/map-navigation/index.mdx +++ b/packages/documentation-redesign/docs/components/map-navigation/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Map navigation layout structures present map-like content, supported by a collapsible context panel and temporary overlays.' title: 'Map navigation' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/panes/index.mdx b/packages/documentation-redesign/docs/components/panes/index.mdx index 26e09d64a5a..8d8d1237222 100644 --- a/packages/documentation-redesign/docs/components/panes/index.mdx +++ b/packages/documentation-redesign/docs/components/panes/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Panes are interactive components that allow users to access content that isn't constantly visible on the screen.' title: 'Panes' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/pill/index.mdx b/packages/documentation-redesign/docs/components/pill/index.mdx index 829cbff3850..b88c90d5b64 100644 --- a/packages/documentation-redesign/docs/components/pill/index.mdx +++ b/packages/documentation-redesign/docs/components/pill/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Pills display small pieces of information, e.g. counters or statuses.' title: 'Pill' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/popover-news/index.mdx b/packages/documentation-redesign/docs/components/popover-news/index.mdx index b76642f981a..150c6dc4a29 100644 --- a/packages/documentation-redesign/docs/components/popover-news/index.mdx +++ b/packages/documentation-redesign/docs/components/popover-news/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Popover news presents important updates and information when the application starts.' title: 'Popover news' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/radio/index.mdx b/packages/documentation-redesign/docs/components/radio/index.mdx index e0b4c57df82..5e5554b9249 100644 --- a/packages/documentation-redesign/docs/components/radio/index.mdx +++ b/packages/documentation-redesign/docs/components/radio/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Radio buttons enable users to choose only one option from a predefined set of mutually exclusive options. ' title: 'Radio' deprecated: - /docs/legacy/radiobutton diff --git a/packages/documentation-redesign/docs/components/select/index.mdx b/packages/documentation-redesign/docs/components/select/index.mdx index 93610bd2e0e..31920e04d80 100644 --- a/packages/documentation-redesign/docs/components/select/index.mdx +++ b/packages/documentation-redesign/docs/components/select/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Selects allow users to choose from a list of options.' title: 'Select' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/settings/index.mdx b/packages/documentation-redesign/docs/components/settings/index.mdx index c07f57fb76c..cb804295223 100644 --- a/packages/documentation-redesign/docs/components/settings/index.mdx +++ b/packages/documentation-redesign/docs/components/settings/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'The settings overlay provides a centralized location for application settings.' title: 'Settings' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/split-button/index.mdx b/packages/documentation-redesign/docs/components/split-button/index.mdx index 580db494b2b..5bf39738017 100644 --- a/packages/documentation-redesign/docs/components/split-button/index.mdx +++ b/packages/documentation-redesign/docs/components/split-button/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Split buttons are button elements that allow users to either trigger an action with one click or select an action from a list of options.' title: 'Split button' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/docs/components/textarea/index.mdx b/packages/documentation-redesign/docs/components/textarea/index.mdx index 2406038bbb3..66ee056dc3c 100644 --- a/packages/documentation-redesign/docs/components/textarea/index.mdx +++ b/packages/documentation-redesign/docs/components/textarea/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Textareas allow users to enter and edit multi-line text input, making it perfect for forms that require longer entries.' title: 'Textarea' deprecated: - /docs/legacy/textarea diff --git a/packages/documentation-redesign/docs/components/toggle-button/index.mdx b/packages/documentation-redesign/docs/components/toggle-button/index.mdx index 4f15808d3a4..da5aabe6920 100644 --- a/packages/documentation-redesign/docs/components/toggle-button/index.mdx +++ b/packages/documentation-redesign/docs/components/toggle-button/index.mdx @@ -1,7 +1,7 @@ --- doc-type: 'component' component-tabs: ['Usage', 'Code'] -description: '' +description: 'Toggle buttons allow users to either activate or deactivate a function.' title: 'Toggle button' deprecated: toc_min_heading_level: 2 diff --git a/packages/documentation-redesign/scripts/migrate.ts b/packages/documentation-redesign/scripts/migrate.ts index 9a1c5ac840a..5073bad7de2 100644 --- a/packages/documentation-redesign/scripts/migrate.ts +++ b/packages/documentation-redesign/scripts/migrate.ts @@ -43,7 +43,7 @@ const no_single_tab_files = [ 'special-chart', 'overview-chart', 'gauge-chart', - 'overview' + 'overview', ]; function removeLeadingNewline(content: string): string { @@ -167,7 +167,10 @@ function normalizeHeadlines(name: string, file: string): string { let contentLines: string[]; let i = 0; - while (i < lines.length && (lines[i].trim().startsWith('import ') || lines[i].trim() === '')) { + while ( + i < lines.length && + (lines[i].trim().startsWith('import ') || lines[i].trim() === '') + ) { importLines.push(lines[i]); i++; } @@ -202,7 +205,7 @@ function normalizeHeadlines(name: string, file: string): string { '#### React', '#### Angular', '#### Vue', - '#### Javascript' + '#### Javascript', ]); const normalizedSections = sections @@ -211,7 +214,10 @@ function normalizeHeadlines(name: string, file: string): string { if (exemptHeadings.has(headline.trim())) { return section; } - if (headline.trim() === "## Guidelines" || headline.trim() === "## Guideline") { + if ( + headline.trim() === '## Guidelines' || + headline.trim() === '## Guideline' + ) { return section; } if (headline.startsWith('## ')) { @@ -249,7 +255,10 @@ function tryToReplaceTags(file: string, name: string): string { /import.*from.*'.*ApiTableTag';/gm, "import { SinceTag } from '@site/src/components/UI/Tags';" ); - file = file.replace(//g, ''); + file = file.replace( + //g, + '' + ); file = file.replace(//g, ''); @@ -258,11 +267,15 @@ function tryToReplaceTags(file: string, name: string): string { function tryToReplaceSourceCodeSnippets(file: string): string { // Remove any direct import for SourceCodePreview from PlaygroundV2. - file = file.replace(/import\s+\{\s*SourceCodePreview\s*}\s+from\s+'.*\/PlaygroundV2';?\n/g, ''); - const componentRegex = /]*)\/>/g; + file = file.replace( + /import\s+\{\s*SourceCodePreview\s*}\s+from\s+'.*\/PlaygroundV2';?\n/g, + '' + ); + const componentRegex = + /]*)\/>/g; const imports = new Set(); file = file.replace(componentRegex, (match, framework, name, rest) => { - const componentName = kebabToCamelCase(name) + "Playground"; + const componentName = kebabToCamelCase(name) + 'Playground'; imports.add( `import ${componentName} from '@site/docs/autogenerated/playground/${name}.mdx';` ); @@ -288,7 +301,11 @@ function enforceSingleBlankLineAroundHeadings(content: string): string { result.push(''); } else { let j = result.length - 1; - while (j > 0 && result[j].trim() === '' && result[j - 1].trim() === '') { + while ( + j > 0 && + result[j].trim() === '' && + result[j - 1].trim() === '' + ) { result.pop(); j--; } @@ -400,7 +417,7 @@ function processGuideFile(guideFile) { // Flatten sections back to lines const resultLines = []; - processedSections.forEach(section => { + processedSections.forEach((section) => { resultLines.push(...section); }); @@ -417,7 +434,10 @@ function processGuideFile(guideFile) { const headingText = headingMatch[2]; // Ensure proper nesting - heading can be at most one level deeper than the last heading - const newLevel = Math.min(lastHeadingLevel + 1, Math.max(headingLevel, lastHeadingLevel)); + const newLevel = Math.min( + lastHeadingLevel + 1, + Math.max(headingLevel, lastHeadingLevel) + ); lastHeadingLevel = newLevel; finalLines.push(`${'#'.repeat(newLevel)} ${headingText}`); @@ -460,6 +480,7 @@ Object.keys(newDocs).forEach((name) => { const { file, text } = tryToGetIntroductionText(guideFile); guideFile = file; + if (text) { introductionText = text; } @@ -475,8 +496,12 @@ Object.keys(newDocs).forEach((name) => { codeFile = codeFile.replace(/^# [^\n]*\n/gm, ''); codeFile = codeFile.replace(/#{1,4} Examples/g, ''); codeFile = codeFile.replace(/import DocsTabs.*;\n/gm, ''); - codeFile = codeFile.replace(/)/g, ''); - const patchCodeMarkdown = //gms; + codeFile = codeFile.replace( + /)/g, + '' + ); + const patchCodeMarkdown = + //gms; const playgrounds = codeFile.match(patchCodeMarkdown); const playgroundImports: string[] = []; playgrounds?.forEach((playground) => { @@ -494,7 +519,10 @@ Object.keys(newDocs).forEach((name) => { playgroundImports.push( `import ${componentName} from '@site/docs/autogenerated/playground/${playgroundName}.mdx';` ); - codeFile = codeFile.replace(playground, `<${componentName}${height} />`); + codeFile = codeFile.replace( + playground, + `<${componentName}${height} />` + ); } }); codeFile = codeFile.replace(/import?.Preview.*;\n/g, ''); @@ -512,9 +540,11 @@ Object.keys(newDocs).forEach((name) => { ); codeFile = codeFile.replace(/#+\s(Properties|Events)\n+/gs, ''); const apiComponents: string[] = []; - Array.from(codeFile.matchAll(/import (.*Api) from.*/gm)).forEach((match) => { - apiComponents.push(match[1]); - }); + Array.from(codeFile.matchAll(/import (.*Api) from.*/gm)).forEach( + (match) => { + apiComponents.push(match[1]); + } + ); codeFile = codeFile.replace( /(#+\sAPI.*\/>)/gms, @@ -558,6 +588,12 @@ Object.keys(newDocs).forEach((name) => { let deprecatedTags: string[] = []; if (newDocs[name].indexPath) { const file = fs.readFileSync(newDocs[name].indexPath, 'utf-8'); + const { file: _file, text } = tryToGetIntroductionText(file); + + if (text) { + introductionText = text; + } + deprecatedTags = getComponentDeprecatedTags(file); }