forked from AstroCB/Stack-Exchange-Editor-Toolkit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
editor.user.js
428 lines (393 loc) · 17.5 KB
/
editor.user.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
// ==UserScript==
// @name Stack-Exchange-Editor-Toolkit
// @author Cameron Bernhardt (AstroCB)
// @namespace https://github.com/AstroCB
// @version 2.0
// @description Fix common grammar/usage annoyances on Stack Exchange posts with a click
// @include http://*.stackexchange.com/questions/*
// @include http://stackoverflow.com/questions/*
// @include http://meta.stackoverflow.com/questions/*
// @include http://serverfault.com/questions/*
// @include http://meta.serverfault.com/questions/*
// @include http://superuser.com/questions/*
// @include http://meta.superuser.com/questions/*
// @include http://askubuntu.com/questions/*
// @include http://meta.askubuntu.com/questions/*
// @include http://stackapps.com/questions/*
// @include http://*.stackexchange.com/posts/*
// @include http://stackoverflow.com/posts/*
// @include http://meta.stackoverflow.com/posts/*
// @include http://serverfault.com/posts/*
// @include http://meta.serverfault.com/posts/*
// @include http://superuser.com/posts/*
// @include http://meta.superuser.com/posts/*
// @include http://askubuntu.com/posts/*
// @include http://meta.askubuntu.com/posts/*
// @include http://stackapps.com/posts/*
// @exclude http://*.stackexchange.com/questions/tagged/*
// @exclude http://stackoverflow.com/questions/tagged/*
// @exclude http://meta.stackoverflow.com/questions/tagged/*
// @exclude http://serverfault.com/questions/tagged/*
// @exclude http://meta.serverfault.com/questions/*
// @exclude http://superuser.com/questions/tagged/*
// @exclude http://meta.superuser.com/questions/tagged/*
// @exclude http://askubuntu.com/questions/tagged/*
// @exclude http://meta.askubuntu.com/questions/tagged/*
// @exclude http://stackapps.com/questions/tagged/*
// ==/UserScript==
var main = function () {
//get url for question id used in id and class names
var URL = window.location.href;
var questionNum = URL.match(/\d/g);
questionNum = questionNum.join("");
// Select button bar
var buttonBar = $('#wmd-button-bar-' + questionNum);
var barReady = false;
var editsMade = false;
var editCount = 0;
var toolkitGlobals = {};
// Wait for the button bar to update
buttonBar.unbind().on('DOMSubtreeModified', function () {
if (!barReady) {
barReady = true;
// Run asynchronously (important)
setTimeout(function () {
var redoButton = $('#wmd-redo-button-' + questionNum);
var privileges = true;
var spacerHTML = '<li class="wmd-spacer wmd-spacer3" id="wmd-spacer3-' + questionNum + '" style="left: 400px !important;"></li>';
var buttonHTML = '<div id="ToolkitButtonWrapper"><button class="wmd-button" id="ToolkitFix"></button><div id="ToolkitInfo"></div></div>';
redoButton.after(buttonHTML); // Insert button
redoButton.after(spacerHTML); // Insert spacer
// Select the button
var buttonWrapper = $('#ToolkitButtonWrapper');
var buttonFix = $('#ToolkitFix');
var buttonInfo = $('#ToolkitInfo');
// Assign button info to toolkitGlobals for use in other functions
toolkitGlobals.buttonInfo = buttonInfo;
// Style button
buttonWrapper.css({
'position': 'relative',
'left': '430px',
});
buttonFix.css({
'position': 'static',
'float': 'left',
'border-width': '0px',
'background-color': 'white',
'background-image': 'url("http://i.imgur.com/cLCZ21L.png")',
'background-size': '100% 100%',
'width': '18px',
'height': '18px',
'outline': 'none'
});
buttonInfo.css({
'position': 'static',
'float': 'left',
'margin-left': '5px',
'font-size': '12px',
'color': '#424242',
'line-height': '19px'
});
buttonFix.hover(function () {
toolkitGlobals.buttonInfo.text('Fix the content!');
buttonFix.css({
'background-image': 'url("http://i.imgur.com/kyE5p6d.png")'
});
}, function () {
toolkitGlobals.buttonInfo.text('');
buttonFix.css({
'background-image': 'url("http://i.imgur.com/cLCZ21L.png")'
});
});
buttonFix.click(function (e) {
e.preventDefault();
if (!editsMade) {
edit(e);
editsMade = true;
}
});
}, 0);
}
});
//check for editing privledges
if (window.location.href.search(/\/posts\/\d*\/edit/) !== -1) { // No editing privileges
privileges = false;
if (localStorage) {
if (!localStorage.hasAsked) {
alert("You do not have editing privileges on this site.\nBe aware that your edits may be rejected.");
localStorage.hasAsked = true;
}
}
}
//Note: by adding a modular name space to all variables, we don't have to worry about mixing variables
//between various functions that we implement. This is more useful in larger projects, but it's not a
//bad thing to practice regularly. Instead of coming up with complex variable names for other functonalities
//within the same function scope, we can now use simple names appended to a namespace object.
//define Editing Module namespace
var EM = {};
// Grab input fields
EM.bodyBox = $(".wmd-input");
EM.titleBox = $(".ask-title-field")l;
EM.reasons = [];
EM.numReasons = 0;
EM.body = EM.bodyBox.val();
EM.title = EM.titleBox.val();
// This is where the magic happens: this function takes a few pieces of information and applies edits to the post with a couple exceptions
EM.fixIt = function(input, expression, replacement, reasoning) {
// Scan the post text using the expression to see if there are any matches
var there = input.search(expression);
// If so, increase the number of edits performed (used later for edit summary formation)
if (there !== -1) {
editCount++;
// Later, this will store what is removed for the first case
var phrase;
// Then, perform the edits using replace()
// What follows is a series of exceptions, which I will explain below; I perform special actions by overriding replace()
// This is used for removing things entirely without giving a replacement; it matches the expression and then replaces it with nothing
if (replacement === "") {
input = input.replace(expression, function (data, match1) {
phrase = match1; // Save what is removed for the edit summary (see below)
return ""; // Replace with nothing
});
reasoning = reasoning.replace("$1", phrase); // This is an interesting tidbit: if you want to make the edit summaries dynamic, you can keep track of a match that you receive from overriding the replace() function and then use that in the summary
} else if (replacement == "$1vote") { // This allows me to combine the upvote and downvote replacement schemes into one
input = input.replace(expression, function (data, match1) {
phrase = match1;
return phrase + "vot"; // "return" in this context is what is used to replace what is matched
});
reasoning = reasoning.replace("$1", phrase.toLowerCase());
} else if (replacement === "$1") { // This is used to capitalize letters; it merely takes what is matched, uppercases it, and replaces what was matched with the uppercased verison
input = input.replace(expression, function (data, match1) {
return match1.toUpperCase();
});
} else { // Default: just replace it with the indicated replacement
input = input.replace(expression, replacement);
}
return { // Return a dictionary with the reasoning for the fix and what is edited (used later to prevent duplicates in the edit summary)
reason: reasoning,
fixed: input
};
} else {
return null; // If nothing needs to be fixed, return null
}
}
//define namespace vars
EM.replacedStrings = {
"block": [],
"inline": []
};
EM.placeHolders = {
"block": "_xCodexBlockxPlacexHolderx_",
"inline": "_xCodexInlinexPlacexHolderx_"
};
EM.checks = {
"block": /( )+.*/gm,
"inline": /`.*`/gm
};
EM.placeHolderChecks = {
"block": /_xCodexBlockxPlacexHolderx_/g,
"inline": /_xCodexInlinexPlacexHolderx_/g
};
//omit code
EM.omitCode = function (str, type) {
str = str.replace(EM.checks[type], function (match) {
EM.replacedStrings[type].push(match);
return EM.placeHolders[type];
});
return str;
}
//omit code
EM.replaceCode = function (str, type) {
for (var i in EM.replacedStrings[type]){
str = str.replace(EM.placeHolderChecks[type], EM.replacedStrings[type][i]);
}
return str;
}
//pipeline body through code omitter
EM.body = EM.omitCode(EM.body, "block");
EM.body = EM.omitCode(EM.body, "inline");
console.log(newString);
console.log(EM);
//Note: no reason to redefine all of these rules for every edit
// Define edit rules
EM.edits = {
i: {
expr: /(^|\s|\()i(\s|,|\.|!|\?|;|\/|\)|'|$)/gm,
replacement: "$1I$2",
reason: "in the English language, the pronoun 'I' is capitalized"
},
so: {
expr: /(^|\s)[Ss]tack\s*overflow|StackOverflow(.|$)/gm,
replacement: "$1Stack Overflow$2",
reason: "the legal name is 'Stack Overflow' (two words, capitalized)"
},
se: {
expr: /(^|\s)[Ss]tack\s*exchange|StackExchange(.|$)/gm,
replacement: "$1Stack Exchange$2",
reason: "the legal name is 'Stack Exchange' (two words, capitalized)"
},
expansionSO: {
expr: /(^|\s)SO(\s|,|\.|!|\?|;|\/|\)|$)/gm,
replacement: "$1Stack Overflow$2",
reason: "expansion"
},
expansionSE: {
expr: /(^|\s)SE(\s|,|\.|!|\?|;|\/|\)|$)/gm,
replacement: "$1Stack Exchange$2",
reason: "expansion"
},
javascript: {
expr: /(^|\s)[Jj]ava\s*script(.|$)/gm,
replacement: "$1JavaScript$2",
reason: "the proper capitalization is 'JavaScript' (see http://en.wikipedia.org/wiki/JavaScript)"
},
jsfiddle: {
expr: /(^|\s)[Jj][Ss][Ff]iddle(.|$)/gm,
replacement: "$1JSFiddle$2",
reason: "the current accepted capitalization is 'JSFiddle' (see title tag on http://jsfiddle.net)"
},
caps: {
expr: /^(?!https?)([a-z])/gm,
replacement: "$1",
reason: "basic capitalization"
},
jquery: {
expr: /(^|\s)[Jj][Qq]uery(.|$)/gm,
replacement: "$1jQuery$2",
reason: "the proper capitalization is 'jQuery' (see http://jquery.com)"
},
html: {
expr: /(^|\s)[Hh]tml(?:5*)(\s|$)/gm,
replacement: "$1HTML$2",
reason: "HTML is an initialism for HyperText Markup Language"
},
css: {
expr: /(^|\s)[Cc]ss(\s|$)/gm,
replacement: "$1CSS$2",
reason: "CSS is an initialism for Cascading Style Sheets"
},
json: {
expr: /(^|\s)[Jj]son(\s|$)/gm,
replacement: "$1JSON$2",
reason: "JSON is an initialism for JavaScript Object Notation"
},
ajax: {
expr: /(^|\s)[Aa]jax(\s|$)/gm,
replacement: "$1AJAX$2",
reason: "AJAX is an initialism for Asynchronous JavaScript and XML"
},
angular: {
expr: /[Aa]ngular[Jj][Ss]/g,
replacement: "AngularJS",
reason: "the 'JS' in 'AngularJS' is capitalized"
},
thanks: {
expr: /(thanks|please\s+help|cheers|regards|thx|thank\s+you|my\s+first\s+question).*$/gmi,
replacement: "",
reason: "please don't include '$1' in your question: it is unnecessary noise"
},
commas: {
expr: /,([^\s])/g,
replacement: ", $1",
reason: "commas have one space after them"
},
php: {
expr: /(^|\s)[Pp]hp(\s|$)/gm,
replacement: "$1PHP$2",
reason: "PHP is an initialism for PHP: Hypertext Preprocessor (recursive)"
},
hello: {
expr: /(?:^|\s)(hi\s+guys|good\s(?:evening|morning|day|afternoon))(?:\.|!)/gmi,
replacement: "",
reason: "please don't include '$1' in your question: it is unnecessary noise"
},
edit: {
expr: /(?:^\**)(edit|update):?(?:\**):?/gmi,
replacement: "",
reason: "Stack Exchange has an advanced revision history system: please don't include 'Edit' or 'Update' with edits, as the revision history makes the timing of your edits clear"
},
voting: {
expr: /([Dd]own|[Uu]p)[\s*\-]vot/g,
replacement: "$1vote",
reason: "the proper spelling (despite the tag name) is '$1vote' (one word)"
},
mysite: {
expr: /mysite\./g,
replacement: "example.",
reason: "links to mysite.domain are not allowed: use example.domain instead"
}
//expansion reminder: let's support those non web devs with capitalization for popular languages such as C#
};
EM.edit = function(e) {
// Visually confirm edit - SE makes it easy because the jQuery color animation plugin seems to be there by default
box.animate({
backgroundColor: '#c8ffa7'
}, 10);
box.animate({
backgroundColor: '#fff'
}, 1000);
//loop through all editing rules
for (var j in EM.edits) {
if (EM.edits.hasOwnProperty(j)) {
// Check body
var fix = EM.fixIt(EM.body, EM.edits[j].expr, EM.edits[j].replacement, EM.edits[j].reason);
if (fix) {
//replace removed code blocks
console.log(fix.fixed);
fix.fixed = EM.replaceCode(fix.fixed, "block");
fix.fixed = EM.replaceCode(fix.fixed, "inline");
//insert results
EM.reasons[numReasons] = fix.reason;
EM.bodyBox.val(fix.fixed);
EM.numReasons++;
EM.edits[j].fixed = true;
}
// Check title
fix = EM.fixIt(EM.title, EM.edits[j].expr, EM.edits[j].replacement, EM.edits[j].reason);
if (fix) {
EM.titleBox.val(fix.fixed);
if (!EM.edits[j].fixed) {
EM/reasons[numReasons] = fix.reason;
EM.numReasons++;
EM.edits[j].fixed = true;
}
}
}
}
// Create summary
var summary = "";
for (var z = 0; z < reasons.length; z++) {
if (z === 0) {
summary += reasons[z][0].toUpperCase() + reasons[z].substring(1);
} else if (z !== reasons.length - 1) {
summary += reasons[z] + "; ";
} else {
summary += reasons[z];
}
if (z === 0 && reasons.length > 1) {
summary += "; ";
}
if (z === reasons.length - 1) {
summary += ".";
}
}
// Update the comment: focusing on the input field to remove placeholder text, but scroll back to the user's original location
var currentPos = document.body.scrollTop;
if (privileges) {
$(".edit-comment").val(summary);
$(".wmd-input").focus();
$(".edit-comment").focus();
} else {
$("#edit-comment").val(summary);
$("#wmd-input").focus();
$("#edit-comment").focus();
}
window.scrollTo(0, currentPos);
toolkitGlobals.buttonInfo.text(editCount + ' changes made');
}
};
// Inject the main script
var script = document.createElement('script');
script.type = "text/javascript";
script.textContent = '(' + main.toString() + ')();';
document.body.appendChild(script);