chore: add comments

Author: rudyxu1102

packages/runtime-core/src/apiDefineComponent.ts

@@ -16,7 +16,7 @@ import {
   SetupContext,
   AllowedComponentProps,
   ComponentCustomProps,
-  HasDefineAttrs
+  noAttrsDefine
 } from './component'
 import {
   ExtractPropTypes,
@@ -109,7 +109,7 @@ export function defineComponent<
   EE extends string = string,
   S extends SlotsType = {},
   Attrs extends AttrsType = Record<string, unknown>,
-  PropsAttrs = HasDefineAttrs<Attrs> extends true
+  PropsAttrs = noAttrsDefine<Attrs> extends true
     ? {}
     : UnwrapAttrsType<NonNullable<Attrs>>
 >(

packages/runtime-core/src/component.ts

@@ -84,7 +84,8 @@ import { SchedulerJob } from './scheduler'
 import { LifecycleHooks } from './enums'
 
 export type Data = Record<string, unknown>
-export type HasDefineAttrs<T> = Equal<keyof T, string>
+// Whether the attrs option is not defined
+export type noAttrsDefine<T> = Equal<keyof T, string>
 /**
  * For extending allowed non-declared props on components in TSX
  */
@@ -191,7 +192,7 @@ export type SetupContext<
   Attrs extends AttrsType = Record<string, unknown>
 > = E extends any
   ? {
-      attrs: HasDefineAttrs<Attrs> extends true
+      attrs: noAttrsDefine<Attrs> extends true
         ? Data
         : UnwrapAttrsType<NonNullable<Attrs>>
       slots: UnwrapSlotsType<S>

packages/runtime-core/src/componentPublicInstance.ts

@@ -2,7 +2,7 @@ import {
   AllowedComponentProps,
   ComponentInternalInstance,
   Data,
-  HasDefineAttrs,
+  noAttrsDefine,
   getExposeProxy,
   isStatefulComponent
 } from './component'
@@ -210,19 +210,20 @@ export type ComponentPublicInstance<
   Options = ComponentOptionsBase<any, any, any, any, any, any, any, any, any>,
   I extends ComponentInjectOptions = {},
   S extends SlotsType = {},
-  Attrs extends AttrsType = Record<string, unknown>,
-  PropsAttrs = HasDefineAttrs<Attrs> extends true
-    ? {}
-    : Omit<UnwrapAttrsType<Attrs>, keyof (P & PublicProps)>
+  Attrs extends AttrsType = Record<string, unknown>, // Attrs type extracted from attrs option
+  // AttrsProps type used for JSX validation of attrs
+  AttrsProps = noAttrsDefine<Attrs> extends true // if attrs is not defined
+    ? {} // no JSX validation of attrs
+    : Omit<UnwrapAttrsType<Attrs>, keyof (P & PublicProps)> // exclude props from attrs, for JSX validation
 > = {
   $: ComponentInternalInstance
   $data: D
   $props: Prettify<
     MakeDefaultsOptional extends true
-      ? Partial<Defaults> & Omit<P & PublicProps, keyof Defaults> & PropsAttrs
-      : P & PublicProps & PropsAttrs
+      ? Partial<Defaults> & Omit<P & PublicProps, keyof Defaults> & AttrsProps
+      : P & PublicProps & AttrsProps
   >
-  $attrs: HasDefineAttrs<Attrs> extends true
+  $attrs: noAttrsDefine<Attrs> extends true
     ? Data
     : Omit<UnwrapAttrsType<Attrs>, keyof (P & PublicProps)> &
         AllowedComponentProps

packages/shared/src/typeUtils.ts

@@ -24,6 +24,8 @@ export type Awaited<T> = T extends null | undefined
 
 // Conditional returns can enforce identical types.
 // See here: https://github.com/Microsoft/TypeScript/issues/27024#issuecomment-421529650
-// prettier-ignore
-export type Equal<Left, Right> =
-(<U>() => U extends Left ? 1 : 0) extends (<U>() => U extends Right ? 1 : 0) ? true : false;
+export type Equal<Left, Right> = (<U>() => U extends Left ? 1 : 0) extends <
+  U
+>() => U extends Right ? 1 : 0
+  ? true
+  : false