Merge pull request #737 from roramirez/deprecated-options

Deprecated options
This commit is contained in:
Michael Teeuw
2017-02-25 11:38:30 +01:00
committed by GitHub
4 changed files with 41 additions and 0 deletions

View File

@@ -62,6 +62,7 @@ var App = function() {
try {
fs.accessSync(configFilename, fs.F_OK);
var c = require(configFilename);
checkDeprecatedOptions(c);
var config = Object.assign(defaults, c);
callback(config);
} catch (e) {
@@ -78,6 +79,27 @@ var App = function() {
}
};
var checkDeprecatedOptions = function(userConfig) {
var deprecated = require(global.root_path + "/js/deprecated.js");
var deprecatedOptions = deprecated.configs;
var usedDeprecated = [];
deprecatedOptions.forEach(function(option) {
if (userConfig.hasOwnProperty(option)) {
usedDeprecated.push(option);
}
});
if (usedDeprecated.length > 0) {
console.warn(deprecated.colors.warn(
"WARNING! Your config is using deprecated options: " +
usedDeprecated.join(", ") +
". Check README and CHANGELOG for more up-to-date ways of getting the same functionality.")
);
}
}
/* loadModule(module)
* Loads a specific module.
*

17
js/deprecated.js Normal file
View File

@@ -0,0 +1,17 @@
/* Magic Mirror Deprecated Config Options List
*
* By Michael Teeuw http://michaelteeuw.nl
* MIT Licensed.
*
* Olex S. original idea this deprecated option
*/
var colors = require("colors/safe");
colors.setTheme({warn: "yellow"})
var deprecated = {
configs: ["kioskmode"],
colors: colors
};
/*************** DO NOT EDIT THE LINE BELOW ***************/
if (typeof module !== "undefined") {module.exports = deprecated;}