Fix build issues (microsoft#474)

1. Fix `rush dogfood`
2. Fix `watch-tmlanguage`
3. Fix regen-samples running in parallel
4. Be consistent about utf-8 with readFile(Sync)

Author: nguerrera

common/changes/@cadl-lang/compiler/cleanup_2022-04-22-21-01.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cadl-lang/compiler",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@cadl-lang/compiler"
+}

common/changes/@cadl-lang/internal-build-utils/cleanup_2022-04-22-21-01.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cadl-lang/internal-build-utils",
+      "comment": "Make RunOptions optional",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@cadl-lang/internal-build-utils"
+}

common/changes/cadl-vs/cleanup_2022-04-22-21-01.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "cadl-vs",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "cadl-vs"
+}

common/changes/cadl-vscode/cleanup_2022-04-22-21-01.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "cadl-vscode",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "cadl-vscode"
+}

eng/scripts/dogfood.js

@@ -1,3 +1,4 @@
 import { npmForEach, run } from "./helpers.js";
+run("rush", ["update"]);
 run("rush", ["build"]);
 npmForEach("dogfood");

eng/scripts/helpers.js

@@ -4,7 +4,7 @@ import { dirname, join, resolve } from "path";
 import { fileURLToPath } from "url";
 
 function read(filename) {
-  const txt = readFileSync(filename, "utf8")
+  const txt = readFileSync(filename, "utf-8")
     .replace(/\r/gm, "")
     .replace(/\n/gm, "«")
     .replace(/\/\*.*?\*\//gm, "")
@@ -24,7 +24,7 @@ export function forEachProject(onEach) {
   for (const each of rush.projects) {
     const packageName = each.packageName;
     const projectFolder = resolve(`${repoRoot}/${each.projectFolder}`);
-    const project = JSON.parse(readFileSync(`${projectFolder}/package.json`));
+    const project = JSON.parse(readFileSync(`${projectFolder}/package.json`, "utf-8"));
     onEach(packageName, projectFolder, project);
   }
 }

packages/cadl-vs/scripts/build.js

@@ -16,8 +16,8 @@ async function main() {
   }
 
   const pkgRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..");
-  const file = await readFile(join(pkgRoot, "package.json"));
-  const version = JSON.parse(file.toString()).version;
+  const file = await readFile(join(pkgRoot, "package.json"), "utf-8");
+  const version = JSON.parse(file).version;
 
   const result = await getBuildTool();
   if (result.type === "dotnet") {

packages/cadl-vs/scripts/restore.js

@@ -5,4 +5,4 @@ import { fileURLToPath } from "url";
 
 const pkgRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..");
 
-runDotnetOrExit(["restore", "Microsoft.Cadl.VS.sln"], { cwd: pkgRoot });
+await runDotnetOrExit(["restore", "Microsoft.Cadl.VS.sln"], { cwd: pkgRoot });

packages/cadl-vscode/scripts/dogfood.js

@@ -2,7 +2,7 @@
 import { run } from "@cadl-lang/internal-build-utils";
 import { readFileSync } from "fs";
 
-const version = JSON.parse(readFileSync("package.json").toString()).version;
+const version = JSON.parse(readFileSync("package.json", "utf-8")).version;
 const vsix = `cadl-vscode-${version}.vsix`;
 
 const options = {
@@ -12,5 +12,5 @@ const options = {
 };
 
 for (const command of ["code", "code-insiders"]) {
-  run(command, ["--install-extension", vsix], options);
+  await run(command, ["--install-extension", vsix], options);
 }

packages/cadl-vscode/scripts/watch-tmlanguage.js

@@ -1,7 +1,6 @@
 import { runWatch } from "@cadl-lang/internal-build-utils";
 import { createRequire } from "module";
 import { resolve } from "path";
-import watch from "watch";
 
 const require = createRequire(import.meta.url);
 const script = resolve("dist-dev/src/tmlanguage.js");
@@ -15,7 +14,7 @@ async function regenerate() {
   await require(script).main();
 }
 
-runWatch(watch, "dist-dev/src", regenerate, {
+runWatch("dist-dev/src", regenerate, {
   // This filter doesn't do as much as one might hope because tsc writes out all
   // the files on recompilation. So tmlanguage.js changes when other .ts files
   // in cadl-vscode change but tmlanguage.ts has not changed. We could check the

packages/cadl-vscode/test/utils.ts

@@ -18,8 +18,8 @@ async function createOnigLib(): Promise<IOnigLib> {
 const registry = new Registry({
   onigLib: createOnigLib(),
   loadGrammar: async (scopeName) => {
-    const data = await readFile(path.resolve(__dirname, "../../dist/cadl.tmLanguage"));
-    return parseRawGrammar(data.toString());
+    const data = await readFile(path.resolve(__dirname, "../../dist/cadl.tmLanguage"), "utf-8");
+    return parseRawGrammar(data);
   },
 });
 

packages/compiler/core/formatter.ts

@@ -85,9 +85,9 @@ export async function findUnformattedCadlFiles(
 }
 
 export async function formatCadlFile(filename: string) {
-  const content = await readFile(filename);
+  const content = await readFile(filename, "utf-8");
   const prettierConfig = await prettier.resolveConfig(filename);
-  const formattedContent = await formatCadl(content.toString(), prettierConfig ?? {});
+  const formattedContent = await formatCadl(content, prettierConfig ?? {});
   await writeFile(filename, formattedContent);
 }
 
@@ -96,9 +96,9 @@ export async function formatCadlFile(filename: string) {
  * @returns true if code is formatted correctly.
  */
 export async function checkFormatCadlFile(filename: string): Promise<boolean> {
-  const content = await readFile(filename);
+  const content = await readFile(filename, "utf-8");
   const prettierConfig = await prettier.resolveConfig(filename);
-  return await checkFormatCadl(content.toString(), prettierConfig ?? {});
+  return await checkFormatCadl(content, prettierConfig ?? {});
 }
 
 async function findFiles(include: string[], ignore: string[] = []): Promise<string[]> {

packages/compiler/scripts/dogfood.js

@@ -2,6 +2,6 @@
 import { run } from "@cadl-lang/internal-build-utils";
 import { readFileSync } from "fs";
 
-const version = JSON.parse(readFileSync("package.json")).version;
-run("npm", ["pack"]);
-run("npm", ["install", "-g", `cadl-lang-compiler-${version}.tgz`]);
+const version = JSON.parse(readFileSync("package.json", "utf-8")).version;
+await run("npm", ["pack"]);
+await run("npm", ["install", "-g", `cadl-lang-compiler-${version}.tgz`]);

packages/compiler/test/formatter/scenarios/scenarios.ts

@@ -20,8 +20,8 @@ const shouldUpdate = process.argv.indexOf("--update-snapshots") !== -1;
 
 async function getOutput(name: string): Promise<string | undefined> {
   try {
-    const output = await readFile(join(scenarioRoot, "outputs", name));
-    return output.toString();
+    const output = await readFile(join(scenarioRoot, "outputs", name), "utf-8");
+    return output;
   } catch {
     return undefined;
   }
@@ -34,9 +34,9 @@ async function saveOutput(name: string, content: string) {
 }
 
 async function testScenario(name: string) {
-  const content = await readFile(join(scenarioRoot, "inputs", name));
+  const content = await readFile(join(scenarioRoot, "inputs", name), "utf-8");
   const output = await getOutput(name);
-  const formatted = format(content.toString());
+  const formatted = format(content);
   if (!output) {
     return await saveOutput(name, formatted);
   }

packages/internal-build-utils/src/common.ts

@@ -13,7 +13,7 @@ export interface RunOptions extends SpawnOptions {
   throwOnNonZeroExit?: boolean;
 }
 
-export async function run(command: string, args: string[], options: RunOptions) {
+export async function run(command: string, args: string[], options?: RunOptions) {
   if (!options?.silent) {
     // eslint-disable-next-line no-console
     console.log();

packages/internal-build-utils/src/generate-third-party-notice.ts

@@ -119,7 +119,7 @@ async function getLicense(packageRoot: string) {
   for (const licenseName of ["LICENSE", "LICENSE.txt", "LICENSE.md", "LICENSE-MIT"]) {
     const licensePath = join(packageRoot, licenseName);
     try {
-      let text = (await readFile(licensePath)).toString("utf-8");
+      let text = await readFile(licensePath, "utf-8");
       text = text.replace("&lt;", "<");
       text = text.replace("&gt;", ">");
       return text;

packages/samples/scripts/regen-samples.js

@@ -20,9 +20,13 @@ const excludedSamples = [
 
 const rootInputPath = resolvePath("../");
 const rootOutputPath = resolvePath("../test/output");
-main();
 
-function main() {
+main().catch((e) => {
+  console.error(e);
+  process.exit(1);
+});
+
+async function main() {
   // clear any previous output as otherwise failing to emit anything could
   // escape PR validation. Also ensures we delete output for samples that
   // no longer exist.
@@ -33,7 +37,7 @@ function main() {
     const outputPath = join(rootOutputPath, folderName);
     mkdirp(outputPath);
 
-    run(process.execPath, [
+    await run(process.execPath, [
       "../../packages/compiler/dist/core/cli.js",
       "compile",
       inputPath,