fix: tlsoption fixed

Author: Raymond Ottun

docs/content/en/start.md

@@ -21,7 +21,7 @@ npx @sayjava/deputy@latest
   <code-block label="Docker">
 
 ```bash
-docker run -p 8080:8080 -p 8081:8081 @sayjava/deputy
+docker run -p 8080:8080 -p 8081:8081 sayjava/deputy
 ```
 
   </code-block>
@@ -39,8 +39,8 @@ This command will:
 | \--port, -p              | DEPUTY_PORT            | 8080      | The port the mock sever runs on                             |
 | \--api-port, -ap         | DEPUTY_API_PORT        | 8081      | The port the api sever runs on                              |
 | \--auto-proxy, -px       | DEPUTY_AUTO_PROXY      | true      | Auto proxy requests                                         |
-| \--tls-enabled, -tls     | DEPUTY_TLS_ENABLED     | undefined | Enables HTTPs and auto generates a self-signed certificate  |
-| \--tls-domains, -domains | DEPUTY_TLS_DOMAINS     | undefined | Domain names that will be included in the certificate       |
+| \--tls-enabled, -tls     | DEPUTY_TLS             | undefined | Enables HTTPs and auto generates a self-signed certificate  |
+| \--tls-domains, -domains | DEPUTY_DOMAINS         | undefined | Domain names that will be included in the certificate       |
 
 ## Initialize Mocks
 

src/deputy.ts

@@ -29,7 +29,7 @@ const logInfo = (config) => {
 
     eth0.forEach((it) => {
         if (it.family === 'IPv4') {
-            const protocol = config.tlsEnabled ? 'https' : 'http';
+            const protocol = config.tls ? 'https' : 'http';
             const table = new Table({ head: ['Description', 'Url'] });
             routes.forEach(([desc, url]) => {
                 table.push([desc, `http://${it.address}:${config.apiPort}${url}`]);
@@ -66,17 +66,16 @@ const args = yargs(hideBin(process.argv))
         describe: 'A directory containing .yml files  definitions',
         default: process.env.DEPUTY_MOCKS_DIRECTORY || 'mocks',
     })
-    .option('tls-enabled', {
+    .option('tls', {
         type: 'boolean',
-        alias: 'tls',
         describe: 'Enable HTTPS, Auto generate ssl certificates',
-        default: process.env.DEPUTY_TSL_ENABLED || false,
+        default: process.env.DEPUTY_TLS || false,
     })
-    .option('tls-domains', {
+    .option('domains', {
         type: 'string',
         alias: 'domains',
         describe: 'Specify domain to auto-generate certification for. localhost is auto included',
-        default: process.env.DEPUTY_TSL_DOMAINS ? process.env.DEPUTY_TSL_DOMAINS.split(',') : [],
+        default: process.env.DEPUTY_DOMAINS || '',
     }).argv;
 
 const startServer = async () => {

src/server/index.ts

@@ -20,8 +20,8 @@ const defaultConfig: DeputyConfig = {
     apiPort: 8081,
     proxy: true,
     mocksDirectory: 'mocks',
-    tlsEnabled: false,
-    tslDomains: '',
+    tls: false,
+    domains: '',
 };
 
 const createExpress = (): Express => {
@@ -73,7 +73,7 @@ export const createMockServer = async ({ engine, config }) => {
     const SERVER_TIMEOUT = 4000;
     const onTimeOut = () => logger.error('Request Timeout');
 
-    if (config.tlsEnabled) {
+    if (config.tls) {
         const { cert, key } = await loadSSLCerts({ domains: config.tlsDomains });
         return https.createServer({ key, cert }, server).setTimeout(SERVER_TIMEOUT, onTimeOut);
     } else {
@@ -82,7 +82,7 @@ export const createMockServer = async ({ engine, config }) => {
 };
 
 export const createServer = async (argConfig: DeputyConfig): Promise<App> => {
-    const tlsDomains = (argConfig.tslDomains || '').split(',');
+    const tlsDomains = (argConfig.domains || '').split(',');
     const config = Object.assign({}, defaultConfig, argConfig, { tlsDomains });
     const engine = createEngine(config);
 

src/types.ts

@@ -137,9 +137,9 @@ export interface DeputyConfig {
     apiPort?: number;
     port?: number;
     mocksDirectory?: string;
-    tlsEnabled?: boolean;
+    tls?: boolean;
     proxy?: boolean;
-    tslDomains?: string;
+    domains?: string;
 }
 
 export interface MiddlewareConfig extends DeputyConfig {