support turning off future proof enums project wide

Author: zth

CHANGELOG.md

@@ -1,5 +1,8 @@
 # master
 
+- Respect `noFutureProofEnums` in generated ReScript enum types, disabling `FutureAddedValue(...)` when configured.
+- Fix issue with the non-React mode.
+
 # 4.2.3
 
 - Actually wire up `autoExhaustiveTypes`.

packages/relay

@@ -117,6 +117,8 @@ module Fragment = %relay(`
 `)
 ```
 
+> If you want to disable `FutureAddedValue(...)` project-wide, set `noFutureProofEnums: true` in `relay.config.js`. This removes the catch-all enum constructor from generated response enums everywhere. But you're strongly encouraged to keep it on, for safer code.
+
 ### Mapping strings to your enum
 
 In addition to the utils listed above, there's also a function available for taking a string and mapping it to your enum, if it's valid. An example:

rescript-relay-documentation/docs/enums.md

@@ -90,6 +90,9 @@ module.exports = {
   // Make these unions/interfaces exhaustive everywhere without adding @exhaustive manually.
   autoExhaustiveTypes: ["UserNameRenderer"],
 
+  // Disable FutureAddedValue(...) for response enums project-wide.
+  noFutureProofEnums: false,
+
   // You can add type definitions for custom scalars here.
   // Whenever a custom scalar is encountered, the type emitted will correspond to the definition defined here. You can then deal with the type as needed when accessing the data.
   customScalarTypes: {

rescript-relay-documentation/docs/getting-started.md

@@ -142,3 +142,12 @@ let make = (~book) => {
   }
 }
 ```
+
+## Safety and Exhaustiveness
+
+Interfaces follow the same future-proofing model as unions when they are emitted as variants:
+
+- By default, generated interface variants include `UnselectedUnionMember(string)`.
+- You can use `@exhaustive`, `@nonExhaustive`, `autoExhaustiveMutations`, and `autoExhaustiveTypes` just like for unions.
+
+For more on those controls, see the [unions docs](unions).

rescript-relay-documentation/docs/interfaces.md

@@ -172,7 +172,9 @@ Any field or fragment returning those types will be treated as if it had `@exhau
 ```graphql
 fragment UserName on User {
   nameRenderer @nonExhaustive {
-    ... on PlainUserNameRenderer { __typename }
+    ... on PlainUserNameRenderer {
+      __typename
+    }
   }
 }
 ```