chore(deps-dev): bump @biomejs/biome to v2 for all packages #2281

mwbrooks · 2025-06-25T03:27:19Z

Summary

This pull request upgrades @biomejs/biome from 1.8.3 to 2.0.5 using the Biome v2 Migration Guide.

The following packages are upgraded:

@slack/socket-mode
@slack/cli-hooks
@slack/cli-test
@slack/logger
@slack/oauth
@slack/rtm-api
@slack/types
@slack/web-api
@slack/webhook

Open PRs that are related to this migration:

Fixes chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.5 in /packages/oauth #2273
Fixes chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.5 in /packages/socket-mode #2274
Fixes chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.5 in /packages/web-api #2275
Fixes chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.5 in /packages/cli-hooks #2276
Fixes chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.5 in /packages/logger #2277
Fixes chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.5 in /packages/types #2278
Fixes chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.5 in /packages/cli-test #2279
chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.6 in /packages/logger #2282
chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.6 in /packages/oauth #2283
chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.6 in /packages/types #2284
chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.6 in /packages/web-api #2285
chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.6 in /packages/cli-test #2286
chore(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.6 in /packages/cli-hooks #2287

Reviewers

Biome v2 appears to have made changes to the organizeImports assist, which is used to sort imports and exports. Most of the changes in this PR are from new rules. Most of the time, alphabetically sorted makes sense. But there are a few situations where it's better to sort by logic (e.g. import the main client then it's types and callbacks).

I'm not advocating for the changes in this PR. I simply migrated to Biome v2. If these changes don't jive with you, then I can explore disabling organizeImports to see if it feels better for us.

Requirements (place an `x` in each `[ ]`)

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

Bumps [@biomejs/biome](https://github.com/biomejs/biome/tree/HEAD/packages/@biomejs/biome) from 1.9.4 to 2.0.5. - [Release notes](https://github.com/biomejs/biome/releases) - [Changelog](https://github.com/biomejs/biome/blob/main/packages/@biomejs/biome/CHANGELOG.md) - [Commits](https://github.com/biomejs/biome/commits/@biomejs/[email protected]/packages/@biomejs/biome) --- updated-dependencies: - dependency-name: "@biomejs/biome" dependency-version: 2.0.5 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>

codecov · 2025-06-25T03:27:52Z

Codecov Report

Attention: Patch coverage is 95.34884% with 2 lines in your changes missing coverage. Please review.

Project coverage is 92.71%. Comparing base (181d486) to head (fbe3737).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2281      +/-   ##
==========================================
- Coverage   92.71%   92.71%   -0.01%     
==========================================
  Files          38       38              
  Lines       10609    10607       -2     
  Branches      683      683              
==========================================
- Hits         9836     9834       -2     
  Misses        761      761              
  Partials       12       12

Flag	Coverage Δ
cli-hooks	`95.23% <ø> (ø)`
cli-test	`94.74% <100.00%> (-0.02%)`	⬇️
oauth	`77.39% <100.00%> (ø)`
socket-mode	`61.87% <71.42%> (+0.05%)`	⬆️
web-api	`97.97% <100.00%> (+<0.01%)`	⬆️
webhook	`96.66% <100.00%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mwbrooks

Some comments to help the kind reviewers understand why these changes were made 🙇🏻

mwbrooks · 2025-06-25T23:07:33Z

biome.json

@@ -1,9 +1,18 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.0.5/schema.json",


note: Upgraded to schema v2 by following the v3 Upgrade Gudie and running:

$ npx @biomejs/biome migrate --write

mwbrooks · 2025-06-25T23:08:10Z

biome.json

+      "style": {
+        "noParameterAssign": "error",
+        "useAsConstAssertion": "error",
+        "useDefaultParameterLast": "error",
+        "useEnumInitializers": "error",
+        "useSelfClosingElements": "error",
+        "useSingleVarDeclarator": "error",
+        "noUnusedTemplateLiteral": "error",
+        "useNumberNamespace": "error",
+        "noInferrableTypes": "error",
+        "noUselessElse": "error"
+      }


note: These are the defaults that the migration command added. I believe they are meant to represent the default, recommended style rules.

mwbrooks · 2025-06-25T23:09:05Z

packages/cli-hooks/biome.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.0.5/schema.json",


note: Each package extends the base biome.json. This is why we need to have 1 PR that upgrades all packages to Biome v2 - because the schema is not compatible with Biome 1.x.

mwbrooks · 2025-06-25T23:09:23Z

packages/cli-hooks/package.json

@@ -51,7 +55,7 @@
    "semver": "^7.5.4"
  },
  "devDependencies": {
-    "@biomejs/biome": "^1.8.3",
+    "@biomejs/biome": "^2.0.5",


note: Upgrading the biome npm package to v2.

mwbrooks · 2025-06-25T23:09:49Z

packages/cli-hooks/package.json

+  "keywords": [
+    "cli",
+    "hooks",
+    "slack"
+  ],


note: biome linter rule requires multiple element arrays to be on newlines.

mwbrooks · 2025-06-25T23:17:24Z

packages/rtm-api/src/index.ts

 } from './RTMClient';

-export { Logger, LogLevel } from './logger';
+// Utilities


note: Added a // Utilities chunk to keep the RTMClient export at the top of the file.

mwbrooks · 2025-06-25T23:18:22Z

packages/socket-mode/examples/manually-connecting.js

+
+// const { WebClient } = require('@slack/web-api');
+// const webClient = new WebClient(process.env.SLACK_BOT_TOKEN, {
+//   logLevel,
+// });


note: Biome didn't like the unused variable, but it's important for the example. I've commented it out, similar to how we've commented out the serverPingTimeout above. The alternative is an _webClient prefix, but that could be misunderstood as a recommended naming pattern.

@mwbrooks Thanks for catching this with comments! I think it's useful to keep with these files too, for fast reference 🙏 ✨

At a glance I didn't realize this was an unused variable also, so I am glad for this linter setting 👾

mwbrooks · 2025-06-25T23:23:21Z

packages/web-api/biome.json

+    {
+      "includes": ["src/index.ts"],
+      "assist": {
+        "actions": {
+          "source": {
+            "organizeImports": "off"
+          }
+        }
+      }


⚠️ note: This one is important. src/index.ts requires the imports to be a specific, logical order but Biome requires the imports to be alphabetical. Right now, the Biome v2 Supressions (e.g. // biome-ignore lint/suspicious/noPrototypeBuiltins: reason why) don't work for the assist category. So, my workaround was to disable the organizeImports for that specific file. 🤷🏻

mwbrooks · 2025-06-25T23:24:45Z

packages/web-api/src/file-upload.ts

+      // biome-ignore lint/suspicious/noPrototypeBuiltins: TODO use hasOwn instead of hasOwnProperty
      if (!Object.prototype.hasOwnProperty.call(toComplete, compareString)) {


note: Biome wants .hasOwn instead of .hasOwnProperty. I didn't feel comfortable making this change here because it uses a .call(...) and I wasn't sure about test coverage.

@mwbrooks Thanks for saving this in a TODO - it would be tough to catch in this PR if it caused regressions of past Node versions 😓

mwbrooks · 2025-06-25T23:25:47Z

packages/web-api/test/integration/esm-project/index.mjs

@@ -1,5 +1,6 @@
 import assert from 'node:assert';
 import { WebClient } from '../../../dist/index.js';
+


note: Biome requires a newline between imports and logic.

zimeg

LGTM! And thanks biome for the wonderful linting upgrades as always.

I'm leaving a few comments but no suggested changes. A few more updates landed in the following PRs that we might want to ignore until this merges, but all is testing well:

🚢 💨

zimeg · 2025-07-01T03:37:53Z

packages/socket-mode/examples/manually-connecting.js

+
+// const { WebClient } = require('@slack/web-api');
+// const webClient = new WebClient(process.env.SLACK_BOT_TOKEN, {
+//   logLevel,
+// });


@mwbrooks Thanks for catching this with comments! I think it's useful to keep with these files too, for fast reference 🙏 ✨

At a glance I didn't realize this was an unused variable also, so I am glad for this linter setting 👾

zimeg · 2025-07-01T03:41:27Z

packages/types/src/index.ts

 export * from './message-attachments';
+export * from './message-metadata';
 export * from './views';


👁‍🗨 The * export worries me sometimes but I believe we're safe against name collisions in the build step.

zimeg · 2025-07-01T03:45:54Z

packages/web-api/src/file-upload.ts

+      // biome-ignore lint/suspicious/noPrototypeBuiltins: TODO use hasOwn instead of hasOwnProperty
      if (!Object.prototype.hasOwnProperty.call(toComplete, compareString)) {


@mwbrooks Thanks for saving this in a TODO - it would be tough to catch in this PR if it caused regressions of past Node versions 😓

zimeg · 2025-07-01T03:46:46Z

packages/web-api/src/logger.ts

@@ -1,4 +1,4 @@
-import { ConsoleLogger, type LogLevel, type Logger } from '@slack/logger';
+import { ConsoleLogger, type Logger, type LogLevel } from '@slack/logger';


📣 Rambling but I thought capital letters appeared before lowercase! 😉

zimeg · 2025-07-01T03:52:41Z

packages/oauth/src/index.ts

 export * from './state-stores';
+
+// Utilities


Half joking, but "errors" and "logger" wouldn't be not descriptive 😉

zimeg · 2025-07-01T03:52:53Z

packages/oauth/src/state-stores/spec-utils.ts

@@ -38,7 +38,7 @@ export class StateStoreChaiTestRunner {
      it('should detect old state values', async () => {
        const { stateStore } = this;
        const installUrlOptions = { scopes: ['channels:read'] };
-        const fifteenMinutesLater = new Date(new Date().getTime() + 15 * 60 * 1000);
+        const fifteenMinutesLater = new Date(Date.now() + 15 * 60 * 1000);


🧠 TIL this was the same thing! Thank you for making this change.

zimeg · 2025-07-01T03:56:37Z

packages/webhook/src/IncomingWebhook.spec.ts

@@ -105,7 +106,7 @@ describe('IncomingWebhook', () => {
        try {
          await webhook.send({ channel: 'different' });
          assert.fail('expected rejection');
-        } catch (error) {
+        } catch (_err) {


📣 @mwbrooks err and _err are good choices!

dependabot bot and others added 10 commits June 23, 2025 21:37

fix: migrate to biome 2.x

9ab66f9

fix: migrate to biome 2.x for packages/cli-hooks

8514f43

fix: migrate to biome 2.x for packages/cli-test

639aac9

fix: migrate to biome 2.x for packages/logger

e6cf5b3

fix: migrate to biome 2.x for packages/oauth

287a1da

fix: migrate to biome 2.x for packages/rtm-api

8d16d34

fix: migrate to biome 2.x for packages/types

9e6e869

fix: migrate to biome 2.x for packages/web-api

2a7a422

fix: migrate to biome 2.x for packages/webhook

c6b420b

mwbrooks self-assigned this Jun 25, 2025

mwbrooks changed the title ~~Mwbrooks biome 2 migration~~ chore(deps-dev): bump @biomejs/biome to v2 for all packages Jun 25, 2025

fix: disable organizeImports for web-api/src/index.ts

7f16dc4

mwbrooks commented Jun 25, 2025

View reviewed changes

mwbrooks requested review from WilliamBergamin, zimeg and hello-ashleyintech June 25, 2025 23:26

mwbrooks marked this pull request as ready for review June 25, 2025 23:30

zimeg approved these changes Jul 1, 2025

View reviewed changes

zimeg mentioned this pull request Jul 1, 2025

build(deps-dev): bump @biomejs/biome from 1.9.4 to 2.0.6 slackapi/slack-github-action#470

Merged

mwbrooks added 2 commits July 2, 2025 12:21

update utlities to errors and logging

22308ce

Merge branch 'main' into mwbrooks-biome-2-migration

fbe3737

mwbrooks merged commit f1ebcc6 into main Jul 2, 2025
57 checks passed

mwbrooks deleted the mwbrooks-biome-2-migration branch July 2, 2025 19:25

		// biome-ignore lint/suspicious/noPrototypeBuiltins: TODO use hasOwn instead of hasOwnProperty
		if (!Object.prototype.hasOwnProperty.call(toComplete, compareString)) {

		@@ -1,5 +1,6 @@
		import assert from 'node:assert';
		import { WebClient } from '../../../dist/index.js';

		@@ -1,4 +1,4 @@
		import { ConsoleLogger, type LogLevel, type Logger } from '@slack/logger';
		import { ConsoleLogger, type Logger, type LogLevel } from '@slack/logger';

chore(deps-dev): bump @biomejs/biome to v2 for all packages #2281

chore(deps-dev): bump @biomejs/biome to v2 for all packages #2281

Uh oh!

Conversation

mwbrooks commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Reviewers

Requirements (place an x in each [ ])

Uh oh!

codecov bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mwbrooks left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mwbrooks commented Jun 25, 2025 •

edited

Loading

Requirements (place an `x` in each `[ ]`)

codecov bot commented Jun 25, 2025 •

edited

Loading