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.

Sign up for GitHub

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

Jump to bottom

docs: add schema.json #175

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add schema.json #175

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions resources/aliae.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"alias": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "the alias name"
},
"value": {
"type": "string",
"description": "the command(s) you want to execute, supports [templating](https://aliae.dev/docs/setup/templates)"
},
"type": {
"type": "string",
"oneOf": [
{
"const": "command",
"description": "a regular alias, value is a one-liner (default)"
},
{
"const": "function",
"description": "a code block to be placed inside a function"
},
{
"const": "git",
"description": "a git alias definition"
}
]
},
"if": {
"type": "string",
"description": "golang [template](https://golang.org/pkg/text/template/) conditional statement, see [if](https://aliae.dev/docs/setup/if)"
}
},
"required": [
"name",
"value"
]
}
},
"env": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "the variable name"
},
"value": {
"type": "string",
"description": "the variable value, supports [templating](https://aliae.dev/docs/setup/templates)"
},
"delimiter": {
"type": "string",
"description": "if you want to join an array of string values (separated by newlines), supports [templating](https://aliae.dev/docs/setup/templates)"
},
"if": {
"type": "string",
"description": "golang template conditional statement, see if"
},
"persist": {
"type": "boolean",
"description": "if you want to persist the environment variable into the registry for the current user (Windows only)"
},
"type": {
"type": "string",
"description": "type to export to",
"enum": [
"string",
"array"
]
}
}
},
"path": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "the path entires you want to add, separated by a newline. Supports [templating](https://aliae.dev/docs/setup/templates)"
},
"if": {
"type": "string",
"description": "golang [template](https://golang.org/pkg/text/template/) conditional statement, see [if](https://aliae.dev/docs/setup/if)"
},
"persist": {
"type": "boolean",
"description": "if you want to persist the environment variable into the registry for the current user (Windows only)"
},
"force": {
"type": "boolean",
"description": "if you want to always export the path even if it already exists in your current shell"
}
}
}
},
"script": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "the script you want to load. Supports [templating](https://aliae.dev/docs/setup/templates)"
},
"if": {
"type": "string",
"description": "golang [template](https://golang.org/pkg/text/template/) conditional statement, see [if](https://aliae.dev/docs/setup/if)"
}
}
}
}
}
}
}