fix(js): format TypeScript files using the faster biomejs formatter a…

…nd Google style #1987

This speeds up formatting by 4-12x and fixes several formatting related
issues whether they have to do with the commit message, source code, or
license headers. This means faster CI and pre-commits.

```
zsh❯ hyperfine -i "pnpm run format:biome" "pnpm run format:prettier"
Benchmark 1: pnpm run format:biome
  Time (mean ± σ):     453.6 ms ±   5.6 ms    [User: 679.3 ms, System: 92.5 ms]
  Range (min … max):   447.9 ms … 465.3 ms    10 runs

  Warning: Ignoring non-zero exit code.

Benchmark 2: pnpm run format:prettier
  Time (mean ± σ):      5.715 s ±  0.285 s    [User: 9.578 s, System: 0.739 s]
  Range (min … max):    5.506 s …  6.426 s    10 runs

Summary
  pnpm run format:biome ran
   12.60 ± 0.65 times faster than pnpm run format:prettier
```

A sample run follows:

```
zsh❯ pnpm run format

> genkit@ format /Users/yesudeep/code/github.com/firebase/genkit
> pnpm dlx @biomejs/biome format --write . && (tsx scripts/copyright.ts)

Formatted 663 files in 86ms. Fixed 217 files.
Checking copyright in sources...
Updated copyright headers in 0 files
```

The configuration for the formatting is more or less based on the Google
TypeScript formatting guidelines at:

- [ ] https://google.github.io/styleguide/tsguide.html#string-literals
- [ ] https://google.github.io/styleguide/jsguide.html
- [ ] https://google.github.io/styleguide/tsguide.html#arrow-function-bodies
- [ ] https://google.github.io/styleguide/tsguide.html#automatic-semicolon-insertion

ISSUE: #1987

CHANGELOG:
- [ ] Update `pnpm run format` to use biomejs
- [ ] Update `pnpm run format:check` to use biomejs
- [ ] Use `bin/add_license` to add license headers.
- [ ] Exclude the `py/` and `go/` runtimes from the formatter.
- [ ] Fix Import attributes cannot be used with a type-only import error
- [ ] Update all the TypeScript files to use Google-style formatting.
- [ ] Re-enable pre-commit formatting for TypeScript.
- [ ] Update the JavaScript GitHub action workflows so that JS
  tests run on node version 20-23.

.github/workflows/builder.yml

@@ -1,16 +1,5 @@
 # Copyright 2024 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# SPDX-License-Identifier: Apache-2.0
 
 name: Build Check (Run npm run build everywhere locally if this fails)
 
@@ -22,21 +11,24 @@ env:
 
 jobs:
   build:
-    name: Run build tasks
+    name: Run build tasks (Node ${{ matrix.node-version }})
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ['20.x', '21.x', '22.x', '23.x']
     steps:
-    - uses: actions/checkout@v3
-    - uses: pnpm/action-setup@v3
-    - name: Set up node v20
-      uses: actions/setup-node@v4
-      with:
-        node-version: 20.x
-        cache: pnpm
-    - name: Install dependencies
-      run: pnpm install
-    - name: Run build script
-      run: pnpm build
-    - name: Run js tests
-      run: pnpm test:js
-    - name: Validate working directory is clean
-      run: .github/workflows/scripts/ensure-clean-working-tree.sh
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v3
+      - name: Set up node v${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: pnpm
+      - name: Install dependencies
+        run: pnpm install
+      - name: Run build script
+        run: pnpm build
+      - name: Run js tests
+        run: pnpm test:js
+      - name: Validate working directory is clean
+        run: .github/workflows/scripts/ensure-clean-working-tree.sh

bin/add_license

@@ -42,6 +42,7 @@ $HOME/go/bin/addlicense \
   -ignore '**/dist/**/*' \
   -ignore '**/node_modules/**/*' \
   -ignore '**/pnpm-lock.yaml' \
+  -ignore '**/py/site/**/*.html' \
   -ignore '.nx/**/*' \
   -ignore '.trunk/**/*' \
   "$TOP_DIR"

bin/check_license

@@ -45,6 +45,7 @@ $HOME/go/bin/addlicense \
   -ignore '**/dist/**/*' \
   -ignore '**/node_modules/**/*' \
   -ignore '**/pnpm-lock.yaml' \
+  -ignore '**/py/site/**/*.html' \
   -ignore '.nx/**/*' \
   -ignore '.trunk/**/*' \
   "$TOP_DIR"

bin/fmt

@@ -39,13 +39,9 @@ fi
 popd
 
 # Format all TypeScript code.
-#
-# TODO: Re-enable once we have biome configured and enabled because that is
-# several times faster and compatible.
-#
-#pushd ${TOP_DIR}
-#pnpm run format
-#if [[ $? -ne 0 ]]; then
-#  exit 1
-#fi
-#popd
+pushd ${TOP_DIR}
+pnpm run format
+if [[ $? -ne 0 ]]; then
+  exit 1
+fi
+popd

biome.json

@@ -31,7 +31,9 @@
       ".nx/**",
       ".trunk/**",
       "bazel-*/**",
+      "go/**",
       "node_modules/**",
+      "py/**",
       "third_party/**"
     ]
   },

genkit-tools/cli/package.json

@@ -3,12 +3,7 @@
   "version": "1.0.4",
   "description": "CLI for interacting with the Google Genkit AI framework",
   "license": "Apache-2.0",
-  "keywords": [
-    "genkit",
-    "ai",
-    "genai",
-    "generative-ai"
-  ],
+  "keywords": ["genkit", "ai", "genai", "generative-ai"],
   "author": "genkit",
   "bin": {
     "genkit": "dist/bin/genkit.js"

genkit-tools/cli/src/cli.ts

@@ -64,7 +64,7 @@ export async function startCLI(): Promise<void> {
       // For now only record known command names, to avoid tools plugins causing
       // arbitrary text to get recorded. Once we launch tools plugins, we'll have
       // to give this more thought
-      const commandNames = commands.map((c) => c.name());
+      const commandNames = commands.map(c => c.name());
       let commandName: string;
       if (commandNames.includes(actionCommand.name())) {
         commandName = actionCommand.name();

genkit-tools/cli/src/commands/config.ts

@@ -29,7 +29,7 @@ const CONFIG_TAGS: Record<
   string,
   (value: string) => string | boolean | number
 > = {
-  [ANALYTICS_OPT_OUT_CONFIG_TAG]: (value) => {
+  [ANALYTICS_OPT_OUT_CONFIG_TAG]: value => {
     let o: boolean | undefined;
     try {
       o = JSON.parse(value);
@@ -46,7 +46,7 @@ config
   .description('set development environment configuration')
   .command('get')
   .argument('<tag>', `The config tag to get. One of [${readableTagsHint()}]`)
-  .action((tag) => {
+  .action(tag => {
     if (!CONFIG_TAGS[tag]) {
       logger.error(
         `Unknown config tag "${clc.bold(tag)}.\nValid options: ${readableTagsHint()}`

genkit-tools/cli/src/commands/eval-extract-data.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import {
+import type {
   EvalInput,
   EvalInputDataset,
   TraceData,
@@ -45,23 +45,23 @@ export const evalExtractData = new Command('eval:extractData')
   .option('--maxRows <maxRows>', 'maximum number of rows', '100')
   .option('--label [label]', 'label flow run in this batch')
   .action(async (flowName: string, options: EvalDatasetOptions) => {
-    await runWithManager(async (manager) => {
+    await runWithManager(async manager => {
       const extractors = await getEvalExtractors(`/flow/${flowName}`);
 
       logger.info(`Extracting trace data '/flow/${flowName}'...`);
       let dataset: EvalInputDataset = [];
       let continuationToken = undefined;
-      while (dataset.length < parseInt(options.maxRows)) {
+      while (dataset.length < Number.parseInt(options.maxRows)) {
         const response = await manager.listTraces({
-          limit: parseInt(options.maxRows),
+          limit: Number.parseInt(options.maxRows),
           continuationToken,
         });
         continuationToken = response.continuationToken;
         const traces = response.traces;
-        let batch: EvalInput[] = traces
-          .map((t) => {
+        const batch: EvalInput[] = traces
+          .map(t => {
             const rootSpan = Object.values(t.spans).find(
-              (s) =>
+              s =>
                 s.attributes['genkit:metadata:subtype'] === 'flow' &&
                 (!options.label ||
                   s.attributes['batchRun'] === options.label) &&
@@ -73,7 +73,7 @@ export const evalExtractData = new Command('eval:extractData')
             return t;
           })
           .filter((t): t is TraceData => !!t)
-          .map((trace) => {
+          .map(trace => {
             return {
               testCaseId: generateTestCaseId(),
               input: extractors.input(trace),
@@ -82,14 +82,14 @@ export const evalExtractData = new Command('eval:extractData')
               // The trace (t) does not contain the traceId, so we have to pull it out of the
               // spans, de- dupe, and turn it back into an array.
               traceIds: Array.from(
-                new Set(Object.values(trace.spans).map((span) => span.traceId))
+                new Set(Object.values(trace.spans).map(span => span.traceId))
               ),
             } as EvalInput;
           })
           .filter((result): result is EvalInput => !!result);
-        batch.forEach((d) => dataset.push(d));
-        if (dataset.length > parseInt(options.maxRows)) {
-          dataset = dataset.splice(0, parseInt(options.maxRows));
+        batch.forEach(d => dataset.push(d));
+        if (dataset.length > Number.parseInt(options.maxRows)) {
+          dataset = dataset.splice(0, Number.parseInt(options.maxRows));
           break;
         }
         if (!continuationToken) {

genkit-tools/cli/src/commands/eval-flow.ts

@@ -15,13 +15,13 @@
  */
 
 import {
-  Action,
-  Dataset,
-  DatasetMetadata,
+  type Action,
+  type Dataset,
+  type DatasetMetadata,
   DatasetSchema,
 } from '@genkit-ai/tools-common';
 import {
-  EvalExporter,
+  type EvalExporter,
   getAllEvaluatorActions,
   getDatasetStore,
   getExporterForString,
@@ -83,7 +83,7 @@ export const evalFlow = new Command('eval:flow')
   .option('-f, --force', 'Automatically accept all interactive prompts')
   .action(
     async (flowName: string, data: string, options: EvalFlowRunCliOptions) => {
-      await runWithManager(async (manager) => {
+      await runWithManager(async manager => {
         const actionRef = `/flow/${flowName}`;
         if (!data && !options.input) {
           throw new Error(
@@ -102,7 +102,7 @@ export const evalFlow = new Command('eval:flow')
         } else {
           const evalActionKeys = options.evaluators
             .split(',')
-            .map((k) => `/evaluator/${k}`);
+            .map(k => `/evaluator/${k}`);
           evaluatorActions = await getMatchingEvaluatorActions(
             manager,
             evalActionKeys
@@ -116,7 +116,7 @@ export const evalFlow = new Command('eval:flow')
           );
         }
         logger.debug(
-          `Using evaluators: ${evaluatorActions.map((action) => action.name).join(',')}`
+          `Using evaluators: ${evaluatorActions.map(action => action.name).join(',')}`
         );
 
         if (!options.force) {

genkit-tools/cli/src/commands/eval-run.ts

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import { Action, EvalInputDataset } from '@genkit-ai/tools-common';
+import type { Action, EvalInputDataset } from '@genkit-ai/tools-common';
 import {
-  EvalExporter,
+  type EvalExporter,
   getAllEvaluatorActions,
   getExporterForString,
   getMatchingEvaluatorActions,
@@ -59,7 +59,7 @@ export const evalRun = new Command('eval:run')
   )
   .option('--force', 'Automatically accept all interactive prompts')
   .action(async (dataset: string, options: EvalRunCliOptions) => {
-    await runWithManager(async (manager) => {
+    await runWithManager(async manager => {
       if (!dataset) {
         throw new Error(
           'No input data passed. Specify input data using [data] argument'
@@ -72,7 +72,7 @@ export const evalRun = new Command('eval:run')
       } else {
         const evalActionKeys = options.evaluators
           .split(',')
-          .map((k) => `/evaluator/${k}`);
+          .map(k => `/evaluator/${k}`);
         evaluatorActions = await getMatchingEvaluatorActions(
           manager,
           evalActionKeys
@@ -86,7 +86,7 @@ export const evalRun = new Command('eval:run')
         );
       }
       logger.info(
-        `Using evaluators: ${evaluatorActions.map((action) => action.name).join(',')}`
+        `Using evaluators: ${evaluatorActions.map(action => action.name).join(',')}`
       );
 
       if (!options.force) {

genkit-tools/cli/src/commands/flow-batch-run.ts

@@ -43,21 +43,21 @@ export const flowBatchRun = new Command('flow:batchRun')
       fileName: string,
       options: FlowBatchRunOptions
     ) => {
-      await runWithManager(async (manager) => {
+      await runWithManager(async manager => {
         const inputData = JSON.parse(await readFile(fileName, 'utf8')) as any[];
         let input = inputData;
         if (inputData.length === 0) {
           throw new Error('batch input data must be a non-empty array');
         }
         if (Object.hasOwn(inputData[0], 'input')) {
           // If object has "input" field, use that instead.
-          input = inputData.map((d) => d.input);
+          input = inputData.map(d => d.input);
         }
 
         const outputValues = [] as { input: any; output: any }[];
         for (const data of input) {
           logger.info(`Running '/flow/${flowName}'...`);
-          let response = await manager.runAction({
+          const response = await manager.runAction({
             key: `/flow/${flowName}`,
             input: data,
             context: options.context ? JSON.parse(options.context) : undefined,

genkit-tools/cli/src/commands/flow-run.ts

@@ -39,17 +39,17 @@ export const flowRun = new Command('flow:run')
     'name of the output file to store the extracted data'
   )
   .action(async (flowName: string, data: string, options: FlowRunOptions) => {
-    await runWithManager(async (manager) => {
+    await runWithManager(async manager => {
       logger.info(`Running '/flow/${flowName}' (stream=${options.stream})...`);
-      let result = (
+      const result = (
         await manager.runAction(
           {
             key: `/flow/${flowName}`,
             input: data ? JSON.parse(data) : undefined,
             context: options.context ? JSON.parse(options.context) : undefined,
           },
           options.stream
-            ? (chunk) => console.log(JSON.stringify(chunk, undefined, '  '))
+            ? chunk => console.log(JSON.stringify(chunk, undefined, '  '))
             : undefined
         )
       ).result;

genkit-tools/cli/src/commands/plugins.ts

@@ -15,10 +15,10 @@
  */
 
 import {
-  BaseToolPluginAction,
-  SpecialAction,
-  SupportedFlagValues,
-  ToolPlugin,
+  type BaseToolPluginAction,
+  type SpecialAction,
+  type SupportedFlagValues,
+  type ToolPlugin,
   findToolsConfig,
 } from '@genkit-ai/tools-common/plugin';
 import { logger } from '@genkit-ai/tools-common/utils';
@@ -37,8 +37,8 @@ export async function getPluginSubCommand(
 ): Promise<Command | undefined> {
   const config = await findToolsConfig();
   const actions = (config?.cliPlugins || [])
-    .filter((p) => !!p.subCommands?.[commandString])
-    .map((p) => ({
+    .filter(p => !!p.subCommands?.[commandString])
+    .map(p => ({
       keyword: p.keyword,
       name: p.name,
       ...p.subCommands![commandString]!,

genkit-tools/cli/src/commands/start.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { RuntimeManager } from '@genkit-ai/tools-common/manager';
+import type { RuntimeManager } from '@genkit-ai/tools-common/manager';
 import { startServer } from '@genkit-ai/tools-common/server';
 import { logger } from '@genkit-ai/tools-common/utils';
 import { spawn } from 'child_process';
@@ -49,7 +49,7 @@ export const start = new Command('start')
       } else {
         port = await getPort({ port: makeRange(4000, 4099) });
       }
-      managerPromise = managerPromise.then((manager) => {
+      managerPromise = managerPromise.then(manager => {
         startServer(manager, port);
         return manager;
       });
@@ -85,7 +85,7 @@ async function startRuntime(telemetryServerUrl?: string) {
         reject(error);
         process.exitCode = 1;
       });
-      appProcess.on('exit', (code) => {
+      appProcess.on('exit', code => {
         process.stdin?.pipe(originalStdIn);
         if (code === 0) {
           urlResolver(undefined);