Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance json schema #353

Merged
10 changes: 10 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"json.schemas": [
{
"fileMatch": [
"programs/*.json"
],
"url": "./json-schema/program.json"
}
]
}
100 changes: 61 additions & 39 deletions json-schema/program.json
Original file line number Diff line number Diff line change
@@ -1,44 +1,66 @@
{
"title": "Program",
"description": "Specification of files or folders in the $HOME folder for a program",
"type": "object",
"properties": {
"name": {
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"empty": {
"type": "string",
"pattern": "^\\s+$"
}
},
"title": "specification",
"description": "A specification of files or folders in the $HOME folder for a program\nhttps://github.com/b3nj5m1n/xdg-ninja",
"type": "object",
"required": ["name", "files"],
"properties": {
"name": {
"title": "name",
"description": "A program name\nRestrictions:\n- can't contain just spaces\nhttps://github.com/b3nj5m1n/xdg-ninja",
"type": "string",
"minLength": 1,
"not": {
"$ref": "#/definitions/empty"
},
"examples": ["abook"]
},
"files": {
"title": "files",
"description": "Files and folders for a program\nhttps://github.com/b3nj5m1n/xdg-ninja",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"description": "A file or a folder for a program\nhttps://github.com/b3nj5m1n/xdg-ninja",
"type": "object",
"required": ["path", "movable", "help"],
"properties": {
"path": {
"title": "path",
"description": "A path to a file or a folder\nRestrictions:\n- can't contain just spaces\nhttps://github.com/b3nj5m1n/xdg-ninja",
"type": "string",
"minLength": 1,
"not": {
"$ref": "#/definitions/empty"
},
"examples": ["$HOME/.abook"]
},
"movable": {
"title": "movable",
"description": "Whether a file or a folder is movable to a place other than $HOME\nhttps://github.com/b3nj5m1n/xdg-ninja",
"type": "boolean"
},
"help": {
"title": "help",
"description": "A help message for a user in markdown\nRestrictions:\n- can't contain just spaces\nhttps://github.com/b3nj5m1n/xdg-ninja",
"type": "string",
"description": "Name of the program",
"minLength": 1
},
"files": {
"description": "List of files (or folders) associated with the program",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Path to file (or folder).",
"minLength": 1
},
"movable": {
"type": "boolean",
"description": "Is file (or folder) movable to a place other than $HOME."
},
"help": {
"type": "string",
"description": "Help text for user. Supports markdown."
}
},
"required": [
"path",
"movable",
"help"
]
"minLength": 1,
"not": {
"$ref": "#/definitions/empty"
},
"minItems": 1
"examples": [
"Alias abook to use custom locations for configuration and data:\n\n```bash\nalias abook=abook --config \"$XDG_CONFIG_HOME\"/abook/abookrc --datafile \"$XDG_DATA_HOME\"/abook/addressbook\n```\n"
]
}
}
},
"required": [
"name",
"files"
]
}
}
}
}
Loading