Add global shell types #13
Conversation
👍 - Agreed. I can't think of a use-case where anyone wouldn't want to import these declarations when using the |
|
On second thought I think we should not import these globals automatically because these globals don't exist in the environment that runs the prefs.js file. So if these types were automatically added, auto completion might trick people into using them in their preferences code, only to have nasty surprise at runtime. As such I think people should have to explicitly opt in to have types for these globals. For the same reason I'll also move these globals to extensions/global to make clear they're only present for extension code inside Gnome shell, but not for prefs. I changed this PR to a draft until I get to do that. |
|
Moved to |
|
@swsnr Looks good to me, can you please complete the REAMDE.md with the information you have mentioned here? So that people know how and why they can include the globals. Thanks a lot for your contribution 👍 |
|
@JumpLink Sure, I'll update the readme file. |
Add a separate exported ambient module which defines the globals from GNOME shell, such as the "global" object or the monkey-patched string class. Do not automatically import this module in the index modules, because these globals are not present in the environment that runs prefs.js code. As such, automatically importing them might trick users into using these globals in their prefs.js code, e.g. through auto completion, with a nasty surprise at runtime. Hence, users should explicitly opt-in to bring these types into their global environment, and hopefully be aware that they can't be used in prefs.js code. Closes #12
|
Update, and I also fixed the definition of |
Closes #12
Add a new
global.d.tsmodule with global shell variables and monkey-patches, see #12. Currently, it's a separate module you'd need to import separately to bring in the global declarations (see changes to the example), but since these are global (i.e. exist regardless of any imports) should I add them toindex-ambient?