improve userTypes config comment

latticexyz · Sep 22, 2023 · 377135c · 377135c
1 parent 88745eb
commit 377135c
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/packages/store/ts/config/storeConfig.ts b/packages/store/ts/config/storeConfig.ts
@@ -244,7 +244,9 @@ export const zEnumsConfig = z.object({
 export type UserTypesConfig<UserTypeNames extends StringForUnion> = never extends UserTypeNames
   ? {
       /**
-       * User types mapped to file paths from which to import them
+       * User types mapped to file paths from which to import them.
+       * Paths are treated as relative to root.
+       * Paths that don't start with a "." have foundry remappings applied to them first.
        *
        * (user types are inferred to be absent)
        */
@@ -253,15 +255,19 @@ export type UserTypesConfig<UserTypeNames extends StringForUnion> = never extend
   : StringForUnion extends UserTypeNames
   ? {
       /**
-       * User types mapped to file paths from which to import them
+       * User types mapped to file paths from which to import them.
+       * Paths are treated as relative to root.
+       * Paths that don't start with a "." have foundry remappings applied to them first.
        *
        * (user types aren't inferred - use `mudConfig` or `storeConfig` helper, and `as const` for variables)
        */
       userTypes?: Record<UserTypeNames, string>;
     }
   : {
       /**
-       * User types mapped to file paths from which to import them
+       * User types mapped to file paths from which to import them.
+       * Paths are treated as relative to root.
+       * Paths that don't start with a "." have foundry remappings applied to them first.
        *
        * User types defined here can be used as types in table schemas/keys
        */