Skip to content

chore(awesomerc): use the group attribute to reduce boilerplate code #4097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cnjhb wants to merge 1 commit into
base: master
Choose a base branch
from
+21 −28
Open

chore(awesomerc): use the group attribute to reduce boilerplate code #4097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 21 additions & 28 deletions awesomerc.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,16 +324,23 @@ awful.keyboard.append_global_keybindings({
{description = "select next", group = "layout"}),
awful.key({ modkey, "Shift" }, "space", function () awful.layout.inc(-1) end,
{description = "select previous", group = "layout"}),
awful.key({ modkey }, "numpad", function(index)
local t = awful.screen.focused().selected_tag
if t then
t.layout = t.layouts[index] or t.layout
end
end,
{ description = "select layout directly", group = "layout" })
})

@Aire-One Aire-One Apr 23, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't get why this one moved (?)

Also, our pattern is to move toward named parameter as much as possible, so having a function style now is like going backward.

@cnjhb cnjhb Jul 14, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved this because its layout differs from the surrounding code. I changed the style to match the style of its new location.

I think our top priority should be to unify the style. Currently, there are two different styles for defining keyboard key bindings.


-- @DOC_NUMBER_KEYBINDINGS@

@actionless actionless Mar 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now your change conflicts with this docstring

@actionless actionless Jul 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i mean you need to raise the comment above numpad binding definition

@cnjhb cnjhb Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I don't see where the conflict is. The generated document looks fine to me.

@actionless actionless Jul 20, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because that documentation block is currently empty: https://github.com/awesomeWM/awesome/blob/master/docs/05-awesomerc.md.lua#L198-L200

and #4097 (comment)

@cnjhb cnjhb Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's empty, so I'm referring to the one generated afterward.

To be honest, I'm not sure what kind of comment to add.

It wouldn't be right to just move “-- @DOC_NUMBER_KEYBINDINGS@” up there, would it?


awful.keyboard.append_global_keybindings({
group = "tag",
awful.key {
modifiers = { modkey },
keygroup = "numrow",
description = "only view tag",
group = "tag",
on_press = function (index)
local screen = awful.screen.focused()
local tag = screen.tags[index]
Expand All @@ -346,7 +353,6 @@ awful.keyboard.append_global_keybindings({
modifiers = { modkey, "Control" },
keygroup = "numrow",
description = "toggle tag",
group = "tag",
on_press = function (index)
local screen = awful.screen.focused()
local tag = screen.tags[index]
Expand All @@ -359,7 +365,6 @@ awful.keyboard.append_global_keybindings({
modifiers = { modkey, "Shift" },
keygroup = "numrow",
description = "move focused client to tag",
group = "tag",
on_press = function (index)
if client.focus then
local tag = client.focus.screen.tags[index]
Expand All @@ -373,7 +378,6 @@ awful.keyboard.append_global_keybindings({
modifiers = { modkey, "Control", "Shift" },
keygroup = "numrow",
description = "toggle focused client on tag",
group = "tag",
on_press = function (index)
if client.focus then
local tag = client.focus.screen.tags[index]
Expand All @@ -383,18 +387,6 @@ awful.keyboard.append_global_keybindings({
end
end,
},
awful.key {
modifiers = { modkey },
keygroup = "numpad",
description = "select layout directly",
group = "layout",
on_press = function (index)
local t = awful.screen.focused().selected_tag
if t then
t.layout = t.layouts[index] or t.layout
end
end,
}
})

-- @DOC_CLIENT_BUTTONS@
Expand All @@ -414,49 +406,50 @@ end)

-- @DOC_CLIENT_KEYBINDINGS@
client.connect_signal("request::default_keybindings", function()
awful.keyboard.append_client_keybindings({
awful.keyboard.append_client_keybindings{
group = "client",
awful.key({ modkey, }, "f",
function (c)
c.fullscreen = not c.fullscreen
c:raise()
end,
{description = "toggle fullscreen", group = "client"}),
{description = "toggle fullscreen"}),
awful.key({ modkey, "Shift" }, "c", function (c) c:kill() end,
{description = "close", group = "client"}),
{description = "close"}),
awful.key({ modkey, "Control" }, "space", awful.client.floating.toggle ,
{description = "toggle floating", group = "client"}),
{description = "toggle floating"}),
awful.key({ modkey, "Control" }, "Return", function (c) c:swap(awful.client.getmaster()) end,
{description = "move to master", group = "client"}),
{description = "move to master"}),
awful.key({ modkey, }, "o", function (c) c:move_to_screen() end,
{description = "move to screen", group = "client"}),
{description = "move to screen"}),
awful.key({ modkey, }, "t", function (c) c.ontop = not c.ontop end,
{description = "toggle keep on top", group = "client"}),
{description = "toggle keep on top"}),
awful.key({ modkey, }, "n",
function (c)
-- The client currently has the input focus, so it cannot be
-- minimized, since minimized clients can't have the focus.
c.minimized = true
end ,
{description = "minimize", group = "client"}),
{description = "minimize"}),
awful.key({ modkey, }, "m",
function (c)
c.maximized = not c.maximized
c:raise()
end ,
{description = "(un)maximize", group = "client"}),
{description = "(un)maximize"}),
awful.key({ modkey, "Control" }, "m",
function (c)
c.maximized_vertical = not c.maximized_vertical
c:raise()
end ,
{description = "(un)maximize vertically", group = "client"}),
{description = "(un)maximize vertically"}),
awful.key({ modkey, "Shift" }, "m",
function (c)
c.maximized_horizontal = not c.maximized_horizontal
c:raise()
end ,
{description = "(un)maximize horizontally", group = "client"}),
})
{description = "(un)maximize horizontally"}),
}
end)

-- }}}
Expand Down
Loading