Linters allow inspection of content

[zachleat]

Option to test and throw warnings based on generated content result.

Examples:

• Show if a template output exceeds a certain KB or gzipped KB
• Show if a template uses words to avoid in educational writing (a la https://css-tricks.com/words-avoid-educational-writing/)

[zachleat]

Sample inclusive-language filter:

eleventyConfig.addLinter("inclusive-language", function(content, inputPath, outputPath) {
	let words = "simply,obviously,basically,of course,clearly,just,everyone knows,however,easy".split(",");
	if( inputPath.endsWith(".md") ) {
		let found = [];
		for( let word of words) {
			word = word.trim();
			let regexp = new RegExp("\\b" + word + "\\b", "gi");
			if(!!content.match(regexp)) {
				let split = content.split(regexp);
				for(let j = 0, k = split.length; j + 1 < k; j++) {
					found.push( split[j].substr(-30) + chalk.underline(word) + split[j+1].substr(0, 30));
				}
			}
		}

		if(found.length) {
			console.warn(chalk.yellow(`Inclusive Language Linter (${inputPath}):`));
			console.warn("    " + found.join("\n" + "    "));
		}
	}
});

Output:

[zachleat]

via https://twitter.com/evaferreira92/status/1039894806200233985