feat(rustc_unpretty): use rustc inspect mir #192

saying121 · 2024-01-28T13:43:14Z

Use rustc -Z unpretty=mir to inspect mir and other things,
and achieve an experience similar to Rust Playground.
The rust-analyzer view does not support viewing MIR for async blocks,
but rustc can do it.

github-actions · 2024-01-28T13:43:25Z

Review Checklist

Does this PR follow the Contribution Guidelines? Following is a partial checklist:

Proper conventional commit scoping:

For example, fix(lsp): some lsp-related bugfix
Pull request title has the appropriate conventional commit prefix.

If applicable:

mrcjkb · 2024-01-28T14:02:56Z

Hey 👋

This looks great! Thanks for the PR! 😄

I'll have a closer look at it later today.

mrcjkb

Thanks again for this awesome PR! ❤️

I have left some thoughts and suggestions.
Let me know if you'd like to implement them. If not, I'm happy to merge this into a feature branch and implement them myself 😄

mrcjkb · 2024-01-28T19:36:12Z

lua/rustaceanvim/commands/init.lua

@@ -97,6 +97,27 @@ local command_tbl = {
    local cmd = args[1] or 'run'
    require('rustaceanvim.commands.fly_check')(cmd)
  end,
+  rustcUnpretty = function(args)


thought: rust-analyzer isn't required for this command. Perhaps it would be better to create a separate Rustc command?

issue: The -Z option requires a nightly compiler.
So we should document that in the readme and lua docs (which I use to generate vimdoc).

I'm not familiar with the code structure, so I'll pass on this task.

mrcjkb · 2024-01-28T19:42:17Z

lua/rustaceanvim/commands/rustc_unpretty.lua

+-- Get a compatible vim range (1 index based) from a TS node range.
+--
+-- TS nodes start with 0 and the end col is ending exclusive.
+-- They also treat a EOF/EOL char as a char ending in the first
+-- col of the next row.


quibble: Doc comments should have a --- commentstring.
(just relevant for lua-language-server hovers here 😄)

Suggested change

-- Get a compatible vim range (1 index based) from a TS node range.

--

-- TS nodes start with 0 and the end col is ending exclusive.

-- They also treat a EOF/EOL char as a char ending in the first

-- col of the next row.

--- Get a compatible vim range (1 index based) from a TS node range.

---

--- TS nodes start with 0 and the end col is ending exclusive.

--- They also treat a EOF/EOL char as a char ending in the first

--- col of the next row.

mrcjkb · 2024-01-28T19:45:10Z

lua/rustaceanvim/commands/rustc_unpretty.lua

+    pos = { temp[1] - 1, temp[2] }
+  end
+
+  local node = ts.get_node { pos = pos }


issue: I tested this (on a line that doesn't contain fn), and got:

Error executing Lua callback: ...rapped-98a4ed0/share/nvim/runtime/lua/vim/treesitter.lua:392: Invalid position: row and col must be non-negative

with a stack trace that leads to this function call.

mrcjkb · 2024-01-28T19:53:15Z

lua/rustaceanvim/commands/rustc_unpretty.lua

+  local node = ts.get_node { pos = pos }
+
+  if node == nil or node:type() ~= 'function_item' then
+    vim.notify('not found function or function is uncomplete', vim.log.levels.ERROR)


quibble

Suggested change

vim.notify('not found function or function is uncomplete', vim.log.levels.ERROR)

vim.notify('no function found or function is incomplete', vim.log.levels.ERROR)

mrcjkb · 2024-01-28T19:56:04Z

lua/rustaceanvim/commands/rustc_unpretty.lua

+---@param level rustcir_level
+function M.rustc_unpretty(level)
+  if #api.nvim_get_runtime_file('parser/rust.so', true) == 0 then
+    vim.notify('please install rust parser in nvim-treesitter', vim.log.levels.ERROR)


suggestion: Technically, nvim-treesitter is not required.

Suggested change

vim.notify('please install rust parser in nvim-treesitter', vim.log.levels.ERROR)

vim.notify('a treesitter parser for Rust is required for 'rustc unpretty'', vim.log.levels.ERROR)

Is there a better way to obtain the function?
I'm not sure what to do.

mrcjkb · 2024-01-28T19:58:41Z

lua/rustaceanvim/config/internal.lua

+    ---settings for rustc -Z unpretty
+    ---@type table
+    rustc_unpretty = {
+      ---@type string
+      edition = '2021',
+    },


issue: This is the internal config.
There's another 'meta' module, rustaceanvim/config/init.lua that contains luacats documentation, from which I generate vimdoc in CI.

docs(README): rustc unpretty need nightly

saying121 · 2024-01-29T05:16:35Z

I think I have done all I can do. 😄
Thanks for your work.

mrcjkb · 2024-01-29T11:02:01Z

I think I have done all I can do. 😄 Thanks for your work.

Thanks 🙏. I'll merge it into the rustc-unpretty-continued branch and continue working on it from there.

mrcjkb · 2024-01-29T12:33:05Z

@saying121 I've just finished the touchup and pushed a 4.1.0 release. The command is now :Rustc unpretty, and the config field is tools.rustc.

Thanks again for the awesome contribution 🙏 😄

saying121 added 3 commits January 28, 2024 21:14

feat(rustc_unpretty): use rustc inspect mir

cf747e4

fix(rustc_unpretty): check arguments

f00ea57

docs(CHANGELOG): update

447de80

saying121 changed the title ~~Rustc unpretty~~ feat(rustc_unpretty): use rustc inspect mir Jan 28, 2024

docs(README): rustc_unpretty need nvim-treesitter

bcdbd3b

mrcjkb requested changes Jan 28, 2024

View reviewed changes

mrcjkb force-pushed the master branch 2 times, most recently from 1bb620a to d0cec19 Compare January 28, 2024 20:46

saying121 closed this Jan 29, 2024

saying121 force-pushed the rustc_unpretty branch from bcdbd3b to d0cec19 Compare January 29, 2024 04:45

saying121 added 2 commits January 29, 2024 12:48

fix(rustc_unpretty): negative index error

39a7bf1

docs(README): rustc unpretty need nightly

Merge branch 'master' into rustc_unpretty

a1c81a5

saying121 reopened this Jan 29, 2024

mrcjkb changed the base branch from master to rustc-unpretty-continued January 29, 2024 11:00

mrcjkb approved these changes Jan 29, 2024

View reviewed changes

mrcjkb merged commit 07f5c2d into mrcjkb:rustc-unpretty-continued Jan 29, 2024
10 checks passed

mrcjkb mentioned this pull request Jan 29, 2024

feat(commands): Rustc unpretty args[] #194

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(rustc_unpretty): use rustc inspect mir #192

feat(rustc_unpretty): use rustc inspect mir #192

saying121 commented Jan 28, 2024

github-actions bot commented Jan 28, 2024

mrcjkb commented Jan 28, 2024

mrcjkb left a comment

mrcjkb Jan 28, 2024

saying121 Jan 29, 2024

mrcjkb Jan 28, 2024

mrcjkb Jan 28, 2024

mrcjkb Jan 28, 2024

mrcjkb Jan 28, 2024

saying121 Jan 29, 2024

mrcjkb Jan 28, 2024

saying121 commented Jan 29, 2024

mrcjkb commented Jan 29, 2024

mrcjkb commented Jan 29, 2024

	vim.notify('not found function or function is uncomplete', vim.log.levels.ERROR)
	vim.notify('no function found or function is incomplete', vim.log.levels.ERROR)

	vim.notify('please install rust parser in nvim-treesitter', vim.log.levels.ERROR)
	vim.notify('a treesitter parser for Rust is required for 'rustc unpretty'', vim.log.levels.ERROR)

feat(rustc_unpretty): use rustc inspect mir #192

feat(rustc_unpretty): use rustc inspect mir #192

Conversation

saying121 commented Jan 28, 2024

github-actions bot commented Jan 28, 2024

Review Checklist

mrcjkb commented Jan 28, 2024

mrcjkb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saying121 commented Jan 29, 2024

mrcjkb commented Jan 29, 2024

mrcjkb commented Jan 29, 2024