User:Enterprisey/script-installer

{{Infobox user script

| desc = Convenient script installation

| author = Enterprisey

| updated = {{start date and age|2024|01|01}}

| status = Stable

| source = MediaWiki:Gadget-script-installer.js

| skins = All desktop skins

| browsers = All modern browsers, and IE 11

| screenshot = File:Screenshot of Enterprisey's script-installer in use.png

| screenshotsize = 500px

}}

Install, uninstall, enable, and disable user scripts without having to edit your JavaScript files. The user interface was inspired by User:Equazcion/ScriptInstaller, but doesn't share any code with it.

Installation instructions

In your preferences, go to {{myprefs|Gadgets}}. At the bottom of the "Advanced" section, click the "{{delink|{{int:Gadget-script-installer}}}}" checkbox, then click the "Save" button.

Usage

  • 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 and reload the page. Certain 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 your user scripts, with options to uninstall (i.e. remove entirely) or disable ("comment out" the user script, without permanently removing it; enable will undo this).
  • WP:US/L and other pages that use {{tl|userscript}} will now show script links with a little "Install" link after them.

= Options =

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 I wanted to, by default, install new scripts to my my monobook.js page instead of my common.js page, I would set the option scriptInstallerInstallTarget to "monobook" by putting the following line somewhere in my common.js:

window.scriptInstallerInstallTarget = "monobook";

class="wikitable"

! 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

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:

See also

{{tl|User wikipedia/script-installer}}, a userbox indicating an editor uses script-installer