peerigon / dynamic-config Goto Github PK
View Code? Open in Web Editor NEWLoads configuration files depending on the given env
License: MIT License
Loads configuration files depending on the given env
License: MIT License
I think, we should set NODE_ENV
according to env
. It is the node.js de-facto standard and can even impact performance.
Hey guys,
currently there is a major problem with dynamic-config, because you cannot create an instance of the config loader. So when using npm >= 2 and dynamic-config can be deduped, you will end up with modules sharing the same dynamic-config instance. That means they are overriding each others plugin settings.
Example:
module a
uses dynamic-config like this:
var dynamicConfig = require("dynamic-config");
dynamicConfig.use(require("dynamic-config/plugins/extend/env"));
module.exports = dynamicConfig(__dirname, "config.js");
module b
uses dynamic-config like this:
var dynamicConfig = require("dynamic-config");
module.exports = dynamicConfig(__dirname, "config.js");
Now it depends on the order:
If module a
is loaded before module b
you will be able to overwrite configs of both modules via environment variables. This is not intended.
If module b
is loaded before module a
you will only be able to overwrite configs of module a
. This is the intended effect.
This problem is even worse with the file extend plugin:
Module a
:
var dynamicConfig = require("dynamic-config");
dynamicConfig.use(require("dynamic-config/plugins/extend/file"));
module.exports = dynamicConfig(__dirname, "config.js");
Module b
:
var dynamicConfig = require("dynamic-config");
dynamicConfig.use(require("dynamic-config/plugins/extend/file"), {
suffix: ".test"
});
module.exports = dynamicConfig(__dirname, "config.js");
If module a
is loaded before module b
dynamic-config will look for a config.local.js
file in both modules, because .local
is the default suffix. This is not correct behavior.
If module b
is loaded before module a
dynamic-config will look for a config.test.js
file in both modules. This is also not correct. It seems plugins can only be registered once.
In my opinion it should be possible to create an instance of dynamic-config to be able to maintain the plugin configuration the developer wanted to use. I can create a PR, but wanted to ask for your opinion first ๐
Ben
Update:
Possible code example for the proposed change:
var dynamicConfig = require("dynamic-config").createInstance();
This can probably be implemented as a backwards compatible change.
Of course something like this would be fine, too, but is a breaking change ofc:
var dynamicConfig = new (require("dynamic-config"))();
Hello there!
I don't know if you want this behavior in dynamic-config, but for our use case it would be a huge improvement to be able to use local configs.
Explanation:
Let's assume you have a config.js
with the following content:
module.exports = {
"path": "/etc/blubb.conf"
"log": {
"level": "debug"
}
"a lot of": "other stuff"
};
This file is under version control and fits for most of your systems. But there is a specific configuration on a server/dev machine/whatsoever that just needs a tiny bit of the config changed. In this case I would propose a config.local.js
with only the specific changes. For example for the config above:
module.exports = {
"path": "/home/benurb/blubb.conf"
};
This would make it a lot easier to have dev/local configurations without messing around with the base configuration.
What do you think about it? If you like it I can create a PR ofc ๐
Ben
Hey guys,
if I'm annoying you just tell me, but I found a little regression with v1.0.0. resolvedConfigPath
was removed. The thing is, that sometimes you need to know the filename of the config, that was loaded. With the file extension plugin this becomes even more interesting. What do you think about a method like getResolvedPaths()
which returns an array like this if only the "main" config file was loaded:
["/some/folder/config/staging/config.js"]
And something like this if an overwrite file was loaded
["/some/folder/config/staging/config.js", "/some/folder/config/staging/config.local.js"]
One use case might be to check for getResolvedPaths().slice(-1).indexOf(".local") >= 0
to check if the config was successfully overwritten.
What do you think about that? For my use case it would be useful, but I'm not the center of the universe ๐
Ben
@Vispercept can you describe why you want a customEnv?
I'm thinking of handling it the same way as defaultEnv
so we'd have something like envArgumentName
which is env
by default and can be changed to whatever you like.
It should be applied on reading from argv
and env
if you change it so the behavior is consistent.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.