Name and stylistic changes to the API

[kasper]

Make some name and stylistic changes to the API to make it more coherent. Many of these are remains from the refactor and have bothered me partly due to their naming, but partly due to not feeling natural.

It’s most likely reasonable to change these, but make the existing ones aliases, deprecate them and remove then in the future — so that users don’t have to make configuration changes so often?

Any others?

Screen

1. Screen.mainScreen() -> Screen.main()
2. Screen.screens() -> Screen.all()
3. #visibleWindows() -> #windows({ visible: true })

Space

1. Space.activeSpace() -> Space.active()
2. Space.spaces() -> Space.all()
3. #visibleWindows() -> #windows({ visible: true })

Mouse

1. Mouse.moveTo(...) -> Mouse.move(...)

App

1. App.focusedApp() -> App.focused()
2. App.runningApps() -> App.all()
3. #visibleWindows() -> #windows({ visible: true })
4. #forceTerminate() -> #terminate({ force: true })

Window

1. Window.focusedWindow() -> Window.focused()
2. Window.windows() -> Window.all()
3. Window.visibleWindows() -> Window.all({ visible: true })
4. Window.visibleWindowsInOrder() -> Window.recent()
5. #otherWindowsOnSameScreen() -> #others({ screen: window.screen })
6. #otherWindowsOnAllScreens() -> #others()
7. #windowsToWest() -> #neighbors('west')
8. #windowsToEast() -> #neighbors('east')
9. #windowsToNorth() -> #neighbors('north')
10. #windowsToSouth() -> #neighbors('south')
11. #focusClosestWindowInWest() -> #focusClosestNeighbor('west')
12. #focusClosestWindowInEast() -> #focusClosestNeighbor('east')
13. #focusClosestWindowInNorth() -> #focusClosestNeighbor('north')
14. #focusClosestWindowInSouth() -> #focusClosestNeighbor('south')

[kasper]

Actually, to save development time, I will probably just delete them straight away. Since 2.2 is shaping to clarify and stabilise many other things anyway. Better evolve rapidly than not at all.

[mafredri]

I've been thinking the exact same thing. Really like most of these changes! I'm a bit torn, though, on the object configuration for the directional (west/east/...) functions. One the one hand it's more flexible, programmatically, and on the other it's maybe not as easy to type / autocomplete. Would these functions also have an action when no direction is passed?

Regarding the #others() function, one possibility could also be to have the actual screen as a parameter, e.g. #others({ screen: win.screen().next() }), might be a bit more flexible. And I think it's a ok default to return from all screens when no screen parameter is passed :).

[kasper]

Good point on passing the screen to #others(…). That makes much more sense!

The directional functions are definitely the hardest to solve. I would like to avoid repeating the word “window” in them. Other options would be:

1. #neighbors('west')
2. #neighborsToWest()
3. #focusClosestNeighbor('west')
4. #focusClosestNeighborInWest()

You are right that 2. and 4. would most likely be the best choice since there are no other options to pass to the functions.

[kasper]

Also, Window.visibleWindowsInOrder() could also be Window.visible({ order: 'frontmost' }) or something similar.