refactor(assets): deprecate uuid & enable identifier for examples

umijs · Dec 8, 2020 · 0466067 · 0466067
1 parent 7dde5c7
commit 0466067
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 2 deletions.
diff --git a/packages/assets-types/typings/atom.d.ts b/packages/assets-types/typings/atom.d.ts
@@ -52,6 +52,7 @@ export default interface AtomAsset {
   'name.en-US'?: string;
   /**
    * atom uuid
+   * @deprecated  legacy HiTu DSM logic
    */
   uuid?: string;
   /**

diff --git a/packages/assets-types/typings/example.d.ts b/packages/assets-types/typings/example.d.ts
@@ -7,8 +7,13 @@ export interface ExampleBaseAsset {
    * The identifier from design draft of atom asset, such as Sketch symbol name
    */
   designId?: string;
+  /**
+   * identifier for asset
+   */
+  identifier: string;
   /**
    * uuid for asset
+   * @deprecated  legacy HiTu DSM logic
    */
   uuid?: string;
   /**

diff --git a/packages/preset-dumi/src/fixtures/assets/assets.expect.json b/packages/preset-dumi/src/fixtures/assets/assets.expect.json
@@ -11,6 +11,7 @@
       {
         "type": "BLOCK",
         "atomAssetId": "Foo",
+        "identifier": "222222",
         "uuid": "222222",
         "dependencies": {
           "index.tsx": {

diff --git a/packages/preset-dumi/src/plugins/commands/assets.ts b/packages/preset-dumi/src/plugins/commands/assets.ts
@@ -49,7 +49,7 @@ export default (api: IApi) => {
   api.register({
     key: 'dumi.detectCodeBlock',
     fn(block: ExampleBlockAsset) {
-      if (block.name || block.uuid) {
+      if (block.name || block.identifier) {
         assetsPkg.assets.examples.push(block);
       }
     },

diff --git a/packages/preset-dumi/src/transformer/remark/previewer.ts b/packages/preset-dumi/src/transformer/remark/previewer.ts
@@ -182,7 +182,8 @@ function applyCodeBlock(props: IPreviewerComponentProps, componentName: string)
       tags: props.tags,
       previewUrl: props.previewUrl,
       atomAssetId: componentName,
-      // for HiTu DSM
+      identifier: props.identifier || props.uuid,
+      // for HiTu DSM, deprecated
       uuid: props.uuid,
       dependencies: {
         // append npm dependencies