improved contribution guide for parameter groups

Author: mtrezza

CONTRIBUTING.md

@@ -189,11 +189,13 @@ Introducing new Parse Errors requires the following steps:
 Introducing new [Parse Server configuration][config] parameters requires the following steps:
 
 1. Add parameters definitions in [/src/Options/index.js][config-index].
-1. If a nested configuration object has been added, add the environment variable option prefix to `getENVPrefix` in [/resources/buildConfigDefinition.js](https://github.com/parse-community/parse-server/blob/master/resources/buildConfigDefinition.js).
-1. Execute `npm run definitions` to automatically create the definitions in [/src/Options/Definitions.js][config-def] and [/src/Options/docs.js][config-docs].
-1. Add parameter value validation in [/src/Config.js](https://github.com/parse-community/parse-server/blob/master/src/Config.js).
-1. Add test cases to ensure the correct parameter value validation. Parse Server throws an error at launch if an invalid value is set for any configuration parameter.
-1. Execute `npm run docs` to generate the documentation in the `/out` directory. Take a look at the documentation whether the description and formatting of the newly introduced parameters is satisfactory.
+2. If a parameter group (nested parameter) has been added:
+   - add the environment variable prefix for the parameter group to `nestedOptionEnvPrefix` in [/resources/buildConfigDefinition.js](https://github.com/parse-community/parse-server/blob/master/resources/buildConfigDefinition.js)
+   - add the parameter group type to `nestedOptionTypes` in [/resources/buildConfigDefinition.js](https://github.com/parse-community/parse-server/blob/master/resources/buildConfigDefinition.js)
+3. Execute `npm run definitions` to automatically create the definitions in [/src/Options/Definitions.js][config-def] and [/src/Options/docs.js][config-docs].
+4. Add parameter value validation in [/src/Config.js](https://github.com/parse-community/parse-server/blob/master/src/Config.js).
+5. Add test cases to ensure the correct parameter value validation. Parse Server throws an error at launch if an invalid value is set for any configuration parameter.
+6. Execute `npm run docs` to generate the documentation in the `/out` directory. Take a look at the documentation whether the description and formatting of the newly introduced parameters is satisfactory.
 
 ## Code of Conduct
 

resources/buildConfigDefinitions.js

@@ -11,6 +11,31 @@
  */
 const parsers = require('../src/Options/parsers');
 
+// The types of nested options.
+const nestedOptionTypes = [
+  'Object',
+  'PasswordPolicyOptions',
+  'IdempotencyOptions',
+  'FileUploadOptions',
+  'CustomPagesOptions',
+  'PagesCustomUrlsOptions',
+  'PagesOptions'
+];
+
+// The prefix of environment variables for nested options.
+const nestedOptionEnvPrefix = {
+  'ParseServerOptions' : 'PARSE_SERVER_',
+  'PagesOptions' : 'PARSE_SERVER_PAGES_',
+  'PagesCustomUrlsOptions' : 'PARSE_SERVER_PAGES_CUSTOM_URL_',
+  'CustomPagesOptions' : 'PARSE_SERVER_CUSTOM_PAGES_',
+  'LiveQueryServerOptions' : 'PARSE_LIVE_QUERY_SERVER_',
+  'LiveQueryOptions' : 'PARSE_SERVER_LIVEQUERY_',
+  'IdempotencyOptions' : 'PARSE_SERVER_EXPERIMENTAL_IDEMPOTENCY_',
+  'AccountLockoutOptions' : 'PARSE_SERVER_ACCOUNT_LOCKOUT_',
+  'PasswordPolicyOptions' : 'PARSE_SERVER_PASSWORD_POLICY_',
+  'FileUploadOptions' : 'PARSE_SERVER_FILE_UPLOAD_',
+}
+
 function last(array) {
   return array[array.length - 1];
 }
@@ -40,20 +65,8 @@ function getCommentValue(comment) {
 }
 
 function getENVPrefix(iface) {
-  const options = {
-    'ParseServerOptions' : 'PARSE_SERVER_',
-    'PagesOptions' : 'PARSE_SERVER_PAGES_',
-    'PagesCustomUrlsOptions' : 'PARSE_SERVER_PAGES_CUSTOM_URL_',
-    'CustomPagesOptions' : 'PARSE_SERVER_CUSTOM_PAGES_',
-    'LiveQueryServerOptions' : 'PARSE_LIVE_QUERY_SERVER_',
-    'LiveQueryOptions' : 'PARSE_SERVER_LIVEQUERY_',
-    'IdempotencyOptions' : 'PARSE_SERVER_EXPERIMENTAL_IDEMPOTENCY_',
-    'AccountLockoutOptions' : 'PARSE_SERVER_ACCOUNT_LOCKOUT_',
-    'PasswordPolicyOptions' : 'PARSE_SERVER_PASSWORD_POLICY_',
-    'FileUploadOptions' : 'PARSE_SERVER_FILE_UPLOAD_',
-  }
-  if (options[iface.id.name]) {
-    return options[iface.id.name]
+  if (nestedOptionEnvPrefix[iface.id.name]) {
+    return nestedOptionEnvPrefix[iface.id.name]
   }
 }
 
@@ -166,8 +179,7 @@ function parseDefaultValue(elt, value, t) {
     if (type == 'NumberOrBoolean') {
       literalValue = t.numericLiteral(parsers.numberOrBoolParser('')(value));
     }
-    const literalTypes = ['Object', 'IdempotencyOptions','FileUploadOptions','CustomPagesOptions', 'PagesCustomUrlsOptions', 'PagesOptions'];
-    if (literalTypes.includes(type)) {
+    if (nestedOptionTypes.includes(type)) {
       const object = parsers.objectParser(value);
       const props = Object.keys(object).map((key) => {
         return t.objectProperty(key, object[value]);