├── .gitignore ├── config ├── config.js └── config.json ├── package-lock.json ├── package.json └── server.js /.gitignore: -------------------------------------------------------------------------------- 1 | # om namah shivay 2 | 3 | node_modules/ 4 | -------------------------------------------------------------------------------- /config/config.js: -------------------------------------------------------------------------------- 1 | // om namah shivay 2 | 3 | // requires 4 | const _ = require('lodash'); 5 | 6 | // module variables 7 | const config = require('./config.json'); 8 | const defaultConfig = config.development; 9 | const environment = process.env.NODE_ENV || 'development'; 10 | const environmentConfig = config[environment]; 11 | const finalConfig = _.merge(defaultConfig, environmentConfig); 12 | 13 | // as a best practice 14 | // all global variables should be referenced via global. syntax 15 | // and their names should always begin with g 16 | global.gConfig = finalConfig; 17 | 18 | // log global.gConfig 19 | console.log(`global.gConfig: ${JSON.stringify(global.gConfig, undefined, global.gConfig.json_indentation)}`); -------------------------------------------------------------------------------- /config/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "development": { 3 | "config_id": "development", 4 | "app_name": "my app", 5 | "app_desc": "my app desc", 6 | "node_port": 3000, 7 | "json_indentation": 4, 8 | "database": "my-app-db-dev" 9 | }, 10 | "testing": { 11 | "config_id": "testing", 12 | "database": "my-app-db-test" 13 | }, 14 | "staging": { 15 | "config_id": "staging", 16 | "node_port": 8080, 17 | "database": "my-app-db-stag" 18 | }, 19 | "production": { 20 | "config_id": "production", 21 | "node_port": 8080, 22 | "database": "my-app-db-prod" 23 | } 24 | } -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "node-smarter-config", 3 | "version": "1.0.0", 4 | "lockfileVersion": 1, 5 | "requires": true, 6 | "dependencies": { 7 | "accepts": { 8 | "version": "1.3.5", 9 | "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.5.tgz", 10 | "integrity": "sha1-63d99gEXI6OxTopywIBcjoZ0a9I=", 11 | "requires": { 12 | "mime-types": "2.1.18", 13 | "negotiator": "0.6.1" 14 | } 15 | }, 16 | "array-flatten": { 17 | "version": "1.1.1", 18 | "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", 19 | "integrity": "sha1-ml9pkFGx5wczKPKgCJaLZOopVdI=" 20 | }, 21 | "body-parser": { 22 | "version": "1.18.2", 23 | "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.18.2.tgz", 24 | "integrity": "sha1-h2eKGdhLR9hZuDGZvVm84iKxBFQ=", 25 | "requires": { 26 | "bytes": "3.0.0", 27 | "content-type": "1.0.4", 28 | "debug": "2.6.9", 29 | "depd": "1.1.2", 30 | "http-errors": "1.6.2", 31 | "iconv-lite": "0.4.19", 32 | "on-finished": "2.3.0", 33 | "qs": "6.5.1", 34 | "raw-body": "2.3.2", 35 | "type-is": "1.6.16" 36 | } 37 | }, 38 | "bytes": { 39 | "version": "3.0.0", 40 | "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", 41 | "integrity": "sha1-0ygVQE1olpn4Wk6k+odV3ROpYEg=" 42 | }, 43 | "content-disposition": { 44 | "version": "0.5.2", 45 | "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.2.tgz", 46 | "integrity": "sha1-DPaLud318r55YcOoUXjLhdunjLQ=" 47 | }, 48 | "content-type": { 49 | "version": "1.0.4", 50 | "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", 51 | "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==" 52 | }, 53 | "cookie": { 54 | "version": "0.3.1", 55 | "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.3.1.tgz", 56 | "integrity": "sha1-5+Ch+e9DtMi6klxcWpboBtFoc7s=" 57 | }, 58 | "cookie-signature": { 59 | "version": "1.0.6", 60 | "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.6.tgz", 61 | "integrity": "sha1-4wOogrNCzD7oylE6eZmXNNqzriw=" 62 | }, 63 | "debug": { 64 | "version": "2.6.9", 65 | "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", 66 | "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", 67 | "requires": { 68 | "ms": "2.0.0" 69 | } 70 | }, 71 | "depd": { 72 | "version": "1.1.2", 73 | "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", 74 | "integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=" 75 | }, 76 | "destroy": { 77 | "version": "1.0.4", 78 | "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.0.4.tgz", 79 | "integrity": "sha1-l4hXRCxEdJ5CBmE+N5RiBYJqvYA=" 80 | }, 81 | "ee-first": { 82 | "version": "1.1.1", 83 | "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", 84 | "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=" 85 | }, 86 | "encodeurl": { 87 | "version": "1.0.2", 88 | "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", 89 | "integrity": "sha1-rT/0yG7C0CkyL1oCw6mmBslbP1k=" 90 | }, 91 | "escape-html": { 92 | "version": "1.0.3", 93 | "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", 94 | "integrity": "sha1-Aljq5NPQwJdN4cFpGI7wBR0dGYg=" 95 | }, 96 | "etag": { 97 | "version": "1.8.1", 98 | "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", 99 | "integrity": "sha1-Qa4u62XvpiJorr/qg6x9eSmbCIc=" 100 | }, 101 | "express": { 102 | "version": "4.16.3", 103 | "resolved": "https://registry.npmjs.org/express/-/express-4.16.3.tgz", 104 | "integrity": "sha1-avilAjUNsyRuzEvs9rWjTSL37VM=", 105 | "requires": { 106 | "accepts": "1.3.5", 107 | "array-flatten": "1.1.1", 108 | "body-parser": "1.18.2", 109 | "content-disposition": "0.5.2", 110 | "content-type": "1.0.4", 111 | "cookie": "0.3.1", 112 | "cookie-signature": "1.0.6", 113 | "debug": "2.6.9", 114 | "depd": "1.1.2", 115 | "encodeurl": "1.0.2", 116 | "escape-html": "1.0.3", 117 | "etag": "1.8.1", 118 | "finalhandler": "1.1.1", 119 | "fresh": "0.5.2", 120 | "merge-descriptors": "1.0.1", 121 | "methods": "1.1.2", 122 | "on-finished": "2.3.0", 123 | "parseurl": "1.3.2", 124 | "path-to-regexp": "0.1.7", 125 | "proxy-addr": "2.0.3", 126 | "qs": "6.5.1", 127 | "range-parser": "1.2.0", 128 | "safe-buffer": "5.1.1", 129 | "send": "0.16.2", 130 | "serve-static": "1.13.2", 131 | "setprototypeof": "1.1.0", 132 | "statuses": "1.4.0", 133 | "type-is": "1.6.16", 134 | "utils-merge": "1.0.1", 135 | "vary": "1.1.2" 136 | } 137 | }, 138 | "finalhandler": { 139 | "version": "1.1.1", 140 | "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.1.1.tgz", 141 | "integrity": "sha512-Y1GUDo39ez4aHAw7MysnUD5JzYX+WaIj8I57kO3aEPT1fFRL4sr7mjei97FgnwhAyyzRYmQZaTHb2+9uZ1dPtg==", 142 | "requires": { 143 | "debug": "2.6.9", 144 | "encodeurl": "1.0.2", 145 | "escape-html": "1.0.3", 146 | "on-finished": "2.3.0", 147 | "parseurl": "1.3.2", 148 | "statuses": "1.4.0", 149 | "unpipe": "1.0.0" 150 | } 151 | }, 152 | "forwarded": { 153 | "version": "0.1.2", 154 | "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.1.2.tgz", 155 | "integrity": "sha1-mMI9qxF1ZXuMBXPozszZGw/xjIQ=" 156 | }, 157 | "fresh": { 158 | "version": "0.5.2", 159 | "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", 160 | "integrity": "sha1-PYyt2Q2XZWn6g1qx+OSyOhBWBac=" 161 | }, 162 | "http-errors": { 163 | "version": "1.6.2", 164 | "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.6.2.tgz", 165 | "integrity": "sha1-CgAsyFcHGSp+eUbO7cERVfYOxzY=", 166 | "requires": { 167 | "depd": "1.1.1", 168 | "inherits": "2.0.3", 169 | "setprototypeof": "1.0.3", 170 | "statuses": "1.4.0" 171 | }, 172 | "dependencies": { 173 | "depd": { 174 | "version": "1.1.1", 175 | "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.1.tgz", 176 | "integrity": "sha1-V4O04cRZ8G+lyif5kfPQbnoxA1k=" 177 | }, 178 | "setprototypeof": { 179 | "version": "1.0.3", 180 | "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.0.3.tgz", 181 | "integrity": "sha1-ZlZ+NwQ+608E2RvWWMDL77VbjgQ=" 182 | } 183 | } 184 | }, 185 | "iconv-lite": { 186 | "version": "0.4.19", 187 | "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.19.tgz", 188 | "integrity": "sha512-oTZqweIP51xaGPI4uPa56/Pri/480R+mo7SeU+YETByQNhDG55ycFyNLIgta9vXhILrxXDmF7ZGhqZIcuN0gJQ==" 189 | }, 190 | "inherits": { 191 | "version": "2.0.3", 192 | "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", 193 | "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=" 194 | }, 195 | "ipaddr.js": { 196 | "version": "1.6.0", 197 | "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.6.0.tgz", 198 | "integrity": "sha1-4/o1e3c9phnybpXwSdBVxyeW+Gs=" 199 | }, 200 | "lodash": { 201 | "version": "4.17.5", 202 | "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.5.tgz", 203 | "integrity": "sha512-svL3uiZf1RwhH+cWrfZn3A4+U58wbP0tGVTLQPbjplZxZ8ROD9VLuNgsRniTlLe7OlSqR79RUehXgpBW/s0IQw==" 204 | }, 205 | "media-typer": { 206 | "version": "0.3.0", 207 | "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", 208 | "integrity": "sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=" 209 | }, 210 | "merge-descriptors": { 211 | "version": "1.0.1", 212 | "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", 213 | "integrity": "sha1-sAqqVW3YtEVoFQ7J0blT8/kMu2E=" 214 | }, 215 | "methods": { 216 | "version": "1.1.2", 217 | "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", 218 | "integrity": "sha1-VSmk1nZUE07cxSZmVoNbD4Ua/O4=" 219 | }, 220 | "mime": { 221 | "version": "1.4.1", 222 | "resolved": "https://registry.npmjs.org/mime/-/mime-1.4.1.tgz", 223 | "integrity": "sha512-KI1+qOZu5DcW6wayYHSzR/tXKCDC5Om4s1z2QJjDULzLcmf3DvzS7oluY4HCTrc+9FiKmWUgeNLg7W3uIQvxtQ==" 224 | }, 225 | "mime-db": { 226 | "version": "1.33.0", 227 | "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz", 228 | "integrity": "sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ==" 229 | }, 230 | "mime-types": { 231 | "version": "2.1.18", 232 | "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz", 233 | "integrity": "sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ==", 234 | "requires": { 235 | "mime-db": "1.33.0" 236 | } 237 | }, 238 | "ms": { 239 | "version": "2.0.0", 240 | "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", 241 | "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" 242 | }, 243 | "negotiator": { 244 | "version": "0.6.1", 245 | "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.1.tgz", 246 | "integrity": "sha1-KzJxhOiZIQEXeyhWP7XnECrNDKk=" 247 | }, 248 | "on-finished": { 249 | "version": "2.3.0", 250 | "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", 251 | "integrity": "sha1-IPEzZIGwg811M3mSoWlxqi2QaUc=", 252 | "requires": { 253 | "ee-first": "1.1.1" 254 | } 255 | }, 256 | "parseurl": { 257 | "version": "1.3.2", 258 | "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.2.tgz", 259 | "integrity": "sha1-/CidTtiZMRlGDBViUyYs3I3mW/M=" 260 | }, 261 | "path-to-regexp": { 262 | "version": "0.1.7", 263 | "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.7.tgz", 264 | "integrity": "sha1-32BBeABfUi8V60SQ5yR6G/qmf4w=" 265 | }, 266 | "proxy-addr": { 267 | "version": "2.0.3", 268 | "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.3.tgz", 269 | "integrity": "sha512-jQTChiCJteusULxjBp8+jftSQE5Obdl3k4cnmLA6WXtK6XFuWRnvVL7aCiBqaLPM8c4ph0S4tKna8XvmIwEnXQ==", 270 | "requires": { 271 | "forwarded": "0.1.2", 272 | "ipaddr.js": "1.6.0" 273 | } 274 | }, 275 | "qs": { 276 | "version": "6.5.1", 277 | "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.1.tgz", 278 | "integrity": "sha512-eRzhrN1WSINYCDCbrz796z37LOe3m5tmW7RQf6oBntukAG1nmovJvhnwHHRMAfeoItc1m2Hk02WER2aQ/iqs+A==" 279 | }, 280 | "range-parser": { 281 | "version": "1.2.0", 282 | "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz", 283 | "integrity": "sha1-9JvmtIeJTdxA3MlKMi9hEJLgDV4=" 284 | }, 285 | "raw-body": { 286 | "version": "2.3.2", 287 | "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.3.2.tgz", 288 | "integrity": "sha1-vNYMd9Prk83gBQKVw/N5OJvIj4k=", 289 | "requires": { 290 | "bytes": "3.0.0", 291 | "http-errors": "1.6.2", 292 | "iconv-lite": "0.4.19", 293 | "unpipe": "1.0.0" 294 | } 295 | }, 296 | "safe-buffer": { 297 | "version": "5.1.1", 298 | "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.1.tgz", 299 | "integrity": "sha512-kKvNJn6Mm93gAczWVJg7wH+wGYWNrDHdWvpUmHyEsgCtIwwo3bqPtV4tR5tuPaUhTOo/kvhVwd8XwwOllGYkbg==" 300 | }, 301 | "send": { 302 | "version": "0.16.2", 303 | "resolved": "https://registry.npmjs.org/send/-/send-0.16.2.tgz", 304 | "integrity": "sha512-E64YFPUssFHEFBvpbbjr44NCLtI1AohxQ8ZSiJjQLskAdKuriYEP6VyGEsRDH8ScozGpkaX1BGvhanqCwkcEZw==", 305 | "requires": { 306 | "debug": "2.6.9", 307 | "depd": "1.1.2", 308 | "destroy": "1.0.4", 309 | "encodeurl": "1.0.2", 310 | "escape-html": "1.0.3", 311 | "etag": "1.8.1", 312 | "fresh": "0.5.2", 313 | "http-errors": "1.6.2", 314 | "mime": "1.4.1", 315 | "ms": "2.0.0", 316 | "on-finished": "2.3.0", 317 | "range-parser": "1.2.0", 318 | "statuses": "1.4.0" 319 | } 320 | }, 321 | "serve-static": { 322 | "version": "1.13.2", 323 | "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.13.2.tgz", 324 | "integrity": "sha512-p/tdJrO4U387R9oMjb1oj7qSMaMfmOyd4j9hOFoxZe2baQszgHcSWjuya/CiT5kgZZKRudHNOA0pYXOl8rQ5nw==", 325 | "requires": { 326 | "encodeurl": "1.0.2", 327 | "escape-html": "1.0.3", 328 | "parseurl": "1.3.2", 329 | "send": "0.16.2" 330 | } 331 | }, 332 | "setprototypeof": { 333 | "version": "1.1.0", 334 | "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz", 335 | "integrity": "sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==" 336 | }, 337 | "statuses": { 338 | "version": "1.4.0", 339 | "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.4.0.tgz", 340 | "integrity": "sha512-zhSCtt8v2NDrRlPQpCNtw/heZLtfUDqxBM1udqikb/Hbk52LK4nQSwr10u77iopCW5LsyHpuXS0GnEc48mLeew==" 341 | }, 342 | "type-is": { 343 | "version": "1.6.16", 344 | "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.16.tgz", 345 | "integrity": "sha512-HRkVv/5qY2G6I8iab9cI7v1bOIdhm94dVjQCPFElW9W+3GeDOSHmy2EBYe4VTApuzolPcmgFTN3ftVJRKR2J9Q==", 346 | "requires": { 347 | "media-typer": "0.3.0", 348 | "mime-types": "2.1.18" 349 | } 350 | }, 351 | "unpipe": { 352 | "version": "1.0.0", 353 | "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", 354 | "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=" 355 | }, 356 | "utils-merge": { 357 | "version": "1.0.1", 358 | "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", 359 | "integrity": "sha1-n5VxD1CiZ5R7LMwSR0HBAoQn5xM=" 360 | }, 361 | "vary": { 362 | "version": "1.1.2", 363 | "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", 364 | "integrity": "sha1-IpnwLG3tMNSllhsLn3RSShj2NPw=" 365 | } 366 | } 367 | } 368 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "node-smarter-config", 3 | "version": "1.0.0", 4 | "description": "Node.js Best Practices - Smarter Ways to Manage Config Files and Variables", 5 | "main": "server.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1", 8 | "start": "node server.js" 9 | }, 10 | "author": "Raj Chaudhary", 11 | "license": "ISC", 12 | "dependencies": { 13 | "express": "^4.16.3", 14 | "lodash": "^4.17.5" 15 | } 16 | } -------------------------------------------------------------------------------- /server.js: -------------------------------------------------------------------------------- 1 | // om namah shivay 2 | 3 | // requires 4 | const express = require('express'); 5 | 6 | // environment variables 7 | process.env.NODE_ENV = 'development'; 8 | 9 | // uncomment below line to test this code against staging environment 10 | // process.env.NODE_ENV = 'staging'; 11 | 12 | // config variables 13 | const config = require('./config/config.js'); 14 | 15 | // module variables 16 | const app = express(); 17 | 18 | app.get('/', (req, res) => { 19 | res.json(global.gConfig); 20 | }); 21 | 22 | app.listen(global.gConfig.node_port, () => { 23 | console.log(`${global.gConfig.app_name} listening on port ${global.gConfig.node_port}`); 24 | }); --------------------------------------------------------------------------------