Change config to camel case with backwards compatibility

This refactors the configs a bit to now use camel case everywhere. This change should help to clean up the config interface and make it better understandable. Signed-off-by: Sheogorath <[email protected]>
eceusc · Mar 25, 2018 · 2411dff · 2411dff
1 parent fa4a841
commit 2411dff
Show file tree

Hide file tree

Showing 29 changed files with 291 additions and 238 deletions.
diff --git a/README.md b/README.md
@@ -147,7 +147,7 @@ There are some config settings you need to change in the files below.
 | `HMD_URL_ADDPORT` | `true` or `false` | set to add port on callback URL (ports `80` or `443` won't be applied) (only applied when domain is set) |
 | `HMD_USECDN` | `true` or `false` | set to use CDN resources or not (default is `true`) |
 | `HMD_ALLOW_ANONYMOUS` | `true` or `false` | set to allow anonymous usage (default is `true`) |
-| `HMD_ALLOW_ANONYMOUS_EDITS` | `true` or `false` | if `allowanonymous` is `true`, allow users to select `freely` permission, allowing guests to edit existing notes (default is `false`) |
+| `HMD_ALLOW_ANONYMOUS_EDITS` | `true` or `false` | if `allowAnonymous` is `true`, allow users to select `freely` permission, allowing guests to edit existing notes (default is `false`) |
 | `HMD_ALLOW_FREEURL` | `true` or `false` | set to allow new note creation by accessing a nonexistent note URL |
 | `HMD_DEFAULT_PERMISSION` | `freely`, `editable`, `limited`, `locked` or `private` | set notes default permission (only applied on signed users) |
 | `HMD_DB_URL` | `mysql://localhost:3306/database` | set the database URL |
@@ -215,46 +215,46 @@ There are some config settings you need to change in the files below.
 | --------- | ------ | ----------- |
 | `debug` | `true` or `false` | set debug mode, show more logs |
 | `domain` | `localhost` | domain name |
-| `urlpath` | `hackmd` | sub URL path, like `www.example.com/<urlpath>` |
+| `urlPath` | `hackmd` | sub URL path, like `www.example.com/<urlpath>` |
 | `port` | `80` | web app port |
-| `alloworigin` | `['localhost']` | domain name whitelist |
-| `usessl` | `true` or `false` | set to use SSL server (if `true`, will auto turn on `protocolusessl`) |
+| `allowOrigin` | `['localhost']` | domain name whitelist |
+| `useSSL` | `true` or `false` | set to use SSL server (if `true`, will auto turn on `protocolUseSSL`) |
 | `hsts` | `{"enable": true, "maxAgeSeconds": 31536000, "includeSubdomains": true, "preload": true}` | [HSTS](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) options to use with HTTPS (default is the example value, max age is a year) |
-| `csp` | `{"enable": true, "directives": {"scriptSrc": "trustworthy-scripts.example.com"}, "upgradeInsecureRequests": "auto", "addDefaults": true}` | Configures [Content Security Policy](https://helmetjs.github.io/docs/csp/). Directives are passed to Helmet - see [their documentation](https://helmetjs.github.io/docs/csp/) for more information on the format. Some defaults are added to the configured values so that the application doesn't break. To disable this behaviour, set `addDefaults` to `false`. Further, if `usecdn` is on, some CDN locations are allowed too. By default (`auto`), insecure (HTTP) requests are upgraded to HTTPS via CSP if `usessl` is on. To change this behaviour, set `upgradeInsecureRequests` to either `true` or `false`. |
-| `protocolusessl` | `true` or `false` | set to use SSL protocol for resources path (only applied when domain is set) |
-| `urladdport` | `true` or `false` | set to add port on callback URL (ports `80` or `443` won't be applied) (only applied when domain is set) |
-| `usecdn` | `true` or `false` | set to use CDN resources or not (default is `true`) |
-| `allowanonymous` | `true` or `false` | set to allow anonymous usage (default is `true`) |
-| `allowanonymousedits` | `true` or `false` | if `allowanonymous` is `true`: allow users to select `freely` permission, allowing guests to edit existing notes (default is `false`) |
-| `allowfreeurl` | `true` or `false` | set to allow new note creation by accessing a nonexistent note URL |
-| `defaultpermission` | `freely`, `editable`, `limited`, `locked`, `protected` or `private` | set notes default permission (only applied on signed users) |
-| `dburl` | `mysql://localhost:3306/database` | set the db URL; if set, then db config (below) won't be applied |
+| `csp` | `{"enable": true, "directives": {"scriptSrc": "trustworthy-scripts.example.com"}, "upgradeInsecureRequests": "auto", "addDefaults": true}` | Configures [Content Security Policy](https://helmetjs.github.io/docs/csp/). Directives are passed to Helmet - see [their documentation](https://helmetjs.github.io/docs/csp/) for more information on the format. Some defaults are added to the configured values so that the application doesn't break. To disable this behaviour, set `addDefaults` to `false`. Further, if `usecdn` is on, some CDN locations are allowed too. By default (`auto`), insecure (HTTP) requests are upgraded to HTTPS via CSP if `useSSL` is on. To change this behaviour, set `upgradeInsecureRequests` to either `true` or `false`. |
+| `protocolUseSSL` | `true` or `false` | set to use SSL protocol for resources path (only applied when domain is set) |
+| `urlAddPort` | `true` or `false` | set to add port on callback URL (ports `80` or `443` won't be applied) (only applied when domain is set) |
+| `useCDN` | `true` or `false` | set to use CDN resources or not (default is `true`) |
+| `allowAnonymous` | `true` or `false` | set to allow anonymous usage (default is `true`) |
+| `allowAnonymousEdits` | `true` or `false` | if `allowAnonymous` is `true`: allow users to select `freely` permission, allowing guests to edit existing notes (default is `false`) |
+| `allowFreeURL` | `true` or `false` | set to allow new note creation by accessing a nonexistent note URL |
+| `defaultPermission` | `freely`, `editable`, `limited`, `locked`, `protected` or `private` | set notes default permission (only applied on signed users) |
+| `dbURL` | `mysql://localhost:3306/database` | set the db URL; if set, then db config (below) won't be applied |
 | `db` | `{ "dialect": "sqlite", "storage": "./db.hackmd.sqlite" }` | set the db configs, [see more here](http://sequelize.readthedocs.org/en/latest/api/sequelize/) |
-| `sslkeypath` | `./cert/client.key` | SSL key path (only need when you set `usessl`) |
-| `sslcertpath` | `./cert/hackmd_io.crt` | SSL cert path (only need when you set `usessl`) |
-| `sslcapath` | `['./cert/COMODORSAAddTrustCA.crt']` | SSL ca chain (only need when you set `usessl`) |
-| `dhparampath` | `./cert/dhparam.pem` | SSL dhparam path (only need when you set `usessl`) |
-| `tmppath` | `./tmp/` | temp directory path |
-| `defaultnotepath` | `./public/default.md` | default note file path |
-| `docspath` | `./public/docs` | docs directory path |
-| `indexpath` | `./public/views/index.ejs` | index template file path |
-| `hackmdpath` | `./public/views/hackmd.ejs` | hackmd template file path |
-| `errorpath` | `./public/views/error.ejs` | error template file path |
-| `prettypath` | `./public/views/pretty.ejs` | pretty template file path |
-| `slidepath` | `./public/views/slide.hbs` | slide template file path |
-| `sessionname` | `connect.sid` | cookie session name |
-| `sessionsecret` | `secret` | cookie session secret |
-| `sessionlife` | `14 * 24 * 60 * 60 * 1000` | cookie session life |
-| `staticcachetime` | `1 * 24 * 60 * 60 * 1000` | static file cache time |
-| `heartbeatinterval` | `5000` | socket.io heartbeat interval |
-| `heartbeattimeout` | `10000` | socket.io heartbeat timeout |
-| `documentmaxlength` | `100000` | note max length |
+| `sslKeyPath` | `./cert/client.key` | SSL key path (only need when you set `useSSL`) |
+| `sslCertPath` | `./cert/hackmd_io.crt` | SSL cert path (only need when you set `useSSL`) |
+| `sslCAPath` | `['./cert/COMODORSAAddTrustCA.crt']` | SSL ca chain (only need when you set `useSSL`) |
+| `dhParamPath` | `./cert/dhparam.pem` | SSL dhparam path (only need when you set `useSSL`) |
+| `tmpPath` | `./tmp/` | temp directory path |
+| `defaultNotePath` | `./public/default.md` | default note file path |
+| `docsPath` | `./public/docs` | docs directory path |
+| `indexPath` | `./public/views/index.ejs` | index template file path |
+| `hackmdPath` | `./public/views/hackmd.ejs` | hackmd template file path |
+| `errorPath` | `./public/views/error.ejs` | error template file path |
+| `prettyPath` | `./public/views/pretty.ejs` | pretty template file path |
+| `slidePath` | `./public/views/slide.hbs` | slide template file path |
+| `sessionName` | `connect.sid` | cookie session name |
+| `sessionSecret` | `secret` | cookie session secret |
+| `sessionLife` | `14 * 24 * 60 * 60 * 1000` | cookie session life |
+| `staticCacheTime` | `1 * 24 * 60 * 60 * 1000` | static file cache time |
+| `heartbeatInterval` | `5000` | socket.io heartbeat interval |
+| `heartbeatTimeout` | `10000` | socket.io heartbeat timeout |
+| `documentMaxLength` | `100000` | note max length |
 | `email` | `true` or `false` | set to allow email signin |
-| `allowemailregister`  | `true` or `false` | set to allow email register (only applied when email is set, default is `true`. Note `bin/manage_users` might help you if registration is `false`.) |
-| `imageuploadtype` | `imgur`(default), `s3`, `minio` or `filesystem` | Where to upload image
-| `minio` | `{ "accessKey": "YOUR_MINIO_ACCESS_KEY", "secretKey": "YOUR_MINIO_SECRET_KEY", "endpoint": "YOUR_MINIO_HOST", port: 9000, secure: true }` | When `imageuploadtype` is set to `minio`, you need to set this key. Also checkout our [Minio Image Upload Guide](docs/guides/minio-image-upload.md) |
+| `allowEmailRegister`  | `true` or `false` | set to allow email register (only applied when email is set, default is `true`. Note `bin/manage_users` might help you if registration is `false`.) |
+| `imageUploadType` | `imgur`(default), `s3`, `minio` or `filesystem` | Where to upload image
+| `minio` | `{ "accessKey": "YOUR_MINIO_ACCESS_KEY", "secretKey": "YOUR_MINIO_SECRET_KEY", "endpoint": "YOUR_MINIO_HOST", port: 9000, secure: true }` | When `imageUploadType` is set to `minio`, you need to set this key. Also checkout our [Minio Image Upload Guide](docs/guides/minio-image-upload.md) |
 | `s3` | `{ "accessKeyId": "YOUR_S3_ACCESS_KEY_ID", "secretAccessKey": "YOUR_S3_ACCESS_KEY", "region": "YOUR_S3_REGION" }` | When `imageuploadtype` be set to `s3`, you would also need to setup this key, check our [S3 Image Upload Guide](docs/guides/s3-image-upload.md) |
-| `s3bucket` | `YOUR_S3_BUCKET_NAME` | bucket name when `imageuploadtype` is set to `s3` or `minio` |
+| `s3bucket` | `YOUR_S3_BUCKET_NAME` | bucket name when `imageUploadType` is set to `s3` or `minio` |
 
 ## Third-party integration API key settings
 

diff --git a/app.js b/app.js
@@ -30,7 +30,7 @@ var csp = require('./lib/csp')
 var constpath = path.join(__dirname, './public/js/lib/common/constant.ejs')
 var data = {
   domain: config.domain,
-  urlpath: config.urlpath,
+  urlpath: config.urlPath,
   debug: config.debug,
   version: config.version,
   GOOGLE_API_KEY: config.google.clientSecret,
@@ -47,20 +47,20 @@ ejs.renderFile(constpath, data, {}, function (err, str) {
 // server setup
 var app = express()
 var server = null
-if (config.usessl) {
+if (config.useSSL) {
   var ca = (function () {
     var i, len, results
     results = []
-    for (i = 0, len = config.sslcapath.length; i < len; i++) {
-      results.push(fs.readFileSync(config.sslcapath[i], 'utf8'))
+    for (i = 0, len = config.sslCAPath.length; i < len; i++) {
+      results.push(fs.readFileSync(config.sslCAPath[i], 'utf8'))
     }
     return results
   })()
   var options = {
-    key: fs.readFileSync(config.sslkeypath, 'utf8'),
-    cert: fs.readFileSync(config.sslcertpath, 'utf8'),
+    key: fs.readFileSync(config.sslKeyPath, 'utf8'),
+    cert: fs.readFileSync(config.sslCertPath, 'utf8'),
     ca: ca,
-    dhparam: fs.readFileSync(config.dhparampath, 'utf8'),
+    dhparam: fs.readFileSync(config.dhParamPath, 'utf8'),
     requestCert: false,
     rejectUnauthorized: false
   }
@@ -105,7 +105,7 @@ if (config.hsts.enable) {
     includeSubdomains: config.hsts.includeSubdomains,
     preload: config.hsts.preload
   }))
-} else if (config.usessl) {
+} else if (config.useSSL) {
   logger.info('Consider enabling HSTS for extra security:')
   logger.info('https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security')
 }
@@ -142,17 +142,17 @@ app.use(i18n.init)
 
 // routes without sessions
 // static files
-app.use('/', express.static(path.join(__dirname, '/public'), { maxAge: config.staticcachetime }))
+app.use('/', express.static(path.join(__dirname, '/public'), { maxAge: config.staticCacheTime }))
 
 // session
 app.use(session({
-  name: config.sessionname,
-  secret: config.sessionsecret,
+  name: config.sessionName,
+  secret: config.sessionSecret,
   resave: false, // don't save session if unmodified
   saveUninitialized: true, // always create session to ensure the origin
   rolling: true, // reset maxAge on every response
   cookie: {
-    maxAge: config.sessionlife
+    maxAge: config.sessionLife
   },
   store: sessionStore
 }))
@@ -207,22 +207,22 @@ io.use(realtime.secure)
 // socket.io auth
 io.use(passportSocketIo.authorize({
   cookieParser: cookieParser,
-  key: config.sessionname,
-  secret: config.sessionsecret,
+  key: config.sessionName,
+  secret: config.sessionSecret,
   store: sessionStore,
   success: realtime.onAuthorizeSuccess,
   fail: realtime.onAuthorizeFail
 }))
 // socket.io heartbeat
-io.set('heartbeat interval', config.heartbeatinterval)
-io.set('heartbeat timeout', config.heartbeattimeout)
+io.set('heartbeat interval', config.heartbeatInterval)
+io.set('heartbeat timeout', config.heartbeatTimeout)
 // socket.io connection
 io.sockets.on('connection', realtime.connection)
 
 // listen
 function startListen () {
   server.listen(config.port, function () {
-    var schema = config.usessl ? 'HTTPS' : 'HTTP'
+    var schema = config.useSSL ? 'HTTPS' : 'HTTP'
     logger.info('%s Server listening at port %d', schema, config.port)
     realtime.maintenance = false
   })

diff --git a/lib/config/default.js b/lib/config/default.js
@@ -2,11 +2,11 @@
 
 module.exports = {
   domain: '',
-  urlpath: '',
+  urlPath: '',
   port: 3000,
-  urladdport: false,
-  alloworigin: ['localhost'],
-  usessl: false,
+  urlAddPort: false,
+  allowOrigin: ['localhost'],
+  useSSL: false,
   hsts: {
     enable: true,
     maxAgeSeconds: 31536000,
@@ -21,42 +21,40 @@ module.exports = {
     upgradeInsecureRequests: 'auto',
     reportURI: undefined
   },
-  protocolusessl: false,
-  usecdn: true,
-  allowanonymous: true,
-  allowanonymousedits: false,
-  allowfreeurl: false,
-  defaultpermission: 'editable',
-  dburl: '',
+  protocolUseSSL: false,
+  useCDN: true,
+  allowAnonymous: true,
+  allowAnonymousEdits: false,
+  allowFreeURL: false,
+  defaultPermission: 'editable',
+  dbURL: '',
   db: {},
   // ssl path
-  sslkeypath: '',
-  sslcertpath: '',
-  sslcapath: '',
-  dhparampath: '',
+  sslKeyPath: '',
+  sslCertPath: '',
+  sslCAPath: '',
+  dhParamPath: '',
   // other path
-  tmppath: './tmp',
-  defaultnotepath: './public/default.md',
-  docspath: './public/docs',
-  indexpath: './public/views/index.ejs',
-  hackmdpath: './public/views/hackmd.ejs',
-  errorpath: './public/views/error.ejs',
-  prettypath: './public/views/pretty.ejs',
-  slidepath: './public/views/slide.ejs',
+  tmpPath: './tmp',
+  defaultNotePath: './public/default.md',
+  docsPath: './public/docs',
+  indexPath: './public/views/index.ejs',
+  hackmdPath: './public/views/hackmd.ejs',
+  errorPath: './public/views/error.ejs',
+  prettyPath: './public/views/pretty.ejs',
+  slidePath: './public/views/slide.ejs',
   // session
-  sessionname: 'connect.sid',
-  sessionsecret: 'secret',
-  sessionlife: 14 * 24 * 60 * 60 * 1000, // 14 days
-  staticcachetime: 1 * 24 * 60 * 60 * 1000, // 1 day
+  sessionName: 'connect.sid',
+  sessionSecret: 'secret',
+  sessionLife: 14 * 24 * 60 * 60 * 1000, // 14 days
+  staticCacheTime: 1 * 24 * 60 * 60 * 1000, // 1 day
   // socket.io
-  heartbeatinterval: 5000,
-  heartbeattimeout: 10000,
+  heartbeatInterval: 5000,
+  heartbeatTimeout: 10000,
   // document
-  documentmaxlength: 100000,
+  documentMaxLength: 100000,
   // image upload setting, available options are imgur/s3/filesystem
-  imageuploadtype: 'filesystem',
-  // legacy variable name for imageuploadtype
-  imageUploadType: undefined,
+  imageUploadType: 'filesystem',
   imgur: {
     clientID: undefined
   },
@@ -133,6 +131,6 @@ module.exports = {
     }
   },
   email: true,
-  allowemailregister: true,
-  allowpdfexport: true
+  allowEmailRegister: true,
+  allowPDFExport: true
 }
diff --git a/lib/config/environment.js b/lib/config/environment.js
@@ -4,10 +4,10 @@ const {toBooleanConfig, toArrayConfig, toIntegerConfig} = require('./utils')
 
 module.exports = {
   domain: process.env.HMD_DOMAIN,
-  urlpath: process.env.HMD_URL_PATH,
+  urlPath: process.env.HMD_URL_PATH,
   port: toIntegerConfig(process.env.HMD_PORT),
-  urladdport: toBooleanConfig(process.env.HMD_URL_ADDPORT),
-  usessl: toBooleanConfig(process.env.HMD_USESSL),
+  urlAddPort: toBooleanConfig(process.env.HMD_URL_ADDPORT),
+  useSSL: toBooleanConfig(process.env.HMD_USESSL),
   hsts: {
     enable: toBooleanConfig(process.env.HMD_HSTS_ENABLE),
     maxAgeSeconds: process.env.HMD_HSTS_MAX_AGE,
@@ -18,15 +18,15 @@ module.exports = {
     enable: toBooleanConfig(process.env.HMD_CSP_ENABLE),
     reportURI: process.env.HMD_CSP_REPORTURI
   },
-  protocolusessl: toBooleanConfig(process.env.HMD_PROTOCOL_USESSL),
-  alloworigin: toArrayConfig(process.env.HMD_ALLOW_ORIGIN),
-  usecdn: toBooleanConfig(process.env.HMD_USECDN),
-  allowanonymous: toBooleanConfig(process.env.HMD_ALLOW_ANONYMOUS),
-  allowanonymousedits: toBooleanConfig(process.env.HMD_ALLOW_ANONYMOUS_EDITS),
-  allowfreeurl: toBooleanConfig(process.env.HMD_ALLOW_FREEURL),
-  defaultpermission: process.env.HMD_DEFAULT_PERMISSION,
-  dburl: process.env.HMD_DB_URL,
-  imageuploadtype: process.env.HMD_IMAGE_UPLOAD_TYPE,
+  protocolUseSSL: toBooleanConfig(process.env.HMD_PROTOCOL_USESSL),
+  allowOrigin: toArrayConfig(process.env.HMD_ALLOW_ORIGIN),
+  useCDN: toBooleanConfig(process.env.HMD_USECDN),
+  allowAnonymous: toBooleanConfig(process.env.HMD_ALLOW_ANONYMOUS),
+  allowAnonymousEdits: toBooleanConfig(process.env.HMD_ALLOW_ANONYMOUS_EDITS),
+  allowFreeURL: toBooleanConfig(process.env.HMD_ALLOW_FREEURL),
+  defaultPermission: process.env.HMD_DEFAULT_PERMISSION,
+  dbURL: process.env.HMD_DB_URL,
+  imageUploadType: process.env.HMD_IMAGE_UPLOAD_TYPE,
   imgur: {
     clientID: process.env.HMD_IMGUR_CLIENTID
   },
@@ -102,6 +102,6 @@ module.exports = {
     }
   },
   email: toBooleanConfig(process.env.HMD_EMAIL),
-  allowemailregister: toBooleanConfig(process.env.HMD_ALLOW_EMAIL_REGISTER),
-  allowpdfexport: toBooleanConfig(process.env.HMD_ALLOW_PDF_EXPORT)
+  allowEmailRegister: toBooleanConfig(process.env.HMD_ALLOW_EMAIL_REGISTER),
+  allowPDFExport: toBooleanConfig(process.env.HMD_ALLOW_PDF_EXPORT)
 }