use safeCloneDeep instead of cloneDeep, update schemas etc

Author: cscheid

src/command/render/pandoc-dependencies-html.ts

@@ -35,6 +35,7 @@ import { ensureDirSync } from "../../deno_ral/fs.ts";
 import { ProjectContext } from "../../project/types.ts";
 import { projectOutputDir } from "../../project/project-shared.ts";
 import { insecureHash } from "../../core/hash.ts";
+import { safeCloneDeep } from "../../core/safe-clone-deep.ts";
 
 export async function writeDependencies(
   dependenciesFile: string,
@@ -146,7 +147,7 @@ export function resolveDependencies(
   project?: ProjectContext,
 ) {
   // deep copy to not mutate caller's object
-  extras = ld.cloneDeep(extras);
+  extras = safeCloneDeep(extras);
 
   const lines: string[] = [];
   const afterBodyLines: string[] = [];

src/command/render/pandoc-html.ts

@@ -5,7 +5,7 @@
  */
 
 import { join } from "../../deno_ral/path.ts";
-import { cloneDeep, uniqBy } from "../../core/lodash.ts";
+import { uniqBy } from "../../core/lodash.ts";
 
 import {
   Format,
@@ -19,7 +19,6 @@ import {
 } from "../../config/types.ts";
 import { ProjectContext } from "../../project/types.ts";
 
-import { TempContext } from "../../core/temp.ts";
 import { cssImports, cssResources } from "../../core/css.ts";
 import { cleanSourceMappingUrl, compileSass } from "../../core/sass.ts";
 
@@ -40,6 +39,7 @@ import { md5HashBytes } from "../../core/hash.ts";
 import { InternalError } from "../../core/lib/error.ts";
 import { assert } from "testing/asserts";
 import { safeModeFromFile } from "../../deno_ral/fs.ts";
+import { safeCloneDeep } from "../../core/safe-clone-deep.ts";
 
 // The output target for a sass bundle
 // (controls the overall style tag that is emitted)
@@ -55,7 +55,7 @@ export async function resolveSassBundles(
   format: Format,
   project: ProjectContext,
 ) {
-  extras = cloneDeep(extras);
+  extras = safeCloneDeep(extras);
 
   const mergedBundles: Record<string, SassBundleWithBrand[]> = {};
 
@@ -91,27 +91,35 @@ export async function resolveSassBundles(
     const maybeBrandBundle = bundlesWithBrand.find((bundle) =>
       bundle.key === "brand"
     );
-    assert(!maybeBrandBundle ||
-      !maybeBrandBundle.user?.find((v) => v === "brand") &&
-      !maybeBrandBundle.dark?.user?.find((v) => v === "brand"));
-    let foundBrand = {light: false, dark: false};
+    assert(
+      !maybeBrandBundle ||
+        !maybeBrandBundle.user?.find((v) => v === "brand") &&
+          !maybeBrandBundle.dark?.user?.find((v) => v === "brand"),
+    );
+    let foundBrand = { light: false, dark: false };
     const bundles: SassBundle[] = bundlesWithBrand.filter((bundle) =>
       bundle.key !== "brand"
     ).map((bundle) => {
       const userBrand = bundle.user?.findIndex((layer) => layer === "brand");
       let cloned = false;
       if (userBrand && userBrand !== -1) {
-        bundle = cloneDeep(bundle);
+        bundle = safeCloneDeep(bundle);
         cloned = true;
         bundle.user!.splice(userBrand, 1, ...(maybeBrandBundle?.user || []));
         foundBrand.light = true;
       }
-      const darkBrand = bundle.dark?.user?.findIndex((layer) => layer === "brand");
+      const darkBrand = bundle.dark?.user?.findIndex((layer) =>
+        layer === "brand"
+      );
       if (darkBrand && darkBrand !== -1) {
         if (!cloned) {
-          bundle = cloneDeep(bundle);
+          bundle = safeCloneDeep(bundle);
         }
-        bundle.dark!.user!.splice(darkBrand, 1, ...(maybeBrandBundle?.dark?.user || []))
+        bundle.dark!.user!.splice(
+          darkBrand,
+          1,
+          ...(maybeBrandBundle?.dark?.user || []),
+        );
         foundBrand.dark = true;
       }
       return bundle as SassBundle;
@@ -122,18 +130,19 @@ export async function resolveSassBundles(
         key: "brand",
         user: !foundBrand.light && maybeBrandBundle?.user as SassLayer[] || [],
         dark: !foundBrand.dark && maybeBrandBundle?.dark?.user && {
-          user: maybeBrandBundle.dark.user as SassLayer[],
-          default: maybeBrandBundle.dark.default
-        } || undefined
+              user: maybeBrandBundle.dark.user as SassLayer[],
+              default: maybeBrandBundle.dark.default,
+            } || undefined,
       });
     }
 
     // See if any bundles are providing dark specific css
     const hasDark = bundles.some((bundle) => bundle.dark !== undefined);
-    defaultStyle =
-      bundles.some((bundle) => bundle.dark !== undefined && bundle.dark.default)
-        ? "dark"
-        : "light";
+    defaultStyle = bundles.some((bundle) =>
+        bundle.dark !== undefined && bundle.dark.default
+      )
+      ? "dark"
+      : "light";
     const targets: SassTarget[] = [{
       name: `${dependency}.min.css`,
       bundles: (bundles as any),
@@ -150,7 +159,7 @@ export async function resolveSassBundles(
 
       // Provide a dark bundle for this
       const darkBundles = bundles.map((bundle) => {
-        bundle = cloneDeep(bundle);
+        bundle = safeCloneDeep(bundle);
         bundle.user = bundle.dark?.user || bundle.user;
         bundle.quarto = bundle.dark?.quarto || bundle.quarto;
         bundle.framework = bundle.dark?.framework || bundle.framework;
@@ -332,7 +341,7 @@ async function resolveQuartoSyntaxHighlighting(
     return extras;
   }
 
-  extras = cloneDeep(extras);
+  extras = safeCloneDeep(extras);
 
   // If we're using default highlighting, use theme darkness to select highlight style
   const mediaAttr = attribForThemeStyle(style);

src/command/render/pandoc.ts

@@ -207,6 +207,8 @@ import { isWindows } from "../../deno_ral/platform.ts";
 import { appendToCombinedLuaProfile } from "../../core/performance/perfetto-utils.ts";
 import { makeTimedFunctionAsync } from "../../core/performance/function-times.ts";
 import { walkJson } from "../../core/json.ts";
+import { safeCloneDeep } from "../../core/safe-clone-deep.ts";
+import { assert } from "testing/asserts";
 
 // in case we are running multiple pandoc processes
 // we need to make sure we capture all of the trace files
@@ -330,7 +332,9 @@ export async function runPandoc(
       JSON.stringify(paramsJson),
     );
 
-    const traceFilters = pandocMetadata?.["_quarto"]?.["trace-filters"] ||
+    // deno-lint-ignore no-explicit-any
+    const traceFilters =
+      (pandocMetadata as any)?.["_quarto"]?.["trace-filters"] ||
       Deno.env.get("QUARTO_TRACE_FILTERS");
 
     if (traceFilters) {
@@ -445,7 +449,7 @@ export async function runPandoc(
 
   // generate defaults and capture defaults to be printed
   let allDefaults = (await generateDefaults(options)) || {};
-  let printAllDefaults = ld.cloneDeep(allDefaults) as FormatPandoc;
+  let printAllDefaults = safeCloneDeep(allDefaults) as FormatPandoc;
 
   // capture any filterParams in the FormatExtras
   const formatFilterParams = {} as Record<string, unknown>;
@@ -1127,7 +1131,7 @@ export async function runPandoc(
 
   // selectively overwrite some resolved metadata (e.g. ensure that metadata
   // computed from inline r expressions gets included @ the bottom).
-  const pandocMetadata = ld.cloneDeep(options.format.metadata || {});
+  const pandocMetadata = safeCloneDeep(options.format.metadata || {});
   for (const key of Object.keys(engineMetadata)) {
     const isChapterTitle = key === kTitle && projectIsBook(options.project);
 
@@ -1161,6 +1165,7 @@ export async function runPandoc(
   dateFields.forEach((dateField) => {
     const date = pandocMetadata[dateField];
     const format = pandocMetadata[kDateFormat];
+    assert(format === undefined || typeof format === "string");
     pandocMetadata[dateField] = resolveAndFormatDate(
       options.source,
       date,
@@ -1180,15 +1185,19 @@ export async function runPandoc(
   // Expand citation dates into CSL dates
   const citationMetadata = pandocMetadata[kCitation];
   if (citationMetadata) {
+    assert(typeof citationMetadata === "object");
+    // ideally we should be asserting non-arrayness here but that's not very fast.
+    // assert(!Array.isArray(citationMetadata));
+    const citationMetadataObj = citationMetadata as Record<string, unknown>;
     const docCSLDate = dateRaw
       ? cslDate(resolveDate(options.source, dateRaw))
       : undefined;
     const fields = ["issued", "available-date"];
     fields.forEach((field) => {
-      if (citationMetadata[field]) {
-        citationMetadata[field] = cslDate(citationMetadata[field]);
+      if (citationMetadataObj[field]) {
+        citationMetadataObj[field] = cslDate(citationMetadataObj[field]);
       } else if (docCSLDate) {
-        citationMetadata[field] = docCSLDate;
+        citationMetadataObj[field] = docCSLDate;
       }
     });
   }
@@ -1228,6 +1237,7 @@ export async function runPandoc(
     !isBeamerOutput(options.format.pandoc)
   ) {
     const docClass = pandocMetadata[kDocumentClass];
+    assert(typeof docClass === "string");
     const isPrintDocumentClass = docClass &&
       ["book", "scrbook"].includes(docClass);
 
@@ -1281,7 +1291,7 @@ export async function runPandoc(
     prefix: "quarto-metadata",
     suffix: ".yml",
   });
-  const pandocPassedMetadata = ld.cloneDeep(pandocMetadata);
+  const pandocPassedMetadata = safeCloneDeep(pandocMetadata);
   delete pandocPassedMetadata.format;
   delete pandocPassedMetadata.project;
   delete pandocPassedMetadata.website;
@@ -1679,7 +1689,7 @@ function runPandocMessage(
 
   const keys = Object.keys(metadata);
   if (keys.length > 0) {
-    const printMetadata = ld.cloneDeep(metadata) as Metadata;
+    const printMetadata = safeCloneDeep(metadata) as Metadata;
     delete printMetadata.format;
 
     // print message

src/command/render/render-contexts.ts

@@ -88,22 +88,8 @@ import {
 } from "../../core/pandoc/pandoc-formats.ts";
 import { ExtensionContext } from "../../extension/types.ts";
 import { NotebookContext } from "../../render/notebook/notebook-types.ts";
+import { safeCloneDeep } from "../../core/safe-clone-deep.ts";
 
-// we can't naively ld.cloneDeep everything
-// because that destroys class instances
-// with private members
-//
-// Currently, that's ProjectContext.
-//
-// TODO: Ideally, we shouldn't be copying the RenderContext at all.
-export function copyRenderContext(
-  context: RenderContext,
-): RenderContext {
-  return {
-    ...ld.cloneDeep(context),
-    project: context.project,
-  };
-}
 export async function resolveFormatsFromMetadata(
   metadata: Metadata,
   input: string,
@@ -230,7 +216,7 @@ export async function renderContexts(
     // we make it optional because some of the callers have
     // actually just cloned it themselves and don't need to preserve
     // the original
-    options = ld.cloneDeep(options) as RenderOptions;
+    options = safeCloneDeep(options) as RenderOptions;
   }
 
   const { engine, target } = await fileExecutionEngineAndTarget(
@@ -357,8 +343,8 @@ function mergeQuartoConfigs(
   ...configs: Array<Metadata>
 ): Metadata {
   // copy all configs so we don't mutate them
-  config = ld.cloneDeep(config);
-  configs = ld.cloneDeep(configs);
+  config = safeCloneDeep(config);
+  configs = safeCloneDeep(configs);
 
   // bibliography needs to always be an array so it can be merged
   const fixupMergeableScalars = (metadata: Metadata) => {
@@ -460,7 +446,7 @@ async function resolveFormats(
 
     // Remove any 'to' information that will force the
     // rendering to a particular format
-    options = ld.cloneDeep(options);
+    options = safeCloneDeep(options);
     delete options.flags?.to;
   }
 
@@ -763,10 +749,10 @@ export async function projectMetadataForInputFile(
       projectType(project.config?.project?.[kProjectType]),
       project.dir,
       dirname(input),
-      ld.cloneDeep(project.config),
+      safeCloneDeep(project.config),
     ) as Metadata;
   } else {
     // Just return the config or empty metadata
-    return ld.cloneDeep(project.config) || {};
+    return safeCloneDeep(project.config) || {};
   }
 }

src/command/render/render-files.ts

@@ -48,7 +48,7 @@ import { outputRecipe } from "./output.ts";
 
 import { renderPandoc } from "./render.ts";
 import { PandocRenderCompletion, RenderServices } from "./types.ts";
-import { copyRenderContext, renderContexts } from "./render-contexts.ts";
+import { renderContexts } from "./render-contexts.ts";
 import { renderProgress } from "./render-info.ts";
 import {
   ExecutedFile,
@@ -114,6 +114,7 @@ import {
 } from "../../project/project-shared.ts";
 import { NotebookContext } from "../../render/notebook/notebook-types.ts";
 import { setExecuteEnvironment } from "../../execute/environment.ts";
+import { safeCloneDeep } from "../../core/safe-clone-deep.ts";
 
 export async function renderExecute(
   context: RenderContext,
@@ -503,7 +504,7 @@ async function renderFileInternal(
 
   for (const format of Object.keys(contexts)) {
     pushTiming("render-context");
-    const context = copyRenderContext(contexts[format]); // since we're going to mutate it...
+    const context = safeCloneDeep(contexts[format]); // since we're going to mutate it...
 
     // disquality some documents from server: shiny
     if (isServerShiny(context.format) && context.project) {

src/config/types.ts

@@ -457,7 +457,7 @@ export interface Format {
 
 export interface LightDarkBrand {
   [kLight]?: Brand;
-  [kDark]?: Brand
+  [kDark]?: Brand;
 }
 
 export interface FormatRender {

src/resources/editor/tools/vs-code.mjs

@@ -8371,6 +8371,10 @@ var require_yaml_intelligence_resources = __commonJS({
             }
           ]
         },
+        {
+          id: "date-format",
+          schema: "string"
+        },
         {
           id: "math-methods",
           enum: {
@@ -12674,6 +12678,13 @@ var require_yaml_intelligence_resources = __commonJS({
           },
           description: "Document date"
         },
+        {
+          name: "date-format",
+          schema: {
+            ref: "date-format"
+          },
+          descript: "Date format for the document"
+        },
         {
           name: "date-modified",
           tags: {
@@ -22914,8 +22925,6 @@ var require_yaml_intelligence_resources = __commonJS({
         "If <code>true</code>, force the presence of the OJS runtime. If\n<code>false</code>, force the absence instead. If unset, the OJS runtime\nis included only if OJS cells are present in the document.",
         "Use the specified file as a style reference in producing a docx,\npptx, or odt file.",
         "Branding information to use for this document. If a string, the path\nto a brand file. If false, don\u2019t use branding on this document. If an\nobject, an inline brand definition, or an object with light and dark\nbrand paths or definitions.",
-        "The path to a light brand file or an inline light brand\ndefinition.",
-        "The path to a dark brand file or an inline dark brand definition.",
         "Theme name, theme scss file, or a mix of both.",
         "The light theme name, theme scss file, or a mix of both.",
         "The light theme name, theme scss file, or a mix of both.",
@@ -24248,12 +24257,12 @@ var require_yaml_intelligence_resources = __commonJS({
         mermaid: "%%"
       },
       "handlers/mermaid/schema.yml": {
-        _internalId: 196120,
+        _internalId: 194255,
         type: "object",
         description: "be an object",
         properties: {
           "mermaid-format": {
-            _internalId: 196112,
+            _internalId: 194247,
             type: "enum",
             enum: [
               "png",
@@ -24269,7 +24278,7 @@ var require_yaml_intelligence_resources = __commonJS({
             exhaustiveCompletions: true
           },
           theme: {
-            _internalId: 196119,
+            _internalId: 194254,
             type: "anyOf",
             anyOf: [
               {