elements"
113 | },
114 | "pre_without_class": {
115 | "message": " w/o class",
116 | "description": "Name of test checking for elements without 'class' attribute"
117 | },
118 | "pre_without_class_desc": {
119 | "message": " elements must have a 'class' attribute assigned in most cases, so their syntax is highlighted. The class 'eval' shouldn't be used.",
120 | "description": "Description of test checking for elements without 'class' attribute"
121 | },
122 | "summary_heading": {
123 | "message": "Summary heading",
124 | "description": "Name of test checking for summary heading"
125 | },
126 | "summary_heading_desc": {
127 | "message": "According to the article style guide there shouldn't be a Summary heading.",
128 | "description": "Description of test checking for summary heading"
129 | },
130 | "example_headings": {
131 | "message": "'Example:' headings",
132 | "description": "Name of test checking for 'Example:' headings"
133 | },
134 | "example_headings_desc": {
135 | "message": "Example headings should not include 'Example: '. E.g. instead of Example: Foobar
just use Foobar
.",
136 | "description": "Description of test checking for 'Example:' headings"
137 | },
138 | "alert_print_in_code": {
139 | "message": "alert, print, eval, document.write",
140 | "description": "Name of test checking for alert(), print(), eval() and document.write() within code samples"
141 | },
142 | "alert_print_in_code_desc": {
143 | "message": "Don't use alert(), print(), eval() or document.write() in code samples.",
144 | "description": "Description of test checking for alert(), print(), eval() and document.write() within code samples"
145 | },
146 | "shell_prompts": {
147 | "message": "Shell prompts in code samples",
148 | "description": "Name of test checking for shell prompts within code samples"
149 | },
150 | "shell_prompts_desc": {
151 | "message": "Don't start shell instructions with '$' or '>'. It confuses more than it helps and causes problems when copying them.",
152 | "description": "Description of test checking for shell prompts within code samples"
153 | },
154 | "html_comments": {
155 | "message": "HTML comments",
156 | "description": "Name of test checking for HTML comments"
157 | },
158 | "html_comments_desc": {
159 | "message": "HTML comments are not visible in WYSIWYG mode and in reading mode. They are not meant to comment the documentation, so they should be removed.",
160 | "description": "Description of test checking for HTML comments"
161 | },
162 | "font_elements": {
163 | "message": " elements",
164 | "description": "Name of test checking for elements"
165 | },
166 | "font_elements_desc": {
167 | "message": "Using elements is obsolete. Either the tag should be removed completely or replaced by CSS.",
168 | "description": "Description of test checking for elements"
169 | },
170 | "http_links": {
171 | "message": "HTTP links",
172 | "description": "Name of test checking for HTTP links"
173 | },
174 | "http_links_desc": {
175 | "message": "URLs to external resources should use HTTPS instead of HTTP, when possible.",
176 | "description": "Description of test checking for HTTP links"
177 | },
178 | "data_macro_note": {
179 | "message": "Data macro note ",
180 | "description": "Name of test checking the notes for data macros linking to the data source"
181 | },
182 | "data_macro_note_desc": {
183 | "message": "Data macros need a note above them linking to the data source.",
184 | "description": "Description of test checking the notes for data macros linking to the data source"
185 | },
186 | "unnecessary_macro_params": {
187 | "message": "Unnecessary macro parameters",
188 | "description": "Name of test checking for macros with unnecessary parameters"
189 | },
190 | "unnecessary_macro_params_desc": {
191 | "message": "The used macro does not require any parameters, so they should be removed.",
192 | "description": "Description of test checking for macros with unnecessary parameters"
193 | },
194 | "macro_syntax_error": {
195 | "message": "Macro syntax error",
196 | "description": "Name of test checking for macro syntax errors"
197 | },
198 | "macro_syntax_error_desc": {
199 | "message": "A macro has a syntax error like a missing closing bracket, e.g. {{jsxref('Array'}}.",
200 | "description": "Description of test checking for macro syntax errors"
201 | },
202 | "invalid_macros": {
203 | "message": "Invalid macros",
204 | "description": "Name of test checking for invalid macros"
205 | },
206 | "invalid_macros_desc": {
207 | "message": "The used macro is not allowed or does not exist",
208 | "description": "Description of test checking for invalid macros"
209 | },
210 | "incorrectly_wrapped_sidebar_macros": {
211 | "message": "Incorrectly wrapped sidebar macros",
212 | "description": "Name of test checking incorrectly wrapped sidebar macros"
213 | },
214 | "incorrectly_wrapped_sidebar_macros_desc": {
215 | "message": "Sidebar macros must be wrapped into elements",
216 | "description": "Description of test checking incorrectly wrapped sidebar macros"
217 | },
218 | "wrong_highlighted_line": {
219 | "message": "Wrong highlighted line",
220 | "description": "Name of test checking for wrong highlighted line within code samples"
221 | },
222 | "wrong_highlighted_line_desc": {
223 | "message": "A code block has a line highlighted that is outside the range of code lines.",
224 | "description": "Description of test checking for wrong highlighted line within code samples"
225 | },
226 | "api_syntax_headlines": {
227 | "message": "API syntax headlines",
228 | "description": "Name of test checking the order and names of API syntax headlines"
229 | },
230 | "api_syntax_headlines_desc": {
231 | "message": "API syntax headlines must be 'Parameters', 'Return value' and 'Exceptions', in that order, not 'Returns', 'Errors' or 'Errors thrown'.",
232 | "description": "Description of test checking the order and names of API syntax headlines"
233 | },
234 | "code_in_pre": {
235 | "message": "
in ",
236 | "description": "Name of test checking whether there are tags within blocks"
237 | },
238 | "code_in_pre_desc": {
239 | "message": " tags should not be used within blocks, because they break syntax highlighting.",
240 | "description": "Description of test checking whether there are tags within blocks"
241 | },
242 | "pre_line_too_long": {
243 | "message": "Line length in too long",
244 | "description": "Name of test checking whether there are too long lines within blocks"
245 | },
246 | "pre_line_too_long_desc": {
247 | "message": "To avoid horizontal scrollbars, there should be maximal 77 characters per line in blocks.",
248 | "description": "Description of test checking whether there are too long lines within blocks"
249 | },
250 | "wrong_syntax_class": {
251 | "message": "Wrong syntax class",
252 | "description": "Name of test checking whether the CSS class for the syntax definition block is correct"
253 | },
254 | "wrong_syntax_class_desc": {
255 | "message": "The CSS class used for the syntax definition block must be 'syntaxbox'.",
256 | "description": "Description of test checking whether the CSS class for the syntax definition block is correct"
257 | },
258 | "url_in_link_title": {
259 | "message": "URL in 'title' attribute",
260 | "description": "Name of test checking whether there is a URL within the 'title' attribute of a link"
261 | },
262 | "url_in_link_title_desc": {
263 | "message": "The URL of a link is already shown on hover, so repeating it within its 'title' attribute is redundant and should be avoided.",
264 | "description": "Description of test checking whether there is a URL within the 'title' attribute of a link"
265 | },
266 | "article_length": {
267 | "message": "Article length",
268 | "description": "Name of test checking the length of the article"
269 | },
270 | "article_length_desc": {
271 | "message": "Hints regarding the length of the article.",
272 | "description": "Description of test checking the length of the article"
273 | },
274 | "link_using_wrong_locale": {
275 | "message": "Link %s uses wrong locale. Expected '%s'.",
276 | "description": "Error message for link using wrong locale"
277 | },
278 | "data_macro_note_missing": {
279 | "message": "The data macro %s is missing a note linking to the data source. The note needs to be hidden using 'class=\"hidden\"'.",
280 | "description": "Error message for data macro missing a note above it linking to the data source"
281 | },
282 | "data_macro_source_link_missing": {
283 | "message": "The note for the data macro %s is missing a link to the data source.",
284 | "description": "Error message for data macro note missing a link referring to the data source"
285 | },
286 | "macro_with_unnecessary_params_equalling_slug": {
287 | "message": "The parameters of the %s macro are unnecessary, because they will be fetched from the slug, so they should be removed.",
288 | "description": "Error message for macro with unnecessary parameters equalling slug"
289 | },
290 | "macro_with_unused_params": {
291 | "message": "The parameters of the %s macro are unused, so they should be removed.",
292 | "description": "Error message for macro with unused parameters"
293 | },
294 | "missing_closing_curly_brace": {
295 | "message": "Macro is missing a closing curly brace: %s",
296 | "description": "Error message for macro missing closing curly brace"
297 | },
298 | "missing_closing_bracket": {
299 | "message": "Parameters list is missing closing bracket: %s",
300 | "description": "Error message for macro missing a closing bracket"
301 | },
302 | "string_parameter_incorrectly_quoted": {
303 | "message": "String parameter is not quoted correctly: %s",
304 | "description": "Error message for macro string parameter not being quoted correctly"
305 | },
306 | "additional_closing_bracket": {
307 | "message": "Macro has additional closing bracket(s): %s",
308 | "description": "Error message for macro having additional closing brackets"
309 | },
310 | "wrong_element_wrapping_sidebar_macro": {
311 | "message": "Sidebar macro %s is wrapped into <%s> element",
312 | "description": "Error message for sidebar macro wrapped into wrong element"
313 | },
314 | "obsolete_macro": {
315 | "message": "The %s macro is obsolete and should be removed.",
316 | "description": "Error message for obsolete macro"
317 | },
318 | "highlighted_line_number_not_positive": {
319 | "message": "Highlighted line number %s must be positive: %s",
320 | "description": "Error message for highlighted line number being zero or negative"
321 | },
322 | "highlighted_line_number_too_big": {
323 | "message": "Highlighted line number %s exceeds the line count of %s: %s",
324 | "description": "Error message for highlighted line number exceeding the line count of the code sample"
325 | },
326 | "invalid_highlighted_range": {
327 | "message": "End of highlighted line range %s bigger than its start %s: %s",
328 | "description": "Error message for highlighted line number range being invalid (start of range bigger than end of range)"
329 | },
330 | "invalid_headline_name": {
331 | "message": "Invalid name '%s'",
332 | "description": "Error message for invalid headline name"
333 | },
334 | "invalid_headline_order": {
335 | "message": "Invalid order",
336 | "description": "Error message for invalid headline order"
337 | },
338 | "wrong_syntax_class_used": {
339 | "message": "The CSS class '%s' used for the syntax definition block is wrong. It must be 'syntaxbox'.",
340 | "description": "Error message for invalid CSS class for the syntax definition block"
341 | },
342 | "article_length_info": {
343 | "message": "The article has %s words. Estimated read time: %s minute(s).",
344 | "description": "Info message for article length and reading time estimation"
345 | },
346 | "long_article": {
347 | "message": "The article is very long. Consider to split it up into smaller articles.",
348 | "description": "Error message for long article"
349 | },
350 | "autoExpandErrors_title": {
351 | "message": "Automatically expand errors",
352 | "description": "Title of 'autoExpandErrors' property (shown in Add-ons Manager)"
353 | },
354 | "autoExpandErrors_description": {
355 | "message": "Immediately display errors and warnings returned by a test when running the test suite.",
356 | "description": "Description of 'autoExpandErrors' property (shown in Add-ons Manager)"
357 | },
358 | "link_count": {
359 | "message": "Link count",
360 | "description": "Name of the rule"
361 | },
362 | "link_count_desc": {
363 | "message": "Number of links in the document",
364 | "description": "Number of links"
365 | },
366 | "count_link_info": {
367 | "message": "There are %s links",
368 | "description": "Informations when there are less than 100 links"
369 | },
370 | "count_link_warning": {
371 | "message": "There should be less than 100 links, currently: %s",
372 | "description": "Warning regarding the number of links"
373 | },
374 | "count_link_error": {
375 | "message": "There should be less than 250 links and ideally less than 100 links, currently: %s",
376 | "description": "Error regarding the number of links"
377 | },
378 | "mixed_content": {
379 | "message": "Mixed Content",
380 | "description": "Name of the rule"
381 | },
382 | "mixed_content_desc": {
383 | "message": "There should be no mixed content on MDN",
384 | "description": "Description of Mixed Content rule"
385 | },
386 | "anchor_exists": {
387 | "message": "Anchor doesn't exist",
388 | "description": "Name of Anchor Exists rule"
389 | },
390 | "anchor_exists_desc": {
391 | "message": "Each fragment identifier (#foo) needs refer to an ID within the page that exists.",
392 | "description" : "Description of Anchor Exists rule"
393 | }
394 | }
395 |
--------------------------------------------------------------------------------
/add-on/rules.js:
--------------------------------------------------------------------------------
1 | (function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.linter = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o {
41 | let href = match.node.getAttribute("href");
42 | let relativeURL = href.replace(reAbsoluteURL, "");
43 | match.node.setAttribute("href", relativeURL);
44 | match.node.setAttribute("data-cke-saved-href", relativeURL);
45 | });
46 | }
47 | };
48 |
49 | },{"./doctests.js":9}],2:[function(require,module,exports){
50 | /*
51 | * Title: Test whether discouraged statements are used in example code.
52 | *
53 | * Example 1: alert("Some message"); should be avoided and
54 | * console.log("Some message"); be used instead.
55 | *
56 | * Implementation notes: This test checks all blocks for the usage of discouraged functions.
57 | * In some cases their usage may not be avoided, like for example on their description pages.
58 | * The test does not account for those cases, though.
59 | */
60 |
61 | const mapMatches = require('./doctests.js').mapMatches;
62 | const ERROR = require('./doctests.js').ERROR;
63 |
64 | exports.alertPrintInCode = {
65 | name: "alert_print_in_code",
66 | desc: "alert_print_in_code_desc",
67 | check: function checkAlertPrintInCode(rootElement) {
68 | let pres = rootElement.getElementsByTagName("pre");
69 | let matches = [];
70 | for (let i = 0; i < pres.length; i++) {
71 | let preMatches = pres[i].textContent.match(/(?:alert|print|eval|document\.write)\s*\((?:.|\n)+?\)/gi) || [];
72 | matches = matches.concat(mapMatches(preMatches, ERROR));
73 | }
74 |
75 | return matches;
76 | }
77 | };
78 |
79 | },{"./doctests.js":9}],3:[function(require,module,exports){
80 | /*
81 | * Title : Test that each internal links match with an anchor
82 | */
83 |
84 | const ERROR = require('./doctests.js').ERROR;
85 |
86 | const REGEX_ID = /#(.*)/
87 |
88 | exports.anchorExists = {
89 | name: 'anchor_exists',
90 | desc: 'anchor_exists_desc',
91 | check: function checkAnchorExists(rootElement) {
92 | let matches = [];
93 | let anchors = rootElement.querySelectorAll('a[href^="#"]');
94 | for(let anchor of anchors) {
95 | let id = REGEX_ID.exec(anchor.href)[0];
96 | let link = rootElement.querySelector(`${id}`);
97 |
98 | if(link === null) matches.push({msg: id, type: ERROR});
99 | }
100 |
101 | return matches;
102 | }
103 | };
104 |
105 | },{"./doctests.js":9}],4:[function(require,module,exports){
106 | /*
107 | * Title: Test whether the API syntax headlines are named correctly, i.e. 'Parameters',
108 | * 'Return value' and 'Exceptions', and whether they appear in the correct order.
109 | *
110 | * Example 1: The return value should have 'Return value' as headline and not 'Returns'.
111 | *
112 | * Example 2: Exceptions should have 'Exceptions' as headline and not 'Errors' or 'Errors thrown'.
113 | *
114 | * Example 3: Having an 'Exceptions' section before the 'Return value' section should be avoided.
115 | * The correct order of the sections is 'Parameters', 'Return value' and 'Exceptions'.
116 | *
117 | * Implementation notes: This test searches for specific keywords like 'returns' or 'errors' and
118 | * expects the headlines to be