overleaf/services/web/public/coffee/ide/human-readable-logs/HumanReadableLogs.coffee

define [
	"libs/latex-log-parser"
	"ide/human-readable-logs/HumanReadableLogsRules"
], (LogParser, ruleset) ->
	parse : (rawLog, options) ->
		parsedLogEntries = LogParser.parse(rawLog, options)

		_getRule = (logMessage) ->
			return rule for rule in ruleset when rule.regexToMatch.test logMessage

		for entry in parsedLogEntries.all
			ruleDetails = _getRule entry.message

			if (ruleDetails?)
				entry.ruleId = 'hint_' + ruleDetails.regexToMatch.toString().replace(/\s/g, '_').slice(1, -1) if ruleDetails.regexToMatch?
				
				entry.humanReadableHint = ruleDetails.humanReadableHint if ruleDetails.humanReadableHint?
				entry.extraInfoURL = ruleDetails.extraInfoURL if ruleDetails.extraInfoURL?
	
		return parsedLogEntries
Create human readable logs module on top of LatexLogParser; use it in the PDF controller. 2016-06-16 06:14:45 -04:00			`define [`
			`"libs/latex-log-parser"`
Add sample rules file. 2016-06-16 10:29:00 -04:00			`"ide/human-readable-logs/HumanReadableLogsRules"`
			`], (LogParser, ruleset) ->`
Create human readable logs module on top of LatexLogParser; use it in the PDF controller. 2016-06-16 06:14:45 -04:00			`parse : (rawLog, options) ->`
			`parsedLogEntries = LogParser.parse(rawLog, options)`
Add sample rules file. 2016-06-16 10:29:00 -04:00
Support extra info URL in human readable hints. 2016-06-17 06:42:32 -04:00			`_getRule = (logMessage) ->`
			`return rule for rule in ruleset when rule.regexToMatch.test logMessage`
Match logs against ruleset; show human readable message when appropriate. 2016-06-16 10:53:39 -04:00
			`for entry in parsedLogEntries.all`
Safety checks for non-existing values; avoid rendering the hint template when there is no hint. 2016-06-21 07:07:47 -04:00			`ruleDetails = _getRule entry.message`
Add sample rules file. 2016-06-16 10:29:00 -04:00
Safety checks for non-existing values; avoid rendering the hint template when there is no hint. 2016-06-21 07:07:47 -04:00			`if (ruleDetails?)`
Improve log hints ids. 2016-06-30 06:30:43 -04:00			`entry.ruleId = 'hint_' + ruleDetails.regexToMatch.toString().replace(/\s/g, '_').slice(1, -1) if ruleDetails.regexToMatch?`

Safety checks for non-existing values; avoid rendering the hint template when there is no hint. 2016-06-21 07:07:47 -04:00			`entry.humanReadableHint = ruleDetails.humanReadableHint if ruleDetails.humanReadableHint?`
			`entry.extraInfoURL = ruleDetails.extraInfoURL if ruleDetails.extraInfoURL?`

Create human readable logs module on top of LatexLogParser; use it in the PDF controller. 2016-06-16 06:14:45 -04:00			`return parsedLogEntries`