Add a prettier config. (#25)

Ensure Prettier formatted code is styled consistently rather than allowing system prettier configs to apply.

Also adds a presubmit check to enforce prettier formatting.

Author: sbarfurth

.github/workflows/presubmit.yaml

@@ -1,23 +1,38 @@
-name: Buildifier
+name: Presubmit
 on:
-    push:
-        branches: [main]
-    pull_request:
-        branches: [main]
-    # Allow manual execution.
-    workflow_dispatch:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  # Allow manual execution.
+  workflow_dispatch:
 jobs:
-    buildifier:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-            - uses: actions/setup-go@v5
-              with:
-                  go-version: '1.24.0'
-            - name: install
-              run: go install github.com/bazelbuild/buildtools/buildifier@latest
-            - name: check
-              run: buildifier --mode=check -r .
-            - name: lint
-              run: buildifier --lint=warn -r .
-              continue-on-error: true
+  buildifier:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '1.24.0'
+      - name: install
+        run: go install github.com/bazelbuild/buildtools/buildifier@latest
+      - name: check
+        run: buildifier --mode=check -r .
+      - name: lint
+        run: buildifier --lint=warn -r .
+        continue-on-error: true
+  prettier:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 10.17.1
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22.18.0
+          cache: 'pnpm'
+      - name: install
+        run: pnpm install
+      - name: check
+        run: pnpm format:check

.prettierignore

@@ -0,0 +1,2 @@
+.prettierrc
+pnpm-lock.yaml 

.prettierrc

@@ -0,0 +1,16 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true, 
+  "singleQuote": true,
+  "quoteProps": "preserve",
+  "bracketSpacing": false,
+  "trailingComma": "all",
+  "arrowParens": "always",
+  "embeddedLanguageFormatting": "off",
+  "bracketSameLine": true,
+  "singleAttributePerLine": false,
+  "jsxSingleQuote": false,
+  "htmlWhitespaceSensitivity": "strict"
+}

MODULE.bazel.lock

@@ -3,11 +3,11 @@ import {
   BrowserPlatform,
   computeExecutablePath,
   getDownloadUrl,
-} from "@puppeteer/browsers";
-import path from "node:path";
+} from '@puppeteer/browsers';
+import path from 'node:path';
 
-import { platforms } from "./platforms.mjs";
-import { downloadFileThroughStreaming, sha256 } from "./download_helpers.mjs";
+import {platforms} from './platforms.mjs';
+import {downloadFileThroughStreaming, sha256} from './download_helpers.mjs';
 
 export interface BrowserBinaryInfo {
   browser: Browser;
@@ -24,7 +24,7 @@ export async function downloadAndHashBinariesForBrowser(
   browser: Browser,
   buildId: string,
   namedFiles: Partial<Record<BrowserPlatform, Record<string, string>>> = {},
-  excludeFilesForPerformance: Partial<Record<BrowserPlatform, string[]>> = {}
+  excludeFilesForPerformance: Partial<Record<BrowserPlatform, string[]>> = {},
 ): Promise<BrowserBinaryInfo[]> {
   const downloadAndHashTasks: Promise<BrowserBinaryInfo>[] = [];
 
@@ -53,7 +53,7 @@ export async function downloadAndHashBinariesForBrowser(
           excludeFilesForPerformance: platformExcludePatterns,
           namedFiles: platformNamedFiles,
         };
-      })()
+      })(),
     );
   }
 

browsers/private/update-tool/download.mts

@@ -6,9 +6,9 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { Readable } from "node:stream";
-import fs from "node:fs";
-import { createHash } from "node:crypto";
+import {Readable} from 'node:stream';
+import fs from 'node:fs';
+import {createHash} from 'node:crypto';
 
 /**
  * Downloads a file and stores it at the given location.
@@ -18,7 +18,7 @@ import { createHash } from "node:crypto";
  */
 export async function downloadFileThroughStreaming(
   sourceUrl: URL,
-  destinationPath: string
+  destinationPath: string,
 ): Promise<void> {
   return new Promise(async (resolve, reject) => {
     const result = await fetch(sourceUrl);
@@ -34,19 +34,19 @@ export async function downloadFileThroughStreaming(
     const stream = Readable.fromWeb(result.body);
     const outStream = fs.createWriteStream(destinationPath);
 
-    stream.on("error", (err) => reject(err));
-    stream.on("close", () => resolve());
+    stream.on('error', (err) => reject(err));
+    stream.on('close', () => resolve());
     stream.pipe(outStream);
   });
 }
 
 export async function sha256(filePath: string): Promise<string> {
   return new Promise((resolve, reject) => {
     const stream = fs.createReadStream(filePath);
-    const hash = createHash("sha256");
+    const hash = createHash('sha256');
 
-    stream.on("error", (err) => reject(err));
-    stream.on("close", () => resolve(hash.digest("hex")));
+    stream.on('error', (err) => reject(err));
+    stream.on('close', () => resolve(hash.digest('hex')));
     stream.pipe(hash);
   });
 }

browsers/private/update-tool/download_helpers.mts

@@ -1,5 +1,5 @@
-import { Browser } from "@puppeteer/browsers";
-import { BrowserBinaryInfo } from "./download.mjs";
+import {Browser} from '@puppeteer/browsers';
+import {BrowserBinaryInfo} from './download.mjs';
 
 export interface RepoInfo {
   url: string;
@@ -11,7 +11,7 @@ export interface RepoInfo {
 export type Versions = Record<string, Record<string, RepoInfo>>;
 
 export function generateRepoInfo(
-  binaries: BrowserBinaryInfo[]
+  binaries: BrowserBinaryInfo[],
 ): Record<string, RepoInfo> {
   const repos: Record<string, RepoInfo> = {};
 
@@ -30,11 +30,11 @@ export function generateRepoInfo(
 export function generateVersionsBzlFile(
   browserName: string,
   defaultVersion: string,
-  versions: Versions
+  versions: Versions,
 ): string {
   return `"""Available versions of "${browserName}".
 
-DO NOT EDIT. Generated by ${process.env["JS_BINARY__TARGET"]}.
+DO NOT EDIT. Generated by ${process.env['JS_BINARY__TARGET']}.
 """
 
 DEFAULT_VERSION = "${defaultVersion}"

browsers/private/update-tool/generation.mts

@@ -6,18 +6,18 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { resolveBuildId, Browser, BrowserPlatform } from "@puppeteer/browsers";
-import { mkdtemp } from "node:fs/promises";
-import os from "node:os";
-import path from "node:path";
-import { downloadAndHashBinariesForBrowser } from "./download.mjs";
+import {resolveBuildId, Browser, BrowserPlatform} from '@puppeteer/browsers';
+import {mkdtemp} from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
+import {downloadAndHashBinariesForBrowser} from './download.mjs';
 import {
   generateRepoInfo,
   generateVersionsBzlFile,
   Versions,
-} from "./generation.mjs";
-import fs from "node:fs/promises";
-import { getChromeMilestones, getFirefoxMilestones } from "./versions.mjs";
+} from './generation.mjs';
+import fs from 'node:fs/promises';
+import {getChromeMilestones, getFirefoxMilestones} from './versions.mjs';
 
 main().catch((e) => {
   console.error(e);
@@ -36,7 +36,7 @@ interface WriteVersionsOptions {
 // We treat chrome-headless-shell as Chromium in the module. This function
 // ensures browser name is written to files as expected.
 function getReadableBrowserName(browser: Browser): string {
-  return browser === Browser.CHROMEHEADLESSSHELL ? "chromium" : browser;
+  return browser === Browser.CHROMEHEADLESSSHELL ? 'chromium' : browser;
 }
 
 async function downloadMilestonesAndWriteVersionsFiles({
@@ -50,20 +50,20 @@ async function downloadMilestonesAndWriteVersionsFiles({
   buildIdToVersion = buildIdToVersion ?? ((buildId) => buildId);
 
   const buildIds = await Promise.all(
-    milestones.map((milestone) => resolveBuildId(browser, null!, milestone))
+    milestones.map((milestone) => resolveBuildId(browser, null!, milestone)),
   );
 
   const fileBasePath = path.join(
     workspaceRoot,
-    "browsers/private/versions",
-    getReadableBrowserName(browser)
+    'browsers/private/versions',
+    getReadableBrowserName(browser),
   );
   // We keep a JSON file around that only holds the versions without any of the
   // additional content in the `.bzl` file. This enables merging of existing
   // versions with newly fetched one's without having to do string gymnastics on
   // the `.bzl` file.
-  const jsonFilePath = fileBasePath + ".json";
-  const bzlFilePath = fileBasePath + ".bzl";
+  const jsonFilePath = fileBasePath + '.json';
+  const bzlFilePath = fileBasePath + '.bzl';
 
   let versions: Versions = {};
 
@@ -72,19 +72,19 @@ async function downloadMilestonesAndWriteVersionsFiles({
   // same milestone. If the new version has a different build ID, we will
   // provide both versions. Otherwise the old version will remain.
   try {
-    const currentVersionsRaw = await fs.readFile(jsonFilePath, "utf8");
+    const currentVersionsRaw = await fs.readFile(jsonFilePath, 'utf8');
     const currentVersions = JSON.parse(currentVersionsRaw) as Versions;
     versions = currentVersions;
   } catch (err: unknown) {
-    console.warn("Failed to read versions JSON file:", (err as Error).message);
+    console.warn('Failed to read versions JSON file:', (err as Error).message);
   }
 
   // Don't download versions we downloaded previously again. This would not
   // catch cases where the binaries under an existing build ID changes, although
   // this should ideally never happen (at least for Chrome).
   const existingVersions = new Set(Object.keys(versions));
   const filteredNewBuildIds = buildIds.filter(
-    (buildId) => !existingVersions.has(buildIdToVersion(buildId))
+    (buildId) => !existingVersions.has(buildIdToVersion(buildId)),
   );
 
   // Fetch the binaries for each build ID. The only reason we do this is to
@@ -96,9 +96,9 @@ async function downloadMilestonesAndWriteVersionsFiles({
         browser,
         buildId,
         {},
-        excludeFilesForPerformance
-      )
-    )
+        excludeFilesForPerformance,
+      ),
+    ),
   );
 
   for (const binariesForBuild of binariesForBuilds) {
@@ -118,14 +118,14 @@ async function downloadMilestonesAndWriteVersionsFiles({
     generateVersionsBzlFile(
       getReadableBrowserName(browser),
       defaultVersion,
-      versions
-    )
+      versions,
+    ),
   );
 }
 
 async function main() {
-  const tmpDir = await mkdtemp(path.join(os.tmpdir(), "rules_browsers_tmp-"));
-  const workspaceRoot = process.env["BUILD_WORKING_DIRECTORY"]!;
+  const tmpDir = await mkdtemp(path.join(os.tmpdir(), 'rules_browsers_tmp-'));
+  const workspaceRoot = process.env['BUILD_WORKING_DIRECTORY']!;
 
   // Fetch the last 15 milestones for each browser. This is mostly relevant when
   // browsers haven't been updated in a long time and we want to backfill. All
@@ -143,10 +143,10 @@ async function main() {
       workspaceRoot,
       excludeFilesForPerformance: {
         // Exclude log files that Chrome might write to— causing remote cache misses.
-        [BrowserPlatform.LINUX]: ["**/*.log"],
-        [BrowserPlatform.MAC]: ["**/*.log"],
-        [BrowserPlatform.MAC_ARM]: ["**/*.log"],
-        [BrowserPlatform.WIN64]: ["**/*.log"],
+        [BrowserPlatform.LINUX]: ['**/*.log'],
+        [BrowserPlatform.MAC]: ['**/*.log'],
+        [BrowserPlatform.MAC_ARM]: ['**/*.log'],
+        [BrowserPlatform.WIN64]: ['**/*.log'],
       },
     }),
     downloadMilestonesAndWriteVersionsFiles({
@@ -162,9 +162,9 @@ async function main() {
       workspaceRoot,
       // We want Firefox to be addressable with "120.0" instead of
       // "stable_120.0", so we rewrite the build ID.
-      buildIdToVersion: (buildId: string) => buildId.replace(/^stable_/, ""),
+      buildIdToVersion: (buildId: string) => buildId.replace(/^stable_/, ''),
     }),
   ]);
 
-  await fs.rm(tmpDir, { recursive: true, maxRetries: 2 });
+  await fs.rm(tmpDir, {recursive: true, maxRetries: 2});
 }

browsers/private/update-tool/index.mts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { BrowserPlatform } from "@puppeteer/browsers";
+import {BrowserPlatform} from '@puppeteer/browsers';
 
 export const platforms: BrowserPlatform[] = [
   BrowserPlatform.LINUX,

browsers/private/update-tool/platforms.mts

@@ -12,10 +12,10 @@ interface ChromeForTestingLatestVersionsPerMilestoneResponse {
 }
 
 export async function getChromeMilestones(
-  maxMilestones: number
+  maxMilestones: number,
 ): Promise<Array<string>> {
   const response = await fetch(
-    "https://googlechromelabs.github.io/chrome-for-testing/latest-versions-per-milestone.json"
+    'https://googlechromelabs.github.io/chrome-for-testing/latest-versions-per-milestone.json',
   );
   const responseJson =
     (await response.json()) as ChromeForTestingLatestVersionsPerMilestoneResponse;
@@ -28,14 +28,14 @@ interface FirefoxMajorReleasesResponse {
 }
 
 export async function getFirefoxMilestones(
-  maxMilestones: number
+  maxMilestones: number,
 ): Promise<Array<string>> {
   const response = await fetch(
-    "https://product-details.mozilla.org/1.0/firefox_history_major_releases.json"
+    'https://product-details.mozilla.org/1.0/firefox_history_major_releases.json',
   );
   const responseJson = (await response.json()) as FirefoxMajorReleasesResponse;
   const milestones = Object.keys(responseJson);
   return [...milestones]
     .slice(-maxMilestones)
-    .map((milestone) => "stable_" + milestone);
+    .map((milestone) => 'stable_' + milestone);
 }