remove Deno.realPathSync from our codebase (keep monkey-patched version because deno's stdlib calls into it)

Author: cscheid

src/command/preview/cmd.ts

@@ -41,6 +41,7 @@ import { isHtmlOutput } from "../../config/format.ts";
 import { renderProject } from "../render/project.ts";
 import { renderServices } from "../render/render-shared.ts";
 import { parseFormatString } from "../../core/pandoc/pandoc-formats.ts";
+import { normalizePath } from "../../core/path.ts";
 export const previewCommand = new Command()
   .name("preview")
   .stopEarly()
@@ -249,7 +250,7 @@ export const previewCommand = new Command()
         // in the project input list -- in this case allow things to proceed
         // without a render
         const format = await previewFormat(file, flags.to, project);
-        const filePath = Deno.realPathSync(file);
+        const filePath = normalizePath(file);
         if (!project.files.input.includes(filePath)) {
           if (extname(file) === ".md" && projectPreviewServe(project)) {
             setPreviewFormat(format, flags, args);

src/command/preview/preview.ts

@@ -72,7 +72,7 @@ import {
 } from "../../project/types.ts";
 import { projectOutputDir } from "../../project/project-shared.ts";
 import { projectContext } from "../../project/project-context.ts";
-import { pathWithForwardSlashes } from "../../core/path.ts";
+import { normalizePath, pathWithForwardSlashes } from "../../core/path.ts";
 import {
   isJupyterHubServer,
   isRStudioServer,
@@ -168,7 +168,7 @@ export async function preview(
   const handler = isPdfContent(result.outputFile)
     ? pdfFileRequestHandler(
       result.outputFile,
-      Deno.realPathSync(file),
+      normalizePath(file),
       flags,
       result.format,
       options.port!,
@@ -178,15 +178,15 @@ export async function preview(
     : project
     ? projectHtmlFileRequestHandler(
       project,
-      Deno.realPathSync(file),
+      normalizePath(file),
       flags,
       result.format,
       reloader,
       changeHandler.render,
     )
     : htmlFileRequestHandler(
       result.outputFile,
-      Deno.realPathSync(file),
+      normalizePath(file),
       flags,
       result.format,
       reloader,
@@ -368,7 +368,7 @@ async function renderForPreview(
   // determine files to watch for reload -- take the resource
   // files detected during render, chase down additional references
   // in css files, then fitler out the _files dir
-  file = Deno.realPathSync(file);
+  file = normalizePath(file);
   const filesDir = join(dirname(file), inputFilesDir(file));
   const resourceFiles = renderResult.files.reduce(
     (resourceFiles: string[], file: RenderResultFile) => {
@@ -399,7 +399,7 @@ async function renderForPreview(
           if (!isAbsolute(extensionFile)) {
             const extensionFullPath = join(dirname(file.input), extensionFile);
             if (existsSync(extensionFullPath)) {
-              extensionFiles.push(Deno.realPathSync(extensionFullPath));
+              extensionFiles.push(normalizePath(extensionFullPath));
             }
           }
         });
@@ -522,7 +522,7 @@ function previewWatcher(watches: Watch[]): Watcher {
     return {
       ...watch,
       files: watch.files.filter(existsSync).map((file) => {
-        return Deno.realPathSync(file);
+        return normalizePath(file);
       }),
     };
   });
@@ -635,7 +635,7 @@ function htmlFileRequestHandlerOptions(
         if (
           prevReq &&
           existsSync(prevReq.path) &&
-          Deno.realPathSync(prevReq.path) === Deno.realPathSync(inputFile) &&
+          normalizePath(prevReq.path) === normalizePath(inputFile) &&
           await previewRenderRequestIsCompatible(prevReq, flags)
         ) {
           // don't wait for the promise so the

src/command/render/cleanup.ts

@@ -10,7 +10,11 @@ import { dirname, extname, isAbsolute, join } from "path/mod.ts";
 
 import * as ld from "../../core/lodash.ts";
 
-import { removeIfEmptyDir, removeIfExists } from "../../core/path.ts";
+import {
+  normalizePath,
+  removeIfEmptyDir,
+  removeIfExists,
+} from "../../core/path.ts";
 import { figuresDir, inputFilesDir } from "../../core/render.ts";
 
 import { Format } from "../../config/types.ts";
@@ -53,7 +57,7 @@ export function renderCleanup(
         filesDirLibDir(input),
       );
       if (existsSync(libDir)) {
-        supporting.push(Deno.realPathSync(libDir));
+        supporting.push(normalizePath(libDir));
       }
       // narrow supporting to figures dir for non-html formats
     } else {
@@ -62,7 +66,7 @@ export function renderCleanup(
         inputFilesDir(input),
       );
       if (existsSync(filesDir)) {
-        filesDir = Deno.realPathSync(filesDir);
+        filesDir = normalizePath(filesDir);
       }
       supporting = supporting.map((supportingDir) => {
         if (filesDir === supportingDir) {

src/command/render/flags.ts

@@ -31,6 +31,7 @@ import { RenderFlags, RenderOptions } from "./types.ts";
 import * as ld from "../../core/lodash.ts";
 
 import { isAbsolute, SEP_PATTERN } from "path/mod.ts";
+import { normalizePath } from "../../core/path.ts";
 
 export const kStdOut = "-";
 
@@ -218,7 +219,7 @@ export async function parseRenderFlags(args: string[]) {
           if (isAbsolute(arg)) {
             flags.executeDir = arg;
           } else {
-            flags.executeDir = Deno.realPathSync(arg);
+            flags.executeDir = normalizePath(arg);
           }
         }
 

src/command/render/freeze.ts

@@ -20,7 +20,12 @@ import { cloneDeep } from "../../core/lodash.ts";
 import { inputFilesDir } from "../../core/render.ts";
 import { TempContext } from "../../core/temp.ts";
 import { md5Hash } from "../../core/hash.ts";
-import { removeIfEmptyDir, removeIfExists, safeRemoveIfExists } from "../../core/path.ts";
+import {
+  normalizePath,
+  removeIfEmptyDir,
+  removeIfExists,
+  safeRemoveIfExists,
+} from "../../core/path.ts";
 
 import {
   kIncludeAfterBody,
@@ -63,7 +68,7 @@ export function freezeExecuteResult(
   // make the supporting dirs relative to the input file dir
   result.supporting = result.supporting.map((file) => {
     if (isAbsolute(file)) {
-      return relative(Deno.realPathSync(dirname(input)), file);
+      return relative(normalizePath(dirname(input)), file);
     } else {
       return file;
     }
@@ -101,7 +106,7 @@ export function defrostExecuteResult(
     if (force || hash === freezeInputHash(source)) {
       // full path to supporting
       result.supporting = result.supporting.map((file) =>
-        join(Deno.realPathSync(dirname(source)), file)
+        join(normalizePath(dirname(source)), file)
       );
 
       // convert includes to files
@@ -135,7 +140,7 @@ export function projectFreezerDir(dir: string, hidden: boolean) {
     ? projectScratchPath(dir, kProjectFreezeDir)
     : join(dir, kProjectFreezeDir);
   ensureDirSync(freezeDir);
-  return Deno.realPathSync(freezeDir);
+  return normalizePath(freezeDir);
 }
 
 export function copyToProjectFreezer(

src/command/render/output-tex.ts

@@ -109,15 +109,15 @@ export function texToPdfOutputRecipe(
 
       // final output needs to either absolute or input dir relative
       // (however it may be working dir relative when it is passed in)
-      return normalizePath(input, finalOutput);
+      return texNormalizePath(input, finalOutput);
     } else {
-      return normalizePath(input, pdfOutput);
+      return texNormalizePath(input, pdfOutput);
     }
   };
 
   const pdfOutput = finalOutput
-    ? finalOutput === kStdOut ? undefined : normalizePath(input, finalOutput)
-    : normalizePath(input, pdfGenerator.computePath(input, format));
+    ? finalOutput === kStdOut ? undefined : texNormalizePath(input, finalOutput)
+    : texNormalizePath(input, pdfGenerator.computePath(input, format));
 
   // tweak writer if it's pdf
   const to = format.pandoc.to === "pdf" ? pdfIntermediateTo : format.pandoc.to;
@@ -210,7 +210,7 @@ export function contextPdfOutputRecipe(
   );
 }
 
-const normalizePath = (input: string, output: string) => {
+const texNormalizePath = (input: string, output: string) => {
   if (isAbsolute(output)) {
     return output;
   } else {

src/command/render/pandoc.ts

@@ -19,7 +19,7 @@ import * as ld from "../../core/lodash.ts";
 import { Document } from "../../core/deno-dom.ts";
 
 import { execProcess } from "../../core/process.ts";
-import { dirAndStem } from "../../core/path.ts";
+import { dirAndStem, normalizePath } from "../../core/path.ts";
 import { mergeConfigs } from "../../core/config.ts";
 
 import {
@@ -468,7 +468,7 @@ export async function runPandoc(
 
     // The user partials (if any)
     const userPartials = readPartials(options.format.metadata, cwd);
-    const inputDir = Deno.realPathSync(cwd);
+    const inputDir = normalizePath(cwd);
     const resolvePath = (path: string) => {
       if (isAbsolute(path)) {
         return path;

src/command/render/project.ts

@@ -61,6 +61,7 @@ import {
   projectOutputDir,
 } from "../../project/project-shared.ts";
 import { asArray } from "../../core/array.ts";
+import { normalizePath } from "../../core/path.ts";
 
 export async function renderProject(
   context: ProjectContext,
@@ -73,7 +74,7 @@ export async function renderProject(
   const projOutputDir = projectOutputDir(context);
 
   // get real path to the project
-  const projDir = Deno.realPathSync(context.dir);
+  const projDir = normalizePath(context.dir);
 
   // is this an incremental render?
   const incremental = !!files;
@@ -90,7 +91,7 @@ export async function renderProject(
       if (!existsSync(target)) {
         throw new Error("Render target does not exist: " + file);
       }
-      return Deno.realPathSync(target);
+      return normalizePath(target);
     });
   };
 
@@ -167,9 +168,9 @@ export async function renderProject(
     (options.flags?.clean == true) && (projType.cleanOutputDir === true)
   ) {
     // ouptut dir
-    const realProjectDir = Deno.realPathSync(context.dir);
+    const realProjectDir = normalizePath(context.dir);
     if (existsSync(projOutputDir)) {
-      const realOutputDir = Deno.realPathSync(projOutputDir);
+      const realOutputDir = normalizePath(projOutputDir);
       if (
         (realOutputDir !== realProjectDir) &&
         realOutputDir.startsWith(realProjectDir)

src/command/render/render-files.ts

@@ -62,7 +62,11 @@ import * as ld from "../../core/lodash.ts";
 import { basename, dirname, join, relative } from "path/mod.ts";
 import { Format } from "../../config/types.ts";
 import { figuresDir, inputFilesDir } from "../../core/render.ts";
-import { removeIfEmptyDir, removeIfExists } from "../../core/path.ts";
+import {
+  normalizePath,
+  removeIfEmptyDir,
+  removeIfExists,
+} from "../../core/path.ts";
 import { resourcePath } from "../../core/resources.ts";
 import { YAMLValidationError } from "../../core/yaml.ts";
 import { resolveParams } from "./flags.ts";
@@ -198,7 +202,7 @@ export async function renderExecute(
     libDir: context.libDir,
     format: context.format,
     projectDir: context.project?.dir,
-    cwd: flags.executeDir || dirname(Deno.realPathSync(context.target.source)),
+    cwd: flags.executeDir || dirname(normalizePath(context.target.source)),
     params: resolveParams(flags.params, flags.paramsFile),
     quiet: flags.quiet,
     previewServer: context.options.previewServer,

src/command/render/render-shared.ts

@@ -46,6 +46,7 @@ import { execProcess } from "../../core/process.ts";
 import { createExtensionContext } from "../../extension/extension.ts";
 import { createTempContext } from "../../core/temp.ts";
 import { createNamedLifetime, getNamedLifetime } from "../../core/lifetimes.ts";
+import { normalizePath } from "../../core/path.ts";
 
 export async function render(
   path: string,
@@ -68,8 +69,8 @@ export async function render(
     // a files list that is only those files in the subdirectory
     let files: string[] | undefined;
     if (context) {
-      const renderDir = Deno.realPathSync(path);
-      const projectDir = Deno.realPathSync(context.dir);
+      const renderDir = normalizePath(path);
+      const projectDir = normalizePath(context.dir);
       if (renderDir !== projectDir) {
         files = context.files.input.filter((file) =>
           file.startsWith(renderDir)