Add support for renaming

[osiewicz]

It seems to be an experimental option in the LSP. I've just unblocked that use case in Zed (zed-industries/zed#25610) if y'all are interested in experimenting.

[ematipico]

At the moment our implementation of renaming is pretty useless because it works only within the current file.

If you attempt to rename a binding that is used in other files, they aren't renamed.

We're about to support multi file analysis, so in the near future we might be able to make it useful

[dmythro]

As I can see, multi-file renaming is working now. At least, it works in TS :)

[ematipico]

Then it's not Biome doing the renaming, but probably the TypeScript language server, which is baked into zed

[dmythro]

@ematipico why does Biome need to bother with this then? Feels like it should be a language specific thing.

[ematipico]

@ematipico why does Biome need to bother with this then? Feels like it should be a language specific thing.

It was added a long time ago as an experimental feature when Rome was a company. We just left it there.

[dmythro]

@ematipico why does Biome need to bother with this then? Feels like it should be a language specific thing.

It was added a long time ago as an experimental feature when Rome was a company. We just left it there.

Just close this issue then? :)
But please have a look at this one, it is a huge bummer to me: #103. Also, this one is pretty weird #59, not stable for some reason.

[kasimir-dka]

When I try to do any renaming, be it just in one file or multiple TS/JS files, I get this error:

Would it be possible to disable renaming with Biome altogether and leave it to Zed?

[ematipico]

I thought it was disabled 🤔 will look into it

[the-dream-machine]

Is there any news about the progress on this issue? I'm still experiencing it using biome v1.9.4 and biome-zed v0.2.0

[the-dream-machine]

@ematipico I've updated to @biomejs/biome v2.0.4 and I'm still getting this error when trying to rename all instances of a variable in zed:

Error: Prepare rename via biome failed: Rename not supported

Do I need some additional configuration to get this working?

[ematipico]

@the-dream-machine I would appreciate it if you could provide a reproduction, because I don't have such a issue

[the-dream-machine]

@ematipico Sure, here is my biome.json:

{
  "$schema": "https://biomejs.dev/schemas/2.0.4/schema.json",
  "formatter": {
    "enabled": true,
    "formatWithErrors": false,
    "indentStyle": "space",
    "indentWidth": 2,
    "lineEnding": "lf",
    "lineWidth": 80,
    "attributePosition": "auto"
  },
  "assist": { "actions": { "source": { "organizeImports": "on" } } },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": false,
      "a11y": {},
      "complexity": {
        "noBannedTypes": "error",
        "noExtraBooleanCast": "error",
        "noUselessCatch": "error",
        "noUselessTypeConstraint": "error",
        "noAdjacentSpacesInRegex": "error"
      },
      "correctness": {
        "noChildrenProp": "error",
        "noConstAssign": "error",
        "noConstantCondition": "error",
        "noEmptyCharacterClassInRegex": "error",
        "noEmptyPattern": "error",
        "noGlobalObjectCalls": "error",
        "noInnerDeclarations": "error",
        "noInvalidConstructorSuper": "error",
        "noNonoctalDecimalEscape": "error",
        "noPrecisionLoss": "error",
        "noSelfAssign": "error",
        "noSetterReturn": "error",
        "noSwitchDeclarations": "error",
        "noUndeclaredVariables": "error",
        "noUnreachable": "error",
        "noUnreachableSuper": "error",
        "noUnsafeFinally": "error",
        "noUnsafeOptionalChaining": "error",
        "noUnusedImports": "warn",
        "noUnusedLabels": "error",
        "noUnusedPrivateClassMembers": "error",
        "noUnusedVariables": "warn",
        "useIsNan": "error",
        "useJsxKeyInIterable": "error",
        "useValidForDirection": "error",
        "useYield": "error",
        "noInvalidBuiltinInstantiation": "error",
        "useValidTypeof": "error"
      },
      "security": {
        "noDangerouslySetInnerHtmlWithChildren": "error",
        "noBlankTarget": "error"
      },
      "style": {
        "noNamespace": "error",
        "useAsConstAssertion": "error",
        "useImportType": { "level": "warn", "fix": "safe" },
        "useArrayLiterals": "off",
        "useFilenamingConvention": "warn"
      },
      "suspicious": {
        "noAsyncPromiseExecutor": "error",
        "noCatchAssign": "error",
        "noClassAssign": "error",
        "noCommentText": "error",
        "noCompareNegZero": "error",
        "noControlCharactersInRegex": "error",
        "noDebugger": "error",
        "noDuplicateCase": "error",
        "noDuplicateClassMembers": "error",
        "noDuplicateJsxProps": "error",
        "noDuplicateObjectKeys": "error",
        "noDuplicateParameters": "error",
        "noEmptyBlockStatements": "error",
        "noExplicitAny": "error",
        "noExtraNonNullAssertion": "error",
        "noFallthroughSwitchClause": "error",
        "noFunctionAssign": "error",
        "noGlobalAssign": "error",
        "noImportAssign": "error",
        "noMisleadingCharacterClass": "error",
        "noMisleadingInstantiator": "error",
        "noPrototypeBuiltins": "error",
        "noRedeclare": "error",
        "noShadowRestrictedNames": "error",
        "noUnsafeDeclarationMerging": "error",
        "noUnsafeNegation": "error",
        "useAwait": "warn",
        "useGetterReturn": "error",
        "noWith": "error",
        "noConsole": { "level": "warn", "options": { "allow": ["log"] } }
      },
      "nursery": {
        "useSortedClasses": {
          "fix": "safe",
          "level": "warn",
          "options": {
            "attributes": ["classList"],
            "functions": ["clsx", "cva", "tw", "cn"]
          }
        }
      }
    },
    "includes": [
      "**",
      "!**/node_modules",
      "!**/build/**",
      "!**/dist/**",
      "!**/.vscode/**",
      "!**/.wrangler/**",
      "!**/.zed/**",
      "!**/.trigger/**",
      "!**/knip.json",
      "!**/tsconfig.json"
    ]
  },
  "javascript": {
    "formatter": {
      "jsxQuoteStyle": "double",
      "quoteProperties": "asNeeded",
      "trailingCommas": "all",
      "semicolons": "asNeeded",
      "arrowParentheses": "always",
      "bracketSpacing": true,
      "bracketSameLine": false,
      "quoteStyle": "single",
      "attributePosition": "auto"
    },
    "globals": []
  },
  "overrides": [
    { "includes": ["**/*.{js,jsx,ts,tsx}"] },
    { "includes": ["**/*.{ts,tsx}"] }
  ]
}

My .zed/settings.json:

{
  "lsp": {
    "biome": {
      "settings": { "config_path": "./biome.json" }
    }
  },
  "format_on_save": "on",
  "languages": {
    "JavaScript": {
      "language_servers": ["biome", "typescript-language-server"],
      "formatter": { "language_server": { "name": "biome" } },
      "code_actions_on_format": {
        "source.fixAll.biome": true,
        "source.organizeImports.biome": true
      }
    },
    "TypeScript": {
      "language_servers": ["biome", "typescript-language-server"],
      "formatter": { "language_server": { "name": "biome" } },
      "code_actions_on_format": {
        "source.fixAll.biome": true,
        "source.organizeImports.biome": true
      }
    },
    "JSX": {
      "language_servers": ["biome", "typescript-language-server"],
      "formatter": { "language_server": { "name": "biome" } },
      "code_actions_on_format": {
        "source.fixAll.biome": true,
        "source.organizeImports.biome": true
      }
    },
    "TSX": {
      "language_servers": ["biome", "typescript-language-server"],
      "formatter": { "language_server": { "name": "biome" } },
      "code_actions_on_format": {
        "source.fixAll.biome": true,
        "source.organizeImports.biome": true
      }
    },
    "JSON": {
      "language_servers": ["biome"],
      "formatter": { "language_server": { "name": "biome" } },
      "code_actions_on_format": {
        "source.fixAll.biome": true,
        "source.organizeImports.biome": true
      }
    },
    "JSONC": {
      "language_servers": ["biome"],
      "formatter": { "language_server": { "name": "biome" } },
      "code_actions_on_format": {
        "source.fixAll.biome": true,
        "source.organizeImports.biome": true
      }
    },
    "CSS": {
      "language_servers": ["biome"],
      "formatter": { "language_server": { "name": "biome" } },
      "code_actions_on_format": {
        "source.fixAll.biome": true,
        "source.organizeImports.biome": true
      }
    },
    "GraphQL": {
      "language_servers": ["biome"],
      "formatter": { "language_server": { "name": "biome" } },
      "code_actions_on_format": {
        "source.fixAll.biome": true,
        "source.organizeImports.biome": true
      }
    }
  }
}

A sample .ts file:

import type { ZodError } from 'zod/v4'

export const parseZodHttpErrorMessage = (error: string): string => {
  const zodErrorString = error.substring('ZodError: '.length)
  const zodErrorIssues = JSON.parse(
    zodErrorString as string,
  ) as ZodError['issues']

  return zodErrorIssues[0].message
}

Steps to reproduce:

• Call the parseZodHttpErrorMessage function in a different .ts file.
• In the zed editor, try renaming all instances of parseZodHttpErrorMessage to parseZodErrorMessage (highlight whole word then press f2 or your configured rename key binding).
• The error referenced here shows up.
• Disable the biome-zed extension and try renaming, it should work.

[kasimir-dka]

When I have in my zed config:

  "formatter": {
    "language_server": {
      "name": "biome"
    }
  },
  "lsp": {
    "biome": {
      "settings": {
        "require_config_file": true
      }
    }
  },
  "language_servers": [ "biome", "..." ],

And have a file test.js in my home directory, the file containing

const foo = "foo"

and try to rename foo then I get

When I change one line in zed config disabling biome by adding "!"

  "language_servers": [ "!biome", "..." ],

then renaming works.