fix(core): add custom path for component

docgeni · Dec 27, 2023 · 87954ae · 87954ae
1 parent 6436122
commit 87954ae
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 3 deletions.
diff --git a/docs/configuration/front-matter.md b/docs/configuration/front-matter.md
@@ -29,7 +29,7 @@ toc: menu
 - 类型：`string`
 - 默认：`文件夹名、文件名`
 
-频道、页面的路由，默认会使用`paramCase`命名转换文件夹名或者文件名，文档实际访问路由会带上分类和频道的 path。
+频道、页面、组件的路由，默认会使用`paramCase`命名转换文件夹名或者文件名，文档实际访问路由会带上分类和频道的 path。
 
 ## hidden
 - 类型：`boolean`

diff --git a/docs/en-us/configuration/front-matter.md b/docs/en-us/configuration/front-matter.md
@@ -29,7 +29,7 @@ The sorting of channels, categories, pages or components, is in ascending order
 - Type: `string`
 - Default: `folder name, file name`
 
-The routing of the channel or page, will use `paramCase` nomenclature to convert the folder name or file name by default, the actual access route of the document will bring the path of the category and channel.
+The routing of the channel or page or component, will use `paramCase` nomenclature to convert the folder name or file name by default, the actual access route of the document will bring the path of the category and channel.
 
 ## hidden
 - Type: `boolean`

diff --git a/packages/core/src/builders/library-component.spec.ts b/packages/core/src/builders/library-component.spec.ts
@@ -362,6 +362,21 @@ describe('#library-component', () => {
             await component.build();
             expect(component.examples[0].standalone).toBeTruthy();
         });
+
+        it('should custom component path', async () => {
+            const docContent = `---
+title: New Button
+path: button-path
+---
+This is button`;
+            await writeFilesToHost(context.host, {
+                [`${buttonDirPath}/doc/en-us.md`]: docContent
+            });
+            const component = new LibraryComponentImpl(context, library, 'button', `${DEFAULT_TEST_ROOT_PATH}/alib/button`);
+            await component.build();
+            const docItem = component.getDocItem('en-us');
+            expect(docItem.path).toEqual('button-path');
+        });
     });
 
     describe('api-docs', () => {

diff --git a/packages/core/src/builders/library-component.ts b/packages/core/src/builders/library-component.ts
@@ -406,7 +406,7 @@ export class LibraryComponentImpl extends FileEmitter implements LibraryComponen
                     id: this.name,
                     title,
                     subtitle,
-                    path: this.name,
+                    path: this.meta.path || this.name,
                     importSpecifier: `${this.lib.name}/${this.name}`,
                     examples: this.examples.map(example => example.key),
                     overview: overviewSourceFile && overviewSourceFile.output ? true : false,

diff --git a/packages/core/src/types/meta.ts b/packages/core/src/types/meta.ts
@@ -3,6 +3,7 @@ import { DocItemToc, HeadingLink, HomeDocMeta } from '../interfaces';
 export interface ComponentDocMeta {
     title?: string;
     name?: string;
+    path?: string;
     category?: string;
     subtitle?: string;
     description?: string;