Wikipedia:Reporting JavaScript errors: Difference between revisions

Content deleted Content added

Inline

Revision as of 23:59, 17 April 2023

This help page is a how-to guide.

It explains concepts or processes used by the Wikipedia community. It is not one of Wikipedia's policies or guidelines, and may reflect varying levels of consensus.

Shortcuts

Info to include in bug reports

When you experience an error with gadgets or user scripts and you want to report the issue at the appropriate page, please include the following information:

What is the behaviour you're seeing?
What is the behaviour you're expecting to see?
How can the incorrect behaviour be reproduced? Describe exactly what you're doing and seeing.
Confirm that you have tried bypassing your browser cache.
Make note of the skin that you use, your browser, browser version, and operating system.
Mention relevant JavaScript errors your browser logged. To do that, open your JavaScript console, and copy the relevant error messages. Error messages usually appear in red.

You are urged to have a look at "How to Report Bugs Effectively" by Simon Tatham for hints on how to report bugs effectively, to make sure the issue you are describing can be resolved as promptly as possible.

How to open your JavaScript console

Shortcuts

Where to find your JavaScript console depends on your browser:

How to open the console
Browser	Windows/Linux	Mac
Chrome/Chromium Edge (version 79+) Opera (version 15+)	`Ctrl`+`⇧ Shift`+`J`	`⌥ Option`+`⌘ Command`+`J`
Firefox	`F12`	`⌥ Option`+`⌘ Command`+`K`
Safari	`Ctrl`+`Alt`+`C`	`⌥ Option`+`⌘ Cmd`+`C`*
Internet Explorer Edge (up to version 78)	`F12` → Console	–
Opera (up to version 14)	Page menu → Developer Tools → Error Console

On some browsers, you may have to click on the "Console" tab once the developer tools pane opens up.

[*] In Safari, you might have to enable the Develop menu first in Preferences (⌘ Cmd+,) → Advanced → check "Show develop menu in menu bar". For OSX, use ⌥ Option+⌘ Command+I then hit esc (escape) to open the JavaScript console. Errors will appear in red.

Once you've opened the console...

The "triangle" can be clicked to reveal some hidden info.

Click on the "Console" tab
Scroll to the bottom of the console and look for log entries in yellow and red. Copy or screenshot these.
If there is a "triangle" you can press to expand and show more info, do so, and copy/screenshot that info too.^[1]

Which one is the error?

Unfortunately there is a lot of junk in the console. Programmers really only need one error message to debug, but the trick is getting the right error message. Here's some examples of useful error messages:

Uncaught – typically red
- Uncaught DOMException
- Uncaught Error
- Uncaught ReferenceError
- Uncaught SyntaxError
- Uncaught TypeError
- Uncaught (something in all lowercase)^[2]
jQuery exception – typically yellow
- jQuery.Deferred exception

Notes

^ This extra info will show the stack trace, which is needed to figure out which user script and what line #.
^ MediaWiki API error

[1] This extra info will show the stack trace, which is needed to figure out which user script and what line #.

[2] MediaWiki API error

[1]

[2]

@@ Line 12: / Line 12: @@
 == How to open your JavaScript console ==
-{{Shortcut|WP:CONSOLEERROR}}
+{{Shortcut|WP:CONSOLEERROR|Help:Console}}
 Where to find your JavaScript console depends on your browser:
 {| class="wikitable"
@@ Line 19: / Line 19: @@
 ! Browser !! Windows/Linux !! Mac
 |-
-| Chrome || {{Key press|Ctrl|Shift|J}} || {{Key press|Option|Command|J}}
+| [[Google Chrome|Chrome]]/[[Chromium (web browser)|Chromium]]<br />[[Microsoft Edge|Edge]] (version 79+)<br />[[Opera (web browser)|Opera]] (version 15+) || {{Key press|Ctrl|Shift|J}} || {{Key press|Option|Command|J}}
 |-
-| Edge (new versions) || {{Key press|Ctrl|Shift|J}} || –
+| [[Firefox]] || {{Key press|F12}} || {{Key press|Option|Command|K}}
 |-
-| Firefox || {{Key press|F12}} || {{Key press|Option|Command|K}}
+| [[Safari (web browser)|Safari]] || {{Key press|Ctrl|Alt|C}} || {{Key press|Option|Cmd|C}}*
 |-
+| [[Internet Explorer]]<br />[[Microsoft Edge|Edge]] (up to version 78) || {{Key press|F12}} → Console || –
-| Safari || {{Key press|Ctrl|Alt|C}} || {{Key press|Option|Cmd|C}}*
 |-
+| [[Opera (web browser)|Opera]] (up to version 14) || Page menu → Developer Tools → Error Console
-| IE or Edge (legacy versions) || {{Key press|F12}} || –
-|-
-| Opera || Page menu → Developer Tools → Error Console
 |}
 On some browsers, you may have to click on the "Console" tab once the developer tools pane opens up.
-[*] In Safari, you might have to enable the Develop menu first in Preferences → Advanced → check "Show develop menu in menu bar". For OSX, use {{Key press|Option|Command|I}} then hit {{key press|esc}} (escape) to open the JavaScript console. Errors will appear in red.
+[*] In Safari, you might have to enable the Develop menu first in Preferences ({{keys|Cmd|,}}) → Advanced → check "Show develop menu in menu bar". For OSX, use {{Key press|Option|Command|I}} then hit {{key press|esc}} (escape) to open the JavaScript console. Errors will appear in red.
 === Once you've opened the console... ===