autoDocstring/package.json at master · vBLFTePebWNi6c/autoDocstring · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
{
    "name": "autodocstring",
    "displayName": "autoDocstring",
    "description": "Generates python docstrings",
    "version": "0.2.4",
    "publisher": "njpwerner",
    "license": "SEE LICENSE IN LICENSE",
    "icon": "images/icon.png",
    "repository": {
        "type": "git",
        "url": "https://github.com/NilsJPWerner/autoDocstring"
    },
    "bugs": {
        "url": "https://github.com/NilsJPWerner/autoDocstring/issues"
    },
    "categories": [
        "Snippets",
        "Formatters"
    ],
    "keywords": [
        "python",
        "docstring",
        "autodocstring",
        "docblockr",
        "docblockr_python",
        "pydocstring"
    ],
    "galleryBanner": {},
    "engines": {
        "vscode": "^1.9.0"
    },
    "activationEvents": [
        "onLanguage:python"
    ],
    "main": "./out/src/extension",
    "contributes": {
        "commands": [
            {
                "command": "extension.generateDocstring",
                "title": "Generate Docstring"
            }
        ],
        "keybindings": [
            {
                "command": "extension.generateDocstring",
                "key": "ctrl+shift+2",
                "mac": "cmd+shift+2",
                "when": "editorTextFocus"
            }
        ],
        "menus": {
            "editor/context": [
                {
                    "when": "resourceLangId == python",
                    "command": "extension.generateDocstring",
                    "group": "1_modification"
                }
            ]
        },
        "configuration": {
            "type": "object",
            "title": "AutoDocstring configuration",
            "properties": {
                "autoDocstring.docstringFormat": {
                    "type": "string",
                    "default": "default",
                    "enum": [
                        "default",
                        "google",
                        "sphinx",
                        "numpy",
                        "pycharm"
                    ],
                    "description": "Which docstring format to use."
                },
                "autoDocstring.generateDocstringOnEnter": {
                    "type": "boolean",
                    "default": true,
                    "description": "Generate docstring on pressing enter after opening a docstring (use quoteStyle)"
                },
                "autoDocstring.includeDescription": {
                    "type": "boolean",
                    "default": false,
                    "description": "Include description tag"
                },
                "autoDocstring.includeName": {
                    "type": "boolean",
                    "default": false,
                    "description": "Include function names at the start of docstrings"
                },
                "autoDocstring.newlineBeforeSummary": {
                    "type": "boolean",
                    "default": false,
                    "description": "New line before summary placeholder"
                },
                "autoDocstring.guessTypes": {
                    "type": "boolean",
                    "default": true,
                    "description": "Guess the type of parameters and return values"
                },
                "autoDocstring.quoteStyle": {
                    "type": "string",
                    "default": "\"\"\"",
                    "description": "Style of quote used with generate docstring command"
                }
            }
        }
    },
    "scripts": {
        "vscode:prepublish": "tsc -p ./",
        "compile": "tsc -watch -p ./",
        "postinstall": "node ./node_modules/vscode/bin/install",
        "test": "node ./node_modules/vscode/bin/test",
        "unit_test": "mocha -r ts-node/register 'test/**/*.spec.ts'"
    },
    "devDependencies": {
        "vscode": "^1.1.10",
        "@types/chai": "^4.1.2",
        "@types/mocha": "^2.2.37",
        "@types/node": "^6.0.59",
        "chai": "^4.1.2",
        "mocha": "^2.5.3",
        "ts-node": "^4.1.0",
        "typescript": "^2.0.3"
    },
    "dependencies": {}
}