Class: Toys::Completion::FileSystem

Inherits:
Base
  • Object
show all
Defined in:
core-docs/toys/completion.rb

Overview

Defined in the toys-core gem

A Completion that returns candidates from the local file system.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cwd: nil, omit_files: false, omit_directories: false, prefix_constraint: "") ⇒ FileSystem

Create a completion that gets candidates from names in the local file system.

Parameters:

  • cwd (String) (defaults to: nil) —

    Working directory (defaults to the current dir).

  • omit_files (Boolean) (defaults to: false) —

    Omit files from candidates

  • omit_directories (Boolean) (defaults to: false) —

    Omit directories from candidates

  • prefix_constraint (String, Regexp) (defaults to: "") —

    Constraint on the fragment prefix. Defaults to requiring the prefix be empty.



204
205
206
 
# File 'core-docs/toys/completion.rb', line 204

def initialize(cwd: nil, omit_files: false, omit_directories: false, prefix_constraint: "")
  # Source available in the toys-core gem
end

Instance Attribute Details

#cwd ⇒ String (readonly)

Path to the starting directory.

Returns:

  • (String) 


230
231
232
 
# File 'core-docs/toys/completion.rb', line 230

def cwd
  @cwd
end

#include_directories ⇒ Boolean (readonly)

Whether directories are included in the completion candidates.

Returns:

  • (Boolean) 


218
219
220
 
# File 'core-docs/toys/completion.rb', line 218

def include_directories
  @include_directories
end

#include_files ⇒ Boolean (readonly)

Whether files are included in the completion candidates.

Returns:

  • (Boolean) 


212
213
214
 
# File 'core-docs/toys/completion.rb', line 212

def include_files
  @include_files
end

#prefix_constraint ⇒ String, Regexp (readonly)

Constraint on the fragment prefix.

Returns:

  • (String, Regexp) 


224
225
226
 
# File 'core-docs/toys/completion.rb', line 224

def prefix_constraint
  @prefix_constraint
end

Instance Method Details

#call(context) ⇒ Array<Toys::Completion::Candidate>

Returns candidates for the current completion.

Parameters:

Returns:



239
240
241
 
# File 'core-docs/toys/completion.rb', line 239

def call(context)
  # Source available in the toys-core gem
end