Major refactor (#18381)

scripts/benchmark/bench.js

@@ -7,7 +7,8 @@ const groupSize = Number(groupSizeString);
 const { format } = await import(`./${version}/dist/index.mjs`);
 
 const sourceText = readFileSync(
-  process.env.PRETTIER_PERF_FILENAME || "../../src/language-js/utils/index.js",
+  process.env.PRETTIER_PERF_FILENAME ||
+    "../../src/language-js/utilities/index.js",
   "utf8",
 );
 

scripts/build-website.js

@@ -14,7 +14,7 @@ import {
   WEBSITE_DIR,
   writeFile,
   writeJson,
-} from "./utils/index.js";
+} from "./utilities/index.js";
 
 const runYarn = (command, args, options) =>
   spawn("yarn", [command, ...args], { stdio: "inherit", ...options });

scripts/build/build-dependencies-license.js

@@ -2,7 +2,7 @@ import fs from "node:fs/promises";
 import path from "node:path";
 import { outdent } from "outdent";
 import rollupPluginLicense from "rollup-plugin-license";
-import { PROJECT_ROOT } from "../utils/index.js";
+import { PROJECT_ROOT } from "../utilities/index.js";
 
 const separator = `\n${"-".repeat(40)}\n\n`;
 

scripts/build/build-javascript-module.js

@@ -6,7 +6,7 @@ import createEsmUtils from "esm-utils";
 import {
   PRODUCTION_MINIMAL_NODE_JS_VERSION,
   PROJECT_ROOT,
-} from "../utils/index.js";
+} from "../utilities/index.js";
 import esbuildPluginAddDefaultExport from "./esbuild-plugins/add-default-export.js";
 import esbuildPluginEvaluate from "./esbuild-plugins/evaluate.js";
 import esbuildPluginPrimitiveDefine from "./esbuild-plugins/primitive-define.js";
@@ -17,7 +17,7 @@ import esbuildPluginThrowWarnings from "./esbuild-plugins/throw-warnings.js";
 import esbuildPluginUmd from "./esbuild-plugins/umd.js";
 import esbuildPluginVisualizer from "./esbuild-plugins/visualizer.js";
 import transform from "./transform/index.js";
-import { getPackageFile } from "./utils.js";
+import { getPackageFile } from "./utilities.js";
 
 const {
   readJsonSync,

scripts/build/build-package-json.js

@@ -4,7 +4,7 @@ import {
   PROJECT_ROOT,
   readJson,
   writeJson,
-} from "../utils/index.js";
+} from "../utilities/index.js";
 
 const keysToKeep = [
   "name",

scripts/build/build-types.js

@@ -3,7 +3,7 @@ import path from "node:path";
 import url from "node:url";
 import { isValidIdentifier } from "@babel/types";
 import { outdent } from "outdent";
-import { PROJECT_ROOT, writeFile } from "../utils/index.js";
+import { PROJECT_ROOT, writeFile } from "../utilities/index.js";
 
 async function typesFileBuilder({ packageConfig, file }) {
   /**

scripts/build/build.js

@@ -7,7 +7,7 @@ import createEsmUtils from "esm-utils";
 import styleText from "node-style-text";
 import prettyBytes from "pretty-bytes";
 import prettyMilliseconds from "pretty-ms";
-import { DIST_DIR } from "../utils/index.js";
+import { DIST_DIR } from "../utilities/index.js";
 import packageConfigs from "./config.js";
 import parseArguments from "./parse-arguments.js";
 

scripts/build/config.js

@@ -3,7 +3,7 @@ import path from "node:path";
 import url from "node:url";
 import createEsmUtils from "esm-utils";
 import { outdent } from "outdent";
-import { copyFile, DIST_DIR, PROJECT_ROOT } from "../utils/index.js";
+import { copyFile, DIST_DIR, PROJECT_ROOT } from "../utilities/index.js";
 import buildDependenciesLicense from "./build-dependencies-license.js";
 import buildJavascriptModule from "./build-javascript-module.js";
 import buildOxcWasmParser from "./build-oxc-wasm-parser.js";
@@ -15,7 +15,7 @@ import {
 import buildTypes from "./build-types.js";
 import esmifyTypescriptEslint from "./esmify-typescript-eslint.js";
 import modifyTypescriptModule from "./modify-typescript-module.js";
-import { getPackageFile } from "./utils.js";
+import { getPackageFile } from "./utilities.js";
 
 const {
   require,

scripts/build/esmify-typescript-eslint.js

@@ -2,7 +2,7 @@
 
 import * as path from "node:path";
 import { outdent } from "outdent";
-import { PROJECT_ROOT, writeFile } from "../utils/index.js";
+import { PROJECT_ROOT, writeFile } from "../utilities/index.js";
 
 function esmifyTypescriptEslint(text) {
   /*

scripts/build/modify-typescript-module.js

@@ -2,7 +2,7 @@ import path from "node:path";
 import escapeStringRegexp from "escape-string-regexp";
 import MagicString from "magic-string";
 import { outdent } from "outdent";
-import { PROJECT_ROOT, writeFile } from "../utils/index.js";
+import { PROJECT_ROOT, writeFile } from "../utilities/index.js";
 import UNUSED_SPECIFIERS from "./typescript-unused-specifiers.js";
 
 function* getModules(text) {

scripts/build/parse-arguments.js

@@ -1,6 +1,6 @@
 import path from "node:path";
 import { parseArgs } from "node:util";
-import { DIST_DIR } from "../utils/index.js";
+import { DIST_DIR } from "../utilities/index.js";
 
 const isUnique = (array) => new Set(array).size === array.length;
 

scripts/build/transform/index.js

@@ -3,7 +3,7 @@ import generate from "@babel/generator";
 import { parse } from "@babel/parser";
 import { traverseFast as traverse } from "@babel/types";
 import { outdent } from "outdent";
-import { PROJECT_ROOT, SOURCE_DIR } from "../../utils/index.js";
+import { PROJECT_ROOT, SOURCE_DIR } from "../../utilities/index.js";
 import * as transforms from "./transforms/index.js";
 
 const packageTransforms = new Map([

scripts/build/transform/transforms/get-public-doc-functionality.js

@@ -1,7 +1,7 @@
 import path from "node:path";
 import { pathToFileURL } from "node:url";
 import makeSynchronized from "make-synchronized";
-import { SOURCE_DIR } from "../../../utils/index.js";
+import { SOURCE_DIR } from "../../../utilities/index.js";
 
 const PUBLIC_MODULE_URL = pathToFileURL(
   path.join(SOURCE_DIR, "document/public.js"),

scripts/build/transform/transforms/transform-doc-module-imports.js

@@ -1,5 +1,5 @@
 import path from "node:path";
-import { SOURCE_DIR } from "../../../utils/index.js";
+import { SOURCE_DIR } from "../../../utilities/index.js";
 import getPublicDocFunctionality from "./get-public-doc-functionality.js";
 import {
   createIdentifier,

scripts/build/utilities.js

@@ -3,7 +3,7 @@ import path from "node:path";
 import url from "node:url";
 import { resolve } from "import-meta-resolve";
 import { isUrl, toUrl } from "url-or-path";
-import { PROJECT_ROOT } from "../utils/index.js";
+import { PROJECT_ROOT } from "../utilities/index.js";
 
 const NODE_MODULES_PATH = path.join(PROJECT_ROOT, "node_modules");
 

scripts/bundle-eslint-config.js

@@ -3,7 +3,7 @@ import fs from "node:fs/promises";
 import path from "node:path";
 import eslintPluginCompat from "eslint-plugin-compat";
 import buildConfig from "./build/config.js";
-import { DIST_DIR } from "./utils/index.js";
+import { DIST_DIR } from "./utilities/index.js";
 
 const { browserslist: targets } = JSON.parse(
   await fs.readFile(new URL("../package.json", import.meta.url)),

scripts/changelog-for-patch.js

@@ -10,7 +10,7 @@ import {
   getEntries,
   printEntries,
   replaceVersions,
-} from "./utils/changelog.js";
+} from "./utilities/changelog.js";
 
 const { previousVersion, newVersion } = parseArguments();
 

scripts/draft-blog-post.js

@@ -12,7 +12,7 @@ import {
   getEntries,
   printEntries,
   replaceVersions,
-} from "./utils/changelog.js";
+} from "./utilities/changelog.js";
 
 const { __dirname, require } = createEsmUtils(import.meta);
 const blogDir = path.join(__dirname, "../website/blog");

scripts/format-test-lint.js

@@ -4,7 +4,7 @@
 
 import fs from "node:fs/promises";
 import path from "node:path";
-import { PROJECT_ROOT } from "./utils/index.js";
+import { PROJECT_ROOT } from "./utilities/index.js";
 
 const FORMAT_TEST_DIRECTORY = path.join(PROJECT_ROOT, "tests/format/");
 const TEST_SCRIPT_FILE_NAME = "format.test.js";

scripts/generate-changelog.js

@@ -12,7 +12,7 @@
 import fs from "node:fs/promises";
 import enquirer from "enquirer";
 import openEditor from "open-editor";
-import { CHANGELOG_CATEGORIES } from "./utils/changelog-categories.js";
+import { CHANGELOG_CATEGORIES } from "./utilities/changelog-categories.js";
 
 const prNumberPrompt = new enquirer.NumberPrompt({
   message: "Input your Pull Request number:",

scripts/generate-schema.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-import { generateSchema } from "./utils/generate-schema.js";
+import { generateSchema } from "./utilities/generate-schema.js";
 
 console.log(await generateSchema());

scripts/lint-changelog.js

@@ -6,7 +6,7 @@ import indexToPosition from "index-to-position";
 import { outdent } from "outdent";
 import remarkParse from "remark-parse";
 import unified from "unified";
-import { CHANGELOG_CATEGORIES } from "./utils/changelog-categories.js";
+import { CHANGELOG_CATEGORIES } from "./utilities/changelog-categories.js";
 
 const CHANGELOG_DIR = "changelog_unreleased";
 const TEMPLATE_FILE = "TEMPLATE.md";

scripts/release/get-formatted-date.js

@@ -1,4 +1,4 @@
-// TODO: Implement this in `utils.js` when jest.importActual is landed.
+// TODO: Implement this in `utilities.js` when jest.importActual is landed.
 export default function getFormattedDate() {
   const date = new Date();
   const isoStr = date.toISOString();

scripts/release/run.js

@@ -1,7 +1,7 @@
 import semver from "semver";
 import parseArguments from "./parse-arguments.js";
 import * as steps from "./steps/index.js";
-import { logPromise, readJson } from "./utils.js";
+import { logPromise, readJson } from "./utilities.js";
 
 const params = parseArguments();
 const {

scripts/release/steps/bump-prettier.js

@@ -1,6 +1,12 @@
 import fs from "node:fs";
 import semver from "semver";
-import { logPromise, readJson, runGit, runYarn, writeJson } from "../utils.js";
+import {
+  logPromise,
+  readJson,
+  runGit,
+  runYarn,
+  writeJson,
+} from "../utilities.js";
 
 async function format() {
   await runYarn(["fix:prettier"]);

scripts/release/steps/check-git-status.js

@@ -1,4 +1,4 @@
-import { runGit } from "../utils.js";
+import { runGit } from "../utilities.js";
 
 export default async function checkGitStatus({ next }) {
   const { stdout: status } = await runGit(["status", "--porcelain"]);

scripts/release/steps/clean-changelog.js

@@ -1,7 +1,7 @@
 import fs from "node:fs/promises";
 import { fileURLToPath } from "node:url";
 import fastGlob from "fast-glob";
-import { runGit } from "../utils.js";
+import { runGit } from "../utilities.js";
 
 export default async function cleanChangelog({ repo }) {
   const changelogUnreleasedDir = fileURLToPath(

scripts/release/steps/generate-bundles.js

@@ -1,5 +1,5 @@
 import styleText from "node-style-text";
-import { logPromise, readJson, runYarn } from "../utils.js";
+import { logPromise, readJson, runYarn } from "../utilities.js";
 
 export default async function generateBundles({ dry, version, manual }) {
   if (!manual) {

scripts/release/steps/install-dependencies.js

@@ -1,5 +1,5 @@
 import fs from "node:fs/promises";
-import { runGit, runYarn } from "../utils.js";
+import { runGit, runYarn } from "../utilities.js";
 
 const PROJECT_ROOT = new URL("../../../", import.meta.url);
 

scripts/release/steps/lint-files.js

@@ -1,4 +1,4 @@
-import { runYarn } from "../utils.js";
+import { runYarn } from "../utilities.js";
 
 const lintFiles = () => runYarn("lint");
 

scripts/release/steps/merge-blog-post.js

@@ -1,6 +1,6 @@
 import styleText from "node-style-text";
 import semver from "semver";
-import { runGit, waitForEnter } from "../utils.js";
+import { runGit, waitForEnter } from "../utilities.js";
 
 export default async function mergeBlogPost({
   dry,

scripts/release/steps/post-publish-steps.js

@@ -1,6 +1,6 @@
 import styleText from "node-style-text";
 import outdent from "outdent";
-import { fetchText, logPromise, writeFile } from "../utils.js";
+import { fetchText, logPromise, writeFile } from "../utilities.js";
 
 const SCHEMA_REPO = "SchemaStore/schemastore";
 const SCHEMA_PATH = "src/schemas/json/prettierrc.json";
@@ -10,7 +10,7 @@ const EDIT_URL = `https://github.com/${SCHEMA_REPO}/edit/master/${SCHEMA_PATH}`;
 // Any optional or manual step can be warned in this script.
 
 async function checkSchema() {
-  const { generateSchema } = await import("../../utils/generate-schema.js");
+  const { generateSchema } = await import("../../utilities/generate-schema.js");
   const schema = await generateSchema();
   const remoteSchema = await logPromise(
     "Checking current schema in SchemaStore",

scripts/release/steps/publish-to-npm.js

@@ -1,6 +1,6 @@
 import enquirer from "enquirer";
 import spawn from "nano-spawn";
-import { waitForEnter } from "../utils.js";
+import { waitForEnter } from "../utilities.js";
 
 export default async function publishToNpm({ dry }) {
   console.log(`Ready to publish to NPM${dry ? "(--dry-run)" : ""}`);

scripts/release/steps/push-to-git.js

@@ -1,4 +1,4 @@
-import { runGit } from "../utils.js";
+import { runGit } from "../utilities.js";
 
 export default async function pushToGit({ version, repo }) {
   await runGit(["commit", "-am", `Release ${version}`]);

scripts/release/steps/show-instructions-after-npm-publish.js

@@ -5,7 +5,7 @@ import {
   getBlogPostInfo,
   getChangelogContent,
   waitForEnter,
-} from "../utils.js";
+} from "../utilities.js";
 
 const RELEASE_URL_BASE = "https://github.com/prettier/prettier/releases/new?";
 export function getReleaseUrl(version, previousVersion) {

scripts/release/steps/update-changelog.js

@@ -8,7 +8,7 @@ import {
   logPromise,
   runYarn,
   waitForEnter,
-} from "../utils.js";
+} from "../utilities.js";
 
 function writeChangelog(params) {
   const changelog = fs.readFileSync("CHANGELOG.md", "utf8");

scripts/release/steps/update-dependents-count.js

@@ -1,5 +1,5 @@
 import styleText from "node-style-text";
-import { fetchText, logPromise, processFile, runGit } from "../utils.js";
+import { fetchText, logPromise, processFile, runGit } from "../utilities.js";
 
 async function getNpmDependentsCount() {
   const npmPage = await logPromise(

scripts/release/steps/update-version.js

@@ -1,4 +1,4 @@
-import { processFile, readJson, runYarn, writeJson } from "../utils.js";
+import { processFile, readJson, runYarn, writeJson } from "../utilities.js";
 
 export default async function updateVersion({ version, next }) {
   const pkg = await readJson("package.json");

scripts/release/steps/wait-for-bot-release.js

@@ -1,6 +1,6 @@
 import styleText from "node-style-text";
 import outdent from "outdent";
-import { logPromise, waitForEnter } from "../utils.js";
+import { logPromise, waitForEnter } from "../utilities.js";
 
 export async function isVersionReleased(version) {
   const response = await fetch("https://registry.npmjs.org/prettier/");