feat: add typings about LoaderDefinition

web-infra-dev · Apr 24, 2023 · 10df027 · 10df027
1 parent e2647bb
commit 10df027
Show file tree

Hide file tree

Showing 99 changed files with 149 additions and 113 deletions.
diff --git a/packages/rspack/src/config/adapter-rule-use.ts b/packages/rspack/src/config/adapter-rule-use.ts
@@ -51,21 +51,21 @@ export interface LoaderObject {
 	normalExecuted: boolean;
 }
 
-export interface LoaderContext {
+export interface LoaderContext<OptionsType = {}> {
 	version: 2;
 	resource: string;
 	resourcePath: string;
 	resourceQuery: string;
 	resourceFragment: string;
 	async(): (
-		err: Error | null,
-		content: string | Buffer,
+		err?: Error | null,
+		content?: string | Buffer,
 		sourceMap?: string | SourceMap,
 		additionalData?: AdditionalData
 	) => void;
 	callback(
-		err: Error | null,
-		content: string | Buffer,
+		err?: Error | null,
+		content?: string | Buffer,
 		sourceMap?: string | SourceMap,
 		additionalData?: AdditionalData
 	): void;
@@ -99,7 +99,7 @@ export interface LoaderContext {
 	loaders: LoaderObject[];
 	mode?: Mode;
 	hot?: boolean;
-	getOptions(schema?: any): unknown;
+	getOptions(schema?: any): OptionsType;
 	resolve(
 		context: string,
 		request: string,
@@ -136,7 +136,7 @@ export interface LoaderContext {
 		contextify: (context: string, request: string) => string;
 		createHash: (algorithm?: string) => Hash;
 	};
-	query: unknown;
+	query: string | OptionsType;
 	data: unknown;
 	_compiler: Compiler;
 	_compilation: Compiler["compilation"];
@@ -147,6 +147,7 @@ export interface LoaderContext {
 	 * @internal
 	 */
 	__internal__isPitching: boolean;
+	// TODO: LoaderPluginLoaderContext
 }
 
 export interface LoaderResult {
@@ -160,6 +161,38 @@ export interface LoaderResult {
 	buildDependencies: string[];
 }
 
+export interface LoaderDefinitionFunction<
+	OptionsType = {},
+	ContextAdditions = {}
+> {
+	(
+		this: LoaderContext<OptionsType> & ContextAdditions,
+		content: string,
+		sourceMap?: string | SourceMap,
+		additionalData?: AdditionalData
+	): string | void | Buffer | Promise<string | Buffer>;
+}
+
+export interface PitchLoaderDefinitionFunction<
+	OptionsType = {},
+	ContextAdditions = {}
+> {
+	(
+		this: LoaderContext<OptionsType> & ContextAdditions,
+		remainingRequest: string,
+		previousRequest: string,
+		data: object
+	): string | void | Buffer | Promise<string | Buffer>;
+}
+
+export type LoaderDefinition<
+	OptionsType = {},
+	ContextAdditions = {}
+> = LoaderDefinitionFunction<OptionsType, ContextAdditions> & {
+	raw?: false;
+	pitch?: PitchLoaderDefinitionFunction;
+};
+
 export function createRawModuleRuleUses(
 	uses: RuleSetUse,
 	options: ComposeJsUseOptions

diff --git a/packages/rspack/src/config/types.ts b/packages/rspack/src/config/types.ts
@@ -15,7 +15,11 @@ import * as oldBuiltins from "./builtins";
 
 export type { BannerConditions, BannerCondition } from "./builtins";
 
-export type { LoaderContext } from "./adapter-rule-use";
+export type {
+	LoaderContext,
+	LoaderDefinitionFunction,
+	LoaderDefinition
+} from "./adapter-rule-use";
 
 export type Configuration = RspackOptions;
 

diff --git a/packages/rspack/tests/configCases/loader/pre-post-loader/loader1.js b/packages/rspack/tests/configCases/loader/pre-post-loader/loader1.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	return source + 'module.exports += " loader1";\n';
 };
diff --git a/packages/rspack/tests/configCases/loader/pre-post-loader/loader2.js b/packages/rspack/tests/configCases/loader/pre-post-loader/loader2.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	return source + 'module.exports += " loader2";\n';
 };
diff --git a/packages/rspack/tests/configCases/loader/pre-post-loader/loader3.js b/packages/rspack/tests/configCases/loader/pre-post-loader/loader3.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	return source + 'module.exports += " loader3";\n';
 };
diff --git a/packages/rspack/tests/fixtures/count-loader.js b/packages/rspack/tests/fixtures/count-loader.js
@@ -1,6 +1,6 @@
 let counter = 0;
 
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function () {
 	return `module.exports = ${counter++};`;
 };
diff --git a/packages/rspack/tests/fixtures/delay-loader.js b/packages/rspack/tests/fixtures/delay-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	var cb = this.async();
 	setTimeout(function () {

diff --git a/packages/rspack/tests/fixtures/errors/add-comment-loader.js b/packages/rspack/tests/fixtures/errors/add-comment-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	return source + "// some comment";
 };
diff --git a/packages/rspack/tests/fixtures/errors/async-error-loader.js b/packages/rspack/tests/fixtures/errors/async-error-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	const callback = this.async();
 	const error = new Error("this is a callback error");

diff --git a/packages/rspack/tests/fixtures/errors/emit-error-loader.js b/packages/rspack/tests/fixtures/errors/emit-error-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	this.emitWarning(new Error("this is a warning"));
 	this.emitError(new Error("this is an error"));

diff --git a/packages/rspack/tests/fixtures/errors/identity-loader.js b/packages/rspack/tests/fixtures/errors/identity-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	return source;
 };
diff --git a/packages/rspack/tests/fixtures/errors/irregular-error-loader.js b/packages/rspack/tests/fixtures/errors/irregular-error-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	const empty = null;
 	const emptyError = new Error();

diff --git a/packages/rspack/tests/fixtures/errors/no-return-loader.js b/packages/rspack/tests/fixtures/errors/no-return-loader.js
@@ -1,2 +1,2 @@
-/** @type {import("../../../../").LoaderDefinition} */
-module.exports = function () {};
+/** @type {import("@rspack/core").LoaderDefinition} */
+module.exports = function () { };
diff --git a/packages/rspack/tests/fixtures/errors/throw-error-loader.js b/packages/rspack/tests/fixtures/errors/throw-error-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	throw new Error("this is a thrown error");
 };
diff --git a/webpack-test/cases/async-modules/runtime-performance/loader.js b/webpack-test/cases/async-modules/runtime-performance/loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition<{ i: string }>} */
+/** @type {import("@rspack/core").LoaderDefinition<{ i: string }>} */
 module.exports = function () {
 	const options = this.getOptions();
 	const i = +options.i;

diff --git a/webpack-test/cases/compile/error-hide-stack/loader.js b/webpack-test/cases/compile/error-hide-stack/loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function () {
 	var err = new Error("Message");
 	err.stack = "Stack";

diff --git a/webpack-test/cases/errors/load-module-cycle-multiple/loader.js b/webpack-test/cases/errors/load-module-cycle-multiple/loader.js
@@ -1,6 +1,6 @@
 const { promisify } = require("util");
 
-/** @type {import("../../../../").LoaderDefinitionFunction} */
+/** @type {import("@rspack/core").LoaderDefinitionFunction} */
 exports.default = function (source) {
 	const content = JSON.parse(source);
 	// content is one reference or an array of references
@@ -13,11 +13,11 @@ exports.default = function (source) {
 		// bug from https://github.com/webpack/webpack/issues/14379 doesn't occur if
 		// they are loaded in parallel.
 		const loadedRefs = []
-		for(const ref of refs) {
+		for (const ref of refs) {
 			try {
 				const source = await loadModulePromise("../loader!" + ref);
 				loadedRefs.push([ref, JSON.parse(source)]);
-			} catch(err) {
+			} catch (err) {
 				loadedRefs.push([ref, `err: ${err && err.message}`]);
 			}
 		}

diff --git a/webpack-test/cases/errors/load-module-cycle/loader.js b/webpack-test/cases/errors/load-module-cycle/loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinitionFunction} */
+/** @type {import("@rspack/core").LoaderDefinitionFunction} */
 exports.default = function (source) {
 	const ref = JSON.parse(source);
 	const callback = this.async();

diff --git a/webpack-test/cases/errors/load-module-error/error-loader.js b/webpack-test/cases/errors/load-module-error/error-loader.js
@@ -1,5 +1,5 @@
-/** @type {import("../../../../types").LoaderDefinition} */
-module.exports = function(source) {
+/** @type {import("@rspack/core").LoaderDefinition} */
+module.exports = function (source) {
 	const callback = this.async();
 	callback(new Error("err: abc"));
 }
diff --git a/webpack-test/cases/errors/load-module-error/loader.js b/webpack-test/cases/errors/load-module-error/loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinitionFunction} */
+/** @type {import("@rspack/core").LoaderDefinitionFunction} */
 exports.default = function (source) {
 	const callback = this.async();
 	const ref = JSON.parse(source);

diff --git a/webpack-test/cases/errors/loader-error-warning/error-loader.js b/webpack-test/cases/errors/loader-error-warning/error-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition<string>} */
+/** @type {import("@rspack/core").LoaderDefinition<string>} */
 module.exports = function (source) {
 	//@ts-expect-error errors must be Errors, string is not recommended and should lead to type error
 	this.emitError(this.query.slice(1));

diff --git a/webpack-test/cases/errors/loader-error-warning/warning-loader.js b/webpack-test/cases/errors/loader-error-warning/warning-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition<string>} */
+/** @type {import("@rspack/core").LoaderDefinition<string>} */
 module.exports = function (source) {
 	//@ts-expect-error warnings must be Errors, string is not recommended and should lead to type error
 	this.emitWarning(this.query.slice(1));

diff --git a/webpack-test/cases/loaders/async/loaders/asyncloader.js b/webpack-test/cases/loaders/async/loaders/asyncloader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (content) {
 	var cb = this.async();
 	if (!cb) throw new Error("Loader should allow async mode");

diff --git a/webpack-test/cases/loaders/async/loaders/syncloader.js b/webpack-test/cases/loaders/async/loaders/syncloader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (content) {
 	return content;
 };
diff --git a/webpack-test/cases/loaders/emit-file/loader.js b/webpack-test/cases/loaders/emit-file/loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (content) {
 	this.emitFile("extra-file.js", content);
 	return "";

diff --git a/webpack-test/cases/loaders/import-module/loader.js b/webpack-test/cases/loaders/import-module/loader.js
@@ -2,7 +2,7 @@
 
 const path = require("path");
 
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function () {
 	const callback = this.async();
 	this.importModule(
@@ -16,8 +16,7 @@ module.exports = function () {
 
 			callback(
 				null,
-				`module.exports = ${
-					exports.asset ? JSON.stringify(exports.asset) : undefined
+				`module.exports = ${exports.asset ? JSON.stringify(exports.asset) : undefined
 				}`
 			);
 		}

diff --git a/webpack-test/cases/loaders/issue-10725/loader.js b/webpack-test/cases/loaders/issue-10725/loader.js
@@ -2,7 +2,7 @@ const { getRemainingRequest, stringifyRequest } = require("loader-utils");
 
 const loaderPath = require.resolve("./loader");
 
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function () {
 	if (this.query === "?load") {
 		return `

diff --git a/webpack-test/cases/loaders/module-description-file/reverseloader.js b/webpack-test/cases/loaders/module-description-file/reverseloader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (content) {
 	return content.split("").reverse().join("");
 };
diff --git a/webpack-test/cases/loaders/query/loaders/queryloader.js b/webpack-test/cases/loaders/query/loaders/queryloader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (content) {
 	return (
 		"module.exports = " +

diff --git a/webpack-test/cases/loaders/resolve/loader.js b/webpack-test/cases/loaders/resolve/loader.js
@@ -1,5 +1,5 @@
 const path = require("path");
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function () {
 	const resolve1 = this.getResolve();
 	const resolve2 = this.getResolve({

diff --git a/webpack-test/cases/loaders/utils/loader.js b/webpack-test/cases/loaders/utils/loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function () {
 	return `module.exports = {
 	request1: ${JSON.stringify(

diff --git a/webpack-test/cases/parsing/context/loaders/queryloader.js b/webpack-test/cases/parsing/context/loaders/queryloader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (content) {
 	return (
 		"module.exports = " +

diff --git a/webpack-test/cases/parsing/precreated-ast/ast-loader.js b/webpack-test/cases/parsing/precreated-ast/ast-loader.js
@@ -3,7 +3,7 @@
 const acorn = require("acorn");
 const acornParser = acorn.Parser;
 
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	const comments = [];
 
@@ -23,7 +23,7 @@ module.exports = function (source) {
 
 	//@ts-ignore
 	ast.comments = comments;
-	this.callback(null, source, null, {
+	this.callback(null, source, undefined, {
 		webpackAST: ast
 	});
 };
diff --git a/webpack-test/cases/resolving/context/loaders/queryloader.js b/webpack-test/cases/resolving/context/loaders/queryloader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (content) {
 	return (
 		"module.exports = " +

diff --git a/webpack-test/configCases/asset-modules/data-url/loader.js b/webpack-test/configCases/asset-modules/data-url/loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition<{ f(): any }>} */
+/** @type {import("@rspack/core").LoaderDefinition<{ f(): any }>} */
 module.exports = function (source) {
 	return `${source}, World!`;
 };
diff --git a/webpack-test/configCases/cache-dependencies/managed-items-unsafe-cache/loader.js b/webpack-test/configCases/cache-dependencies/managed-items-unsafe-cache/loader.js
@@ -1,6 +1,6 @@
 const path = require("path");
 
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	this.addDependency(path.resolve(__dirname, "node_modules/package/extra.js"));
 	this.addDependency(path.resolve(__dirname, "extra.js"));

diff --git a/webpack-test/configCases/cache-dependencies/managed-items/loader.js b/webpack-test/configCases/cache-dependencies/managed-items/loader.js
@@ -1,6 +1,6 @@
 const path = require("path");
 
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	this.addDependency(path.resolve(__dirname, "node_modules/package/extra.js"));
 	this.addDependency(path.resolve(__dirname, "extra.js"));

diff --git a/webpack-test/configCases/concatenate-modules/import-module/loader.js b/webpack-test/configCases/concatenate-modules/import-module/loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinitionFunction} */
+/** @type {import("@rspack/core").LoaderDefinitionFunction} */
 module.exports = function () {
 	const callback = this.async();
 	this.importModule("./module1", { baseUri: "webpack://" }, (err, exports) => {

diff --git a/webpack-test/configCases/context-replacement/d/queryloader.js b/webpack-test/configCases/context-replacement/d/queryloader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (content) {
 	return (
 		"module.exports = " +

diff --git a/webpack-test/configCases/deprecations/invalid-dependencies/loader.js b/webpack-test/configCases/deprecations/invalid-dependencies/loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	this.addDependency("loader.js");
 	this.addDependency("../**/dir/*.js");

diff --git a/webpack-test/configCases/dll-plugin/0-create-dll/g-loader.js b/webpack-test/configCases/dll-plugin/0-create-dll/g-loader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition} */
+/** @type {import("@rspack/core").LoaderDefinition} */
 module.exports = function (source) {
 	return source;
 };
diff --git a/webpack-test/configCases/inner-graph/_helpers/entryLoader.js b/webpack-test/configCases/inner-graph/_helpers/entryLoader.js
@@ -1,4 +1,4 @@
-/** @type {import("../../../../").LoaderDefinition<string>} */
+/** @type {import("@rspack/core").LoaderDefinition<string>} */
 module.exports = function () {
 	const { name, expect, usedExports } = JSON.parse(this.query.slice(1));
 	return [