Address second round of comments on f3d-app#2845

Author: skusel

.github/workflows/style-checks.yml

@@ -56,10 +56,8 @@ jobs:
           prettier_options: "-w **/*.{js,json,md,html,yml}"
 
       - name: Validate cli-options.json against schema
-        uses: python-jsonschema/check-jsonschema@0.36.1
-        with:
-          files: "resources/cli-options.json"
-          schema: "resources/cli-options.schema.json"
+        shell: bash
+        run: pipx run check-jsonschema==0.36.1 --schemafile resources/cli-options.schema.json resources/cli-options.json
 
       - name: Echo Diff
         shell: bash

application/CMakeLists.txt

@@ -346,12 +346,6 @@ if(UNIX AND NOT APPLE AND NOT ANDROID)
   install(FILES "${F3D_SOURCE_DIR}/resources/logo-mono.svg"
     DESTINATION "share/icons/HighContrast/scalable/apps" COMPONENT assets
     RENAME "f3d.svg")
-  install(FILES
-    "${F3D_SOURCE_DIR}/resources/cli-options.json"
-    "${F3D_SOURCE_DIR}/resources/cli-options.schema.json"
-    DESTINATION "${f3d_resources_dir}"
-    COMPONENT shellext
-  )
   install(FILES "${CMAKE_BINARY_DIR}/completion.bash"
     DESTINATION "share/bash-completion/completions" COMPONENT shellext
     RENAME "f3d")

application/F3DCLIOptions.h.in

@@ -33,6 +33,11 @@ struct CLIGroup
   std::vector<CLIOption> Options;
 };
 
+/**
+ * The CLIOptions array will be generated by CMake from
+ * resources/cli-options.json. To add or update CLI options please update the
+ * JSON file.
+ */
 // clang-format off
 @F3D_CLI_OPTIONS_CPP@
 // clang-format on

cmake/f3dCLIOptions.cmake

@@ -152,7 +152,7 @@ foreach(_si RANGE ${_last_surv})
 
     # use the `*_json_error`s as an indicator of whether the key is present for this option
     if(_long_name_json_error)
-      set(_long_name "")
+      message(FATAL_ERROR "An option was found in ${F3D_SOURCE_DIR}/resources/cli-options.json without a long name")
     endif()
     if(_short_name_json_error)
       set(_short_name "")
@@ -176,26 +176,22 @@ foreach(_si RANGE ${_last_surv})
 
     # generate completion file content for this CLI option
     if(F3D_CLI_OPTIONS_BASH)
-      string(APPEND F3D_CLI_OPTIONS_BASH " ") # bash string uses space separator between options
+      string(APPEND F3D_CLI_OPTIONS_BASH " ") # space separates completion options in bash array
     endif()
     if(F3D_CLI_OPTIONS_FISH)
-      string(APPEND F3D_CLI_OPTIONS_FISH " \\\n") # fish uses a space, escape character, and newline to separate option commands
+      string(APPEND F3D_CLI_OPTIONS_FISH "\n") # newline separates fish completion commands
     endif()
     if(F3D_CLI_OPTIONS_ZSH)
-      string(APPEND F3D_CLI_OPTIONS_ZSH "\n") # zsh uses a new line to separate options in an array
+      string(APPEND F3D_CLI_OPTIONS_ZSH "\n") # newline separates completion options in zsh array
     endif()
     if(_long_name AND _short_name)
       string(APPEND F3D_CLI_OPTIONS_BASH "--${_long_name} -${_short_name}")
-      string(APPEND F3D_CLI_OPTIONS_FISH "    'complete -c f3d -l ${_long_name} -s ${_short_name} -d \"${_help_text}\"'")
+      string(APPEND F3D_CLI_OPTIONS_FISH "complete -c f3d -l ${_long_name} -s ${_short_name} -d \"${_help_text}\"")
       string(APPEND F3D_CLI_OPTIONS_ZSH "  '(-${_short_name} --${_long_name})'{-${_short_name},--${_long_name}}'[${_help_text}]'")
-    elseif(_long_name)
+    else() # _long_name must be set (checked earlier)
       string(APPEND F3D_CLI_OPTIONS_BASH "--${_long_name}")
-      string(APPEND F3D_CLI_OPTIONS_FISH "    'complete -c f3d -l ${_long_name} -d \"${_help_text}\"'")
+      string(APPEND F3D_CLI_OPTIONS_FISH "complete -c f3d -l ${_long_name} -d \"${_help_text}\"")
       string(APPEND F3D_CLI_OPTIONS_ZSH "  '--${_long_name}[${_help_text}]'")
-    elseif(_short_name)
-      string(APPEND F3D_CLI_OPTIONS_BASH "-${_short_name}")
-      string(APPEND F3D_CLI_OPTIONS_FISH "    'complete -c f3d -s ${_short_name} -d \"${_help_text}\"'")
-      string(APPEND F3D_CLI_OPTIONS_ZSH "  '--${_short_name}[${_help_text}]'")
     endif()
 
   endforeach()

resources/cli-options.schema.json

@@ -40,12 +40,13 @@
       "properties": {
         "longName": {
           "type": "string",
-          "minLength": 1,
+          "minLength": 2,
           "description": "Long form of the option (e.g., 'help')"
         },
         "shortName": {
           "type": "string",
           "minLength": 1,
+          "maxLength": 1,
           "description": "Short form of the option (e.g., 'h')"
         },
         "helpText": {
@@ -67,8 +68,7 @@
           "description": "Preprocessor definition that must be defined for this option to be available"
         }
       },
-      "anyOf": [{ "required": ["longName"] }, { "required": ["shortName"] }],
-      "required": ["helpText"],
+      "required": ["longName", "helpText"],
       "additionalProperties": false
     }
   }

resources/completion.fish.in

@@ -1,6 +1 @@
-set -l compl_cmds \
 @F3D_CLI_OPTIONS_FISH@
-    
-for current_cmd in $compl_cmds
-    eval $current_cmd
-end