Pretty Fold.nvim 使用教程

Pretty Fold.nvim 使用教程

pretty-fold.nvim Foldtext customization in Neovim 项目地址: https://gitcode.com/gh_mirrors/pr/pretty-fold.nvim

1. 项目介绍

Pretty Fold.nvim 是一个为 Neovim 设计的 Lua 插件，专注于提供易于定制的折叠文本（foldtext）功能。该插件允许用户根据文件类型和折叠方法进行特定的配置，从而实现高度个性化的折叠文本显示。

主要功能

• 折叠文本定制：提供丰富的配置选项，允许用户自定义折叠文本的显示内容和格式。
• 文件类型特定配置：支持针对不同文件类型的个性化折叠文本配置。
• 折叠方法特定配置：支持针对不同折叠方法（如 marker、expr 等）的个性化配置。

2. 项目快速启动

安装

使用 packer.nvim 进行安装：

use {
  'anuvyklack/pretty-fold.nvim',
  config = function()
    require('pretty-fold').setup()
  end
}

配置

以下是一个简单的配置示例：

require('pretty-fold').setup {
  sections = {
    left = {
      'content',
    },
    right = {
      ' ',
      'number_of_folded_lines',
      ': ',
      'percentage',
      ' ',
      function(config)
        return config.fill_char:rep(3)
      end
    }
  },
  fill_char = '•',
  remove_fold_markers = true,
  keep_indentation = true,
  process_comment_signs = 'spaces',
  comment_signs = {},
  stop_words = { '@brief%s*' },
  add_close_pattern = true,
  matchup_patterns = {
    { '[' , ']' },
    { '%(' , ')' },
    { '%[' , ']' },
  },
  ft_ignore = { 'neorg' },
}

3. 应用案例和最佳实践

案例1：自定义折叠文本

假设你希望在折叠文本中显示折叠的行数和百分比，可以使用以下配置：

require('pretty-fold').setup {
  sections = {
    left = {
      'content',
    },
    right = {
      ' ',
      'number_of_folded_lines',
      ': ',
      'percentage',
      ' ',
      function(config)
        return config.fill_char:rep(3)
      end
    }
  },
  fill_char = '•',
}

案例2：特定文件类型的配置

如果你希望为 Lua 文件类型设置特定的折叠文本配置，可以使用以下代码：

require('pretty-fold').ft_setup('lua', {
  matchup_patterns = {
    { '^%s*do$', 'end' },
    { '^%s*if', 'end' },
    { '^%s*for', 'end' },
    { 'function%s*%(', 'end' },
    { '[', ']' },
    { '%(', ')' },
    { '%[', ']' },
  },
})

4. 典型生态项目

1. Neovim

Pretty Fold.nvim 是 Neovim 生态系统中的一个插件，依赖于 Neovim 的核心功能。Neovim 是一个高度可扩展的文本编辑器，支持 Lua 脚本，非常适合开发者和高级用户使用。

2. Packer.nvim

Packer.nvim 是一个用于管理 Neovim 插件的插件管理器。通过 Packer，用户可以轻松安装、更新和管理 Pretty Fold.nvim 以及其他 Neovim 插件。

3. Fold-Preview.nvim

Fold-Preview.nvim 是另一个与折叠相关的 Neovim 插件，它允许用户在浮动窗口中预览折叠区域的内容。虽然它与 Pretty Fold.nvim 功能不同，但两者可以结合使用，提供更丰富的折叠体验。

通过这些生态项目的结合，用户可以构建一个高度定制化和功能丰富的 Neovim 开发环境。

pretty-fold.nvim Foldtext customization in Neovim 项目地址: https://gitcode.com/gh_mirrors/pr/pretty-fold.nvim