package.json
{
"name": "yard",
"displayName": "YARD Documenter",
"description": "Document Ruby source code with YARD",
"version": "0.4.0",
"publisher": "pavlitsky",
"engines": {
"vscode": "^1.18.0"
},
"lincense": "SEE LICENSE IN LICENSE.txt",
"keywords": [
"documentation",
"ruby",
"rails",
"yard",
"snippet"
],
"author": {
"name": "Vitaly Pavlitsky"
},
"categories": [
"Snippets",
"Other"
],
"galleryBanner": {
"color": "#333333",
"theme": "dark"
},
"icon": "images/icon.png",
"bugs": {
"url": "https://github.com/pavlitsky/vscode-yard/issues",
"email": "pavlitsky@gmail.com"
},
"repository": {
"type": "git",
"url": "https://github.com/pavlitsky/vscode-yard.git"
},
"homepage": "https://github.com/pavlitsky/vscode-yard/blob/master/README.md",
"activationEvents": [
"onCommand:extension.generateYard"
],
"main": "./out/extension",
"contributes": {
"commands": [
{
"command": "extension.generateYard",
"title": "Document with YARD"
}
],
"keybindings": [
{
"command": "extension.generateYard",
"key": "ctrl+alt+enter",
"mac": "cmd+alt+enter",
"when": "editorTextFocus && !editorReadonly && editorLangId == ruby"
}
],
"configuration": {
"type": "object",
"title": "YARD Documenter configuration",
"properties": {
"yard.spacers.beforeDescription": {
"type": "boolean",
"default": true,
"description": "Prepend an empty line to descriptive texts"
},
"yard.spacers.afterDescription": {
"type": "boolean",
"default": true,
"description": "Append an empty line to descriptive texts"
},
"yard.spacers.beforeTags": {
"type": "boolean",
"default": true,
"description": "Prepend an empty line to all method's tags"
},
"yard.spacers.separateTags": {
"type": "boolean",
"default": true,
"description": "Separate method's tags of the same name (@params and @return) with an empty line"
},
"yard.spacers.afterTags": {
"type": "boolean",
"default": true,
"description": "Append an empty line to all method's tags"
},
"yard.spacers.beforeSingleTag": {
"type": "boolean",
"default": false,
"description": "Prepend an empty line to directives or single tags (for example constants)"
},
"yard.spacers.afterSingleTag": {
"type": "boolean",
"default": false,
"description": "Append an empty line to directives or single tags (for example constants)"
},
"yard.tags.author": {
"type": "boolean",
"default": false,
"description": "Append @author tag to Class and Module documentation"
},
"yard.tags.paramNameBeforeType": {
"type": "boolean",
"default": true,
"description": "Print param name before its type (for example '@param username [String]')"
}
}
}
},
"scripts": {
"vscode:prepublish": "npm run compile",
"compile": "tsc -p ./",
"watch": "tsc -watch -p ./",
"postinstall": "node ./node_modules/vscode/bin/install",
"test": "npm run compile && node ./node_modules/vscode/bin/test"
},
"devDependencies": {
"typescript": "^2.6.1",
"vscode": "^1.1.6",
"@types/node": "^7.0.43",
"@types/mocha": "^2.2.42"
}
}