Merge pull request #1 from cometkim/gentype-to-main-docs

TypeScript section into JavaScript interop
fhammerschmidt · Dec 27, 2023 · 5283161 · 5283161
2 parents 9889c7d + e9a89fa
commit 5283161
Show file tree

Hide file tree

Showing 12 changed files with 233 additions and 610 deletions.
diff --git a/data/sidebar_manual_latest.json b/data/sidebar_manual_latest.json
@@ -51,18 +51,8 @@
     "use-illegal-identifier-names",
     "generate-converters-accessors",
     "browser-support-polyfills",
-    "libraries"
-  ],
-  "TypeScript Interop": [
-    "gentype-introduction",
-    "gentype-usage",
-    "bind-to-ts-primitive",
-    "bind-to-ts-collections",
-    "bind-to-ts-object",
-    "bind-to-ts-option-null",
-    "bind-to-ts-function",
-    "bind-to-ts-variant",
-    "bind-to-ts-other"
+    "libraries",
+    "typescript-integration"
   ],
   "Build System": [
     "build-overview",

diff --git a/pages/docs/manual/latest/bind-to-ts-collections.mdx b/pages/docs/manual/latest/bind-to-ts-collections.mdx
diff --git a/pages/docs/manual/latest/bind-to-ts-function.mdx b/pages/docs/manual/latest/bind-to-ts-function.mdx
diff --git a/pages/docs/manual/latest/bind-to-ts-object.mdx b/pages/docs/manual/latest/bind-to-ts-object.mdx
diff --git a/pages/docs/manual/latest/bind-to-ts-option-null.mdx b/pages/docs/manual/latest/bind-to-ts-option-null.mdx
diff --git a/pages/docs/manual/latest/bind-to-ts-other.mdx b/pages/docs/manual/latest/bind-to-ts-other.mdx
diff --git a/pages/docs/manual/latest/bind-to-ts-primitive.mdx b/pages/docs/manual/latest/bind-to-ts-primitive.mdx
diff --git a/pages/docs/manual/latest/bind-to-ts-variant.mdx b/pages/docs/manual/latest/bind-to-ts-variant.mdx
diff --git a/pages/docs/manual/latest/build-configuration.mdx b/pages/docs/manual/latest/build-configuration.mdx
@@ -192,6 +192,41 @@ The warning numbers are shown in the build output when they're triggered. See [W
 
 Extra flags to pass to the compiler. For advanced usages.
 
+## gentypeconfig
+
+To enable genType, set `"gentypeconfig"` at top level in the project's `rescript.json`.
+
+```json
+{
+  "gentypeconfig": {
+    "module": "es6",
+    "moduleResolution": "node",
+    "generatedFileExtension": ".gen.tsx",
+    "debug": {
+      "all": false,
+      "basic": false
+    }
+  }
+}
+```
+
+`generatedFileExtension`: File extension used for genType generated files (defaults to `".gen.tsx"`)
+
+`module`: Module format used for the generated `*.gen.tsx` files (supports `"es6"` and `"commonjs"`)
+
+`moduleResolution`: Module resolution strategy used in genType outputs. This may be required for compatibility with TypeScript projects. Specify the value as the same in `tsconfig.json`.
+- `"node"`(default): Drop extensions in import paths.
+- `"node16"`: Use TS output's extension. This provides compatibility with projects using `"moduleResolution": "node16"` and ES Modules.
+- `"bundler"`: Use TS input's extension. This provides compatibility with projects using `"moduleResolution": "bundler"` and ES Modules. This also requires TS v5.0+ and `compilerOptions.allowImportingTsExtensions` to `true`
+
+`debug`: Enable debug logs.
+
+### Deprecated options
+
+`language`: the `language` setting is not required from compiler v10.1.
+
+`shims`: Required only if one needs to export certain basic ReScript data types to JS when one cannot modify the sources to add annotations (e.g. exporting ReScript lists), and if the types are not first-classed in genType.
+
 ## Environment Variables
 
 We heavily disrecommend the usage of environment variables, but for certain cases, they're justified.