🍂 fall-std

A standard library for using Fall, a Vim/Neovim Fuzzy Finder plugin powered by Denops. Users should import this library to use the built-in extensions and utility functions.

Usage

Extensions

Extensions are available in the builtin directory. You can access them like this:

import * as builtin from "jsr:@vim-fall/std/builtin";

// Display all curators
console.log(builtin.curator);

// Display all sources
console.log(builtin.source);

// Display all actions
console.log(builtin.action);

// ...

Utility Functions

Utility functions are defined in the root directory. You can access them like this:

import * as builtin from "jsr:@vim-fall/std/builtin";
import * as std from "jsr:@vim-fall/std";

// Refine a source with refiners
const refinedSource = std.refineSource(
  // File source
  builtin.source.file,
  // Refiner to filter files based on the current working directory
  builtin.refiner.cwd,
  // Refiner to modify item paths to be relative from the current working directory
  builtin.refiner.relativePath,
  // ...
);

More Extensions

For more extensions (including integrations with other Vim plugins, non-standard workflows, etc.), check out vim-fall/fall-extra (@vim-fall/extra).

License

The code in this repository follows the MIT license, as detailed in the LICENSE. Contributors must agree that any modifications submitted to this repository also adhere to the license.

This Markdown version will render properly when used in a Markdown environment. Let me know if you'd like to adjust anything further!