bin: Convert all CLI flags to be kebab-case

Author: Matt Farmer

README.md

@@ -167,7 +167,7 @@ $ solid start --help
 
     --root [value]                Root folder to serve (default: './data')
     --port [value]                SSL port to use
-    --serverUri [value]           Solid server uri (default: 'https://localhost:8443')
+    --server-uri [value]          Solid server uri (default: 'https://localhost:8443')
     --webid                       Enable WebID authentication and access control (uses HTTPS)
     --mount [value]               Serve on a specific URL path (default: '/')
     --config-path [value]
@@ -182,7 +182,7 @@ $ solid start --help
     --idp [value]                 Obsolete; use --multiuser
     --no-live                     Disable live support through WebSockets
     --proxy [value]               Obsolete; use --corsProxy
-    --corsProxy [value]           Serve the CORS proxy on this path
+    --cors-proxy [value]          Serve the CORS proxy on this path
     --suppress-data-browser       Suppress provision of a data browser
     --data-browser-path [value]   An HTML file which is sent to allow users to browse the data (eg using mashlib.js)
     --suffix-acl [value]          Suffix for acl files (default: '.acl')
@@ -191,12 +191,12 @@ $ solid start --help
     --error-pages [value]         Folder from which to look for custom error pages files (files must be named <error-code>.html -- eg. 500.html)
     --force-user [value]          Force a WebID to always be logged in (useful when offline)
     --strict-origin               Enforce same origin policy in the ACL
-    --useEmail                    Do you want to set up an email service?
+    --use-email                   Do you want to set up an email service?
     --email-host [value]          Host of your email service
     --email-port [value]          Port of your email service
     --email-auth-user [value]     User of your email service
     --email-auth-pass [value]     Password of your email service
-    --useApiApps                  Do you want to load your default apps on /api/apps?
+    --use-api-apps                Do you want to load your default apps on /api/apps?
     --api-apps [value]            Path to the folder to mount on /api/apps
     --redirect-http-from [value]  HTTP port or ','-separated ports to redirect to the solid server port (e.g. "80,8080").
     --server-name [value]         A name for your server (not required, but will be presented on your server's frontpage)

bin/lib/options.js

@@ -26,7 +26,7 @@ module.exports = [
     prompt: true
   },
   {
-    name: 'serverUri',
+    name: 'server-uri',
     question: 'Solid server uri (with protocol, hostname and port)',
     help: "Solid server uri (default: 'https://localhost:8443')",
     default: 'https://localhost:8443',
@@ -84,7 +84,7 @@ module.exports = [
     }
   },
   {
-    name: 'useOwner',
+    name: 'use-owner',
     question: 'Do you already have a WebID?',
     type: 'confirm',
     default: false,
@@ -148,7 +148,7 @@ module.exports = [
   //   help: 'URI to use as a default app for resources (default: https://linkeddata.github.io/warp/#/list/)'
   // },
   {
-    name: 'useCorsProxy',
+    name: 'use-cors-proxy',
     help: 'Do you want to have a CORS proxy endpoint?',
     flag: true,
     default: false,
@@ -160,7 +160,7 @@ module.exports = [
     prompt: false
   },
   {
-    name: 'corsProxy',
+    name: 'cors-proxy',
     help: 'Serve the CORS proxy on this path',
     when: function (answers) {
       return answers.useCorsProxy
@@ -169,7 +169,7 @@ module.exports = [
     prompt: true
   },
   {
-    name: 'authProxy',
+    name: 'auth-proxy',
     help: 'Object with path/server pairs to reverse proxy',
     default: {},
     prompt: false,
@@ -241,7 +241,7 @@ module.exports = [
     prompt: false
   },
   {
-    name: 'useEmail',
+    name: 'use-email',
     help: 'Do you want to set up an email service?',
     flag: true,
     prompt: true,
@@ -289,7 +289,7 @@ module.exports = [
     }
   },
   {
-    name: 'useApiApps',
+    name: 'use-api-apps',
     help: 'Do you want to load your default apps on /api/apps?',
     flag: true,
     prompt: false,
@@ -337,15 +337,15 @@ module.exports = [
     prompt: true
   },
   {
-    name: 'enforceToc',
+    name: 'enforce-toc',
     help: 'Do you want to enforce Terms & Conditions for your service?',
     flag: true,
     prompt: true,
     default: true,
     when: answers => answers.multiuser
   },
   {
-    name: 'tocUri',
+    name: 'toc-uri',
     help: 'URI to your Terms & Conditions',
     prompt: true,
     validate: validUri,

test/unit/options.js

@@ -0,0 +1,18 @@
+var assert = require('chai').assert
+
+var options = require('../../bin/lib/options')
+
+describe('Command line options', function () {
+  describe('options', function () {
+    it('is an array', function () {
+      assert.equal(Array.isArray(options), true)
+    })
+
+    it('contains only `name`s that are kebab-case', function () {
+      assert.equal(
+        options.every(({name}) => (/^[a-z][a-z0-9-]*$/).test(name)),
+        true
+      )
+    })
+  })
+})