-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add FlutterRename command (#234)
- Loading branch information
Showing
8 changed files
with
189 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| local M = {} | ||
|
|
||
| local lazy = require("flutter-tools.lazy") | ||
| local config = lazy.require("flutter-tools.config") ---@module "flutter-tools.config" | ||
| local lsp_utils = lazy.require("flutter-tools.lsp.utils") ---@module "flutter-tools.lsp.utils" | ||
| local path = lazy.require("flutter-tools.utils.path") ---@module "flutter-tools.utils.path" | ||
| local ui = lazy.require("flutter-tools.ui") ---@module "flutter-tools.ui" | ||
|
|
||
| local api = vim.api | ||
| local util = vim.lsp.util | ||
| local lsp = vim.lsp | ||
| local fn = vim.fn | ||
| local fs = vim.fs | ||
|
|
||
| --- Computes a filename for a given class name (convert from PascalCase to snake_case). | ||
| ---@param class_name string | ||
| ---@return string? | ||
| local function convert_to_file_name(class_name) | ||
| local starts_uppercase = class_name:find("^%u") | ||
| if not starts_uppercase then return end | ||
| local file_name = class_name:gsub("(%u)", "_%1"):lower() | ||
| -- Removes first underscore | ||
| file_name = file_name:sub(2) | ||
| return file_name .. ".dart" | ||
| end | ||
|
|
||
| ---@param old_name string | ||
| ---@param new_name string | ||
| ---@param callback function | ||
| local function will_rename_files(old_name, new_name, callback) | ||
| local params = lsp.util.make_position_params() | ||
| if not new_name then return end | ||
| local file_change = { | ||
| newUri = vim.uri_from_fname(new_name), | ||
| oldUri = vim.uri_from_fname(old_name), | ||
| } | ||
| params.files = { file_change } | ||
| lsp.buf_request(0, "workspace/willRenameFiles", params, function(err, result) | ||
| if err then | ||
| return ui.notify(err.message or "Error on getting lsp rename results!", ui.ERROR) | ||
| end | ||
| callback(result) | ||
| end) | ||
| end | ||
|
|
||
| --- Call this function when you want rename class or anything else. | ||
| --- If file will be renamed too, this function will update imports. | ||
| --- This is a modificated version of `vim.lsp.buf.rename()` function and can be used instead of it. | ||
| --- Original version: https://github.com/neovim/neovim/blob/0bc323850410df4c3c1dd8fabded9d2000189270/runtime/lua/vim/lsp/buf.lua#L271 | ||
| function M.rename(new_name, options) | ||
| options = options or {} | ||
| local bufnr = options.bufnr or api.nvim_get_current_buf() | ||
| local client = lsp_utils.get_dartls_client(bufnr) | ||
| if not client or config.lsp.settings.renameFilesWithClasses ~= "always" then | ||
| -- Fallback to default rename function if language server is not dartls | ||
| -- or if user doesn't want to rename files on class rename. | ||
| return lsp.buf.rename(new_name, options) | ||
| end | ||
|
|
||
| local win = api.nvim_get_current_win() | ||
|
|
||
| -- Compute early to account for cursor movements after going async | ||
| local word_under_cursor = fn.expand("<cword>") | ||
| local current_file_path = api.nvim_buf_get_name(bufnr) | ||
| local current_file_name = fs.basename(current_file_path) | ||
| local filename_from_class_name = convert_to_file_name(word_under_cursor) | ||
| local is_file_rename = filename_from_class_name == current_file_name | ||
|
|
||
| ---@param range table | ||
| ---@param offset_encoding string | ||
| local function get_text_at_range(range, offset_encoding) | ||
| return api.nvim_buf_get_text( | ||
| bufnr, | ||
| range.start.line, | ||
| -- Private method that may be not stable. | ||
| -- Source in case of changes: https://github.com/neovim/neovim/blob/0bc323850410df4c3c1dd8fabded9d2000189270/runtime/lua/vim/lsp/util.lua#L2152 | ||
| util._get_line_byte_from_position(bufnr, range.start, offset_encoding), | ||
| range["end"].line, | ||
| util._get_line_byte_from_position(bufnr, range["end"], offset_encoding), | ||
| {} | ||
| )[1] | ||
| end | ||
|
|
||
| ---@param name string the name of the thing | ||
| ---@param result table | nil the result from the call to will rename | ||
| local function rename(name, result) | ||
| local params = util.make_position_params(win, client.offset_encoding) | ||
| params.newName = name | ||
| local handler = client.handlers["textDocument/rename"] or lsp.handlers["textDocument/rename"] | ||
| client.request("textDocument/rename", params, function(...) | ||
| handler(...) | ||
| if result then lsp.util.apply_workspace_edit(result, client.offset_encoding) end | ||
| end, bufnr) | ||
| end | ||
|
|
||
| ---@param name string | ||
| local function rename_fix_imports(name) | ||
| if is_file_rename then | ||
| local new_filename = convert_to_file_name(name) | ||
| local new_file_path = path.join(fs.dirname(current_file_path), new_filename) | ||
|
|
||
| will_rename_files(current_file_path, new_file_path, function(result) rename(name, result) end) | ||
| else | ||
| rename(name) | ||
| end | ||
| end | ||
|
|
||
| if client.supports_method("textDocument/prepareRename") then | ||
| local params = util.make_position_params(win, client.offset_encoding) | ||
| client.request("textDocument/prepareRename", params, function(err, result) | ||
| if err or not result then | ||
| local msg = err and ("Error on prepareRename: %s"):format(err.message) | ||
| or "Nothing to rename" | ||
| return ui.notify(msg, ui.INFO) | ||
| end | ||
|
|
||
| if new_name then return rename_fix_imports(new_name) end | ||
|
|
||
| local prompt_opts = { prompt = "New Name: " } | ||
| -- result: Range | { range: Range, placeholder: string } | ||
| if result.placeholder then | ||
| prompt_opts.default = result.placeholder | ||
| elseif result.start then | ||
| prompt_opts.default = get_text_at_range(result, client.offset_encoding) | ||
| elseif result.range then | ||
| prompt_opts.default = get_text_at_range(result.range, client.offset_encoding) | ||
| else | ||
| prompt_opts.default = word_under_cursor | ||
| end | ||
| ui.input(prompt_opts, function(input) | ||
| if not input or #input == 0 then return end | ||
| rename_fix_imports(input) | ||
| end) | ||
| end, bufnr) | ||
| else | ||
| assert(client.supports_method("textDocument/rename"), "Client must support textDocument/rename") | ||
| if new_name then return rename_fix_imports(new_name) end | ||
|
|
||
| local prompt_opts = { | ||
| prompt = "New Name: ", | ||
| default = word_under_cursor, | ||
| } | ||
| ui.input(prompt_opts, function(input) | ||
| if not input or #input == 0 then return end | ||
| rename_fix_imports(input) | ||
| end) | ||
| end | ||
| end | ||
|
|
||
| return M |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| local M = {} | ||
|
|
||
| local lsp = vim.lsp | ||
|
|
||
| M.SERVER_NAME = "dartls" | ||
|
|
||
| ---@param bufnr number? | ||
| ---@return lsp.Client? | ||
| function M.get_dartls_client(bufnr) | ||
| return lsp.get_active_clients({ name = M.SERVER_NAME, bufnr = bufnr })[1] | ||
| end | ||
|
|
||
| return M |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters