Simplify installation

Author: fisker

README.md

@@ -25,17 +25,16 @@ run alternativeVersionPrettier vs originalVersionPrettier
 
 Required.
 
-There are 3 ways to specify.
+There are 2 ways to specify.
 
-1. Versions (e.g. `2.0.0`, `1.7.1`)
-2. Repository name + ref (e.g. `sosukesuzuki/prettier#2f3fc241f8cb1867a0a3073ceac9d662e4b25fab`).
-3. Pull Request number on [prettier/prettier](https://github.com/prettier/prettier) repository (e.g. `#110168`).
+1. Versions or repository name + ref (e.g. `2.0.0`, `1.7.1`, or `sosukesuzuki/prettier#2f3fc241f8cb1867a0a3073ceac9d662e4b25fab`), it's installed directly with `yarn add`, so anything that [`yarn add`](https://yarnpkg.com/cli/add) allows
+2. Pull Request number on [prettier/prettier](https://github.com/prettier/prettier) repository (e.g. `#110168`).
 
 ### `originalVersionPrettier`
 
 Optional.
 
-In default, use `prettier/prettier#main`.
+In default, use `prettier/prettier`.
 
 Also, you can specify with the logic same as `alternativeVersionPrettier`.
 
@@ -46,11 +45,11 @@ run #110168
 ```
 
 ```
-run #110168 vs sosukesuzuki/prettier#main
+run #110168 vs sosukesuzuki/prettier#fix-foo
 ```
 
 ```
-run sosukesuzuki/prettier#main vs 1.8.1
+run sosukesuzuki/prettier#fix-foo vs 1.8.1
 ```
 
 ## Add new project

package.json

@@ -39,6 +39,7 @@
     "npm-run-all": "^4.1.5",
     "outdent": "^0.8.0",
     "prettier": "3.6.2",
+    "temp-dir": "^3.0.0",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.46.2",
     "vitest": "^4.0.6"

src/configuration.ts

@@ -2,7 +2,6 @@ import path from "path";
 import ci from "ci-info";
 
 export const cwd = process.cwd();
-export const prettierRepositoryPath = path.join(cwd, "./prettier");
 export const targetRepositoriesPath = path.join(cwd, "./repos");
 export const isCI = ci.isCI;
 export const authToken = process.env.NODE_AUTH_TOKEN ?? "nothing";

src/execute/create-temporary-directory.ts

@@ -0,0 +1,27 @@
+import fs from 'node:fs/promises'
+import os from 'node:os'
+import path from 'node:path';
+import crypto from "node:crypto";
+
+export async function createTemporaryDirectory() {
+  const directory = path.join(
+    // The following quoted from https://github.com/es-tooling/module-replacements/blob/27d1acd38f19741e31d2eae561a5c8a914373fc5/docs/modules/tempy.md?plain=1#L20-L21, not sure if it's true
+    // MacOS and possibly some other platforms return a symlink from `os.tmpdir`.
+    // For some applications, this can cause problems; thus, we use `realpath`.
+    await fs.realpath(os.tmpdir()),
+    crypto.randomBytes(16).toString("hex"),
+  );
+
+  fs.mkdir(directory);
+
+  return {
+    path: directory,
+    dispatch: () => destroyTemporaryDirectory(directory)
+  };
+}
+
+async function destroyTemporaryDirectory(directory: string) {
+  await fs.rm(directory, {recursive: true, force: true})
+}
+
+export type TemporaryDirectory = Awaited<ReturnType<typeof createTemporaryDirectory>>

src/execute/index.ts

@@ -1,33 +1,21 @@
-import { existsSync } from "fs";
 import { Command } from "../parse.ts";
 import { getPrettyHeadCommitHash } from "./get-pretty-head-commit-hash.ts";
 import { preparePrettierIgnoreFile } from "./prepare-prettier-ignore-file.ts";
 import { runPrettier } from "./run-prettier.ts";
-import { setupPrettierRepository } from "./setup-repository.ts";
 import * as configuration from "../configuration.ts";
 import * as git from "../tools/git.ts";
 import * as logger from "../logger.ts";
 import { getProjects, getTargetRepositoryPath } from "../projects.ts";
+import {installPrettier} from './install-prettier.ts'
 
 export interface ExecuteResultEntry {
   commitHash: string;
   diff: string;
 }
 
-async function clonePrettier() {
-  if (!existsSync(configuration.prettierRepositoryPath)) {
-    await logger.log("Cloning Prettier repository...");
-    await git.clone(
-      "https://github.com/prettier/prettier.git",
-      "./prettier",
-      configuration.cwd,
-    );
-  }
-}
-
 export async function execute({
-  alternativePrettier,
-  originalPrettier,
+  originalPrettier: originalPrettierVersion,
+  alternativePrettier: alternativePrettierVersion,
 }: Command): Promise<ExecuteResultEntry[]> {
   const projects = await getProjects();
   const commitHashes = await Promise.all(
@@ -36,18 +24,16 @@ export async function execute({
     ),
   );
 
-  await clonePrettier();
-
   // Setup originalVersionPrettier
   await logger.log("Setting up originalVersionPrettier...");
-  await setupPrettierRepository(originalPrettier);
+  const originalPrettier = await installPrettier(originalPrettierVersion);
   // Run originalVersionPrettier
   await logger.log("Running originalVersionPrettier...");
   await Promise.all(
     projects.map(async (project) => {
       const targetRepositoryPath = getTargetRepositoryPath(project);
       await preparePrettierIgnoreFile(project);
-      await runPrettier(configuration.prettierRepositoryPath, project);
+      await runPrettier(originalPrettier, project);
       await git.add(".", targetRepositoryPath);
       await git.commitAllowEmptyNoVerify(
         "Fixed by originalVersionPrettier",
@@ -56,16 +42,19 @@ export async function execute({
     }),
   );
 
+  await originalPrettier.dispatch()
+
   // Setup alternativeVersionPrettier
   await logger.log("Setting up alternativeVersionPrettier...");
-  await setupPrettierRepository(alternativePrettier);
+  const alternativePrettier = await installPrettier(alternativePrettierVersion);
   // Run alternativeVersionPrettier
   await logger.log("Running alternativeVersionPrettier...");
   await Promise.all(
     projects.map(async (project) => {
-      await runPrettier(configuration.prettierRepositoryPath, project);
+      await runPrettier(alternativePrettier, project);
     }),
   );
+  await alternativePrettier.dispatch()
 
   const diffs = await Promise.all(
     projects.map(getTargetRepositoryPath).map(git.diffRepository),

src/execute/install-prettier.ts

@@ -0,0 +1,67 @@
+import path from "node:path";
+import {
+  PrettierVersion,
+  PrettierPullRequest,
+  sourceTypes
+} from "../parse.ts";
+import * as configuration from "../configuration.ts";
+import * as brew from "../tools/brew.ts";
+import * as gh from "../tools/gh.ts";
+import * as yarn from "../tools/yarn.ts";
+import * as npm from "../tools/npm.ts";
+import * as unix from "../tools/unix.ts";
+import {createTemporaryDirectory, type TemporaryDirectory} from './create-temporary-directory.ts'
+
+export type InstalledPrettier = Awaited<ReturnType<typeof installPrettier>>
+
+export async function installPrettier(
+  prettierVersion: PrettierVersion,
+) {
+  let version: string
+  let pullRequestDirectory: TemporaryDirectory | undefined
+  if (prettierVersion.type === sourceTypes.pullRequest) {
+    ({version, directory: pullRequestDirectory} = await getPullRequest(prettierVersion.number) )
+  } else {
+    ({version} = prettierVersion)
+  }
+
+  
+  const directory = await createTemporaryDirectory()
+  const {path: cwd} = directory
+  await yarn.init(['-y'], {cwd})
+  await yarn.add([`prettier@${version}`],{cwd})
+
+  await pullRequestDirectory?.dispatch()
+
+  return {
+    dispatch: () => {directory.dispatch()},
+    bin: path.join(cwd, 'node_modules/prettier/bin/prettier.cjs'),
+    name: prettierVersion.raw
+  }
+}
+
+async function existsGh() {
+  return !(await unix.which("gh")).includes("gh not found");
+}
+
+async function getPullRequest(
+  pullRequestNumber: PrettierPullRequest['number'],
+) {
+  if (!(await existsGh())) {
+    await brew.install("gh");
+  }
+  if (configuration.authToken !== "nothing") {
+    // running locally, `gh` can be already authenticated
+    await gh.authLoginWithToken(configuration.authToken);
+  }
+
+  const directory = await createTemporaryDirectory()
+
+  await gh.prCheckout(pullRequestNumber, directory.path);
+  const {stdout} = await npm.pack({cwd: directory.path});
+
+  return {
+    directory,
+    version: `file:${path.join(directory.path, stdout.trim())}`
+  };
+}

src/execute/run-prettier.ts

@@ -2,21 +2,17 @@ import path from "path";
 import spawn from "nano-spawn";
 import { type Project, getTargetRepositoryPath } from "../projects.ts";
 import * as yarn from "../tools/yarn.ts";
+import {type InstalledPrettier} from './install-prettier.ts'
 
 export async function runPrettier(
-  prettierRepositoryPath: string,
+  prettier: InstalledPrettier,
   project: Project,
 ): Promise<void> {
   const repositoryPath = getTargetRepositoryPath(project);
   const glob = project.glob ?? ["."];
 
-  const prettierRepositoryBinPath = path.join(
-    prettierRepositoryPath,
-    "./bin/prettier.js",
-  );
-
   const args = [
-    prettierRepositoryBinPath,
+    prettier.bin,
     "--write",
     "--no-color",
     ...(Array.isArray(glob) ? glob : [glob]),

src/execute/setup-repository.ts

@@ -1,36 +1,10 @@
 import * as configuration from "./configuration.ts";
 import { ExecuteResultEntry } from "./execute/index.ts";
-import { Command, PrettierRepositorySource } from "./parse.ts";
+import { Command } from "./parse.ts";
 
-function getPrettierRepositorySourceText(
-  prettierRepositorySource: PrettierRepositorySource,
-) {
-  switch (prettierRepositorySource.type) {
-    case "prNumber": {
-      return configuration.isCI
-        ? `prettier/prettier#${prettierRepositorySource.prNumber}`
-        : `https://github.com/prettier/prettier/pull/${prettierRepositorySource.prNumber}`;
-    }
-    case "repositoryAndRef": {
-      return configuration.isCI
-        ? `${prettierRepositorySource.repositoryName}@${prettierRepositorySource.ref}`
-        : `https://github.com/${prettierRepositorySource.repositoryName}/blob/${prettierRepositorySource.ref}/README.md`;
-    }
-    case "version": {
-      const versionUrl = `https://github.com/prettier/prettier/tree/${prettierRepositorySource.version}`;
-      return configuration.isCI
-        ? `[prettier/prettier@${prettierRepositorySource.version}](${versionUrl})`
-        : versionUrl;
-    }
-  }
-}
 function getLogTitle(command: Command): string {
-  const alternativePrettierRepositoryText = getPrettierRepositorySourceText(
-    command.alternativePrettier,
-  );
-  const originalPrettierRepositoryText = getPrettierRepositorySourceText(
-    command.originalPrettier,
-  );
+  const alternativePrettierRepositoryText = command.alternativePrettier.raw;
+  const originalPrettierRepositoryText = command.originalPrettier.raw;
   if (configuration.isCI) {
     return `**${alternativePrettierRepositoryText} VS ${originalPrettierRepositoryText}**`;
   } else {