Final Prettier Test Migration (#1510)

Author: Janther

src/slang-utils/create-hug-function.ts

@@ -18,20 +18,20 @@ export function createHugFunction(
         {
           kind: NonterminalKind.TupleExpression,
           loc: { ...loc },
-          comments: [],
+          comments: undefined,
           items: Object.assign(
             Object.create(TupleValues.prototype) as TupleValues,
             {
               kind: NonterminalKind.TupleValues,
               loc: { ...loc },
-              comments: [],
+              comments: undefined,
               items: [
                 Object.assign(
                   Object.create(TupleValue.prototype) as TupleValue,
                   {
                     kind: NonterminalKind.TupleValue,
                     loc: { ...loc },
-                    comments: [],
+                    comments: undefined,
                     expression: node
                   }
                 )

tests/config/utils/compile-contract.js tests/config/compile-contract.jstests/config/utils/compile-contract.js renamed to tests/config/compile-contract.js

@@ -10,7 +10,7 @@ export const FORMAT_TEST_DIRECTORY = normalizeDirectory(
   path.join(__dirname, "../format/"),
 );
 
-export const { FULL_TEST } = process.env;
+export const { FULL_TEST, TEST_STANDALONE } = process.env;
 export const BOM = "\uFEFF";
 
 export const CURSOR_PLACEHOLDER = "<|>";

…s/config/utils/consistent-end-of-line.js tests/config/consistent-end-of-line.jstests/config/utils/consistent-end-of-line.js renamed to tests/config/consistent-end-of-line.js tests/config/utils/consistent-end-of-line.js renamed to tests/config/consistent-end-of-line.js

@@ -1,5 +1,5 @@
 import { wrap as raw } from "jest-snapshot-serializer-raw";
-import { CURSOR_PLACEHOLDER } from "../constants.js";
+import { CURSOR_PLACEHOLDER } from "./constants.js";
 import visualizeEndOfLine from "./visualize-end-of-line.js";
 import visualizeRange from "./visualize-range.js";
 

tests/config/constants.js

@@ -1,3 +1,3 @@
-import runFormatTest from "./run-format-test.js";
+import { runFormatTest } from "./run-format-test.js";
 
 globalThis.runFormatTest = runFormatTest;

tests/config/utils/create-snapshot.js tests/config/create-snapshot.jstests/config/utils/create-snapshot.js renamed to tests/config/create-snapshot.js

@@ -1,5 +1,7 @@
+import { TEST_STANDALONE } from "./constants.js";
+
 function getCreateParserInternal() {
-  const entry = process.env.TEST_STANDALONE
+  const entry = TEST_STANDALONE
     ? "../../dist/create-parser.js"
     : "../../src/slang-utils/create-parser.js";
 

tests/config/format-test-setup.js

@@ -1,13 +1,24 @@
 import fs from "node:fs";
 import path from "node:path";
 import { FORMAT_SCRIPT_FILENAME } from "./constants.js";
-import visualizeEndOfLine from "./utils/visualize-end-of-line.js";
+import visualizeEndOfLine from "./visualize-end-of-line.js";
 
+/**
+@import {Context} from "./run-format-test.js"
+@typedef {Exclude<ReturnType<ReturnType<getFixtures>["next"]>["value"], void>} Fixture
+*/
+
+/**
+@param {Context} context
+*/
 function* getFixtures(context) {
   yield* getFiles(context);
   yield* getSnippets(context);
 }
 
+/**
+@param {Context} context
+*/
 function* getFiles(context) {
   const { dirname } = context;
   for (const file of fs.readdirSync(dirname, { withFileTypes: true })) {
@@ -36,6 +47,9 @@ function* getFiles(context) {
   }
 }
 
+/**
+@param {Context} context
+*/
 function* getSnippets(context) {
   for (const [index, snippet] of context.snippets.entries()) {
     const testCase =

tests/config/get-create-parser.js

@@ -1,11 +1,12 @@
 import path from "node:path";
 import createEsmUtils from "esm-utils";
 import getPrettier from "./get-prettier.js";
+import { TEST_STANDALONE } from "./constants.js";
 
 const { __dirname } = createEsmUtils(import.meta);
 
 // populate the root object for the standalone in node
-if (process.env.TEST_STANDALONE) {
+if (TEST_STANDALONE) {
   const root =
     typeof globalThis !== "undefined"
       ? globalThis
@@ -19,7 +20,7 @@ if (process.env.TEST_STANDALONE) {
 
 function getPluginsInternal() {
   return Promise.all(
-    process.env.TEST_STANDALONE
+    TEST_STANDALONE
       ? [
           import("prettier/plugins/babel"),
           import("prettier/plugins/estree"),

tests/config/get-fixtures.js

@@ -1,7 +1,7 @@
+import { TEST_STANDALONE } from "./constants.js";
+
 function getPrettierInternal() {
-  const entry = process.env.TEST_STANDALONE
-    ? "prettier/standalone"
-    : "prettier";
+  const entry = TEST_STANDALONE ? "prettier/standalone" : "prettier";
 
   return import(entry).then((module) => module.default);
 }