Merge pull request #603 from flovilmart/proper-cli
Proper CLI with commander
This commit is contained in:
Drew
110
src/cli/cli-definitions.js
Normal file
110
src/cli/cli-definitions.js
Normal file
@@ -0,0 +1,110 @@
|
||||
export default {
|
||||
"appId": {
|
||||
env: "PARSE_SERVER_APPLICATION_ID",
|
||||
help: "Your Parse Application ID",
|
||||
required: true
|
||||
},
|
||||
"masterKey": {
|
||||
env: "PARSE_SERVER_MASTER_KEY",
|
||||
help: "Your Parse Master Key",
|
||||
required: true
|
||||
},
|
||||
"port": {
|
||||
port: "PORT",
|
||||
help: "The port to run the ParseServer. defaults to 1337.",
|
||||
default: 1337,
|
||||
action: function(opt) {
|
||||
opt = parseInt(opt);
|
||||
if (!Number.isInteger(opt)) {
|
||||
throw new Error("The port is invalid");
|
||||
}
|
||||
return opt;
|
||||
}
|
||||
},
|
||||
"databaseURI": {
|
||||
env: "PARSE_SERVER_DATABASE_URI",
|
||||
help: "The full URI to your mongodb database"
|
||||
},
|
||||
"serverURL": {
|
||||
env: "PARSE_SERVER_URL",
|
||||
help: "URL to your parse server with http:// or https://.",
|
||||
},
|
||||
"clientKey": {
|
||||
env: "PARSE_SERVER_CLIENT_KEY",
|
||||
help: "Key for iOS, MacOS, tvOS clients"
|
||||
},
|
||||
"javascriptKey": {
|
||||
env: "PARSE_SERVER_JAVASCRIPT_KEY",
|
||||
help: "Key for the Javascript SDK"
|
||||
},
|
||||
"restAPIKey": {
|
||||
env: "PARSE_SERVER_REST_API_KEY",
|
||||
help: "Key for REST calls"
|
||||
},
|
||||
"dotNetKey": {
|
||||
env: "PARSE_SERVER_DOT_NET_KEY",
|
||||
help: "Key for Unity and .Net SDK"
|
||||
},
|
||||
"cloud": {
|
||||
env: "PARSE_SERVER_CLOUD_CODE_MAIN",
|
||||
help: "Full path to your cloud code main.js"
|
||||
},
|
||||
"push": {
|
||||
env: "PARSE_SERVER_PUSH",
|
||||
help: "Configuration for push, as stringified JSON. See https://github.com/ParsePlatform/parse-server/wiki/Push",
|
||||
action: function(opt) {
|
||||
return JSON.parse(opt)
|
||||
}
|
||||
},
|
||||
"oauth": {
|
||||
env: "PARSE_SERVER_OAUTH_PROVIDERS",
|
||||
help: "Configuration for your oAuth providers, as stringified JSON. See https://github.com/ParsePlatform/parse-server/wiki/Parse-Server-Guide#oauth",
|
||||
action: function(opt) {
|
||||
return JSON.parse(opt)
|
||||
}
|
||||
},
|
||||
"fileKey": {
|
||||
env: "PARSE_SERVER_FILE_KEY",
|
||||
help: "Key for your files",
|
||||
},
|
||||
"facebookAppIds": {
|
||||
env: "PARSE_SERVER_FACEBOOK_APP_IDS",
|
||||
help: "Comma separated list for your facebook app Ids",
|
||||
type: "list",
|
||||
action: function(opt) {
|
||||
return opt.split(",")
|
||||
}
|
||||
},
|
||||
"enableAnonymousUsers": {
|
||||
env: "PARSE_SERVER_ENABLE_ANON_USERS",
|
||||
help: "Enable (or disable) anon users, defaults to true",
|
||||
action: function(opt) {
|
||||
if (opt == "true" || opt == "1") {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
},
|
||||
"mountPath": {
|
||||
env: "PARSE_SERVER_MOUNT_PATH",
|
||||
help: "Mount path for the server, defaults to /parse",
|
||||
default: "/parse"
|
||||
},
|
||||
"databaseAdapter": {
|
||||
env: "PARSE_SERVER_DATABASE_ADAPTER",
|
||||
help: "Adapter module for the database sub-system"
|
||||
},
|
||||
"filesAdapter": {
|
||||
env: "PARSE_SERVER_FILES_ADAPTER",
|
||||
help: "Adapter module for the files sub-system"
|
||||
},
|
||||
"loggerAdapter": {
|
||||
env: "PARSE_SERVER_LOGGER_ADAPTER",
|
||||
help: "Adapter module for the logging sub-system"
|
||||
},
|
||||
"maxUploadSize": {
|
||||
env: "PARSE_SERVER_MAX_UPLOAD_SIZE",
|
||||
help: "Max file size for uploads.",
|
||||
default: "20mb"
|
||||
}
|
||||
};
|
||||
79
src/cli/parse-server.js
Executable file
79
src/cli/parse-server.js
Executable file
@@ -0,0 +1,79 @@
|
||||
import path from 'path';
|
||||
import express from 'express';
|
||||
import { ParseServer } from '../index';
|
||||
import definitions from './cli-definitions';
|
||||
import program from './utils/commander';
|
||||
import colors from 'colors';
|
||||
|
||||
program.loadDefinitions(definitions);
|
||||
|
||||
program
|
||||
.usage('[options] <path/to/configuration.json>');
|
||||
|
||||
program.on('--help', function(){
|
||||
console.log(' Get Started guide:');
|
||||
console.log('');
|
||||
console.log(' Please have a look at the get started guide!')
|
||||
console.log(' https://github.com/ParsePlatform/parse-server/wiki/Parse-Server-Guide');
|
||||
console.log('');
|
||||
console.log('');
|
||||
console.log(' Usage with npm start');
|
||||
console.log('');
|
||||
console.log(' $ npm start -- path/to/config.json');
|
||||
console.log(' $ npm start -- --appId APP_ID --masterKey MASTER_KEY --serverURL serverURL');
|
||||
console.log(' $ npm start -- --appId APP_ID --masterKey MASTER_KEY --serverURL serverURL');
|
||||
console.log('');
|
||||
console.log('');
|
||||
console.log(' Usage:');
|
||||
console.log('');
|
||||
console.log(' $ parse-server path/to/config.json');
|
||||
console.log(' $ parse-server -- --appId APP_ID --masterKey MASTER_KEY --serverURL serverURL');
|
||||
console.log(' $ parse-server -- --appId APP_ID --masterKey MASTER_KEY --serverURL serverURL');
|
||||
console.log('');
|
||||
});
|
||||
|
||||
program.parse(process.argv, process.env);
|
||||
|
||||
let options;
|
||||
if (program.args.length > 0 ) {
|
||||
let jsonPath = program.args[0];
|
||||
jsonPath = path.resolve(jsonPath);
|
||||
options = require(jsonPath);
|
||||
console.log(`Configuation loaded from ${jsonPath}`)
|
||||
}
|
||||
|
||||
if (!program.appId || !program.masterKey || !program.serverURL) {
|
||||
program.outputHelp();
|
||||
console.error("");
|
||||
console.error(colors.red("ERROR: appId, masterKey and serverURL are required"));
|
||||
console.error("");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
options = Object.keys(definitions).reduce(function (options, key) {
|
||||
if (program[key]) {
|
||||
options[key] = program[key];
|
||||
}
|
||||
return options;
|
||||
}, options);
|
||||
|
||||
if (!options.serverURL) {
|
||||
options.serverURL = `http://localhost:${options.port}${options.mountPath}`;
|
||||
}
|
||||
|
||||
const app = express();
|
||||
const api = new ParseServer(options);
|
||||
app.use(options.mountPath, api);
|
||||
|
||||
app.listen(options.port, function() {
|
||||
|
||||
for (let key in options) {
|
||||
let value = options[key];
|
||||
if (key == "masterKey") {
|
||||
value = "***REDACTED***";
|
||||
}
|
||||
console.log(`${key}: ${value}`);
|
||||
}
|
||||
console.log('');
|
||||
console.log('parse-server running on '+options.serverURL);
|
||||
});
|
||||
85
src/cli/utils/commander.js
Normal file
85
src/cli/utils/commander.js
Normal file
@@ -0,0 +1,85 @@
|
||||
import { Command } from 'commander';
|
||||
|
||||
let _definitions;
|
||||
let _reverseDefinitions;
|
||||
let _defaults;
|
||||
|
||||
Command.prototype.loadDefinitions = function(definitions) {
|
||||
_definitions = definitions;
|
||||
|
||||
Object.keys(definitions).reduce((program, opt) => {
|
||||
if (typeof definitions[opt] == "object") {
|
||||
const additionalOptions = definitions[opt];
|
||||
if (additionalOptions.required === true) {
|
||||
return program.option(`--${opt} <${opt}>`, additionalOptions.help, additionalOptions.action);
|
||||
} else {
|
||||
return program.option(`--${opt} [${opt}]`, additionalOptions.help, additionalOptions.action);
|
||||
}
|
||||
}
|
||||
return program.option(`--${opt} [${opt}]`);
|
||||
}, this);
|
||||
|
||||
_defaults = Object.keys(definitions).reduce((defs, opt) => {
|
||||
if(_definitions[opt].default) {
|
||||
defs[opt] = _definitions[opt].default;
|
||||
}
|
||||
return defs;
|
||||
}, {});
|
||||
|
||||
_reverseDefinitions = Object.keys(definitions).reduce((object, key) => {
|
||||
let value = definitions[key];
|
||||
if (typeof value == "object") {
|
||||
value = value.env;
|
||||
}
|
||||
if (value) {
|
||||
object[value] = key;
|
||||
}
|
||||
return object;
|
||||
}, {});
|
||||
|
||||
/* istanbul ignore next */
|
||||
this.on('--help', function(){
|
||||
console.log(' Configure From Environment:');
|
||||
console.log('');
|
||||
Object.keys(_reverseDefinitions).forEach((key) => {
|
||||
console.log(` $ ${key}='${_reverseDefinitions[key]}'`);
|
||||
});
|
||||
console.log('');
|
||||
});
|
||||
}
|
||||
|
||||
function parseEnvironment(env = {}) {
|
||||
return Object.keys(_reverseDefinitions).reduce((options, key) => {
|
||||
if (env[key]) {
|
||||
const originalKey = _reverseDefinitions[key];
|
||||
let action = (option) => (option);
|
||||
if (typeof _definitions[originalKey] === "object") {
|
||||
action = _definitions[originalKey].action || action;
|
||||
}
|
||||
options[_reverseDefinitions[key]] = action(env[key]);
|
||||
}
|
||||
return options;
|
||||
}, {});
|
||||
}
|
||||
|
||||
Command.prototype.setValuesIfNeeded = function(options) {
|
||||
Object.keys(options).forEach((key) => {
|
||||
if (!this[key]) {
|
||||
this[key] = options[key];
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
Command.prototype._parse = Command.prototype.parse;
|
||||
|
||||
Command.prototype.parse = function(args, env) {
|
||||
this._parse(args);
|
||||
// Parse the environment first
|
||||
const envOptions = parseEnvironment(env);
|
||||
|
||||
// Load the env if not passed from command line
|
||||
this.setValuesIfNeeded(envOptions);
|
||||
this.setValuesIfNeeded(_defaults);
|
||||
}
|
||||
|
||||
export default new Command();
|
||||
Reference in New Issue
Block a user