fix: Fix type checking in config examples (#2965)

* Fix type checking in config examples * Update rspack.config.js
web-infra-dev · Apr 28, 2023 · 2de569b · 2de569b
1 parent 43359d5
commit 2de569b
Show file tree

Hide file tree

Showing 32 changed files with 93 additions and 90 deletions.
diff --git a/examples/arco-pro/rspack.config.js b/examples/arco-pro/rspack.config.js
@@ -3,10 +3,8 @@ const { default: HtmlPlugin } = require("@rspack/plugin-html");
 
 const prod = process.env.NODE_ENV === "production";
 
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	context: __dirname,
 	entry: { main: "./src/index.tsx" },
 	devServer: {
@@ -70,3 +68,4 @@ module.exports = {
 		debug: false
 	}
 };
+module.exports = config;
diff --git a/examples/basic/rspack.config.js b/examples/basic/rspack.config.js
@@ -1,7 +1,5 @@
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	context: __dirname,
 	entry: {
 		main: "./src/index.js"
@@ -14,3 +12,4 @@ module.exports = {
 		],
 	}
 };
+module.exports = config;
diff --git a/examples/bundle-splitting/rspack.config.js b/examples/bundle-splitting/rspack.config.js
@@ -1,7 +1,5 @@
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	mode: "development",
 	entry: {
 		main: {
@@ -39,3 +37,4 @@ module.exports = {
 		}
 	}
 };
+module.exports = config;
diff --git a/examples/code-splitting/rspack.config.js b/examples/code-splitting/rspack.config.js
@@ -1,4 +1,5 @@
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	mode: "development",
 	entry: {
 		main: {
@@ -12,3 +13,4 @@ module.exports = {
 		}
 	}
 };
+module.exports = config;
diff --git a/examples/cra-ts/rspack.config.js b/examples/cra-ts/rspack.config.js
@@ -1,8 +1,6 @@
 const CopyPlugin = require("copy-webpack-plugin");
-/*
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: "./src/index.tsx"
 	},
@@ -29,3 +27,4 @@ module.exports = {
 		}
 	}
 };
+module.exports = config;
diff --git a/examples/cra/rspack.config.js b/examples/cra/rspack.config.js
@@ -1,8 +1,6 @@
 const CopyPlugin = require("copy-webpack-plugin");
-/*
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: "./src/index.jsx"
 	},
@@ -29,3 +27,4 @@ module.exports = {
 		}
 	}
 };
+module.exports = config;
diff --git a/examples/emotion/rspack.config.js b/examples/emotion/rspack.config.js
@@ -1,7 +1,5 @@
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: "./src/index.jsx"
 	},
@@ -18,3 +16,4 @@ module.exports = {
 		}
 	}
 };
+module.exports = config;
diff --git a/examples/eslint/rspack.config.js b/examples/eslint/rspack.config.js
@@ -1,12 +1,11 @@
 const EslintPlugin = require("eslint-rspack-plugin");
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	mode: "development",
 	context: __dirname,
 	entry: {
 		main: "./src/index.js"
 	},
 	plugins: [new EslintPlugin()]
 };
+module.exports = config;
diff --git a/examples/eslint/rspack.config.loader.js b/examples/eslint/rspack.config.loader.js
@@ -1,8 +1,6 @@
 const EslintPlugin = require("eslint-rspack-plugin");
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	mode: "development",
 	context: __dirname,
 	entry: {
@@ -23,3 +21,4 @@ module.exports = {
 		]
 	}
 };
+module.exports = config;
diff --git a/examples/library/rspack.config.js b/examples/library/rspack.config.js
@@ -1,7 +1,5 @@
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = [
+/** @type {import('@rspack/cli').Configuration} */
+const config = [
 	"var",
 	"module",
 	"assign",
@@ -33,3 +31,4 @@ module.exports = [
 		}
 	}
 }));
+module.exports = config;
diff --git a/examples/loader-compat/rspack.config.js b/examples/loader-compat/rspack.config.js
@@ -1,7 +1,5 @@
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: "./src/index.js"
 	},
@@ -118,3 +116,4 @@ module.exports = {
 		]
 	}
 };
+module.exports = config;
diff --git a/examples/multi-entry/rspack.config.js b/examples/multi-entry/rspack.config.js
@@ -1,4 +1,5 @@
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	mode: "development",
 	entry: {
 		index: "./index.js",
@@ -14,3 +15,4 @@ module.exports = {
 		}
 	}
 };
+module.exports = config;
diff --git a/examples/nestjs/rspack.config.js b/examples/nestjs/rspack.config.js
@@ -1,7 +1,5 @@
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	context: __dirname,
 	target: "node",
 	entry: {
@@ -46,3 +44,4 @@ module.exports = {
 		}
 	]
 };
+module.exports = config;
diff --git a/examples/perfsee/rspack.config.js b/examples/perfsee/rspack.config.js
@@ -1,8 +1,6 @@
 const { PerfseePlugin } = require("@perfsee/webpack");
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	context: __dirname,
 	entry: {
 		main: "./src/index.js"
@@ -16,3 +14,4 @@ module.exports = {
 	},
 	plugins: [new PerfseePlugin({})]
 };
+module.exports = config;
diff --git a/examples/plugin-compat/rspack.config.js b/examples/plugin-compat/rspack.config.js
@@ -4,10 +4,8 @@ const CopyPlugin = require("copy-webpack-plugin");
 const HtmlPlugin = require("@rspack/plugin-html").default;
 const { StatsWriterPlugin } = require("webpack-stats-plugin");
 const GeneratePackageJsonPlugin = require('generate-package-json-webpack-plugin')
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	target: "node",
 	mode: "development",
 	stats: { all: true },
@@ -38,6 +36,7 @@ module.exports = {
 		new GeneratePackageJsonPlugin(basePackage, {})
 	]
 };
+module.exports = config;
 
 
 

diff --git a/examples/polyfill/rspack.config.js b/examples/polyfill/rspack.config.js
@@ -1,8 +1,6 @@
 const path = require("path");
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	context: __dirname,
 	entry: {
 		main: "./src/index.js"
@@ -25,3 +23,4 @@ module.exports = {
 		]
 	}
 };
+module.exports = config;
diff --git a/examples/postcss/rspack.config.js b/examples/postcss/rspack.config.js
@@ -1,4 +1,5 @@
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	mode: "development",
 	entry: "./index.js",
 	builtins: {
@@ -8,3 +9,4 @@ module.exports = {
 		}
 	}
 };
+module.exports = config;
diff --git a/examples/react-15-classic/rspack.config.js b/examples/react-15-classic/rspack.config.js
@@ -1,4 +1,5 @@
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: "./src/index.jsx"
 	},
@@ -21,3 +22,4 @@ module.exports = {
 		}
 	}
 };
+module.exports = config;
diff --git a/examples/react-15/rspack.config.js b/examples/react-15/rspack.config.js
@@ -1,4 +1,5 @@
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: "./src/index.jsx"
 	},
@@ -18,3 +19,4 @@ module.exports = {
 		]
 	}
 };
+module.exports = config;
diff --git a/examples/react-refresh/rspack.config.js b/examples/react-refresh/rspack.config.js
@@ -1,7 +1,7 @@
 /**
  * @type {import('@rspack/cli').Configuration}
  */
-module.exports = {
+const config = {
 	mode: "development",
 	entry: { main: "./src/index.tsx" },
 	builtins: {
@@ -11,3 +11,4 @@ module.exports = {
 		}
 	}
 };
+module.exports = config;
diff --git a/examples/react-with-less/rspack.config.js b/examples/react-with-less/rspack.config.js
@@ -1,5 +1,6 @@
 const path = require("path");
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	context: __dirname,
 	mode: "development",
 	entry: {
@@ -24,3 +25,4 @@ module.exports = {
 		path: path.resolve(__dirname, "dist")
 	}
 };
+module.exports = config;
diff --git a/examples/react-with-sass/rspack.config.js b/examples/react-with-sass/rspack.config.js
@@ -1,4 +1,5 @@
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	mode: "development",
 	entry: {
 		main: ["./src/index.jsx"]
@@ -19,3 +20,4 @@ module.exports = {
 		html: [{}]
 	}
 };
+module.exports = config;
diff --git a/examples/react/rspack.config.js b/examples/react/rspack.config.js
@@ -1,4 +1,5 @@
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: "./src/index.jsx"
 	},
@@ -18,3 +19,4 @@ module.exports = {
 		]
 	}
 };
+module.exports = config;
diff --git a/examples/solid/rspack.config.js b/examples/solid/rspack.config.js
@@ -1,4 +1,5 @@
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	context: __dirname,
 	entry: {
 		main: "./src/index.jsx"

diff --git a/examples/styled-components/rspack.config.js b/examples/styled-components/rspack.config.js
@@ -1,7 +1,5 @@
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: "./src/index.tsx"
 	},
@@ -13,3 +11,4 @@ module.exports = {
 		]
 	}
 };
+module.exports = config;
diff --git a/examples/svelte/rspack.config.js b/examples/svelte/rspack.config.js
@@ -4,8 +4,8 @@ const { default: HtmlPlugin } = require("@rspack/plugin-html");
 
 const mode = process.env.NODE_ENV || "development";
 const prod = mode === "production";
-
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: ["./src/main.ts"]
 	},
@@ -56,3 +56,4 @@ module.exports = {
 		historyApiFallback: true
 	}
 };
+module.exports = config;
diff --git a/examples/svgr/rspack.config.js b/examples/svgr/rspack.config.js
@@ -1,7 +1,5 @@
-/**
- * @type {import('@rspack/cli').Configuration}
- */
-module.exports = {
+/** @type {import('@rspack/cli').Configuration} */
+const config = {
 	entry: {
 		main: "./index.jsx"
 	},
@@ -17,3 +15,4 @@ module.exports = {
 		html: [{ template: "./index.html" }]
 	}
 };
+module.exports = config;