User:Enterprisey/script-installer
 | |
| Description | Convenient script installation |
|---|---|
| Author | Enterprisey |
| Status | Release |
| Updated | January 1, 2024 |
| Browsers | All modern browsers, and IE 11 |
| Skins | All desktop skins |
| Source | MediaWiki:Gadget-script-installer.js |
Install, uninstall, enable, and disable user scripts without having to manually edit your JavaScript files. The user interface was inspired by User:Equazcion/ScriptInstaller, but doesn't share any code with it.
Installation instructions
[edit]In your preferences, go to Preferences → Gadgets. At the bottom of the "Advanced" section, click the "Install scripts without having to manually edit JavaScript files (documentation)" checkbox, then click the "Save" button.
Usage
[edit]- If you go to a user script page (like User:Enterprisey/reply-link.js), there will now be an "Install" link at the top. Clicking it will install the script (by default, by adding it to your common.js page) and reload the page. Certain script pages may have this option disabled.
- Also on user script pages, there will be a "Manage user scripts" option at the top, which will show you a list of all of the user scripts you have installed, with options to uninstall (i.e. remove entirely) or disable them. The latter option works by commenting them out (if the script is already disabled, there will be an option to enable it instead).
- WP:US/L and other pages that use {{userscript}} will now show script links with a little "Install" link after them.
Options
[edit]The script has a number of options that allow you to customize its behavior. To set any of the preferences, add the following pattern (on a new line in your common.js file):
window.OPTION = VALUE;
For example, if you wanted to, by default, install new scripts to your monobook.js page instead of your common.js page, you would set the option scriptInstallerInstallTarget to "monobook" by putting the following line somewhere in your common.js:
window.scriptInstallerInstallTarget = "monobook";
| Name | Values (Default in bold) |
Description |
|---|---|---|
scriptInstallerInstallTarget
|
"common", "monobook", "timeless", "skin name goes here"
|
What skin should scripts be installed for? (Equivalently, what target page should scripts be installed on?) |
scriptInstallerAutoReload
|
true, false
|
Should the script reload after installing, uninstalling, and other actions? |
Future improvements
[edit]People have asked for these, but I don't plan to work on them myself. If anyone would like to try doing it themselves, I would be happy to mentor them through the process:
- Support for global scripts installed at Meta
- Support for the User:MusikAnimal/scriptManager format
- Bulk actions, especially bulk deletion
See also
[edit]{{User wikipedia/script-installer}}, a userbox indicating an editor uses script-installer