{"action":"opened","issue":{"url":"https://api.github.com/repos/Hammerspoon/hammerspoon/issues/1086","repository_url":"https://api.github.com/repos/Hammerspoon/hammerspoon","labels_url":"https://api.github.com/repos/Hammerspoon/hammerspoon/issues/1086/labels{/name}","comments_url":"https://api.github.com/repos/Hammerspoon/hammerspoon/issues/1086/comments","events_url":"https://api.github.com/repos/Hammerspoon/hammerspoon/issues/1086/events","html_url":"https://github.com/Hammerspoon/hammerspoon/issues/1086","id":190513275,"number":1086,"title":"Should hs.spotlight be a core module?","user":{"login":"asmagill","id":8139480,"avatar_url":"https://avatars.githubusercontent.com/u/8139480?v=3","gravatar_id":"","url":"https://api.github.com/users/asmagill","html_url":"https://github.com/asmagill","followers_url":"https://api.github.com/users/asmagill/followers","following_url":"https://api.github.com/users/asmagill/following{/other_user}","gists_url":"https://api.github.com/users/asmagill/gists{/gist_id}","starred_url":"https://api.github.com/users/asmagill/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/asmagill/subscriptions","organizations_url":"https://api.github.com/users/asmagill/orgs","repos_url":"https://api.github.com/users/asmagill/repos","events_url":"https://api.github.com/users/asmagill/events{/privacy}","received_events_url":"https://api.github.com/users/asmagill/received_events","type":"User","site_admin":false},"labels":[{"id":135973450,"url":"https://api.github.com/repos/Hammerspoon/hammerspoon/labels/enhancement","name":"enhancement","color":"84b6eb","default":true},{"id":135973453,"url":"https://api.github.com/repos/Hammerspoon/hammerspoon/labels/question","name":"question","color":"cc317c","default":true}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2016-11-19T18:52:04Z","updated_at":"2016-11-19T18:52:04Z","closed_at":null,"body":"@cmsj (& others?  not sure who the regulars are anymore), I was finishing up the documentation for a proposed `hs.spotlight` module (which can add alternate application name mapping as requested in #1043) when I began to wonder if we really want this to be a core module... The syntax for complex queries is not exactly simple, and even simple ones require the use of less than obvious attribute names (unless we want to write a parser to go with it that is way beyond what I had in mind when I started the module).\r\n\r\nI do not want to have to provide support for questions along the lines of \"why doesn't my query work\"...\r\n\r\nThe proposed module can be found at https://github.com/asmagill/hammerspoon_asm/tree/master/spotlight, and a name mapping solution can be found in its examples directory.\r\n\r\nAnd it is useful and it does fill a need, so I see the following options:\r\n\r\n* we include it, and if people do post query related questions to the Hammerspoon issues that aren't about an error in the module or an extension suggestion, we refer them back to the [query string documentation](https://github.com/asmagill/hammerspoon_asm/tree/master/spotlight#queryString) and tell them to RTFM.\r\n* we include it, but do not document it, leaving pointers in the init.lua file that points them to documentation online if they really want to use it, but understand that it is not fully supported\r\n* we do not include it and it remains a third part extension addition (in this case, I would go through and change the path so that `_asm` is included in, reinforcing the idea that it is a third party module, not an included one)\r\n\r\nThe first two allow us to extend `hs.application` so that the functions which currently do not handle alternate application names could do so... and I suppose we could add code to detect if the third-party version was installed and support it then, but not otherwise, but... that way lies a whole other set of issues/questions I don't want to have to handle.\r\n\r\nI'm leaning towards option 1, but perhaps replicate the links that are provided in the queryString documentation at the top of the module header as well and make it clear that the Google group and not Hammerspoon Github issues is where query help may be requested... and to RTFM!\r\n\r\nThoughts?  As always, I will go with the consensus, if there is one."}}
{"actor":{"display_login":"asmagill"}}