Cleanup check_config jsdoc

This commit is contained in:
rejas 2020-07-27 20:14:10 +02:00
parent 5ec51d0ccc
commit 9888f66c84

View File

@ -17,8 +17,10 @@ const Log = require(rootPath + "/js/logger.js");
const Utils = require(rootPath + "/js/utils.js"); const Utils = require(rootPath + "/js/utils.js");
/** /**
* Return string with path of configuration file * Returns a string with path of configuration file.
* Check if set by environment variable MM_CONFIG_FILE * Check if set by environment variable MM_CONFIG_FILE
*
* @returns {string} path and filename of the config file
*/ */
function getConfigFile() { function getConfigFile() {
// FIXME: This function should be in core. Do you want refactor me ;) ?, be good! // FIXME: This function should be in core. Do you want refactor me ;) ?, be good!
@ -30,7 +32,7 @@ function getConfigFile() {
} }
/** /**
* * Checks the config file using eslint.
*/ */
function checkConfigFile() { function checkConfigFile() {
const configFileName = getConfigFile(); const configFileName = getConfigFile();
@ -41,7 +43,7 @@ function checkConfigFile() {
throw new Error("No config file present!"); throw new Error("No config file present!");
} }
// check permission // Check permission
try { try {
fs.accessSync(configFileName, fs.F_OK); fs.accessSync(configFileName, fs.F_OK);
} catch (e) { } catch (e) {