Merge pull request #2084 from umijs/feature/2.3.0

chore: merge feature into master

.eslintignore

@@ -1,3 +1,5 @@
 /dist
 /compiled
 /theme-default
+/suites/*/compiled
+/suites/preset-vue/lib

.eslintrc.js

@@ -1,3 +1,9 @@
 module.exports = {
   extends: require.resolve('@umijs/lint/dist/config/eslint'),
+  rules: {
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      { ignoreRestSiblings: true },
+    ],
+  },
 };

.gitignore

@@ -17,3 +17,4 @@
 /target
 /compiled/crates
 .swc
+/server

assets-types/typings/atom/index.d.ts

@@ -1,4 +1,8 @@
-import type { ObjectPropertySchema, PropertySchema } from './props';
+import type {
+  FunctionArgSchema,
+  ObjectPropertySchema,
+  PropertySchema,
+} from './props';
 
 /**
  * base atom asset
@@ -41,6 +45,20 @@ export interface AtomComponentAsset extends AtomBaseAsset {
    * props definition of component
    */
   propsConfig: ObjectPropertySchema;
+  /**
+   * slots definition of component
+   */
+  slotsConfig?: ObjectPropertySchema;
+  /**
+   * events definition of component
+   */
+  eventsConfig?: ObjectPropertySchema;
+  /**
+   * Whether it is methods and properties exposed by component instances,
+   * or common functional calls, such as Popup.open().
+   * Such imperative methods and properties should be classified under this configuration
+   */
+  imperativeConfig?: ObjectPropertySchema;
 
   /**
    * available parent components of component
@@ -77,10 +95,7 @@ export interface AtomFunctionAsset extends AtomBaseAsset {
     /**
      * arguments of function
      */
-    arguments: {
-      key: string;
-      schema: PropertySchema;
-    }[];
+    arguments: FunctionArgSchema[];
 
     /**
      * return value of function

assets-types/typings/atom/props/index.d.ts

@@ -1,6 +1,25 @@
 import type { BuiltinTags } from './jsdoc';
 import type { TypeMap } from './types';
 
+export interface PropertySourceReference {
+  /**
+   * fileName of the source file
+   */
+  fileName: string;
+  /**
+   * The one based number of the line that emitted the declaration
+   */
+  line: number;
+  /**
+   * The index of the character that emitted the declaration
+   */
+  character: number;
+  /**
+   * URL for displaying source file, usually the git repo file URL
+   */
+  url?: string;
+}
+
 /**
  * base props definition
  */
@@ -25,6 +44,10 @@ export interface BasePropertySchema<T extends keyof TypeMap = keyof TypeMap> {
    * value type of prop
    */
   type?: T;
+  /**
+   * the full name of the type
+   */
+  className?: string;
   /**
    * const value of prop
    */
@@ -50,6 +73,10 @@ export interface BasePropertySchema<T extends keyof TypeMap = keyof TypeMap> {
    * extra jsdoc tags
    */
   tags?: BuiltinTags & Record<string, any>;
+  /**
+   * source of prop
+   */
+  source?: PropertySourceReference[];
 }
 
 /**
@@ -115,13 +142,37 @@ export interface ObjectPropertySchema extends BasePropertySchema {
   required?: string[];
 }
 
+export interface ReferencePropertySchema extends BasePropertySchema {
+  type: 'reference';
+  name: string;
+  typeParameters?: PropertySchema[];
+  externalUrl: string;
+}
+
+export interface FunctionArgSchema {
+  key: string;
+  schema: PropertySchema;
+  hasQuestionToken?: boolean;
+}
+
+export interface FunctionPropertySchema extends BasePropertySchema {
+  type: 'function';
+  signature: {
+    isAsync: boolean;
+    returnType: PropertySchema;
+    arguments: FunctionArgSchema[];
+  };
+}
+
 /**
  * prop definition
  */
 export type PropertySchema =
   | BasePropertySchema
   | ObjectPropertySchema
   | ArrayPropertySchema
+  | FunctionPropertySchema
   | StringPropertySchema
   | NumberPropertySchema
-  | BooleanPropertySchema;
+  | BooleanPropertySchema
+  | ReferencePropertySchema;

assets-types/typings/example.d.ts

@@ -64,6 +64,10 @@ export interface ExampleBlockAsset extends ExampleBaseAsset {
       value: string;
     }
   >;
+  /**
+   * Entry file name, you can find the relevant entry file content from `dependencies`
+   */
+  entry?: string;
 }
 
 /**

docs/config/index.md

@@ -98,6 +98,8 @@ export default () => '我会被编译，展示为组件';
 
 `resolveFilter` 配置项用于跳过指定原子资产的解析以提升性能。部分组件属性或函数签名存在多层嵌套，甚至是循环引用时，会导致解析结果巨大，此时可以通过该配置项跳过解析。
 
+上述配置是默认 React 解析器的配置， dumi 也提供方法覆盖原有解析器，具体可查看[API Table 支持](../plugin/techstack.md#api-table-支持)。
+
 ### autoAlias
 
 - 类型：`boolean`

docs/guide/markdown.md

@@ -237,3 +237,66 @@ features:
     </li>
   </ul>
 </Tree>
+
+## CodeGroup <Badge>2.3.0+</Badge>
+
+需要将多代码块合并成一个分组进行展示时，可以使用 CodeGroup 语法，例如：
+
+```jsx
+/**
+ * inline: true
+ */
+import SourceCode from 'dumi/theme/builtins/SourceCode';
+const content = `
+:::code-group
+
+\`\`\`bash [npm]
+npm install -D dumi
+\`\`\`
+
+\`\`\`bash [yarn]
+yarn add -D dumi
+\`\`\`
+
+\`\`\`bash [pnpm]
+pnpm add -D dumi
+\`\`\`
+
+\`\`\`ts [.dumirc.ts] {3}
+import { defineConfig } from 'dumi';
+
+export default defineConfig({
+  // ...
+});
+\`\`\`
+:::
+`.trim();
+
+export default () => <SourceCode lang="markdown">{content}</SourceCode>;
+```
+
+将会被渲染为：
+
+:::code-group
+
+```bash [npm]
+npm install -D dumi
+```
+
+```bash [yarn]
+yarn add -D dumi
+```
+
+```bash [pnpm]
+pnpm add -D dumi
+```
+
+```ts [.dumirc.ts] {3}
+import { defineConfig } from 'dumi';
+
+export default defineConfig({
+  // ...
+});
+```
+
+:::