LuaLS / LuaLS/lua-language-server

feature request: refactor to expand and collapse expressions

Open
#2,833 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feat/diagnostics
Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

It would be nice to be able to pull out repeated expressions or expand an expression on demand.
So one could jump back and forth between for example:

function love.draw()
    local w, h = love.graphics.getDimensions()
    love.graphics.setColor(1, 0, 0)
    love.graphics.circle('fill', 50, 50, 22)
    love.graphics.setColor(1, 1, 0)
    love.graphics.circle('fill', 50, 100, 22)
    love.graphics.setColor(0, 1, 0)
    love.graphics.circle('fill', 50, 150, 22)
end

and

local g = love.graphics

function love.draw()
    local w, h = g.getDimensions()
    g.setColor(1, 0, 0)
    g.circle('fill', 50, 50, 22)
    g.setColor(1, 1, 0)
    g.circle('fill', 50, 100, 22)
    g.setColor(0, 1, 0)
    g.circle('fill', 50, 150, 22)
end

It would also be nice to do this for local variables, so that the change is only applied where all the nessecary variables are visible (i.e. for required modules within a scope or long paths in arguments), so one can easily switch between

local function compileInfo(project)
    return {
        root = project.main,
        compiler = project.conf.toolchain == 'gnu' and 'gcc'
            or project.conf.toolchain == 'windows' and 'msvc'
            or project.conf.toolchain == 'clang' and 'clang'
    }
end

and

local function compileInfo(project)
    local c = project.conf
    return {
        root = project.main,
        compiler = c.toolchain == 'gnu' and 'gcc'
            or c.toolchain == 'windows' and 'msvc'
            or c.toolchain == 'clang' and 'clang'
    }
end

or

local function compileInfo(project)
    local t = project.conf.toolchain
    return {
        root = project.main,
        compiler = t == 'gnu' and 'gcc'
            or t == 'windows' and 'msvc'
            or t == 'clang' and 'clang'
	}
end

This is most usefull for long namespaced paths, but it may also be usefull to extract out some repeated constants or function calls and expand them again, so one can switch between:

local function copy(src, dst)
    for f in lfs.dir(src) do
        local src = io.open(src..package.config:sub(1, 1)..f, "rb")
        local dst = io.open(dst..package.config:sub(1, 1)..f, "wb")
    end
end

and

local DIR_SEP = package.config:sub(1, 1)

local function copy(src, dst)
    for f in lfs.dir(src) do
        local src = io.open(src..DIR_SEP..f, "rb")
        local dst = io.open(dst..DIR_SEP..f, "wb")
    end
end

Ideally one could chose the name of the pulled out expression via an prompt.

It's a long time since I had a good look at your codebase, so I wouldn't know where to start if I wanted to implement such a feature myself. I might be willing to try, if someone gives me a few pointers though.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by mapping the language server's refactoring or code-action implementation and determine how scope analysis, naming prompts, expansion, and undoable transformations would be specified and tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.