yaml-companion.nvim 使用教程

yaml-companion.nvim 使用教程

yaml-companion.nvimGet, set and autodetect YAML schemas in your buffers.项目地址:https://gitcode.com/gh_mirrors/ya/yaml-companion.nvim

项目介绍

yaml-companion.nvim 是一个用于 Neovim 的插件，旨在帮助用户在编辑 YAML 文件时自动检测和设置 YAML 模式。这个插件通过与 nvim-lspconfig 和 telescope.nvim 等其他插件集成，提供了强大的 YAML 文件编辑支持。

项目快速启动

安装

使用 Packer 进行安装：

use {
  "someone-stole-my-name/yaml-companion.nvim",
  requires = {
    { "neovim/nvim-lspconfig" },
    { "nvim-lua/plenary.nvim" },
    { "nvim-telescope/telescope.nvim" }
  },
  config = function()
    require("telescope").load_extension("yaml_schema")
  end
}

配置

在 Neovim 配置文件中添加以下内容：

require("yaml-companion").setup {
  builtin_matchers = {
    kubernetes = { enabled = true },
    cloud_init = { enabled = true }
  },
  schemas = {
    {
      name = "Kubernetes 1.22.4",
      uri = "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.22.4-standalone-strict/all.json"
    }
  }
}

应用案例和最佳实践

案例一：Kubernetes 配置文件编辑

假设你正在编辑一个 Kubernetes 部署文件，yaml-companion.nvim 可以自动检测到这是一个 Kubernetes 文件，并应用相应的模式，提供代码补全和验证功能。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: example-deployment
spec:
  replicas: 3
  selector:
    matchLabels:
      app: example
  template:
    metadata:
      labels:
        app: example
    spec:
      containers:
      - name: example-container
        image: example-image:latest
        ports:
        - containerPort: 80

案例二：Cloud Init 配置文件编辑

在编辑 Cloud Init 配置文件时，yaml-companion.nvim 同样可以自动检测并应用相应的模式。

#cloud-config
users:
  - name: exampleuser
    sudo: ALL=(ALL) NOPASSWD:ALL
    groups: users, admin
    ssh-authorized-keys:
      - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...

典型生态项目

nvim-lspconfig

nvim-lspconfig 是 Neovim 的 LSP 配置插件，提供了对多种语言服务器的支持，是 yaml-companion.nvim 的核心依赖之一。

telescope.nvim

telescope.nvim 是一个强大的模糊查找器，与 yaml-companion.nvim 集成后，可以方便地选择和应用 YAML 模式。

plenary.nvim

plenary.nvim 是一个包含了许多有用函数的 Neovim 插件，为 yaml-companion.nvim 提供了额外的功能支持。

通过这些生态项目的协同工作，yaml-companion.nvim 提供了完整且高效的 YAML 文件编辑体验。

yaml-companion.nvimGet, set and autodetect YAML schemas in your buffers.项目地址:https://gitcode.com/gh_mirrors/ya/yaml-companion.nvim