Class: Toys::Completion::FileSystem

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

Overview

A Completion that returns candidates from the local file system.

Defined in the toys-core gem

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cwd: nil, omit_files: false, omit_directories: false) ⇒ 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



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

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

Instance Attribute Details

#cwd ⇒ String (readonly)

Path to the starting directory.

Returns:

  • (String) 


243
244
245
 
# File 'core-docs/toys/completion.rb', line 243

def cwd
  @cwd
end

#include_directories ⇒ boolean (readonly)

Whether directories are included in the completion candidates.

Returns:

  • (boolean) 


237
238
239
 
# File 'core-docs/toys/completion.rb', line 237

def include_directories
  @include_directories
end

#include_files ⇒ boolean (readonly)

Whether files are included in the completion candidates.

Returns:

  • (boolean) 


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

def include_files
  @include_files
end

Instance Method Details

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

Returns candidates for the current completion.

Parameters:

Returns:



252
253
254
 
# File 'core-docs/toys/completion.rb', line 252

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