nvim-scissors 项目教程

nvim-scissors 项目教程

nvim-scissors Automagical editing and creation of snippets. 项目地址: https://gitcode.com/gh_mirrors/nv/nvim-scissors

1. 项目的目录结构及介绍

nvim-scissors 项目是一个为 Neovim 编辑器提供自动编辑和创建代码片段功能的插件。项目的目录结构如下：

• .github/
  • 存放 GitHub 工作流和配置文件。
• doc/
  • 包含项目文档和说明。
• lua/scissors/
  • 包含插件的 Lua 代码。
• plugin/
  • 包含 Neovim 插件文件。
• .editorconfig
  • 定义代码风格配置。
• .gitignore
  • 指定 Git 忽略的文件和目录。
• .luarc.json
  • Lua 配置文件。
• .markdownlint.yaml
  • Markdown 语法检查配置。
• .stylua.toml
  • Lua 代码格式化工具配置。
• LICENSE
  • 项目许可证文件。
• README.md
  • 项目说明文件。

2. 项目的启动文件介绍

nvim-scissors 插件的启动主要是通过 Neovim 的配置文件（通常是 init.vim 或 init.lua）来完成的。用户需要在 Neovim 配置文件中添加插件的引入和配置代码。以下是一个基本的启动文件示例：

-- 使用 lazy.nvim 管理插件
lazy.nvim({
  "chrisgrieser/nvim-scissors",
  dependencies = "nvim-telescope/telescope.nvim",
  opts = {
    snippetDir = "path/to/your/snippetFolder",
  }
})

-- 或者使用 packer 管理插件
packer.use({
  "chrisgrieser/nvim-scissors",
  dependencies = "nvim-telescope/telescope.nvim",
  config = function()
    require("scissors").setup({
      snippetDir = vim.fn.stdpath("config") .. "/snippets",
    })
  end
})

用户需要替换 "path/to/your/snippetFolder" 为实际的代码片段文件夹路径。

3. 项目的配置文件介绍

nvim-scissors 插件的配置主要是通过 .luarc.json 文件进行的，该文件可以放置在 Neovim 的配置目录中。以下是一个基本的配置文件示例：

{
  "scissors": {
    "snippetDir": "/path/to/your/snippetFolder",
    "editSnippetPopup": {
      "height": 0.4,
      "width": 0.6,
      "border": "rounded",
      "keymaps": {
        "cancel": "q",
        "saveChanges": "<CR>",
        "goBackToSearch": "<BS>",
        "deleteSnippet": "<C-BS>",
        "duplicateSnippet": "<C-d>",
        "openInFile": "<C-o>",
        "insertNextPlaceholder": "<C-p>",
        "showHelp": "?"
      }
    },
    "snippetSelection": {
      "picker": "auto",
      "telescope": {
        "alsoSearchSnippetBody": false,
        "opts": {
          "layout_strategy": "horizontal",
          "layout_config": {
            "horizontal": {
              "width": 0.9
            },
            "preview_width": 0.6
          }
        }
      }
    }
  }
}

用户同样需要替换 /path/to/your/snippetFolder 为实际的代码片段文件夹路径。配置文件中的其他设置可以根据用户的偏好进行调整。

nvim-scissors Automagical editing and creation of snippets. 项目地址: https://gitcode.com/gh_mirrors/nv/nvim-scissors