From 9f45c04c2cdf3ca3b0424002e3274ac07dbd32b7 Mon Sep 17 00:00:00 2001 From: Nitzan Yizhar Date: Sun, 4 May 2025 10:50:33 +0300 Subject: [PATCH 1/4] Added composite category in docs build script --- scripts/docs/buildDocsCommon.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/scripts/docs/buildDocsCommon.js b/scripts/docs/buildDocsCommon.js index faa278da79..0f0f2e92fa 100644 --- a/scripts/docs/buildDocsCommon.js +++ b/scripts/docs/buildDocsCommon.js @@ -7,6 +7,7 @@ const fs = require('fs'); const COMPONENTS_DOCS_DIR = './docs/components'; const SERVICES_DOCS_DIR = './docs/services'; +const COMPOSITE_DOCS_DIR = './docs/composite'; const FOUNDATION_DOCS_DIR = './docs/foundation'; const VALID_COMPONENTS_CATEGORIES = [ @@ -95,6 +96,10 @@ function processComponents(components) { let dirPath; switch (component.category) { + case 'composite': { + dirPath = `${COMPOSITE_DOCS_DIR}`; + break; + } case 'services': { dirPath = `${SERVICES_DOCS_DIR}`; break; From 5fcc741b2d6c3b79f08a76a160990533a0b18fdf Mon Sep 17 00:00:00 2001 From: Nitzan Yizhar Date: Sun, 4 May 2025 11:02:59 +0300 Subject: [PATCH 2/4] Added composite category to valid categories --- scripts/docs/buildDocsCommon.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/docs/buildDocsCommon.js b/scripts/docs/buildDocsCommon.js index 0f0f2e92fa..fd9edfb835 100644 --- a/scripts/docs/buildDocsCommon.js +++ b/scripts/docs/buildDocsCommon.js @@ -28,7 +28,8 @@ const VALID_COMPONENTS_CATEGORIES = [ 'infra', // non components categories 'services', - 'dev' // development category for components we don't want to render in our docs (used in test.api.json) + 'dev', // development category for components we don't want to render in our docs (used in test.api.json), + 'composite' ]; function buildDocs(apiFolders, componentsPreProcess) { From 342324ed0d3b1421e765b0ac991fe88264a1e434 Mon Sep 17 00:00:00 2001 From: Nitzan Yizhar Date: Sun, 4 May 2025 11:03:41 +0300 Subject: [PATCH 3/4] Refactor category validation to use consistent VALID_CATEGORIES constant --- scripts/docs/buildDocsCommon.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/docs/buildDocsCommon.js b/scripts/docs/buildDocsCommon.js index fd9edfb835..c9cea9acb9 100644 --- a/scripts/docs/buildDocsCommon.js +++ b/scripts/docs/buildDocsCommon.js @@ -10,7 +10,7 @@ const SERVICES_DOCS_DIR = './docs/services'; const COMPOSITE_DOCS_DIR = './docs/composite'; const FOUNDATION_DOCS_DIR = './docs/foundation'; -const VALID_COMPONENTS_CATEGORIES = [ +const VALID_CATEGORIES = [ 'foundation', 'basic', 'assets', @@ -75,7 +75,7 @@ function processComponents(components) { const isParentComponent = parentComponents.includes(componentName); const isIncubatorComponent = component.category === 'incubator'; - if (!VALID_COMPONENTS_CATEGORIES.includes(component.category)) { + if (!VALID_CATEGORIES.includes(component.category)) { console.error(`${componentName} has invalid category "${component.category}"`); } From 23b2f3cf3382e3fcef6dcef29d361a15265dee77 Mon Sep 17 00:00:00 2001 From: Nitzan Yizhar Date: Sun, 4 May 2025 11:05:16 +0300 Subject: [PATCH 4/4] Revert "Refactor category validation to use consistent VALID_CATEGORIES constant" This reverts commit 342324ed0d3b1421e765b0ac991fe88264a1e434. --- scripts/docs/buildDocsCommon.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/docs/buildDocsCommon.js b/scripts/docs/buildDocsCommon.js index c9cea9acb9..fd9edfb835 100644 --- a/scripts/docs/buildDocsCommon.js +++ b/scripts/docs/buildDocsCommon.js @@ -10,7 +10,7 @@ const SERVICES_DOCS_DIR = './docs/services'; const COMPOSITE_DOCS_DIR = './docs/composite'; const FOUNDATION_DOCS_DIR = './docs/foundation'; -const VALID_CATEGORIES = [ +const VALID_COMPONENTS_CATEGORIES = [ 'foundation', 'basic', 'assets', @@ -75,7 +75,7 @@ function processComponents(components) { const isParentComponent = parentComponents.includes(componentName); const isIncubatorComponent = component.category === 'incubator'; - if (!VALID_CATEGORIES.includes(component.category)) { + if (!VALID_COMPONENTS_CATEGORIES.includes(component.category)) { console.error(`${componentName} has invalid category "${component.category}"`); }