Release 0.9.58

[cmsj]

No specific timelines in mind, just a tracking bug for y'all to list the things you'd like to see/do in 0.9.57 :)

[latenitefilms]

My Wishlist for 0.9.57:

• Rewrite of hs.menubar. See: hs.menubar - Rewrite Extension to make use of modern macOS Frameworks #1530
• Add hs.dialog.font. See hs.dialog.font - Add Font Panel Support #1528
• hs.plist.edit() & NSKeyedArchiver support. See: hs.preferences - Property List Editor with NSKeyedArchiver support #1498
• hs.keycodes should be able to return a keycode map for the current layout. See: hs.keycodes should be able to return a keycode map for the current layout #1307
• Add Ability to add Custom Items to Dock Icon Contextual Menu. See: Add Ability to add Custom Items to Dock Icon Contextual Menu #1350
• Add hs._asm.touchbar to Hammerspoon core. See: hs.touchbar - Add Extension for Touch Bar Support #1078
• Add hs._asm.axuielement to Hammerspoon core.
• Add API to allow drag & drop support to Hammerspoon Dock Icon and/or Menubar. See: Drag & Drop to Menubar #1057
• Add hs.guitk to Hammerspoon core. See: hs.guitk - New Extension for creating UI Elements #1544
• Add hs.midi for MIDI Control. See: hs.midi - Add Extension for MIDI Control #1422

[asmagill]

• hs.logger review and LuaSkin logging overhaul for targeted module logging. See hs.logger updates? #1426
• modal only hotkey set; may end up being a spoon and released there instead. See hotkey.modal that ignores anything but given hotkeys #1505
• PhilipsHue support; most likely will end up being a spoon and released there instead. See Philips Hue extension #779
• KODI/XBMC support; most likely will end up being a spoon and released there instead.
• make a decision about LuaSkin addition to support lua functions #916 (giving LuaSkin the ability to automatically handle lua function references)
• review/rewrite eventtap and clarify which NSEvents we can and can't actually handle. (hs.eventtap additions/changes #1161 and others)
• handle gestures for canvas objects; may add this to hs._asm.guitk instead if it makes it into 0.9.57.

These are all things I've already started or assigned to me, so this is more to serve as a reminder so they don't get forgotten. Again.

edit: to clarify, forgotten by me; didn't intend to disparage anyone else's contributions or suggestions, but upon rereading, I thought it sounded bad...

[cmsj]

Not specific to the release, but relevant to the work that will produce it... I'd like to propose that we put changelog messages in our commit messages.

• Not every commit needs a changelog message, just one per:
  • bug fix
  • API additions
  • module additions
  • API behaviour modified
• Changelog messages must be a single line
• Each message should start with "*Fixed*:", "*Added*:", "*Changed*:"

I hope this doesn't seem onerous - at least part of the motivation for doing this is that I think I'm missing out on highlighting some of our work, by not recognising its importance/effects from the commit message.

I'm also happy to consider changing the message format - e.g. it might be nice to include names :)

[asmagill]

Not opposed to the idea... have you submitted any recently that can be reviewed to make sure I understand exactly what you have in mind?

[cmsj]

Not as commits, but check out our release notes, for loads of the sorts of thing I’m looking for.

[cmsj]

And I guess we’ll need a delimiter, so maybe a line that looks like this:

CL: *Added*: hs.foo.bar()

[farcaller]

Some plan on tackling complex monitor layouts (e.g. one found in #1522) would be nice.

[asmagill]

@cmsj, I'm not up on the innermost details of git; is that 50 char limit the web site recommends a hard limit (i.e. is the text itself split into multiple fields or lines) or is that just a formatting limitation where only the first 50 chars are used by some git internals? Basically do our messages have to be short (and potentially unclear) -- like the one I just did for hs.battery.getAll -- or can we ignore the 50 char limit? Or do we put it into the lower section when updating via the web site?

[cmsj]

@asmagill there's no hard limit. Ideally the changelog messages would be pretty short, but if they do need to be longer, it's fine :)

[cmsj]

@asmagill one comment on the battery one though - in isolation the message doesn't tell people what really changed - I would have put hs.battery.getAll() rather than just getAll.

I've also tended to use an active, future-oriented voice, so something like "foo should no longer crash when X and Y".

(The actual reality here is that any kind of CL message at all, helps me, so nobody needs to get too hung up on sounding exactly like my editorial voice :)

[asmagill]

Just to confirm, ignore the "suggestion" about 50 chars that is popped up when doing an edit directly through the web site, correct? e.g.

[cmsj]

Yep, ignore it. It’s just a convention to keep the first line of the commit message short. Git doesn’t care 🙂

[cmsj]

Ok, it's been unnecessarily long since I opened this issue. Let's revisit the idea of getting 0.9.58 out, preferably prior to Christmas.

So, any nominations for things that actually have a decent chance of being fixed/landed in the next ~2 weeks? :)

[latenitefilms]

Once @asmagill has tested it hs.midi should be pretty good to go. We have about 559 active monthly users running CommandPost, and we've had hs.midi included for the last couple of beta's and it hasn't exploded the world, so it should be safe for the Hammerspoon community too.

I think we can put hs.dialog.font on the back-burner for the foreseeable future until someone can come up with a suitable fix.

hs.guitk will solve a lot of my hs.menubar issues (#1045, #1567, #914, #1229, #1057 and #974) when it's ready for primetime, which is awesome! Not sure if @asmagill will have it ready before Christmas however, but fingers crossed!

I would LOVE to see hs.plist.edit() & NSKeyedArchiver support (#1498) competed - but I'd imagine @asmagill already has more than enough on his plate.

Other issues that could be addressed/closed if anyone's eager:

• Add Sample Mixed Lua/Objective-C Extension to Contribution Guide (issue Add Sample Mixed Lua/Objective-C Extension to Contribution Guide  #1345)
• ERROR: wfilter: app is not registered! (issue ERROR: wfilter: app is not registered! #1551)
• Add callback option to hs.mouse.scrollDirection() (issue Add callback option to hs.mouse.scrollDirection() #1549)
• Reading contents of a UTF-16 Little-Endian Encoded Text File? (issue Reading contents of a UTF-16 Little-Endian Encoded Text File? #1452)

Things that I'll get to... eventually, but not before Christmas:

• Detect external mouse? (issue Detect external mouse? #1587)
• hs.osc - Add Extension for OSC Control (issue hs.osc - Add Extension for OSC Control #1580)
• Localise Hammerspoon (issue Localise Hammerspoon #1357)
• Add Ability to add Custom Items to Dock Icon Contextual Menu (issue Add Ability to add Custom Items to Dock Icon Contextual Menu #1350)

[asmagill]

I will let you know tomorrow what I've been working on that I think I can have release ready in time -- my availability until late Jan is going to be sporadic, so I want to do a review before promising anything.

[asmagill]

Sorry guys, I've had much less time then I anticipated and it probably won't get any better until sometime in January.

The guitk is probably safe enough, but it's a huge addition -- something like 10 separate modules so that its various components can be mixed-and-matched in a variety of ways, so i'd really like to get some more documentation ready before unleashing it on the world. Canvas will need some tweaks to integrate fully (it mostly works but not with all of the placement options the guitk manager offers), which I still need to work out.

The menubar addition (and replacement wrapper for hs.menubar) to it is coming along nicely and can accept drag-and-drop items, but only to the status icon -- don't have it so you can drag to a specific menu item yet (though I think I'm close). I'll review the list of menubar issues you've listed above -- I think I've addressed most of them with guitk/menubar but I'll check when I do get a chance to get back to it.

I will make a point to look at hs.midi in a day or so; I doubt there is any reason it can't be included in the upcoming release.

[latenitefilms]

Sorry guys, I've had much less time then I anticipated and it probably won't get any better until sometime in January.

No worries at all! The work you do is HUGELY appreciated - thank you, thank you.

The guitk is probably safe enough, but it's a huge addition

I'm planning to start using guitk in CommandPost soon, so that we can really put it through its paces - especially the menubar addition.

CommandPost might be a good testing ground for the extension, before you commit it to Hammerspoon.

I will make a point to look at hs.midi in a day or so; I doubt there is any reason it can't be included in the upcoming release.

Legend, thank you! I've been using hs.midi on several machines with CommandPost for a few weeks now, and it seems very stable, which is good!

Oh, and I'll get you the best belated Christmas present in the world if you add "notifications" to hs._asm.axuielement in the New Year! This is one feature that would offer HUGE amounts of benefits to my crazy CommandPost project once it's done. If only we could clone you...

[cmsj]

And done :)