cmd.ts

/*
 * cmd.ts
 *
 * Copyright (C) 2021-2022 Posit Software, PBC
 */

import { Command } from "cliffy/command/mod.ts";

import {
  ESBuildAnalysis,
  esbuildAnalyze,
  esbuildCompile,
} from "../../../core/esbuild.ts";
import { buildIntelligenceResources } from "../../../core/schema/build-schema-file.ts";
import { formatResourcePath, resourcePath } from "../../../core/resources.ts";
import { simple } from "acorn/walk";
import { Parser } from "acorn/acorn";
import classFields from "acorn-class-fields";
import { initYamlIntelligenceResourcesFromFilesystem } from "../../../core/schema/utils.ts";

// initialize language handlers
import "../../../core/handlers/handlers.ts";
import { join } from "../../../deno_ral/path.ts";

function ensureAllowableIDESyntax(src: string, filename: string) {
  const ast = Parser.extend(classFields).parse(src, {
    ecmaVersion: "2020",
    sourceType: "module",
  });
  let failed = false;
  simple(ast, {
    // deno-lint-ignore no-explicit-any
    ChainExpression(_node: any) {
      console.error(
        `Failure: Chain expression \`?.\` not allowed in ${filename}`,
      );
      failed = true;
    },
    // deno-lint-ignore no-explicit-any
    LogicalExpression(node: any) {
      if (node.operator === "??") {
        console.error(
          `Failure: Nullish coalescing operator \`??\` not allows in ${filename}`,
        );
        failed = true;
      }
    },
  });
  if (failed) {
    throw new Error("Found syntax that is not allowed");
  }
}

async function buildYAMLJS() {
  // convert tree-sitter-yaml to a JSON object that can be imported directly.
  // In principle this never changes so running it every time is overkill, but this
  // way we document the generation of the JSON object.
  //
  // inexplicably, using TextEncoder inside a web worker on QtWebEngine freezes
  // the entire thread. That means we can't use base64 strings to encode the wasm
  // values. So we will encode them as plain js numbers. facepalm
  const treeSitterYamlJson = {
    "data": Array.from(Deno.readFileSync(
      resourcePath("editor/tools/yaml/tree-sitter-yaml.wasm"),
    )),
  };
  Deno.writeTextFileSync(
    resourcePath("editor/tools/yaml/tree-sitter-yaml.json"),
    JSON.stringify(treeSitterYamlJson),
  );

  const esbuild = async (
    cwd: string,
    filename: string,
    outputType: "esm" | "iife" | "cjs" = "iife",
    checkIde = true,
  ) => {
    const result = (await esbuildCompile(
      "",
      cwd,
      [filename],
      outputType,
    ))!;
    if (checkIde) {
      ensureAllowableIDESyntax(result, filename);
    }
    return result;
  };

  Deno.writeTextFileSync(
    resourcePath("editor/tools/yaml/yaml-intelligence.js"),
    await esbuild(
      resourcePath("../core/lib/yaml-intelligence"),
      "ide-main.ts",
      "esm",
    ),
  );

  Deno.writeTextFileSync(
    resourcePath("editor/tools/yaml/yaml.js"),
    await esbuild(
      resourcePath("editor/tools/yaml"),
      "automation.js",
    ),
  );

  const webWorkerSrc = await esbuild(
    resourcePath("../core/lib/yaml-intelligence"),
    "web-worker.ts",
  );
  const vsCodeSrc = await esbuild(
    resourcePath("../core/lib/yaml-intelligence"),
    "vs-code.ts",
    "esm",
    false,
  );

  const treeSitter = Deno.readTextFileSync(
    resourcePath("editor/tools/yaml/tree-sitter.js"),
  );
  ensureAllowableIDESyntax(treeSitter, "tree-sitter.js");

  Deno.writeTextFileSync(
    resourcePath("editor/tools/vs-code.mjs"),
    [treeSitter, vsCodeSrc].join(""),
  );

  Deno.writeTextFileSync(
    resourcePath("editor/tools/yaml/web-worker.js"),
    [treeSitter, webWorkerSrc].join(""),
  );
}

async function buildEsbuildAnalysisCache() {
  // build the necessary esbuild analysis cache
  const inputFiles = [
    "quarto.js",
  ];
  const analysisCache: Record<string, ESBuildAnalysis> = {};
  for (const file of inputFiles) {
    analysisCache[file] = await esbuildAnalyze(
      formatResourcePath("html", file),
      resourcePath(join("formats", "html")),
    );
  }
  Deno.writeTextFileSync(
    formatResourcePath("html", "esbuild-analysis-cache.json"),
    JSON.stringify(analysisCache, null, 2),
  );
}

export async function buildAssets() {
  // this has to come first because buildYAMLJS depends on it.
  await buildIntelligenceResources();
  await buildYAMLJS();
  await buildEsbuildAnalysisCache();
}

export const buildJsCommand = new Command()
  .name("build-artifacts")
  .hidden()
  .description(
    "Builds all the javascript assets necessary for IDE support.\n\n",
  )
  .action(async () => {
    await initYamlIntelligenceResourcesFromFilesystem();
    await buildAssets();
  });