use std::path::Path;

use crate::matcher::Matcher;

/// Create completion hint for given directory and term. If term is None, return

/// all components of the directory. If term is Some, return the directory

/// component that is the closest fuzzy match to the term.

///

/// # Examples

///

/// ## For Some term

///

/// ```

/// let matcher = cdup::matcher::Matcher::default();

/// let cwd = std::path::Path::new("/home/rsprta/games/angband");

/// let term = Some("ang");

/// let expected = String::from("angband");

///

/// assert_eq!(expected, cdup::hint::completion_for(&matcher, &cwd, term));

/// ```

///

/// ## For None term

/// ```

/// let matcher = cdup::matcher::Matcher::default();

/// let cwd = std::path::Path::new("/home/rsprta/games/angband");

/// let term = None;

/// let expected = String::from("/\nhome\nrsprta\ngames\nangband");

///

/// assert_eq!(expected, cdup::hint::completion_for(&matcher, &cwd, term));

/// ```

            }

        }

    }