Book projects now collect all the cites

Author: dragonstyle

src/command/render/filters.ts

@@ -64,6 +64,7 @@ import { metadataNormalizationFilterActive } from "./normalize.ts";
 import { kCodeAnnotations } from "../../format/html/format-html-shared.ts";
 import { projectOutputDir } from "../../project/project-shared.ts";
 import { relative } from "path/mod.ts";
+import { citeIndexFilterParams } from "../../project/project-cites.ts";
 
 const kQuartoParams = "quarto-params";
 
@@ -122,6 +123,7 @@ export async function filterParamsJson(
     ...quartoColumnParams,
     ...await quartoFilterParams(options, defaults),
     ...crossrefFilterParams(options, defaults),
+    ...citeIndexFilterParams(options, defaults),
     ...layoutFilterParams(options.format),
     ...languageFilterParams(options.format.language),
     ...filterParams,

src/project/project-cites.ts

@@ -0,0 +1,49 @@
+/*
+* project-cites.ts
+*
+* Copyright (C) 2020-2022 Posit Software, PBC
+*
+*/
+
+import { ensureDirSync, existsSync } from "fs/mod.ts";
+
+import { join } from "path/mod.ts";
+import { PandocOptions } from "../command/render/types.ts";
+import { FormatPandoc } from "../config/types.ts";
+import { projectIsBook } from "./project-context.ts";
+
+import { projectScratchPath } from "./project-scratch.ts";
+
+export const kCitesIndexFile = "cites-index-file";
+
+const kCiteIndexDir = "cites";
+
+type CiteIndex = Record<string, string[]>;
+
+export function citeIndexFilterParams(
+  options: PandocOptions,
+  _defaults?: FormatPandoc,
+) {
+  if (options.project && projectIsBook(options.project)) {
+    return {
+      [kCitesIndexFile]: citeIndexFile(options.project.dir),
+    };
+  } else {
+    return {};
+  }
+}
+
+export function citeIndex(projectDir: string) {
+  const mainIndexFile = citeIndexFile(projectDir);
+  const mainIndex: CiteIndex = existsSync(mainIndexFile)
+    ? JSON.parse(Deno.readTextFileSync(mainIndexFile))
+    : {};
+  return mainIndex;
+}
+
+function citeIndexFile(projectDir: string) {
+  // read (or create) main index
+  const citesDir = projectScratchPath(projectDir, kCiteIndexDir);
+  ensureDirSync(citesDir);
+  return join(citesDir, "index.json");
+}

src/resources/filters/main.lua

@@ -60,6 +60,7 @@ import("./quarto-init/includes.lua")
 import("./quarto-init/resourcerefs.lua")
 
 import("./quarto-post/book.lua")
+import("./quarto-post/cites.lua")
 import("./quarto-post/delink.lua")
 import("./quarto-post/fig-cleanup.lua")
 import("./quarto-post/foldcode.lua")
@@ -217,6 +218,7 @@ local quartoPre = {
 
 local quartoPost = {
   -- quarto-post
+  { name = "post-cites", filter = indexCites() },
   { name = "post-foldCode", filter = foldCode() },
   { name = "post-figureCleanupCombined", filter = combineFilters({
     latexDiv(),
@@ -244,6 +246,7 @@ local quartoFinalize = {
     })
   },
   { name = "finalize-bookCleanup", filter = bookCleanup() },
+  { name = "finalize-cites", filter = writeCites() },
   { name = "finalize-metaCleanup", filter = metaCleanup() },
   { name = "finalize-dependencies", filter = dependencies() },
   { name = "finalize-wrapped-writer", filter = wrapped_writer() }

src/resources/filters/quarto-post/cites.lua

@@ -0,0 +1,54 @@
+-- cites.lua
+-- Copyright (C) 2020-2022 Posit Software, PBC
+
+local cites = pandoc.List() 
+local kRefsIndentifier = "refs-target-identifier"
+
+function indexCites()   
+  return {
+    Div = function(el) 
+      local refsIndentifier = param(kRefsIndentifier)
+      if el.attr.identifier == 'refs' and refsIndentifier then 
+        tappend(el.content, {pandoc.Plain(refsIndentifier)})
+        return el;
+      end
+    end,
+    Cite = function(el) 
+      el.citations:map(function (cite) 
+        cites:insert(cite.id)
+      end)
+    end
+  }
+end
+
+function writeCites() 
+  return {
+    Pandoc = function(el)
+      -- the file to write to
+      local citesFilePath = param("cites-index-file")
+      if citesFilePath then
+        -- open the file
+        local citesRaw = _quarto.file.read(citesFilePath)
+        local documentCites = {}
+        if citesRaw then
+          documentCites = quarto.json.decode(citesRaw)
+        end
+
+        -- write the cites
+        local inputFile = quarto.doc.input_file
+        local relativeFilePath = pandoc.path.make_relative(inputFile, quarto.project.directory)
+        documentCites[relativeFilePath] = cites
+
+        -- write the file
+        local json = quarto.json.encode(documentCites)
+        local file = io.open(citesFilePath, "w")
+        if file ~= nil then
+          file:write(json .. "\n")
+          file:close()
+        else
+          fail('Error opening book citations file at ' .. citesFilePath)
+        end
+      end
+    end
+  }
+end