forked from slysherz/vscode-comment-box
-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
250 lines (250 loc) · 14.7 KB
/
package.json
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
{
"name": "comment-box",
"displayName": "Comment Box",
"description": "Transform text into a configurable comment box",
"icon": "images/comment-box-logo.png",
"version": "2.0.0",
"publisher": "SlySherZ",
"license": "MIT",
"repository": {
"url": "https://github.com/SlySherZ/vscode-comment-box"
},
"engines": {
"vscode": "^1.33.0"
},
"categories": [
"Formatters"
],
"activationEvents": [
"onCommand:extension.commentBox",
"onCommand:commentBox.transformUsingStyle"
],
"main": "./src/extension",
"contributes": {
"commands": [
{
"command": "extension.commentBox",
"title": "Transform to Comment Box"
},
{
"command": "commentBox.transformUsingStyle",
"title": "Transform to Comment Box using style"
}
],
"configuration": {
"title": "Comment Box",
"properties": {
"commentBox.styles": {
"type": "object",
"default": {
"defaultStyle": {}
},
"additionalProperties": {
"type": "object",
"properties": {
"capitalize": {
"type": "boolean",
"default": true,
"description": "Capitalizes the text inside the box."
},
"textAlignment": {
"type": "string",
"enum": [
"center",
"left"
],
"default": "center",
"description": "Controls how the text should be aligned. Can be: \n- \"center\" or \n- \"left\"."
},
"boxWidth": {
"type": "number",
"default": 0,
"description": "The width of the comment box. When set to 0, it will automatically pick the smallest possible value."
},
"extendSelection": {
"type": "boolean",
"default": true,
"description": "When 'true' the whole line is replaced, not just the selected part."
},
"commentStartToken": {
"type": "string",
"default": "/*",
"description": "Characters that start a multi-line comment for your current language. This also defines the top left corner of the box."
},
"commentEndToken": {
"type": "string",
"default": "**/",
"description": "Characters that end a multi-line comment for your current language. This also defines the bottom right corner of the box."
},
"topRightToken": {
"type": "string",
"default": "**",
"description": "Characters that are used to draw the top right corner of the box."
},
"bottomLeftToken": {
"type": "string",
"default": " **",
"description": "Characters that are used to draw the bottom left corner of the box."
},
"topEdgeToken": {
"type": "string",
"default": "*",
"description": "Characters that are used to draw top edge of the box. The entire top edge is skipped when this is set to an empty string."
},
"bottomEdgeToken": {
"type": "string",
"default": "*",
"description": "Characters that are used to draw bottom edge of the box. The entire bottom edge is skipped when this is set to an empty string."
},
"leftEdgeToken": {
"type": "string",
"default": " * ",
"description": "Characters that are used to draw the left edge of the box."
},
"rightEdgeToken": {
"type": "string",
"default": " *",
"description": "Characters that are used to draw the right edge of the box."
},
"fillingToken": {
"type": "string",
"default": " ",
"description": "Characters that are used to fill the space between the text and the edges."
},
"removeEmptyLines": {
"type": "boolean",
"default": true,
"description": "When set to 'true', skips drawing lines that are empty."
},
"ignoreOuterIndentation": {
"type": "boolean",
"default": true,
"description": "When set to 'false', the box is placed in a way that matches the indentation of the text being commented. Works best when 'extendSelection' is enabled."
},
"ignoreInnerIndentation": {
"type": "boolean",
"default": true,
"description": "When set to 'false', the text inside the box will keep the same relative indentation between the lines. Requires 'commentBox.textAlignment' to be set to 'left'."
}
},
"additionalProperties": false
}
},
"commentBox.capitalize": {
"type": "boolean",
"default": true,
"description": "Capitalizes the text inside the box.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"capitalize\": ...\n }\n}"
},
"commentBox.textAlignment": {
"type": "string",
"enum": [
"center",
"left"
],
"default": "center",
"description": "Controls how the text should be aligned. Can be: \n- \"center\" or \n- \"left\".",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"textAlignment\": ...\n }\n}"
},
"commentBox.boxWidth": {
"type": "number",
"default": 0,
"description": "The width of the comment box. When set to 0, it will automatically pick the smallest possible value.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"boxWidth\": ...\n }\n}"
},
"commentBox.extendSelection": {
"type": "boolean",
"default": true,
"description": "When 'true' the whole line is replaced, not just the selected part.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"extendSelection\": ...\n }\n}"
},
"commentBox.commentStartToken": {
"type": "string",
"default": "/*",
"description": "Characters that start a multi-line comment for your current language. This also defines the top left corner of the box.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"commentStartToken\": ...\n }\n}"
},
"commentBox.commentEndToken": {
"type": "string",
"default": "**/",
"description": "Characters that end a multi-line comment for your current language. This also defines the bottom right corner of the box.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"commentEndToken\": ...\n }\n}"
},
"commentBox.topRightToken": {
"type": "string",
"default": "**",
"description": "Characters that are used to draw the top right corner of the box.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"topRightToken\": ...\n }\n}"
},
"commentBox.bottomLeftToken": {
"type": "string",
"default": " **",
"description": "Characters that are used to draw the bottom left corner of the box.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"bottomLeftToken\": ...\n }\n}"
},
"commentBox.topEdgeToken": {
"type": "string",
"default": "*",
"description": "Characters that are used to draw top edge of the box. The entire top edge is skipped when this is set to an empty string.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"topEdgeToken\": ...\n }\n}"
},
"commentBox.bottomEdgeToken": {
"type": "string",
"default": "*",
"description": "Characters that are used to draw bottom edge of the box. The entire bottom edge is skipped when this is set to an empty string.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"bottomEdgeToken\": ...\n }\n}"
},
"commentBox.leftEdgeToken": {
"type": "string",
"default": " * ",
"description": "Characters that are used to draw the left edge of the box.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"leftEdgeToken\": ...\n }\n}"
},
"commentBox.rightEdgeToken": {
"type": "string",
"default": " *",
"description": "Characters that are used to draw the right edge of the box.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"rightEdgeToken\": ...\n }\n}"
},
"commentBox.fillingToken": {
"type": "string",
"default": " ",
"description": "Characters that are used to fill the space between the text and the edges.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"fillingToken\": ...\n }\n}"
},
"commentBox.removeEmptyLines": {
"type": "boolean",
"default": true,
"description": "When set to 'true', skips drawing lines that are empty.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"removeEmptyLines\": ...\n }\n}"
},
"commentBox.ignoreOuterIndentation": {
"type": "boolean",
"default": true,
"description": "When set to 'false', the box is placed in a way that matches the indentation of the text being commented. Works best when 'extendSelection' is enabled.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"ignoreOuterIndentation\": ...\n }\n}"
},
"commentBox.ignoreInnerIndentation": {
"type": "boolean",
"default": true,
"description": "When set to 'false', the text inside the box will keep the same relative indentation between the lines. Requires 'commentBox.textAlignment' to be set to 'left'.",
"deprecationMessage": "This works for now but it might be removed in the future. Please use instead:\n\"commentBox.styles\": {\n \"defaultStyle\": {\n \"ignoreInnerIndentation\": ...\n }\n}"
}
}
}
},
"scripts": {
"test": "node ./test/runTest.js"
},
"devDependencies": {
"@types/glob": "^7.1.1",
"@types/mocha": "^5.2.7",
"@types/node": "^12.11.7",
"@types/vscode": "^1.33.0",
"eslint": "^6.6.0",
"glob": "^7.1.5",
"mocha": "^6.2.2",
"typescript": "^3.6.4",
"vscode-test": "^1.2.2"
}
}