Skip to content

Commit

Permalink
Use markdown for rendering descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@rchl
rchl committed Mar 19, 2020
1 parent 50ea24e commit af3b3d4
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 162 deletions.
38 changes: 19 additions & 19 deletions schemas/sublime-build.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@
"properties": {
"selector": {
"type": "string",
"description": "The base scope name of the syntax that this build system should be enabled for."
"markdownDescription": "The base scope name of the syntax that this build system should be enabled for."
},
"file_patterns": {
"description": "A list of file name patterns the build system should be enabled for.",
"markdownDescription": "A list of file name patterns the build system should be enabled for.",
"type": "array",
"items": {
"type": "string"
}
},
"keyfiles": {
"description": "A list of file names, if present in one of the opened folders, that will cause the build system to be enabled.",
"markdownDescription": "A list of file names, if present in one of the opened folders, that will cause the build system to be enabled.",
"type": "array",
"items": {
"type": "string"
}
},
"variants": {
"description": "A list of subsidiary build systems that will inherit the options from the top-level build system. Each variant needs to specify a `name` key, and may override or add options to the top-level build system",
"markdownDescription": "A list of subsidiary build systems that will inherit the options from the top-level build system. Each variant needs to specify a `name` key, and may override or add options to the top-level build system",
"type": "array",
"items": {
"allOf": [
Expand All @@ -41,80 +41,80 @@
}
},
"cancel": {
"description": "A string command name, or an object of string options. If a string is specified, the command specified will be used to cancel the build. If an object, the primary target will be called, with these options added on. This only needs to be specified when using a custom `target`.",
"markdownDescription": "A string command name, or an object of string options. If a string is specified, the command specified will be used to cancel the build. If an object, the primary target will be called, with these options added on. This only needs to be specified when using a custom `target`.",
"type": ["string", "object"]
},
"target": {
"description": "The command to run when the build system is invoked. The default value of exec allows use of the additional options specified in [exec Target Options](https://www.sublimetext.com/docs/3/build_systems.html#exec_options). If a value other than `exec` is specified, none of the options in exec Target Options will do anything. See the [Advanced Example](https://www.sublimetext.com/docs/3/build_systems.html#advanced_example) for a complete example.",
"markdownDescription": "The command to run when the build system is invoked. The default value of exec allows use of the additional options specified in [exec Target Options](https://www.sublimetext.com/docs/3/build_systems.html#exec_options). If a value other than `exec` is specified, none of the options in exec Target Options will do anything. See the [Advanced Example](https://www.sublimetext.com/docs/3/build_systems.html#advanced_example) for a complete example.",
"type": "string"
},
"windows": {
"allOf": [
{"$ref": "#"},
{
"description": "An object of options to use when the build system is being executed on a Windows machine.\nExample:\n```\n{\n\t\"cmd\": [\"my_command.exe\", \"/D\", \"$file\"]\n}\n```"
"markdownDescription": "An object of options to use when the build system is being executed on a Windows machine.\nExample:\n```\n{\n\t\"cmd\": [\"my_command.exe\", \"/D\", \"$file\"]\n}\n```"
}
]
},
"osx": {
"allOf": [
{"$ref": "#"},
{
"description": "An object of options to use when the build system is being executed on a Mac machine.\nExample:\n```\n{\n\t\"cmd\": [\"/Applications/MyProgram.app/Contents/MacOS/my_command\", \"-d\", \"$file\"]\n}"
"markdownDescription": "An object of options to use when the build system is being executed on a Mac machine.\nExample:\n```\n{\n\t\"cmd\": [\"/Applications/MyProgram.app/Contents/MacOS/my_command\", \"-d\", \"$file\"]\n}"
}
]
},
"linux": {
"allOf": [
{"$ref": "#"},
{
"description": "An object of options to use when the build system is being executed on a Linux machine.\nExample:\n```\n{\n\t\"cmd\": [\"/usr/local/bin/my_command\", \"-d\", \"$file\"]\n}"
"markdownDescription": "An object of options to use when the build system is being executed on a Linux machine.\nExample:\n```\n{\n\t\"cmd\": [\"/usr/local/bin/my_command\", \"-d\", \"$file\"]\n}"
}
]
},
"cmd": {
"description": "A list of strings specifying the executable to run, plus any arguments to pass to it. Shell constructs such as piping and redirection are not supported – see [shell_cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-shell_cmd). May use [variables](https://www.sublimetext.com/docs/3/build_systems.html#variables).",
"markdownDescription": "A list of strings specifying the executable to run, plus any arguments to pass to it. Shell constructs such as piping and redirection are not supported – see [shell_cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-shell_cmd). May use [variables](https://www.sublimetext.com/docs/3/build_systems.html#variables).",
"type": "array",
"items": {
"type": "string"
}
},
"shell_cmd": {
"description": "A string specifying a shell command to execute. Unlike the [cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-cmd) option, this does allow piping and redirection. Will use `bash` on Mac and Linux machine, and `cmd.exe` on Windows. May use [variables](https://www.sublimetext.com/docs/3/build_systems.html#variables).\nExample: `\"my_command \\\"$file\\\" | other_command\"`",
"markdownDescription": "A string specifying a shell command to execute. Unlike the [cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-cmd) option, this does allow piping and redirection. Will use `bash` on Mac and Linux machine, and `cmd.exe` on Windows. May use [variables](https://www.sublimetext.com/docs/3/build_systems.html#variables).\nExample: `\"my_command \\\"$file\\\" | other_command\"`",
"type": "string"
},
"working_dir": {
"description": "A string specifying the directory to execute the [cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-cmd) or [shell_cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-shell_cmd) within. May use [variables](https://www.sublimetext.com/docs/3/build_systems.html#variables).\nExample: `\"$file_path\"`",
"markdownDescription": "A string specifying the directory to execute the [cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-cmd) or [shell_cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-shell_cmd) within. May use [variables](https://www.sublimetext.com/docs/3/build_systems.html#variables).\nExample: `\"$file_path\"`",
"type": "string"
},
"file_regex": {
"description": "A string containing a regular expression to run on the build output to match file information. The matched file information is used to enable result navigation. The regex should capture 2, 3 or 4 groups.\n\nThe capture groups should be:\n\n1. filename\n2. line number\n3. column number\n4. message\n\nExample: `\"^\\s*(\\S[^:]*)\\((\\d+):(\\d+)\\): ([^\\n]+)\"`",
"markdownDescription": "A string containing a regular expression to run on the build output to match file information. The matched file information is used to enable result navigation. The regex should capture 2, 3 or 4 groups.\n\nThe capture groups should be:\n\n1. filename\n2. line number\n3. column number\n4. message\n\nExample: `\"^\\s*(\\S[^:]*)\\((\\d+):(\\d+)\\): ([^\\n]+)\"`",
"type": "string",
"format": "regex"
},
"line_regex": {
"description": "A string containing a regular expression to run on the build output to match line information. The matched file information is used to enable result navigation. The regex should capture 1, 2 or 3 groups.\n\nThe groups should capture:\n\n1.line number\n2. column number\n3. error message\n\nThis regular expression is only necessary when some results contain strictly a line number, line and column numbers, or line and column numbers with a message. When such a match is made, the [file_regex](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-file_regex) option will be used to search backwards to find the appropriate file name.\n\nExample: `\"^\\s*line (\\d+) col (\\d+): ([^\\n]+)\"",
"markdownDescription": "A string containing a regular expression to run on the build output to match line information. The matched file information is used to enable result navigation. The regex should capture 1, 2 or 3 groups.\n\nThe groups should capture:\n\n1.line number\n2. column number\n3. error message\n\nThis regular expression is only necessary when some results contain strictly a line number, line and column numbers, or line and column numbers with a message. When such a match is made, the [file_regex](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-file_regex) option will be used to search backwards to find the appropriate file name.\n\nExample: `\"^\\s*line (\\d+) col (\\d+): ([^\\n]+)\"",
"type": "string",
"format": "regex"
},
"encoding": {
"description": "A string specifying the encoding of the build system output. Uses [Python codec names](https://docs.python.org/3.3/library/codecs.html#id3). Defaults to `\"utf-8\"`.\n\nExample: `\"iso-8859-1\"`",
"markdownDescription": "A string specifying the encoding of the build system output. Uses [Python codec names](https://docs.python.org/3.3/library/codecs.html#id3). Defaults to `\"utf-8\"`.\n\nExample: `\"iso-8859-1\"`",
"type": "string"
},
"env": {
"description": "An object containing environment variable values to use when running the [cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-cmd) or [shell_cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-shell_cmd).\nExample:\n```\n{\n\t\"PYTHONIOENCODING\": \"utf-8\"\n}",
"markdownDescription": "An object containing environment variable values to use when running the [cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-cmd) or [shell_cmd](https://www.sublimetext.com/docs/3/build_systems.html#exec_option-shell_cmd).\nExample:\n```\n{\n\t\"PYTHONIOENCODING\": \"utf-8\"\n}",
"type": "object"
},
"quiet": {
"description": "A boolean that reduces the amount of output about the build system invocation.",
"markdownDescription": "A boolean that reduces the amount of output about the build system invocation.",
"type": "boolean"
},
"word_wrap": {
"description": "A boolean that turns on word wrapping in the build system output panel.",
"markdownDescription": "A boolean that turns on word wrapping in the build system output panel.",
"type": "boolean"
},
"syntax": {
"description": "A string specifying the syntax file to use to highlight the build system output panel.\nExample: `\"Packages/JavaScript/JSON.sublime-syntax\"`",
"markdownDescription": "A string specifying the syntax file to use to highlight the build system output panel.\nExample: `\"Packages/JavaScript/JSON.sublime-syntax\"`",
"type": "string",
"pattern": "^Packages/.+\\.(sublime-syntax|tmLanguage)"
}
Expand Down
22 changes: 11 additions & 11 deletions schemas/sublime-project.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,59 +8,59 @@
"properties": {
"additionalProperties": false,
"folders": {
"description": "List of folders added to the project",
"markdownDescription": "List of folders added to the project",
"type": "array",
"items": {
"type": "object",
"properties": {
"additionalProperties": false,
"path": {
"description": "A path of a project folder.",
"markdownDescription": "A path of a project folder.",
"type": "string"
},
"name": {
"description": "A string used in place of the folder name in the side bar.",
"markdownDescription": "A string used in place of the folder name in the side bar.",
"type": "string"
},
"file_include_patterns": {
"description": "A list of filenames to include from the folder. Anything not matching these patterns will be excluded. This is checked before `file_exclude_patterns`.",
"markdownDescription": "A list of filenames to include from the folder. Anything not matching these patterns will be excluded. This is checked before `file_exclude_patterns`.",
"type": "array",
"items": {
"type": "string"
}
},
"file_exclude_patterns": {
"description": "A list of strings for filenames to exclude from the folder. This is added to the global setting of the same name. This is checked after `file_include_patterns`.",
"markdownDescription": "A list of strings for filenames to exclude from the folder. This is added to the global setting of the same name. This is checked after `file_include_patterns`.",
"type": "array",
"items": {"type": "string", "examples": ["Hello", "World"]}
},
"folder_include_patterns": {
"description": "A list of strings for subfolder paths to include from the folder. Anything not matching these patterns will be excluded. This is checked before `folder_exclude_patterns`.",
"markdownDescription": "A list of strings for subfolder paths to include from the folder. Anything not matching these patterns will be excluded. This is checked before `folder_exclude_patterns`.",
"type": "array",
"items": {"type": "string"}
},
"folder_exclude_patterns": {
"description": "A list of strings for subfolder paths to exclude from the folder. This is added to the global setting of the same name. This is checked after `folder_include_patterns`.",
"markdownDescription": "A list of strings for subfolder paths to exclude from the folder. This is added to the global setting of the same name. This is checked after `folder_include_patterns`.",
"type": "array",
"items": {"type": "string"}
},
"binary_file_patterns": {
"description": "A list of strings for filenames to treat as binary files, and thus ignored in _Goto Anything_ or _Find in Files_.",
"markdownDescription": "A list of strings for filenames to treat as binary files, and thus ignored in _Goto Anything_ or _Find in Files_.",
"type": "array",
"items": {"type": "string"}
},
"index_include_patterns": {
"description": "A list of strings for full file paths to index in the folder. This is added to the global setting of the same name. Anything not matching these patterns will be excluded from the index. This is checked before `index_exclude_patterns`.",
"markdownDescription": "A list of strings for full file paths to index in the folder. This is added to the global setting of the same name. Anything not matching these patterns will be excluded from the index. This is checked before `index_exclude_patterns`.",
"type": "array",
"items": {"type": "string"}
},
"index_exclude_patterns": {
"description": "A list of strings for file full paths to index in the folder. This is added to the global setting of the same name. This is checked after `index_include_patterns`.",
"markdownDescription": "A list of strings for file full paths to index in the folder. This is added to the global setting of the same name. This is checked after `index_include_patterns`.",
"type": "array",
"items": {"type": "string"}
},
"follow_symlinks": {
"description": "If symlinks should be followed when building the folder tree.",
"markdownDescription": "If symlinks should be followed when building the folder tree.",
"type": "boolean"
}
}
Expand Down
Loading

0 comments on commit af3b3d4

Please sign in to comment.