chore: export types for using it in configuration files (#1733)

* chore: export types for using it in configuration files
docs: add example for typed config

* chore: run fmt

* fix: wrong config comment

Author: nmerget

.changeset/proud-scissors-trade.md

@@ -0,0 +1,5 @@
+---
+'@builder.io/mitosis': patch
+---
+
+[all] export `types.ts` to enable `@type` comment for JS like this: `/** @type {import('@builder.io/mitosis').ToReactOptions} */`

e2e/e2e-app/mitosis.config.cjs

@@ -1,5 +1,5 @@
 /**
- * @type {import('@builder.io/mitosis'.MitosisConfig)}
+ * @type {import('@builder.io/mitosis').MitosisConfig}
  */
 module.exports = {
   files: 'src/**',

packages/core/src/generators/alpine/index.ts

@@ -1 +1,2 @@
 export * from './generate';
+export * from './types';

packages/core/src/generators/angular/index.ts

@@ -858,3 +858,5 @@ const tryFormat = (str: string, parser: string) => {
   }
   return str;
 };
+
+export * from './types';

packages/core/src/generators/builder/index.ts

@@ -1 +1,2 @@
 export * from './generator';
+export * from './types';

packages/core/src/generators/html/index.ts

@@ -1 +1,2 @@
 export * from './generator';
+export * from './types';

packages/core/src/generators/liquid/index.ts

@@ -1 +1,2 @@
 export * from './generator';
+export * from './types';

packages/core/src/generators/lit/index.ts

@@ -1 +1,2 @@
 export * from './generate';
+export * from './types';

packages/core/src/generators/marko/index.ts

@@ -1 +1,2 @@
 export * from './generate';
+export * from './types';

packages/core/src/generators/mitosis/index.ts

@@ -1 +1,2 @@
 export * from './generator';
+export * from './types';

packages/core/src/generators/qwik/index.ts

@@ -2,3 +2,4 @@ export { addCommonStyles, addComponent, createFileSet } from './component';
 export type { FileSet, QwikOptions } from './component';
 export { componentToQwik } from './component-generator';
 export { File } from './src-generator';
+export * from './types';

packages/core/src/generators/react-native/index.ts

@@ -293,3 +293,5 @@ export const componentToReactNative: TranspilerGenerator<Partial<ToReactNativeOp
 
     return componentToReact({ ...options, type: 'native' })({ component: json, path });
   };
+
+export * from './types';

packages/core/src/generators/rsc/index.ts

@@ -1 +1,2 @@
 export * from './generator';
+export * from './types';

packages/core/src/generators/solid/index.ts

@@ -270,3 +270,5 @@ export const componentToSolid: TranspilerGenerator<Partial<ToSolidOptions>> =
     }
     return str;
   };
+
+export * from './types';

packages/core/src/generators/stencil/index.ts

@@ -1 +1,2 @@
 export * from './component';
+export * from './types';

packages/core/src/generators/svelte/index.ts

@@ -1 +1,2 @@
 export { componentToSvelte } from './svelte';
+export * from './types';

packages/core/src/generators/swift/index.ts

@@ -1 +1,2 @@
 export * from './generator';
+export * from './types';

packages/core/src/generators/taro/index.ts

@@ -1 +1,2 @@
 export * from './generator';
+export * from './types';

packages/core/src/generators/template/index.ts

@@ -1 +1,2 @@
 export * from './generator';
+export * from './types';

packages/docs/src/routes/docs/configuration/index.mdx

@@ -6,7 +6,45 @@ title: Configuration - Mitosis
 
 ## Mitosis Configuration
 
-In the root of the project, from which you run mitosis, you can add a `mitosis.config.js` file that will be read by Mitosis. You can also specify a config file by option: `--config=<file>`.
+In the root of the project, from which you run mitosis,
+you can add a `mitosis.config.js` file that will be read by Mitosis.
+You can also specify a config file by option: `--config=<file>`.
+An example might look like this:
+
+````js react-options.cjs
+// react-options.cjs
+
+/** @type {import('@builder.io/mitosis').ToReactOptions} */
+module.exports = {
+	typescript: true
+};
+````
+
+````js vue-options.cjs
+// vue-options.cjs
+
+/** @type {import('@builder.io/mitosis').ToVueOptions} */
+module.exports = {
+	typescript: true
+};
+````
+
+````js mitosis-config.cjs
+// mitosis-config.cjs
+const react = require('./react-options.cjs');
+const vue = require('./vue-options.cjs');
+
+/** @type {import('@builder.io/mitosis').MitosisConfig} */
+module.exports = {
+	files: 'src/**',
+	targets: ['vue', 'react'],
+	options: {
+		react,
+		vue
+	}
+};
+````
+
 
 The `mitosis.config.js` file uses the [MitosisConfig](https://github.com/BuilderIO/mitosis/blob/main/packages/core/src/types/config.ts#L22) type: