Skip to content

Commit

Permalink
feat: rename packspec field to packspec_version
Browse files Browse the repository at this point in the history
  • Loading branch information
mjlbach committed Apr 17, 2022
1 parent 93475e4 commit 682e9bd
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 48 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The Neovim package specification supports a single, top-level package metadata f

* `version` (String) the version of the package. Should obey semantic versioning conventions, for example `0.1.0`. Plugins should have a git commit with a `tag` matching this version. For all version identifiers, implementation should check for a `version` prefixed with `v` in the git repository, as this is a common convention.

* `packspec` (String) the current specification version. (0.1.0) at this time.
* `packspec_version` (String) the current specification version. (0.1.0) at this time.

* `source` (String) The URL of the package source archive. Examples: "http://github.com/downloads/keplerproject/wsapi/wsapi-1.3.4.tar.gz", "git://github.com/keplerproject/wsapi.git". Different protocols are supported:

Expand Down Expand Up @@ -57,7 +57,7 @@ The Neovim package specification supports a single, top-level package metadata f
```lua
package = "lspconfig"
version = "0.1.2"
specification_version = "0.1.0"
packspec_version = "0.1.0"
source = "git://github.com/neovim/nvim-lspconfig.git",
description = {
summary = "Quickstart configurations for the Nvim-lsp client",
Expand Down Expand Up @@ -89,7 +89,7 @@ And in json format
{
"package" : "lspconfig",
"version" : "0.1.2",
"specification_version" : "0.1.0",
"packspec_version" : "0.1.0",
"source" : "git://github.com/neovim/nvim-lspconfig.git",
"description" : {
"summary" : "Quickstart configurations for the Nvim-lsp client",
Expand Down
2 changes: 1 addition & 1 deletion examples/packspec.1.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"package" : "lspconfig",
"version" : "0.1.2",
"packspec": "0.1.0",
"packspec_version": "0.1.0",
"$schema": "https://raw.githubusercontent.com/nvim-lua/nvim-package-specification/master/schema/packspec_schema.json",
"source" : "git://github.com/neovim/nvim-lspconfig.git",
"description" : {
Expand Down
2 changes: 1 addition & 1 deletion examples/packspec.1.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package = "lspconfig"
version = "0.1.2"
packspec = "0.1.0"
packspec_version = "0.1.0"
source = "git://github.com/neovim/nvim-lspconfig.git"
description = {
summary = "Quickstart configurations for the Nvim-lsp client",
Expand Down
2 changes: 1 addition & 1 deletion lua/packspec/schema.lua
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ return {
type = "string",
pattern = PAT_VERSION,
},
packspec = {
packspec_version = {
description = "The current specification version. (0.1.0) at this time.",
type = "string",
pattern = PAT_VERSION,
Expand Down
84 changes: 42 additions & 42 deletions schema/packspec_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,43 @@
"source"
],
"properties": {
"packspec": {
"type": "string",
"description": "The current specification version. (0.1.0) at this time.",
"pattern": "^(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))*$"
"description": {
"properties": {
"summary": {
"description": "Short description of the package, typically less than 100 character\nlong.",
"type": "string"
},
"homepage": {
"description": "Homepage of the package. In most cases this will be the GitHub URL.",
"type": "string"
},
"author": {
"properties": {
"name": {
"description": "Author name",
"type": "string"
},
"email": {
"description": "Author email",
"type": "string"
}
},
"type": "object",
"description": "Author of the package",
"additionalProperties": false
},
"license": {
"description": "This is [SPDX](https:\/\/spdx.org\/licenses\/) license identifier. Dual\nlicensing is indicated via joining the relevant licenses via `\/`.",
"type": "string"
},
"detailed": {
"description": "Long-form description of the package, this should convey the\npackage's principal functionality to the user without being as\ndetailed as the package readme.",
"type": "string"
}
},
"type": "object",
"description": "Description of the package",
"additionalProperties": false
},
"dependencies": {
"patternProperties": {
Expand Down Expand Up @@ -60,43 +93,10 @@
"description": "The name of the package",
"type": "string"
},
"description": {
"properties": {
"summary": {
"description": "Short description of the package, typically less than 100 character\nlong.",
"type": "string"
},
"homepage": {
"description": "Homepage of the package. In most cases this will be the GitHub URL.",
"type": "string"
},
"author": {
"properties": {
"name": {
"description": "Author name",
"type": "string"
},
"email": {
"description": "Author email",
"type": "string"
}
},
"type": "object",
"description": "Author of the package",
"additionalProperties": false
},
"license": {
"description": "This is [SPDX](https:\/\/spdx.org\/licenses\/) license identifier. Dual\nlicensing is indicated via joining the relevant licenses via `\/`.",
"type": "string"
},
"detailed": {
"description": "Long-form description of the package, this should convey the\npackage's principal functionality to the user without being as\ndetailed as the package readme.",
"type": "string"
}
},
"type": "object",
"description": "Description of the package",
"additionalProperties": false
"packspec_version": {
"type": "string",
"description": "The current specification version. (0.1.0) at this time.",
"pattern": "^(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))*$"
},
"source": {
"pattern": "^\\w+:\/\/",
Expand All @@ -114,4 +114,4 @@
},
"additionalProperties": false,
"description": "A package specification for Neovim"
}
}

0 comments on commit 682e9bd

Please sign in to comment.