vim-addon-info

vim plugin addon-info.json metadata files

Type object
File match **/*vim*/addon-info.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/vim-addon-info/latest.json
Source https://www.schemastore.org/vim-addon-info.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

name string

The name of the plugin. Used by plugin managers and some introspection tools. Generally corresponds to the name of the repository but without "vim" prefix/suffix.

Examples: "surround.vim", "nerdtree", "maktaba"
version string

Dotted version number of the plugin, generally in semantic versioning scheme.

Default: "0.0.1"
Examples: "0.0.1", "2.0"
description string

Short description of the plugin and what it does (a sentence or two)

homepage string

Primary homepage of the plugin.

format=uri
author string

Name of the person or organization that created the plugin

Examples: "Priya Exampleton", "Example Industries"
maintainer string

Name of the person who maintains the plugin

Examples: "Priya Exampleton"
repository object

Info for the plugin itself. Describes where the canonical copy of the plugin can be fetched from.

3 nested properties
type enum
Values: "hg" "git" "svn" "bzr"
url string
Examples: "git://github.com/tpope/vim-surround"
format=uri
deprecated string

For a deprecated plugin, a deprecation message to be shown to any user who installs the plugin.

dependencies Record<string, object>

Plugins that are strictly required for the plugin to work, where keys are plugin names and values may describe where plugins can be fetched from.

Definitions

url string
Examples:
  • "git://github.com/tpope/vim-surround"
repoType enum
selfRepository object

Info for the plugin itself. Describes where the canonical copy of the plugin can be fetched from.

type enum
Values: "hg" "git" "svn" "bzr"
url string
Examples: "git://github.com/tpope/vim-surround"
format=uri
deprecated string

For a deprecated plugin, a deprecation message to be shown to any user who installs the plugin.

otherRepository object

Info about a plugin/repository outside this one.

homepage string

Primary homepage of the plugin.

format=uri
addon-info