feat: add first sketch of CommandTOptions type alias

Author: wincent

lua/wincent/commandt/private/options/schema.lua

@@ -4,6 +4,50 @@
 local is_table = require('wincent.commandt.private.is_table')
 local types = require('wincent.commandt.private.options.types')
 
+---@alias CommandTOptions {
+---  always_show_dot_files?: boolean,
+---  finders?: table<string, {
+---    candidates?: (fun(): string[]) | string[],
+---    mode?: ModeOption,
+---    on_close?: fun(),
+---    on_directory?: fun(),
+---    options?: fun(),
+---    command?: fun() | string,
+---    fallback?: boolean,
+---    max_files?: (fun(): number) | number,
+---    open?: fun(),
+---  }>,
+---  height?: number,
+---  ignore_case?: boolean | fun(),
+---  mappings?: MappingsOption,
+---  margin?: number,
+---  match_listing?: {
+---    border?: BorderOption,
+---    icons?: boolean | fun(),
+---    truncate?: TruncateOption,
+---  },
+---  never_show_dot_files?: boolean,
+---  order?: OrderOption,
+---  position?: PositionOption,
+---  prompt?: {
+---    border?: BorderOption,
+---  },
+---  open?: fun(),
+---  root_markers?: string[],
+---  scanners?: {
+---    fd?: { max_files?: number },
+---    find?: { max_files?: number },
+---    file?: { max_files?: number },
+---    git?: { max_files?: number, submodules?: boolean, untracked?: boolean },
+---    rg?: { max_files?: number },
+---    tag?: { include_filenames?: boolean },
+---  },
+---  selection_highlight?: string,
+---  smart_case?: boolean | fun(),
+---  threads?: number,
+---  traverse?: TraverseOption,
+---}
+
 local schema = {
   kind = 'table',
   keys = {
@@ -25,15 +69,7 @@ local schema = {
             },
             optional = true,
           },
-          mode = {
-            kind = {
-              one_of = {
-                'file',
-                'virtual',
-              },
-            },
-            optional = true,
-          },
+          mode = types.mode,
           on_close = {
             kind = 'function',
             optional = true,
@@ -118,7 +154,7 @@ local schema = {
       },
     },
     never_show_dot_files = { kind = 'boolean' },
-    order = { kind = { one_of = { 'forward', 'reverse' } } },
+    order = types.order,
     position = types.position,
     prompt = {
       kind = 'table',
@@ -211,7 +247,7 @@ local schema = {
       kind = 'number',
       optional = true,
     },
-    traverse = { kind = { one_of = { 'file', 'pwd', 'none' } } },
+    traverse = types.traverse,
   },
   meta = function(t)
     if t.always_show_dot_files == true and t.never_show_dot_files == true then

lua/wincent/commandt/private/options/types.lua

@@ -27,9 +27,36 @@ local border = {
   },
 }
 
+---@alias MappingsOption {
+---    i?: table<string, string>,
+---    n?: table<string, string>
+---}
+local mappings = {
+  kind = 'table',
+  keys = {
+    i = {
+      kind = 'table',
+      values = { kind = 'string' },
+    },
+    n = {
+      kind = 'table',
+      values = { kind = 'string' },
+    },
+  },
+}
+
+---@alias ModeOption 'file' | 'virtual'
+local mode = { kind = { one_of = { 'file', 'virtual' } }, optional = true }
+
+---@alias OrderOption 'forward' | 'reverse'
+local order = { kind = { one_of = { 'forward', 'reverse' } } }
+
 ---@alias PositionOption 'bottom' | 'center' | 'top'
 local position = { kind = { one_of = { 'bottom', 'center', 'top' } } }
 
+---@alias TraverseOption 'file' | 'pwd' | 'none'
+local traverse = { kind = { one_of = { 'file', 'pwd', 'none' } } }
+
 ---@alias TruncateOption
 ---| 'beginning'
 ---| 'middle'
@@ -50,24 +77,6 @@ local truncate = {
   },
 }
 
----@alias MappingsOption {
----    i?: table<string, string>,
----    n?: table<string, string>
----}
-local mappings = {
-  kind = 'table',
-  keys = {
-    i = {
-      kind = 'table',
-      values = { kind = 'string' },
-    },
-    n = {
-      kind = 'table',
-      values = { kind = 'string' },
-    },
-  },
-}
-
 return {
   border = border,
   height = {
@@ -89,6 +98,9 @@ return {
       end
     end,
   },
+  mode = mode,
+  order = order,
   position = position,
+  traverse = traverse,
   truncate = truncate,
 }

lua/wincent/commandt/private/ui.lua

@@ -7,6 +7,7 @@ local MatchListing = require('wincent.commandt.private.match_listing')
 local Prompt = require('wincent.commandt.private.prompt')
 local Settings = require('wincent.commandt.private.settings')
 local validate = require('wincent.commandt.private.validate')
+local types = require('wincent.commandt.private.options.types')
 
 -- Reverses `list` in place.
 local reverse = function(list)
@@ -95,13 +96,7 @@ end
 local schema = {
   kind = 'table',
   keys = {
-    mode = { kind = {
-      one_of = {
-        'file',
-        'virtual',
-      },
-      optional = true,
-    } },
+    mode = types.mode,
     name = { kind = 'string' },
     on_close = { kind = 'function', optional = true },
     on_open = { kind = 'function', optional = true },