Misaligned assign statements

[yaSebastian]

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

MacOS

What is the issue affecting?

Formatting

Expected Behaviour

The issue manifests in the first two lines and the last table assignment, the rest is for context.

local product_to_recipe_map = require("utility.product_to_recipe_map")
local events                = require("utility.events")

---Represents the self refreshing cache for production statistics.
---@class ProductionStatisticsCache
---@field production_statistics ProductionStatistics The production statistics for all forces.
---@field on_production_statistics_refreshed fun(subscriber: fun()) Registers a subscriber to be notified when the production statistics have been refreshed.

---Represents the production statistics for all forces.
---@alias ProductionStatistics Dictionary<ForceName, ForceProductionStatistics>

---Represents the production statistics for a specific force.
---@class ForceProductionStatistics
---@field items Dictionary<ItemName, number> The item production statistics for a specific force.
---@field fluids Dictionary<FluidName, number> The fluid production statistics for a specific force.

---List of subscribers to notify when production statistics have been refreshed
---@type Array<fun()>
local production_statistics_refreshed_subscribers = {}

---@type ProductionStatisticsCache
local production_statistics_cache = {
    production_statistics = {},
    on_production_statistics_refreshed = function(subscriber)
        table.insert(production_statistics_refreshed_subscribers, subscriber)
    end
}

Actual Behaviour

local product_to_recipe_map                       = require("utility.product_to_recipe_map")
local events                                      = require("utility.events")

---Represents the self refreshing cache for production statistics.
---@class ProductionStatisticsCache
---@field production_statistics ProductionStatistics The production statistics for all forces.
---@field on_production_statistics_refreshed fun(subscriber: fun()) Registers a subscriber to be notified when the production statistics have been refreshed.

---Represents the production statistics for all forces.
---@alias ProductionStatistics Dictionary<ForceName, ForceProductionStatistics>

---Represents the production statistics for a specific force.
---@class ForceProductionStatistics
---@field items Dictionary<ItemName, number> The item production statistics for a specific force.
---@field fluids Dictionary<FluidName, number> The fluid production statistics for a specific force.

---List of subscribers to notify when production statistics have been refreshed
---@type Array<fun()>
local production_statistics_refreshed_subscribers = {}

---@type ProductionStatisticsCache
local production_statistics_cache                 = {
    production_statistics = {},
    on_production_statistics_refreshed = function(subscriber)
        table.insert(production_statistics_refreshed_subscribers, subscriber)
    end
}

Reproduction steps

1. Insert the code above into a new file
2. Format the file

Additional Notes

Current version: v3.13.4

When inserting two empty lines in between the assignments, as suggested in #2069 , I get the expected result.
In that issue, the two assignment blocks were close to each other though, in my case, they are separated by a lot of comments.
Also, personally, I think even a single empty line should be enough to split the blocks, or alternatively comments should count as empty lines. Ideally, it would be configurable in the .editorconfig.

Log File

No response

[CppCXY]

set align_continuous_line_space = 1

[yaSebastian]

Thanks, I wasn't aware of this settings, as it was not in the documentation. I found it in the template though.

I can't verify it though, unfortunately.

Before, I temporarily disabled the feature by adding an .editorconfig file, setting align_continuous_assign_statement=false, which disabled it successfully.

Now, when trying to re-enable it, it just does not start working again.

All assignments stay in the form of local events = require("utility.events").

This is the Lua part of my .editorconfig

[*.lua]
indent_size = 4
align_continuous_assign_statement = true
align_continuous_line_space = 2

I've tried all of these things:

• Setting align_continuous_assign_statement to true
• Experimenting with align_continuous_line_space values 0, 1, 5, 10
• Removing align_continuous_assign_statement and align_continuous_line_space
• Deleting the .editorconfig file completely
• Restarting VS Code several times to make sure the changes were picked up and no stale state could interfere
• Changing indent_size to see if the changes are picked up at all (that setting is picked up and applied right away, as soon as the file is saved)

I am out of ideas what else I could try.

[CppCXY]

set align_continuous_assign_statement=always

[yaSebastian]

Thanks a lot. That did it.
I sent you a pull request for a possibly incomplete documentation update for the affected setting.