Major refactor (#18381)

commands.md

@@ -1,4 +1,4 @@
-The core of the algorithm is implemented in `src/document/{printer,builders,utils}.js`. The printer uses the basic formatting abstractions provided to construct a format when printing a node.
+The core of the algorithm is implemented in `src/document/{printer,builders,utilities}/`. The printer uses the basic formatting abstractions provided to construct a format when printing a node.
 
 ## Prettier's intermediate representation: `Doc`
 

eslint.config.js

@@ -435,7 +435,7 @@ const configs = [
       "prettier-internal-rules/no-node-comments": [
         "error",
         {
-          file: "src/language-js/utils/index.js",
+          file: "src/language-js/utilities/index.js",
           functions: ["hasComment", "getComments"],
         },
         "src/language-js/pragma.js",
@@ -445,7 +445,7 @@ const configs = [
         "src/language-js/parse/json.js",
         "src/language-js/parse/acorn.js",
         "src/language-js/parse/oxc.js",
-        "src/language-js/parse/utils/wrap-babel-expression.js",
+        "src/language-js/parse/utilities/wrap-babel-expression.js",
       ],
       "prettier-internal-rules/prefer-create-type-check-function": [
         "error",

jest.config.js

@@ -51,7 +51,7 @@ if (nodejsMajorVersion <= 14) {
   testPathIgnorePatterns.push(
     "<rootDir>/tests/integration/__tests__/plugin-parsers.js",
     "<rootDir>/tests/integration/__tests__/normalize-doc.js",
-    "<rootDir>/tests/integration/__tests__/doc-utils-clean-doc.js",
+    "<rootDir>/tests/integration/__tests__/doc-utilities-clean-doc.js",
     "<rootDir>/tests/integration/__tests__/config-invalid.js",
     // `@prettier/cli` uses `node:stream/consumers`, not available on Node.js v14
     "<rootDir>/tests/integration/__tests__/experimental-cli.js",

package.json

@@ -229,7 +229,7 @@
       "src/index.cjs",
       "src/document/debug.js",
       "src/universal/*.browser.js",
-      "src/utils/unexpected-node-error.js",
+      "src/utilities/unexpected-node-error.js",
       "src/language-js/types/estree.d.ts",
       "src/**/**/*.d.ts"
     ]

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/");

src/cli/expand-patterns.js

@@ -4,7 +4,7 @@ import {
   directoryIgnorerWithoutNodeModules,
 } from "./directory-ignorer.js";
 import { fastGlob } from "./prettier-internal.js";
-import { lstatSafe, normalizeToPosix } from "./utils.js";
+import { lstatSafe, normalizeToPosix } from "./utilities.js";
 
 /** @import {Context} from './context.js' */
 

src/cli/file-info.js

@@ -1,7 +1,7 @@
 import path from "node:path";
 import stringify from "fast-json-stable-stringify";
 import { format, getFileInfo } from "../index.js";
-import { printToScreen } from "./utils.js";
+import { printToScreen } from "./utilities.js";
 
 // Note: This does not work with `--config-precedence`
 async function logFileInfoOrDie(context) {

src/cli/find-cache-file.js

@@ -2,7 +2,7 @@ import fs from "node:fs/promises";
 import os from "node:os";
 import path from "node:path";
 import findCacheDirectory from "find-cache-directory";
-import { isJson, statSafe } from "./utils.js";
+import { isJson, statSafe } from "./utilities.js";
 
 /**
  * Find default cache file (`./node_modules/.cache/prettier/.prettier-cache`) using https://github.com/sindresorhus/find-cache-directory

src/cli/find-config-path.js

@@ -1,6 +1,6 @@
 import path from "node:path";
 import { resolveConfigFile } from "../index.js";
-import { normalizeToPosix, printToScreen } from "./utils.js";
+import { normalizeToPosix, printToScreen } from "./utilities.js";
 
 async function logResolvedConfigPathOrDie(context) {
   const file = context.argv.findConfigPath;

src/cli/format-results-cache.js

@@ -5,7 +5,7 @@ import fs from "node:fs";
 import stringify from "fast-json-stable-stringify";
 import fileEntryCache from "file-entry-cache";
 import { version as prettierVersion } from "../index.js";
-import { createHash } from "./utils.js";
+import { createHash } from "./utilities.js";
 
 const optionsHashCache = new WeakMap();
 const nodeVersion = process.version;

src/cli/format.js

@@ -13,7 +13,7 @@ import {
   errors,
   picocolors,
 } from "./prettier-internal.js";
-import { normalizeToPosix, statSafe } from "./utils.js";
+import { normalizeToPosix, statSafe } from "./utilities.js";
 
 function diff(a, b) {
   return createTwoFilesPatch("", "", a, b, "", "", { context: 2 });

src/cli/index.js

@@ -8,7 +8,7 @@ import mockable from "./mockable.js";
 import { parseArgvWithoutPlugins } from "./options/parse-cli-arguments.js";
 import printSupportInfo from "./print-support-info.js";
 import { createDetailedUsage, createUsage } from "./usage.js";
-import { printToScreen } from "./utils.js";
+import { printToScreen } from "./utilities.js";
 
 async function run(rawArguments = process.argv.slice(2)) {
   // Create a default level logger, so we can log errors during `logLevel` parsing

src/cli/mockable.js

@@ -5,7 +5,7 @@ import { isCI } from "ci-info";
 import { __internal as sharedWithCli } from "../index.js";
 import clearStreamText from "./utilities/clear-stream-text.js";
 
-const mockable = sharedWithCli.utils.createMockable({
+const mockable = sharedWithCli.utilities.createMockable({
   clearStreamText,
   getTimestamp: performance.now.bind(performance),
   isCI: () => isCI,

src/cli/options/parse-cli-arguments.js

@@ -1,5 +1,5 @@
 import camelCase from "camelcase";
-import { pick } from "../utils.js";
+import { pick } from "../utilities.js";
 import createMinimistOptions from "./create-minimist-options.js";
 import { getContextOptionsWithoutPlugins } from "./get-context-options.js";
 import minimist from "./minimist.js";

src/cli/print-support-info.js

@@ -1,6 +1,6 @@
 import stringify from "fast-json-stable-stringify";
 import { format, getSupportInfo } from "../index.js";
-import { omit, printToScreen } from "./utils.js";
+import { omit, printToScreen } from "./utilities.js";
 
 const sortByName = (array) =>
   array.sort((a, b) => a.name.localeCompare(b.name));

src/cli/usage.js

@@ -1,7 +1,7 @@
 import camelCase from "camelcase";
 import { categoryOrder, usageSummary } from "./constants.evaluate.js";
 import { formatOptionsHiddenDefaults } from "./prettier-internal.js";
-import { groupBy } from "./utils.js";
+import { groupBy } from "./utilities.js";
 
 const OPTION_USAGE_THRESHOLD = 25;
 const CHOICE_USAGE_MARGIN = 3;

src/cli/utilities.js

@@ -106,7 +106,7 @@ const normalizeToPosix =
     ? (filepath) => filepath.replaceAll("\\", "/")
     : (filepath) => filepath;
 
-export const { omit } = sharedWithCli.utils;
+export const { omit } = sharedWithCli.utilities;
 export {
   createHash,
   groupBy,

src/common/get-file-info.js

@@ -1,7 +1,7 @@
 import { resolveConfig } from "../config/resolve-config.js";
 import { loadBuiltinPlugins, loadPlugins } from "../main/plugins/index.js";
-import { isIgnored } from "../utils/ignore.js";
+import { isIgnored } from "../utilities/ignore.js";
-import inferParser from "../utils/infer-parser.js";
+import inferParser from "../utilities/infer-parser.js";
 
 /**
  * @typedef {{ ignorePath?: string | URL | (string | URL)[], withNodeModules?: boolean, plugins: object, resolveConfig?: boolean }} FileInfoOptions

src/common/mockable.js

@@ -1,4 +1,4 @@
-import createMockable from "../utils/create-mockable.js";
+import createMockable from "../utilities/create-mockable.js";
 
 const mockable = createMockable({
   getPrettierConfigSearchStopDirectory: () => undefined,

src/config/prettier-config/load-external-config.js

@@ -1,5 +1,5 @@
-import importFromFile from "../../utils/import-from-file.js";
+import importFromFile from "../../utilities/import-from-file.js";
-import requireFromFile from "../../utils/require-from-file.js";
+import requireFromFile from "../../utilities/require-from-file.js";
 
 const requireErrorCodesShouldBeIgnored = new Set([
   "MODULE_NOT_FOUND",

src/config/prettier-config/loaders.js

@@ -2,7 +2,7 @@ import { pathToFileURL } from "node:url";
 import json5 from "json5";
 import parseJson from "parse-json";
 import { parse as parseToml } from "smol-toml";
-import readFile from "../../utils/read-file.js";
+import readFile from "../../utilities/read-file.js";
 
 async function readJson(file) {
   const content = await readFile(file);

src/config/resolve-config.js

@@ -1,7 +1,7 @@
 import path from "node:path";
 import micromatch from "micromatch";
 import { toPath } from "url-or-path";
-import partition from "../utils/partition.js";
+import partition from "../utilities/partition.js";
 import {
   clearEditorconfigCache,
   loadEditorconfig as loadEditorconfigForFile,

src/document/printer/printer.js

@@ -1,5 +1,5 @@
 import { convertEndOfLineToChars } from "../../common/end-of-line.js";
-import getStringWidth from "../../utils/get-string-width.js";
+import getStringWidth from "../../utilities/get-string-width.js";
 import {
   DOC_TYPE_ALIGN,
   DOC_TYPE_ARRAY,

src/document/utilities/assert-doc.js

@@ -1,4 +1,4 @@
-import noop from "../../utils/noop.js";
+import noop from "../../utilities/noop.js";
 import {
   DOC_TYPE_IF_BREAK,
   DOC_TYPE_LINE,

src/index.cjs

@@ -39,7 +39,7 @@ for (const name of debugApiFunctionNames) {
 prettier.__debug = debugApis;
 
 if (process.env.NODE_ENV === "production") {
-  prettier.util = require("./utils/public.js");
+  prettier.util = require("./utilities/public.js");
   prettier.doc = require("./document/public.js");
   prettier.version = require("./main/version.evaluate.js").default;
 } else {
@@ -47,7 +47,7 @@ if (process.env.NODE_ENV === "production") {
     util: {
       get() {
         try {
-          return require("./utils/public.js");
+          return require("./utilities/public.js");
         } catch {
           // No op
         }

src/index.d.ts

@@ -844,7 +844,7 @@ export function getSupportInfo(
  */
 export const version: string;
 
-// https://github.com/prettier/prettier/blob/next/src/utils/public.js
+// https://github.com/prettier/prettier/blob/main/src/utilities/public.js
 export namespace util {
   interface SkipOptions {
     backwards?: boolean | undefined;

src/index.js

@@ -30,10 +30,10 @@ import {
   getSupportInfo as getSupportInfoWithoutPlugins,
   normalizeOptionSettings,
 } from "./main/support.js";
-import createMockable from "./utils/create-mockable.js";
+import createMockable from "./utilities/create-mockable.js";
-import { createIsIgnoredFunction } from "./utils/ignore.js";
+import { createIsIgnoredFunction } from "./utilities/ignore.js";
-import inferParserWithoutPlugins from "./utils/infer-parser.js";
+import inferParserWithoutPlugins from "./utilities/infer-parser.js";
-import omit from "./utils/object-omit.js";
+import omit from "./utilities/object-omit.js";
 
 /**
  * @param {*} fn
@@ -109,7 +109,7 @@ const sharedWithCli = {
   createTwoFilesPatch,
   picocolors,
   closetLevenshteinMatch,
-  utils: {
+  utilities: {
     omit,
     createMockable,
   },
@@ -139,4 +139,4 @@ export {
 export { default as getFileInfo } from "./common/get-file-info.js";
 export * as doc from "./document/public.js";
 export { default as version } from "./main/version.evaluate.js";
-export * as util from "./utils/public.js";
+export * as util from "./utilities/public.js";

src/language-css/get-visitor-keys.js

@@ -1,4 +1,4 @@
-import createGetVisitorKeys from "../utils/create-get-visitor-keys.js";
+import createGetVisitorKeys from "../utilities/create-get-visitor-keys.js";
 import visitorKeys from "./visitor-keys.js";
 
 const getVisitorKeys = createGetVisitorKeys(visitorKeys);

src/language-css/languages.evaluate.js

@@ -1,5 +1,5 @@
 import * as linguistLanguages from "linguist-languages";
-import createLanguage from "../utils/create-language.js";
+import createLanguage from "../utilities/create-language.js";
 
 const languages = [
   createLanguage(linguistLanguages.CSS, (data) => ({

src/language-css/loc.js

@@ -1,6 +1,6 @@
-import isNonEmptyArray from "../utils/is-non-empty-array.js";
+import isNonEmptyArray from "../utilities/is-non-empty-array.js";
-import lineColumnToIndex from "../utils/line-column-to-index.js";
+import lineColumnToIndex from "../utilities/line-column-to-index.js";
-import { skipEverythingButNewLine } from "../utils/skip.js";
+import { skipEverythingButNewLine } from "../utilities/skip.js";
 
 function fixValueWordLoc(node, originalIndex) {
   const { value } = node;

src/language-css/parse/parse-media-query.js

@@ -1,5 +1,5 @@
 import postcssMediaQueryParser from "postcss-media-query-parser";
-import { addMissingType, addTypePrefix } from "./utils.js";
+import { addMissingType, addTypePrefix } from "./utilities.js";
 
 const parse = postcssMediaQueryParser.default;
 

src/language-css/parse/parse-selector.js

@@ -1,5 +1,5 @@
 import PostcssSelectorParser from "postcss-selector-parser/dist/processor.js";
-import { addTypePrefix } from "./utils.js";
+import { addTypePrefix } from "./utilities.js";
 
 function parseSelector(selector) {
   // If there's a comment inside of a selector, the parser tries to parse

src/language-css/parse/parse-value.js

@@ -1,11 +1,11 @@
 import PostcssValuesParser from "postcss-values-parser/lib/parser.js";
-import getFunctionArgumentsText from "../utils/get-function-arguments-text.js";
+import getFunctionArgumentsText from "../utilities/get-function-arguments-text.js";
-import getValueRoot from "../utils/get-value-root.js";
+import getValueRoot from "../utilities/get-value-root.js";
-import hasSCSSInterpolation from "../utils/has-scss-interpolation.js";
+import hasSCSSInterpolation from "../utilities/has-scss-interpolation.js";
-import hasStringOrFunction from "../utils/has-string-or-function.js";
+import hasStringOrFunction from "../utilities/has-string-or-function.js";
-import isSCSSVariable from "../utils/is-scss-variable.js";
+import isSCSSVariable from "../utilities/is-scss-variable.js";
 import parseSelector from "./parse-selector.js";
-import { addTypePrefix } from "./utils.js";
+import { addTypePrefix } from "./utilities.js";
 
 const isClosingParenthesis = (node) =>
   node.type === "paren" && node.value === ")";

src/language-css/parser-postcss.js

@@ -12,10 +12,10 @@ import {
 import parseMediaQuery from "./parse/parse-media-query.js";
 import parseSelector from "./parse/parse-selector.js";
 import parseValue from "./parse/parse-value.js";
-import { addTypePrefix } from "./parse/utils.js";
+import { addTypePrefix } from "./parse/utilities.js";
 import { hasIgnorePragma, hasPragma } from "./pragma.js";
-import isModuleRuleName from "./utils/is-module-rule-name.js";
+import isModuleRuleName from "./utilities/is-module-rule-name.js";
-import isSCSSNestedPropertyNode from "./utils/is-scss-nested-property-node.js";
+import isSCSSNestedPropertyNode from "./utilities/is-scss-nested-property-node.js";
 
 const DEFAULT_SCSS_DIRECTIVE = /(\s*)(!default).*$/u;
 const GLOBAL_SCSS_DIRECTIVE = /(\s*)(!global).*$/u;

src/language-css/print/comma-separated-value-group.js

@@ -37,7 +37,7 @@ import {
   isSCSSControlDirectiveNode,
   isSubtractionNode,
   isWordNode,
-} from "../utils/index.js";
+} from "../utilities/index.js";
 
 /**
  * @import AstPath from "../../common/ast-path.js"

src/language-css/print/misc.js

@@ -1,5 +1,5 @@
-import printNumber from "../../utils/print-number.js";
+import printNumber from "../../utilities/print-number.js";
-import printString from "../../utils/print-string.js";
+import printString from "../../utilities/print-string.js";
 import CSS_UNITS from "./css-units.evaluate.js";
 
 function printUnit(unit) {

src/language-css/print/parenthesized-value-group.js

@@ -14,8 +14,8 @@ import {
   line,
   softline,
 } from "../../document/index.js";
-import isNextLineEmpty from "../../utils/is-next-line-empty.js";
+import isNextLineEmpty from "../../utilities/is-next-line-empty.js";
-import isNonEmptyArray from "../../utils/is-non-empty-array.js";
+import isNonEmptyArray from "../../utilities/is-non-empty-array.js";
 import { locEnd, locStart } from "../loc.js";
 import {
   isConfigurationNode,
@@ -24,7 +24,7 @@ import {
   isSCSSMapItemNode,
   isURLFunctionNode,
   isVarFunctionNode,
-} from "../utils/index.js";
+} from "../utilities/index.js";
 import { shouldPrintTrailingComma } from "./misc.js";
 
 function hasComma({ node, parent }, options) {

src/language-css/print/sequence.js

@@ -1,7 +1,7 @@
 import { hardline, line } from "../../document/index.js";
 import { isFrontMatter } from "../../main/front-matter/index.js";
-import hasNewline from "../../utils/has-newline.js";
+import hasNewline from "../../utilities/has-newline.js";
-import isNextLineEmpty from "../../utils/is-next-line-empty.js";
+import isNextLineEmpty from "../../utilities/is-next-line-empty.js";
 import { locEnd, locStart } from "../loc.js";
 
 function printSequence(path, options, print) {

src/language-css/printer-postcss.js

@@ -10,9 +10,9 @@ import {
   removeLines,
   softline,
 } from "../document/index.js";
-import isNonEmptyArray from "../utils/is-non-empty-array.js";
+import isNonEmptyArray from "../utilities/is-non-empty-array.js";
-import printString from "../utils/print-string.js";
+import printString from "../utilities/print-string.js";
-import UnexpectedNodeError from "../utils/unexpected-node-error.js";
+import UnexpectedNodeError from "../utilities/unexpected-node-error.js";
 import clean from "./clean.js";
 import embed from "./embed.js";
 import getVisitorKeys from "./get-visitor-keys.js";
@@ -47,7 +47,7 @@ import {
   isWideKeywords,
   lastLineHasInlineComment,
   maybeToLowerCase,
-} from "./utils/index.js";
+} from "./utilities/index.js";
 
 function genericPrint(path, options, print) {
   const { node } = path;

src/language-css/utilities/has-scss-interpolation.js

@@ -1,4 +1,4 @@
-import isNonEmptyArray from "../../utils/is-non-empty-array.js";
+import isNonEmptyArray from "../../utilities/is-non-empty-array.js";
 
 function hasSCSSInterpolation(groupList) {
   if (isNonEmptyArray(groupList)) {

src/language-graphql/get-visitor-keys.js

@@ -1,4 +1,4 @@
-import createGetVisitorKeys from "../utils/create-get-visitor-keys.js";
+import createGetVisitorKeys from "../utilities/create-get-visitor-keys.js";
 import visitorKeys from "./visitor-keys.js";
 
 const getVisitorKeys = createGetVisitorKeys(visitorKeys, "kind");

src/language-graphql/languages.evaluate.js

@@ -1,5 +1,5 @@
 import * as linguistLanguages from "linguist-languages";
-import createLanguage from "../utils/create-language.js";
+import createLanguage from "../utilities/create-language.js";
 
 const languages = [
   createLanguage(linguistLanguages.GraphQL, () => ({

src/language-graphql/pragma.js

@@ -2,7 +2,7 @@ import {
   FORMAT_PRAGMA_TO_INSERT,
   GRAPHQL_HAS_IGNORE_PRAGMA_REGEXP,
   GRAPHQL_HAS_PRAGMA_REGEXP,
-} from "../utils/pragma/pragma.evaluate.js";
+} from "../utilities/pragma/pragma.evaluate.js";
 
 const hasPragma = (text) => GRAPHQL_HAS_PRAGMA_REGEXP.test(text);
 const hasIgnorePragma = (text) => GRAPHQL_HAS_IGNORE_PRAGMA_REGEXP.test(text);

src/language-graphql/printer-graphql.js

@@ -7,9 +7,9 @@ import {
   line,
   softline,
 } from "../document/index.js";
-import isNextLineEmpty from "../utils/is-next-line-empty.js";
+import isNextLineEmpty from "../utilities/is-next-line-empty.js";
-import isNonEmptyArray from "../utils/is-non-empty-array.js";
+import isNonEmptyArray from "../utilities/is-non-empty-array.js";
-import UnexpectedNodeError from "../utils/unexpected-node-error.js";
+import UnexpectedNodeError from "../utilities/unexpected-node-error.js";
 import getVisitorKeys from "./get-visitor-keys.js";
 import { locEnd, locStart } from "./loc.js";
 import { insertPragma } from "./pragma.js";

src/language-handlebars/clean.js

@@ -1,4 +1,4 @@
-import htmlWhitespaceUtils from "../utils/html-whitespace-utils.js";
+import htmlWhitespace from "../utilities/html-whitespace.js";
 
 function clean(original, cloned, parent) {
   // (Glimmer/HTML) ignore TextNode
@@ -16,7 +16,7 @@ function clean(original, cloned, parent) {
     ) {
       cloned.chars = "";
     } else {
-      cloned.chars = htmlWhitespaceUtils.split(trimmed).join(" ");
+      cloned.chars = htmlWhitespace.split(trimmed).join(" ");
     }
   }
 

src/language-handlebars/get-visitor-keys.js

@@ -1,4 +1,4 @@
-import createGetVisitorKeys from "../utils/create-get-visitor-keys.js";
+import createGetVisitorKeys from "../utilities/create-get-visitor-keys.js";
 import visitorKeys from "./visitor-keys.evaluate.js";
 
 const getVisitorKeys = createGetVisitorKeys(visitorKeys);

src/language-handlebars/languages.evaluate.js

@@ -1,5 +1,5 @@
 import * as linguistLanguages from "linguist-languages";
-import createLanguage from "../utils/create-language.js";
+import createLanguage from "../utilities/create-language.js";
 
 const languages = [
   createLanguage(linguistLanguages.Handlebars, () => ({

src/language-handlebars/printer-glimmer.js

@@ -10,15 +10,19 @@ import {
   replaceEndOfLine,
   softline,
 } from "../document/index.js";
-import getPreferredQuote from "../utils/get-preferred-quote.js";
+import getPreferredQuote from "../utilities/get-preferred-quote.js";
-import htmlWhitespaceUtils from "../utils/html-whitespace-utils.js";
+import htmlWhitespace from "../utilities/html-whitespace.js";
-import isNonEmptyArray from "../utils/is-non-empty-array.js";
+import isNonEmptyArray from "../utilities/is-non-empty-array.js";
-import UnexpectedNodeError from "../utils/unexpected-node-error.js";
+import UnexpectedNodeError from "../utilities/unexpected-node-error.js";
 import clean from "./clean.js";
 import embed from "./embed.js";
 import getVisitorKeys from "./get-visitor-keys.js";
 import { locEnd, locStart } from "./loc.js";
-import { hasPrettierIgnore, isVoidElement, isWhitespaceNode } from "./utils.js";
+import {
+  hasPrettierIgnore,
+  isVoidElement,
+  isWhitespaceNode,
+} from "./utilities.js";
 
 /**
 @import {Doc} from "../document/index.js"
@@ -170,8 +174,8 @@ function print(path, options, print) {
 
         if (parent.tag === "style") {
           text = text.replaceAll(/^\n+/gu, "");
-          text = htmlWhitespaceUtils.trimEnd(text);
+          text = htmlWhitespace.trimEnd(text);
-          text = htmlWhitespaceUtils.dedentString(text);
+          text = htmlWhitespace.dedentString(text);
 
           return replaceEndOfLine(text, hardline);
         }
@@ -218,7 +222,7 @@ function print(path, options, print) {
         return replaceEndOfLine(text);
       }
 
-      const isWhitespaceOnly = htmlWhitespaceUtils.isWhitespaceOnly(text);
+      const isWhitespaceOnly = htmlWhitespace.isWhitespaceOnly(text);
       const { isFirst, isLast } = path;
 
       if (options.htmlWhitespaceSensitivity !== "ignore") {
@@ -249,8 +253,7 @@ function print(path, options, print) {
           return breaks;
         }
 
-        const leadingWhitespace =
+        const leadingWhitespace = htmlWhitespace.getLeadingWhitespace(text);
-          htmlWhitespaceUtils.getLeadingWhitespace(text);
 
         let leadBreaks = [];
         if (leadingWhitespace) {
@@ -264,8 +267,7 @@ function print(path, options, print) {
           text = text.slice(leadingWhitespace.length);
         }
 
-        const tailingWhitespace =
+        const tailingWhitespace = htmlWhitespace.getTrailingWhitespace(text);
-          htmlWhitespaceUtils.getTrailingWhitespace(text);
         let trailBreaks = [];
         if (tailingWhitespace) {
           if (!shouldTrimTrailingNewlines) {
@@ -351,12 +353,12 @@ function print(path, options, print) {
         trailingSpace = "";
       }
 
-      if (htmlWhitespaceUtils.hasLeadingWhitespace(text)) {
+      if (htmlWhitespace.hasLeadingWhitespace(text)) {
-        text = leadingSpace + htmlWhitespaceUtils.trimStart(text);
+        text = leadingSpace + htmlWhitespace.trimStart(text);
       }
 
-      if (htmlWhitespaceUtils.hasTrailingWhitespace(text)) {
+      if (htmlWhitespace.hasTrailingWhitespace(text)) {
-        text = htmlWhitespaceUtils.trimEnd(text) + trailingSpace;
+        text = htmlWhitespace.trimEnd(text) + trailingSpace;
       }
 
       return [
@@ -672,7 +674,7 @@ function printInverse(path, options, print) {
 /* TextNode print helpers */
 
 function getTextValueParts(value) {
-  return join(line, htmlWhitespaceUtils.split(value));
+  return join(line, htmlWhitespace.split(value));
 }
 
 function getCurrentAttributeName(path) {
@@ -712,7 +714,7 @@ function generateHardlines(number = 0) {
 
 /* StringLiteral print helpers */
 
-/** @import {Quote} from "../utils/get-preferred-quote.js" */
+/** @import {Quote} from "../utilities/get-preferred-quote.js" */
 
 /**
  * Prints a string literal with the correct surrounding quotes based on