refactor: Resolver.resolveElements returns MetaDataTable to be consistent with other methods

ext · ext · commit 8e4cc43d31fc · 2023-12-24T17:07:33.000+01:00
diff --git a/etc/browser.api.md b/etc/browser.api.md
@@ -979,7 +979,7 @@ export interface ResolvedConfigData {
 export interface Resolver {
     name: string;
     resolveConfig?(id: string, options: ResolverOptions): ConfigData | null;
-    resolveElements?(id: string, options: ResolverOptions): unknown | null;
+    resolveElements?(id: string, options: ResolverOptions): MetaDataTable | null;
     resolvePlugin?(id: string, options: ResolverOptions): Plugin_2 | null;
     resolveTransformer?(id: string, options: ResolverOptions): Transformer_2 | null;
 }
diff --git a/etc/index.api.md b/etc/index.api.md
@@ -1072,7 +1072,7 @@ export interface ResolvedConfigData {
 export interface Resolver {
     name: string;
     resolveConfig?(id: string, options: ResolverOptions): ConfigData | null;
-    resolveElements?(id: string, options: ResolverOptions): unknown | null;
+    resolveElements?(id: string, options: ResolverOptions): MetaDataTable | null;
     resolvePlugin?(id: string, options: ResolverOptions): Plugin_2 | null;
     resolveTransformer?(id: string, options: ResolverOptions): Transformer_2 | null;
 }
diff --git a/src/config/resolver/nodejs/nodejs-resolver.ts b/src/config/resolver/nodejs/nodejs-resolver.ts
@@ -1,4 +1,5 @@
 import path from "node:path";
+import { type MetaDataTable } from "../../../meta";
 import { type Plugin } from "../../../plugin";
 import { legacyRequire } from "../../../resolve";
 import { type Transformer } from "../../../transform";
@@ -68,7 +69,7 @@ export function nodejsResolver(options: { rootDir?: string } = {}): NodeJSResolv
 	return {
 		name: "nodejs-resolver",
 
-		resolveElements(id: string, options: ResolverOptions): unknown | null {
+		resolveElements(id: string, options: ResolverOptions): MetaDataTable | null {
 			return internalRequire(id, options);
 		},
 
diff --git a/src/config/resolver/resolve-helpers.spec.ts b/src/config/resolver/resolve-helpers.spec.ts
@@ -1,4 +1,5 @@
 import { Source } from "../../context";
+import { type MetaDataTable } from "../../meta";
 import { type Plugin } from "../../plugin";
 import { type Transformer } from "../../transform";
 import { type ConfigData } from "../config-data";
@@ -25,10 +26,10 @@ function mockConfigResolver(givenId: string, config: ConfigData): Resolver {
 	};
 }
 
-function mockElementsResolver(givenId: string, elements: unknown): Resolver {
+function mockElementsResolver(givenId: string, elements: MetaDataTable): Resolver {
 	return {
 		name: "mock-elements-resolver",
-		resolveElements(id: string): unknown | null {
+		resolveElements(id: string): MetaDataTable | null {
 			return id === givenId ? elements : null;
 		},
 	};
@@ -122,9 +123,9 @@ describe("resolveElements()", () => {
 	it("should throw error if no entry matches", () => {
 		expect.assertions(1);
 		const resolvers = [
-			mockElementsResolver("foo", { foo: "error" }),
-			mockElementsResolver("bar", { bar: "error" }),
-			mockElementsResolver("baz", { foo: "error" }),
+			mockElementsResolver("foo", { foo: {} }),
+			mockElementsResolver("bar", { bar: {} }),
+			mockElementsResolver("baz", { foo: {} }),
 		];
 		expect(() => {
 			return resolveElements(resolvers, "spam", { cache: false });
diff --git a/src/config/resolver/resolve-helpers.ts b/src/config/resolver/resolve-helpers.ts
@@ -1,4 +1,5 @@
 import { UserError } from "../../error";
+import { type MetaDataTable } from "../../meta";
 import { type Plugin } from "../../plugin";
 import { type Transformer } from "../../transform";
 import { type ConfigData } from "../config-data";
@@ -53,7 +54,7 @@ export function resolveElements(
 	resolvers: Resolver[],
 	id: string,
 	options: ResolverOptions,
-): unknown {
+): MetaDataTable {
 	for (const resolver of resolvers.filter(haveElementsResolver)) {
 		const elements = resolver.resolveElements(id, options);
 		if (elements) {
diff --git a/src/config/resolver/resolver.ts b/src/config/resolver/resolver.ts
@@ -1,3 +1,4 @@
+import { type MetaDataTable } from "../../meta";
 import { type Plugin } from "../../plugin";
 import { type Transformer } from "../../transform";
 import { type ConfigData } from "../config-data";
@@ -21,7 +22,7 @@ export interface Resolver {
 	/**
 	 * Resolve table of element metadata.
 	 */
-	resolveElements?(id: string, options: ResolverOptions): unknown | null;
+	resolveElements?(id: string, options: ResolverOptions): MetaDataTable | null;
 
 	/**
 	 * Resolve a configuration to extend.

Original file line number	Diff line number	Diff line change
`@@ -979,7 +979,7 @@ export interface ResolvedConfigData {`
`979`	`979`	`export interface Resolver {`
`980`	`980`	`name: string;`
`981`	`981`	`resolveConfig?(id: string, options: ResolverOptions): ConfigData \| null;`
`982`		`- resolveElements?(id: string, options: ResolverOptions): unknown \| null;`
	`982`	`+ resolveElements?(id: string, options: ResolverOptions): MetaDataTable \| null;`
`983`	`983`	`resolvePlugin?(id: string, options: ResolverOptions): Plugin_2 \| null;`
`984`	`984`	`resolveTransformer?(id: string, options: ResolverOptions): Transformer_2 \| null;`
`985`	`985`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1072,7 +1072,7 @@ export interface ResolvedConfigData {`
`1072`	`1072`	`export interface Resolver {`
`1073`	`1073`	`name: string;`
`1074`	`1074`	`resolveConfig?(id: string, options: ResolverOptions): ConfigData \| null;`
`1075`		`- resolveElements?(id: string, options: ResolverOptions): unknown \| null;`
	`1075`	`+ resolveElements?(id: string, options: ResolverOptions): MetaDataTable \| null;`
`1076`	`1076`	`resolvePlugin?(id: string, options: ResolverOptions): Plugin_2 \| null;`
`1077`	`1077`	`resolveTransformer?(id: string, options: ResolverOptions): Transformer_2 \| null;`
`1078`	`1078`	`}`