Merge pull request #146 from DannyBen/fix/port-bind-config

Fix config.port and config.bind
DannyBen · Mar 9, 2023 · 7a7d7a5 · 7a7d7a5
2 parents 037e576 + ed5e02e
commit 7a7d7a5
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 14 deletions.
diff --git a/lib/madness/commands/server.rb b/lib/madness/commands/server.rb
@@ -6,13 +6,13 @@ class Server < Base
       usage 'madness server [PATH] [options]'
       usage 'madness init (-h|--help)'
 
-      param 'PATH', 'Path to the markdown directory [default: .]'
+      param 'PATH', 'Path to the markdown directory (default: .)'
 
-      option '-p --port NUMBER', 'Set server port number [default: 3000]'
-      option '-b --bind ADDRESS', 'Set server listen address [default: 0.0.0.0]'
+      option '-p --port NUMBER', 'Set server port number (default: 3000)'
+      option '-b --bind ADDRESS', 'Set server listen address (default: 0.0.0.0)'
       option '-o --open', 'Open a web browser after launching'
       option '--auth USER:PASS', 'Enable basic authentication'
-      option '--auth-zone NAME', 'The basic authentication prompt title [default: Restricted Documentation]'
+      option '--auth-zone NAME', 'The basic authentication realm (default: Restricted Documentation)'
       option '--theme FOLDER', 'Use a custom theme (either absolute or relative to the main documentation path)'
 
       example 'madness server'

diff --git a/spec/approvals/cli/config/show-non-default b/spec/approvals/cli/config/show-non-default
@@ -10,7 +10,7 @@
            copy_code:  true
           shortlinks:  ~
                  toc:  Table of Contents
-               theme:  ~
+               theme:  my_theme
                 open:  ~
                 auth:  ~
            auth_zone:  Restricted Documentation

diff --git a/spec/approvals/cli/server/help b/spec/approvals/cli/server/help
@@ -6,10 +6,10 @@ Usage:
 
 Options:
   -p --port NUMBER
-    Set server port number [default: 3000]
+    Set server port number (default: 3000)
 
   -b --bind ADDRESS
-    Set server listen address [default: 0.0.0.0]
+    Set server listen address (default: 0.0.0.0)
 
   -o --open
     Open a web browser after launching
@@ -18,7 +18,7 @@ Options:
     Enable basic authentication
 
   --auth-zone NAME
-    The basic authentication prompt title [default: Restricted Documentation]
+    The basic authentication realm (default: Restricted Documentation)
 
   --theme FOLDER
     Use a custom theme (either absolute or relative to the main documentation
@@ -29,7 +29,7 @@ Options:
 
 Parameters:
   PATH
-    Path to the markdown directory [default: .]
+    Path to the markdown directory (default: .)
 
 Examples:
   madness server

diff --git a/spec/approvals/cli/server/run-with-config b/spec/approvals/cli/server/run-with-config
@@ -1,7 +1,8 @@
 ▌ generating Table of Contents
 ▌ starting server
 ▌ env    : production
-▌ listen : 0.0.0.0:3000
+▌ listen : 4.3.2.1:1337
 ▌ path   : ...docs
 ▌ config : .madness.yml
+▌ theme  : my_theme
 
diff --git a/spec/fixtures/docroot-with-config/.madness.yml b/spec/fixtures/docroot-with-config/.madness.yml
@@ -1,6 +1,7 @@
 # .madness.yml
-path: 'docs'
-port: '1337'
-bind: '4.3.2.1'
+path: docs
+port: 1337
+bind: 4.3.2.1
 toc: Table of Contents
-invalid_key: with some value
+invalid_key: with some value
+theme: my_theme