further type reworks

noelforte · Dec 10, 2024 · 088fe72 · 088fe72
1 parent c2e0bc7
commit 088fe72
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 17 deletions.
diff --git a/src/types/vento.ts b/src/types/vento.ts
@@ -1,13 +1,19 @@
-import type { Merge } from 'type-fest';
+// Vento library augmentations
+import type { MergeDeep } from 'type-fest';
 import type { Environment, Tag } from 'ventojs/src/environment.js';
-import type { Token } from 'ventojs/src/tokenizer.js';
 
-import type { EleventyTagInfo } from '../utils/create-vento-tag.ts';
+import type { EleventyTagInfo, EleventyTag } from '../utils/create-vento-tag.ts';
 import type { EleventyFunctionMap, EleventyDataCascade, EleventyFunction } from './eleventy.ts';
 
-export type EleventyVentoEnvironment = Merge<Environment, VentoOverrides>;
+// Filters
+type EleventyVentoFilterThis = {
+	data: EleventyDataCascade;
+	env: EleventyVentoEnvironment;
+};
+
 type EleventyVentoFilter = EleventyFunction<EleventyVentoFilterThis>;
 
+// Environment overrides
 type VentoOverrides = {
 	tags: (Tag | EleventyTag)[];
 	filters: Record<string, EleventyVentoFilter>;
@@ -17,18 +23,9 @@ type VentoOverrides = {
 	};
 };
 
-export type EleventyVentoFilterThis = {
-	data: EleventyDataCascade;
-	env: EleventyVentoEnvironment;
-};
-
-export type EleventyTag = (
-	env: EleventyVentoEnvironment,
-	code: string,
-	output: string,
-	tokens: Token[]
-) => string | undefined;
+export type EleventyVentoEnvironment = MergeDeep<Environment, VentoOverrides>;
 
+// Redeclare vento's default export declaration so we can use EleventyVentoEnvironment instead
 declare module 'ventojs' {
-	export default function (options: Options): Merge<Environment, VentoOverrides>;
+	export default function (options: Options): EleventyVentoEnvironment;
 }
diff --git a/src/utils/create-vento-tag.ts b/src/utils/create-vento-tag.ts
@@ -2,7 +2,15 @@
  * @file Factory function that creates vento tags from eleventy functions
  */
 
-import type { EleventyTag } from '../types/vento.js';
+import type { EleventyVentoEnvironment } from '../types/vento.js';
+import type { Token } from 'ventojs/src/tokenizer.js';
+
+export type EleventyTag = (
+	env: EleventyVentoEnvironment,
+	code: string,
+	output: string,
+	tokens: Token[]
+) => string | undefined;
 
 export interface EleventyTagInfo {
 	name: string;