Improve filter type system

Author: dragonstyle

src/command/render/defaults.ts

@@ -8,7 +8,7 @@
 import { extname } from "path/mod.ts";
 import { stringify } from "encoding/yaml.ts";
 
-import { FormatPandoc } from "../../config/types.ts";
+import { FormatPandoc, QuartoFilter } from "../../config/types.ts";
 import { isLatexOutput } from "../../config/format.ts";
 
 import {
@@ -121,6 +121,16 @@ export function pandocDefaultsMessage(
     }
   });
 
+  const filtersContains = (filters: QuartoFilter[], filter: QuartoFilter) => {
+    return filters.find((sysFilter) => {
+      const sysPath = typeof (sysFilter) === "string"
+        ? sysFilter
+        : sysFilter.path;
+      const filterPath = typeof (filter) === "string" ? filter : filter.path;
+      return sysPath === filterPath;
+    });
+  };
+
   // simplify crossref filter
   if (defaults.filters?.length) {
     defaults.filters = defaults.filters
@@ -137,7 +147,7 @@ export function pandocDefaultsMessage(
           filter !== layoutFilter() &&
           filter !== authorsFilter() &&
           filter !== quartoFinalizeFilter() &&
-          !sysFilters.includes(filter);
+          filtersContains(sysFilters, filter);
       });
     if (defaults.filters?.length === 0) {
       delete defaults.filters;

src/command/render/filters.ts

@@ -35,7 +35,11 @@ import {
   kTocTitleDocument,
 } from "../../config/constants.ts";
 import { PandocOptions } from "./types.ts";
-import { FormatLanguage, FormatPandoc } from "../../config/types.ts";
+import {
+  FormatLanguage,
+  FormatPandoc,
+  QuartoFilter,
+} from "../../config/types.ts";
 import { Metadata } from "../../config/types.ts";
 import { kProjectType } from "../../project/types.ts";
 import { bibEngine } from "../../config/pdf.ts";
@@ -482,7 +486,10 @@ function initFilterParams(dependenciesFile: string) {
 
 const kQuartoFilterMarker = "quarto";
 
-export function resolveFilters(filters: string[], options: PandocOptions) {
+export function resolveFilters(
+  filters: QuartoFilter[],
+  options: PandocOptions,
+): QuartoFilter[] | undefined {
   // build list of quarto filters
   const quartoFilters: string[] = [];
   quartoFilters.push(quartoPreFilter());
@@ -559,10 +566,18 @@ function citeMethod(options: PandocOptions): CiteMethod | null {
   }
 }
 
-function resolveFilterExtension(options: PandocOptions, filters: string[]) {
+function resolveFilterExtension(
+  options: PandocOptions,
+  filters: QuartoFilter[],
+): QuartoFilter[] {
   // Resolve any filters that are provided by an extension
   const results = filters.flatMap((filter) => {
-    if (filter !== kQuartoFilterMarker && !existsSync(filter)) {
+    // Look for extension names in the filter list and result them
+    // into the filters provided by the extension
+    if (
+      filter !== kQuartoFilterMarker && typeof (filter) === "string" &&
+      !existsSync(filter)
+    ) {
       const extension = options.extension?.find(
         filter,
         options.source,

src/command/render/pandoc.ts

@@ -562,7 +562,16 @@ export async function runPandoc(
     ];
 
     // make the filter paths windows safe
-    allDefaults.filters = allDefaults.filters.map(pandocMetadataPath);
+    allDefaults.filters = allDefaults.filters.map((filter) => {
+      if (typeof (filter) === "string") {
+        return pandocMetadataPath(filter);
+      } else {
+        return {
+          type: filter.type,
+          path: pandocMetadataPath(filter.path),
+        };
+      }
+    });
 
     // Capture any format filter params
     const filterParams = extras[kFilterParams];

src/config/types.ts

@@ -245,6 +245,13 @@ export interface SassBundle extends SassBundleLayers {
   attribs?: Record<string, string>;
 }
 
+export type PandocFilter = {
+  type: "json" | "lua";
+  path: string;
+};
+
+export type QuartoFilter = string | PandocFilter;
+
 export interface FormatExtras {
   args?: string[];
   pandoc?: FormatPandoc;
@@ -254,8 +261,8 @@ export interface FormatExtras {
   [kIncludeBeforeBody]?: string[];
   [kIncludeAfterBody]?: string[];
   [kFilters]?: {
-    pre?: string[];
-    post?: string[];
+    pre?: QuartoFilter[];
+    post?: QuartoFilter[];
   };
   [kFilterParams]?: Record<string, unknown>;
   postprocessors?: Array<(output: string) => Promise<void>>;
@@ -383,7 +390,7 @@ export interface FormatPandoc {
   [kReferenceLocation]?: string;
   [kCiteproc]?: boolean;
   [kCiteMethod]?: string;
-  [kFilters]?: string[];
+  [kFilters]?: QuartoFilter[];
   [kPdfEngine]?: string;
   [kPdfEngineOpts]?: string[];
   [kPdfEngineOpt]?: string;