MagicMirror/tests/configs/check_config.js

/* Magic Mirror
 *
 * Checker configuration file
 *
 * By Rodrigo Ramírez Norambuena
 *    https://rodrigoramirez.com
 *
 * MIT Licensed.
 *
 */

const Linter = require("eslint").Linter;
const linter = new Linter();
const config = require(__dirname + "/../../.eslintrc.json");

var path = require("path");
var fs = require("fs");
var Utils = require(__dirname + "/../../js/utils.js");

/* getConfigFile()
 * Return string with path of configuration file
 * Check if set by environment variable MM_CONFIG_FILE
 */
function getConfigFile() {
	// FIXME: This function should be in core. Do you want refactor me ;) ?, be good!
	rootPath = path.resolve(__dirname + "/../../");
	var configFileName = path.resolve(rootPath + "/config/config.js");
	if (process.env.MM_CONFIG_FILE) {
		configFileName = path.resolve(process.env.MM_CONFIG_FILE);
	}
	return configFileName;
}

function checkConfigFile() {
	var configFileName = getConfigFile();
	// Check if file is present
	if (fs.existsSync(configFileName) === false) {
		console.error(Utils.colors.error("File not found: "), configFileName);
		return;
	}
	// check permission
	try {
		fs.accessSync(configFileName, fs.F_OK);
	} catch (e) {
		console.log(Utils.colors.error(e));
		return;
	}

	// Validate syntax of the configuration file.
	// In case the there errors show messages and
	// return
	console.info(Utils.colors.info("Checking file... ", configFileName));
	// I'm not sure if all ever is utf-8
	fs.readFile(configFileName, "utf-8", function (err, data) {
		if (err) { throw err; }
		const messages = linter.verify(data, config);
		if (messages.length === 0) {
			console.log("Your configuration file doesn't contain syntax errors :)");
			return true;
		} else {
			errors = messages;
			for (var idx in errors) {
				error = errors[idx];
				console.log("Line", error.line, "col", error.column, error.message);
			}
		}
	});
}

if (process.env.NODE_ENV !== "test") {
	checkConfigFile();
}