Skip to content

Commit 0cda72a

Browse files
dcodeIOdcodeIO
committed
CLI: Added a few helpful comments to static code
1 parent 24b293c commit 0cda72a

File tree

7 files changed

+438
-433
lines changed

7 files changed

+438
-433
lines changed

Diff for: ‎cli/targets/static.js

+7-2
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ function slightlyBeautify(generatedCode) {
138138
.replace(/(!?[=<>|&%?:]+)([^\s])/g, " $1 $2") // a!==b, a&&b, a?b:c etc.
139139
.replace(/\b([+-])\b/g," $1 ") // a+b
140140
.replace(/\b(if|else|else if|for|while|do|switch)\(/g, "$1 (") // if(a)
141-
.replace(/\breturn"/g, "return \"") // return"error"
141+
.replace(/\b(return|case)"/g, "$1 \"") // return"error", case"one"
142142
.replace(/([;,])([^\s])/g, "$1 $2") // cond(var a=0;a<b;++b), var a=1,b;
143143
.replace(/{$/mg, " {")
144144
.replace(/\br\b/g, "reader")
@@ -148,7 +148,12 @@ function slightlyBeautify(generatedCode) {
148148
.replace(/\bl\b/g, "length")
149149
.replace(/\bc\b/g, "end")
150150
.replace(/\bk\b/g, "key")
151-
.replace(/\bks\b/g, "keys");
151+
.replace(/\bks\b/g, "keys")
152+
.replace(/\bs\b/g, "reason")
153+
.replace(/(uint32)\((\d+)\)/g, function($0, $1, $2) {
154+
var tag = parseInt($2, 10);
155+
return $1 + "(" + tag + "/*= id " + (tag >>> 3) + ", wireType " + (tag & 7) + " */)";
156+
});
152157
}
153158

154159
function buildFunction(type, functionName, gen, scope) {

Diff for: ‎tests/data/ambiguous-names.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ $root.A = (function() {
5252
A.encode = /* eslint-disable */ (function(Writer, util, types) { $lazyTypes.push(types); return function encode(message, writer) {
5353
writer || (writer = Writer.create())
5454
if (message.whatever !== undefined && message.whatever !== "")
55-
writer.uint32(10).string(message.whatever)
55+
writer.uint32(10/*= id 1, wireType 2 */).string(message.whatever)
5656
return writer
5757
}})($protobuf.Writer, $protobuf.util, [null]); /* eslint-enable */
5858

@@ -161,7 +161,7 @@ $root.B = (function() {
161161
B.encode = /* eslint-disable */ (function(Writer, util, types) { $lazyTypes.push(types); return function encode(message, writer) {
162162
writer || (writer = Writer.create())
163163
if (message.A !== undefined && message.A !== null)
164-
types[0].encode(message.A, writer.uint32(10).fork()).ldelim()
164+
types[0].encode(message.A, writer.uint32(10/*= id 1, wireType 2 */).fork()).ldelim()
165165
return writer
166166
}})($protobuf.Writer, $protobuf.util, ["A"]); /* eslint-enable */
167167

@@ -217,9 +217,9 @@ $root.B = (function() {
217217
*/
218218
B.verify = /* eslint-disable */ (function(util, types) { $lazyTypes.push(types); return function verify(message) {
219219
if (message.A !== undefined && message.A !== null) {
220-
var s;
221-
if (s = types[0].verify(message.A))
222-
return s
220+
var reason;
221+
if (reason = types[0].verify(message.A))
222+
return reason
223223
}
224224
return null
225225
}})($protobuf.util, ["A"]); /* eslint-enable */

Diff for: ‎tests/data/mapbox/vector_tile.js

+27-27
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ $root.vector_tile = (function() {
6262
writer || (writer = Writer.create())
6363
if (message.layers)
6464
for (var i = 0; i < message.layers.length; ++i)
65-
types[0].encode(message.layers[i], writer.uint32(26).fork()).ldelim()
65+
types[0].encode(message.layers[i], writer.uint32(26/*= id 3, wireType 2 */).fork()).ldelim()
6666
return writer
6767
}})($protobuf.Writer, $protobuf.util, ["vector_tile.Tile.Layer"]); /* eslint-enable */
6868

@@ -122,9 +122,9 @@ $root.vector_tile = (function() {
122122
if (!Array.isArray(message.layers))
123123
return "invalid value for field .vector_tile.Tile.layers (array expected)"
124124
for (var i = 0; i < message.layers.length; ++i) {
125-
var s;
126-
if (s = types[0].verify(message.layers[i]))
127-
return s
125+
var reason;
126+
if (reason = types[0].verify(message.layers[i]))
127+
return reason
128128
}
129129
}
130130
return null
@@ -223,19 +223,19 @@ $root.vector_tile = (function() {
223223
Value.encode = /* eslint-disable */ (function(Writer, util, types) { $lazyTypes.push(types); return function encode(message, writer) {
224224
writer || (writer = Writer.create())
225225
if (message.stringValue !== undefined && message.stringValue !== "")
226-
writer.uint32(10).string(message.stringValue)
226+
writer.uint32(10/*= id 1, wireType 2 */).string(message.stringValue)
227227
if (message.floatValue !== undefined && message.floatValue !== 0)
228-
writer.uint32(21).float(message.floatValue)
228+
writer.uint32(21/*= id 2, wireType 5 */).float(message.floatValue)
229229
if (message.doubleValue !== undefined && message.doubleValue !== 0)
230-
writer.uint32(25).double(message.doubleValue)
230+
writer.uint32(25/*= id 3, wireType 1 */).double(message.doubleValue)
231231
if (message.intValue !== undefined && message.intValue !== null && util.longNe(message.intValue, 0, 0))
232-
writer.uint32(32).int64(message.intValue)
232+
writer.uint32(32/*= id 4, wireType 0 */).int64(message.intValue)
233233
if (message.uintValue !== undefined && message.uintValue !== null && util.longNe(message.uintValue, 0, 0))
234-
writer.uint32(40).uint64(message.uintValue)
234+
writer.uint32(40/*= id 5, wireType 0 */).uint64(message.uintValue)
235235
if (message.sintValue !== undefined && message.sintValue !== null && util.longNe(message.sintValue, 0, 0))
236-
writer.uint32(48).sint64(message.sintValue)
236+
writer.uint32(48/*= id 6, wireType 0 */).sint64(message.sintValue)
237237
if (message.boolValue !== undefined && message.boolValue !== false)
238-
writer.uint32(56).bool(message.boolValue)
238+
writer.uint32(56/*= id 7, wireType 0 */).bool(message.boolValue)
239239
return writer
240240
}})($protobuf.Writer, $protobuf.util, [null, null, null, null, null, null, null]); /* eslint-enable */
241241

@@ -404,17 +404,17 @@ $root.vector_tile = (function() {
404404
Feature.encode = /* eslint-disable */ (function(Writer, util, types) { $lazyTypes.push(types); return function encode(message, writer) {
405405
writer || (writer = Writer.create())
406406
if (message.id !== undefined && message.id !== null && util.longNe(message.id, 0, 0))
407-
writer.uint32(8).uint64(message.id)
407+
writer.uint32(8/*= id 1, wireType 0 */).uint64(message.id)
408408
if (message.tags && message.tags.length) {
409-
writer.uint32(18).fork()
409+
writer.uint32(18/*= id 2, wireType 2 */).fork()
410410
for (var i = 0; i < message.tags.length; ++i)
411411
writer.uint32(message.tags[i])
412412
writer.ldelim()
413413
}
414414
if (message.type !== undefined && message.type !== "UNKNOWN")
415-
writer.uint32(24).uint32(message.type)
415+
writer.uint32(24/*= id 3, wireType 0 */).uint32(message.type)
416416
if (message.geometry && message.geometry.length) {
417-
writer.uint32(34).fork()
417+
writer.uint32(34/*= id 4, wireType 2 */).fork()
418418
for (var i = 0; i < message.geometry.length; ++i)
419419
writer.uint32(message.geometry[i])
420420
writer.ldelim()
@@ -604,19 +604,19 @@ $root.vector_tile = (function() {
604604
*/
605605
Layer.encode = /* eslint-disable */ (function(Writer, util, types) { $lazyTypes.push(types); return function encode(message, writer) {
606606
writer || (writer = Writer.create())
607-
writer.uint32(120).uint32(message.version)
608-
writer.uint32(10).string(message.name)
607+
writer.uint32(120/*= id 15, wireType 0 */).uint32(message.version)
608+
writer.uint32(10/*= id 1, wireType 2 */).string(message.name)
609609
if (message.features)
610610
for (var i = 0; i < message.features.length; ++i)
611-
types[2].encode(message.features[i], writer.uint32(18).fork()).ldelim()
611+
types[2].encode(message.features[i], writer.uint32(18/*= id 2, wireType 2 */).fork()).ldelim()
612612
if (message.keys)
613613
for (var i = 0; i < message.keys.length; ++i)
614-
writer.uint32(26).string(message.keys[i])
614+
writer.uint32(26/*= id 3, wireType 2 */).string(message.keys[i])
615615
if (message.values)
616616
for (var i = 0; i < message.values.length; ++i)
617-
types[4].encode(message.values[i], writer.uint32(34).fork()).ldelim()
617+
types[4].encode(message.values[i], writer.uint32(34/*= id 4, wireType 2 */).fork()).ldelim()
618618
if (message.extent !== undefined && message.extent !== 4096)
619-
writer.uint32(40).uint32(message.extent)
619+
writer.uint32(40/*= id 5, wireType 0 */).uint32(message.extent)
620620
return writer
621621
}})($protobuf.Writer, $protobuf.util, [null, null, "vector_tile.Tile.Feature", null, "vector_tile.Tile.Value", null]); /* eslint-enable */
622622

@@ -697,9 +697,9 @@ $root.vector_tile = (function() {
697697
if (!Array.isArray(message.features))
698698
return "invalid value for field .vector_tile.Tile.Layer.features (array expected)"
699699
for (var i = 0; i < message.features.length; ++i) {
700-
var s;
701-
if (s = types[2].verify(message.features[i]))
702-
return s
700+
var reason;
701+
if (reason = types[2].verify(message.features[i]))
702+
return reason
703703
}
704704
}
705705
if (message.keys !== undefined) {
@@ -714,9 +714,9 @@ $root.vector_tile = (function() {
714714
if (!Array.isArray(message.values))
715715
return "invalid value for field .vector_tile.Tile.Layer.values (array expected)"
716716
for (var i = 0; i < message.values.length; ++i) {
717-
var s;
718-
if (s = types[4].verify(message.values[i]))
719-
return s
717+
var reason;
718+
if (reason = types[4].verify(message.values[i]))
719+
return reason
720720
}
721721
}
722722
if (message.extent !== undefined) {

Diff for: ‎tests/data/package.js

+26-26
Original file line numberDiff line numberDiff line change
@@ -142,63 +142,63 @@ $root.Package = (function() {
142142
Package.encode = /* eslint-disable */ (function(Writer, util, types) { $lazyTypes.push(types); return function encode(message, writer) {
143143
writer || (writer = Writer.create())
144144
if (message.name !== undefined && message.name !== "")
145-
writer.uint32(10).string(message.name)
145+
writer.uint32(10/*= id 1, wireType 2 */).string(message.name)
146146
if (message.version !== undefined && message.version !== "")
147-
writer.uint32(18).string(message.version)
147+
writer.uint32(18/*= id 2, wireType 2 */).string(message.version)
148148
if (message.description !== undefined && message.description !== "")
149-
writer.uint32(26).string(message.description)
149+
writer.uint32(26/*= id 3, wireType 2 */).string(message.description)
150150
if (message.author !== undefined && message.author !== "")
151-
writer.uint32(34).string(message.author)
151+
writer.uint32(34/*= id 4, wireType 2 */).string(message.author)
152152
if (message.license !== undefined && message.license !== "")
153-
writer.uint32(42).string(message.license)
153+
writer.uint32(42/*= id 5, wireType 2 */).string(message.license)
154154
if (message.repository !== undefined && message.repository !== null)
155-
types[5].encode(message.repository, writer.uint32(50).fork()).ldelim()
155+
types[5].encode(message.repository, writer.uint32(50/*= id 6, wireType 2 */).fork()).ldelim()
156156
if (message.bugs !== undefined && message.bugs !== "")
157-
writer.uint32(58).string(message.bugs)
157+
writer.uint32(58/*= id 7, wireType 2 */).string(message.bugs)
158158
if (message.homepage !== undefined && message.homepage !== "")
159-
writer.uint32(66).string(message.homepage)
159+
writer.uint32(66/*= id 8, wireType 2 */).string(message.homepage)
160160
if (message.keywords)
161161
for (var i = 0; i < message.keywords.length; ++i)
162-
writer.uint32(74).string(message.keywords[i])
162+
writer.uint32(74/*= id 9, wireType 2 */).string(message.keywords[i])
163163
if (message.main !== undefined && message.main !== "")
164-
writer.uint32(82).string(message.main)
164+
writer.uint32(82/*= id 10, wireType 2 */).string(message.main)
165165
if (message.bin && message.bin !== util.emptyObject) {
166166
for (var keys = Object.keys(message.bin), i = 0; i < keys.length; ++i) {
167-
writer.uint32(90).fork().uint32(10).string(keys[i])
168-
writer.uint32(18).string(message.bin[keys[i]])
167+
writer.uint32(90/*= id 11, wireType 2 */).fork().uint32(10/*= id 1, wireType 2 */).string(keys[i])
168+
writer.uint32(18/*= id 2, wireType 2 */).string(message.bin[keys[i]])
169169
writer.ldelim()
170170
}
171171
}
172172
if (message.scripts && message.scripts !== util.emptyObject) {
173173
for (var keys = Object.keys(message.scripts), i = 0; i < keys.length; ++i) {
174-
writer.uint32(98).fork().uint32(10).string(keys[i])
175-
writer.uint32(18).string(message.scripts[keys[i]])
174+
writer.uint32(98/*= id 12, wireType 2 */).fork().uint32(10/*= id 1, wireType 2 */).string(keys[i])
175+
writer.uint32(18/*= id 2, wireType 2 */).string(message.scripts[keys[i]])
176176
writer.ldelim()
177177
}
178178
}
179179
if (message.dependencies && message.dependencies !== util.emptyObject) {
180180
for (var keys = Object.keys(message.dependencies), i = 0; i < keys.length; ++i) {
181-
writer.uint32(106).fork().uint32(10).string(keys[i])
182-
writer.uint32(18).string(message.dependencies[keys[i]])
181+
writer.uint32(106/*= id 13, wireType 2 */).fork().uint32(10/*= id 1, wireType 2 */).string(keys[i])
182+
writer.uint32(18/*= id 2, wireType 2 */).string(message.dependencies[keys[i]])
183183
writer.ldelim()
184184
}
185185
}
186186
if (message.optionalDependencies && message.optionalDependencies !== util.emptyObject) {
187187
for (var keys = Object.keys(message.optionalDependencies), i = 0; i < keys.length; ++i) {
188-
writer.uint32(114).fork().uint32(10).string(keys[i])
189-
writer.uint32(18).string(message.optionalDependencies[keys[i]])
188+
writer.uint32(114/*= id 14, wireType 2 */).fork().uint32(10/*= id 1, wireType 2 */).string(keys[i])
189+
writer.uint32(18/*= id 2, wireType 2 */).string(message.optionalDependencies[keys[i]])
190190
writer.ldelim()
191191
}
192192
}
193193
if (message.devDependencies && message.devDependencies !== util.emptyObject) {
194194
for (var keys = Object.keys(message.devDependencies), i = 0; i < keys.length; ++i) {
195-
writer.uint32(122).fork().uint32(10).string(keys[i])
196-
writer.uint32(18).string(message.devDependencies[keys[i]])
195+
writer.uint32(122/*= id 15, wireType 2 */).fork().uint32(10/*= id 1, wireType 2 */).string(keys[i])
196+
writer.uint32(18/*= id 2, wireType 2 */).string(message.devDependencies[keys[i]])
197197
writer.ldelim()
198198
}
199199
}
200200
if (message.types !== undefined && message.types !== "")
201-
writer.uint32(138).string(message.types)
201+
writer.uint32(138/*= id 17, wireType 2 */).string(message.types)
202202
return writer
203203
}})($protobuf.Writer, $protobuf.util, [null, null, null, null, null, "Package.Repository", null, null, null, null, null, null, null, null, null, null]); /* eslint-enable */
204204

@@ -355,9 +355,9 @@ $root.Package = (function() {
355355
return "invalid value for field .Package.license (string expected)"
356356
}
357357
if (message.repository !== undefined && message.repository !== null) {
358-
var s;
359-
if (s = types[5].verify(message.repository))
360-
return s
358+
var reason;
359+
if (reason = types[5].verify(message.repository))
360+
return reason
361361
}
362362
if (message.bugs !== undefined) {
363363
if (!util.isString(message.bugs))
@@ -481,9 +481,9 @@ $root.Package = (function() {
481481
Repository.encode = /* eslint-disable */ (function(Writer, util, types) { $lazyTypes.push(types); return function encode(message, writer) {
482482
writer || (writer = Writer.create())
483483
if (message.type !== undefined && message.type !== "")
484-
writer.uint32(10).string(message.type)
484+
writer.uint32(10/*= id 1, wireType 2 */).string(message.type)
485485
if (message.url !== undefined && message.url !== "")
486-
writer.uint32(18).string(message.url)
486+
writer.uint32(18/*= id 2, wireType 2 */).string(message.url)
487487
return writer
488488
}})($protobuf.Writer, $protobuf.util, [null, null]); /* eslint-enable */
489489

Diff for: ‎tests/data/rpc.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ $root.MyRequest = (function() {
144144
MyRequest.encode = /* eslint-disable */ (function(Writer, util, types) { $lazyTypes.push(types); return function encode(message, writer) {
145145
writer || (writer = Writer.create())
146146
if (message.path !== undefined && message.path !== "")
147-
writer.uint32(10).string(message.path)
147+
writer.uint32(10/*= id 1, wireType 2 */).string(message.path)
148148
return writer
149149
}})($protobuf.Writer, $protobuf.util, [null]); /* eslint-enable */
150150

@@ -253,7 +253,7 @@ $root.MyResponse = (function() {
253253
MyResponse.encode = /* eslint-disable */ (function(Writer, util, types) { $lazyTypes.push(types); return function encode(message, writer) {
254254
writer || (writer = Writer.create())
255255
if (message.status !== undefined && message.status !== 0)
256-
writer.uint32(16).int32(message.status)
256+
writer.uint32(16/*= id 2, wireType 0 */).int32(message.status)
257257
return writer
258258
}})($protobuf.Writer, $protobuf.util, [null]); /* eslint-enable */
259259

Diff for: ‎tests/data/test.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// $> pbts --out tests/data/test.d.ts --no-comments tests/data/test.js
2-
// Generated Sat, 31 Dec 2016 02:51:42 UTC
2+
// Generated Sat, 31 Dec 2016 03:08:36 UTC
33

44
import * as $protobuf from "../..";
55

0 commit comments

Comments
 (0)