Skip to content

Commit b9d1d35

Browse files
marshallstockmarshallstock
committed
[api-extractor] address comments
1 parent b6448b6 commit b9d1d35

File tree

16 files changed

+17
-71
lines changed

16 files changed

+17
-71
lines changed

‎apps/api-extractor/src/analyzer/TypeScriptInternals.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ export class TypeScriptInternals {
126126
}
127127

128128
/**
129-
* Returns whether a variable has the const declaration
129+
* Returns whether a variable is declared with the const keyword
130130
*/
131131
public static isVarConst(node: ts.VariableDeclaration | ts.VariableDeclarationList): boolean {
132132
// Compiler internal: https://github.com/microsoft/TypeScript/blob/71286e3d49c10e0e99faac360a6bbd40f12db7b6/src/compiler/utilities.ts#L925

‎apps/api-extractor/src/generators/ApiModelGenerator.ts

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -473,9 +473,8 @@ export class ApiModelGenerator {
473473
const apiItemMetadata: ApiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
474474
const docComment: tsdoc.DocComment | undefined = apiItemMetadata.tsdocComment;
475475
const releaseTag: ReleaseTag = apiItemMetadata.effectiveReleaseTag;
476-
const isReadonly: boolean = this._determineReadonly(astDeclaration);
477476

478-
apiEnum = new ApiEnum({ name, docComment, releaseTag, excerptTokens, isReadonly });
477+
apiEnum = new ApiEnum({ name, docComment, releaseTag, excerptTokens });
479478
parentApiItem.addMember(apiEnum);
480479
}
481480

@@ -712,7 +711,6 @@ export class ApiModelGenerator {
712711
}
713712
const isOptional: boolean =
714713
(astDeclaration.astSymbol.followedSymbol.flags & ts.SymbolFlags.Optional) !== 0;
715-
const isReadonly: boolean = this._determineReadonly(astDeclaration);
716714

717715
apiMethod = new ApiMethod({
718716
name,
@@ -724,8 +722,7 @@ export class ApiModelGenerator {
724722
parameters,
725723
overloadIndex,
726724
excerptTokens,
727-
returnTypeTokenRange,
728-
isReadonly
725+
returnTypeTokenRange
729726
});
730727

731728
parentApiItem.addMember(apiMethod);
@@ -770,7 +767,6 @@ export class ApiModelGenerator {
770767
const releaseTag: ReleaseTag = apiItemMetadata.effectiveReleaseTag;
771768
const isOptional: boolean =
772769
(astDeclaration.astSymbol.followedSymbol.flags & ts.SymbolFlags.Optional) !== 0;
773-
const isReadonly: boolean = this._determineReadonly(astDeclaration);
774770

775771
apiMethodSignature = new ApiMethodSignature({
776772
name,
@@ -781,8 +777,7 @@ export class ApiModelGenerator {
781777
parameters,
782778
overloadIndex,
783779
excerptTokens,
784-
returnTypeTokenRange,
785-
isReadonly
780+
returnTypeTokenRange
786781
});
787782

788783
parentApiItem.addMember(apiMethodSignature);
@@ -1059,10 +1054,10 @@ export class ApiModelGenerator {
10591054
const apiItemMetadata: ApiItemMetadata = this._collector.fetchApiItemMetadata(astDeclaration);
10601055
const docComment: tsdoc.DocComment | undefined = apiItemMetadata.tsdocComment;
10611056
const declarationMetadata: DeclarationMetadata = this._collector.fetchDeclarationMetadata(astDeclaration);
1062-
//Line 1: sees whether the readonly or const modifiers present
1057+
//Line 1: sees whether the readonly or const modifiers are present
10631058
//Line 2: sees if the TSDoc comment for @readonly is present
10641059
//Line 3: sees whether a getter is present for a property with no setter
1065-
//Line 4: sees if the var has a Const flag
1060+
//Line 4: sees if the var declaration has Const keyword
10661061
return (astDeclaration.modifierFlags & (ts.ModifierFlags.Readonly + ts.ModifierFlags.Const)) !== 0
10671062
|| (docComment !== undefined && docComment.modifierTagSet.hasTagName('@readonly'))
10681063
|| (declarationMetadata.ancillaryDeclarations.length === 0 && astDeclaration.declaration.kind === ts.SyntaxKind.GetAccessor)

‎build-tests/api-documenter-test/etc/api-documenter-test.api.json

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,6 @@
400400
"text": ";"
401401
}
402402
],
403-
"isReadonly": false,
404403
"isOptional": false,
405404
"isStatic": false,
406405
"returnTypeTokenRange": {
@@ -446,7 +445,6 @@
446445
"text": ";"
447446
}
448447
],
449-
"isReadonly": false,
450448
"isOptional": false,
451449
"isStatic": false,
452450
"returnTypeTokenRange": {
@@ -501,7 +499,6 @@
501499
"text": ";"
502500
}
503501
],
504-
"isReadonly": false,
505502
"isOptional": false,
506503
"isStatic": false,
507504
"returnTypeTokenRange": {
@@ -570,7 +567,6 @@
570567
"text": ";"
571568
}
572569
],
573-
"isReadonly": false,
574570
"isOptional": false,
575571
"isStatic": false,
576572
"returnTypeTokenRange": {
@@ -622,7 +618,6 @@
622618
"text": ";"
623619
}
624620
],
625-
"isReadonly": false,
626621
"isOptional": false,
627622
"isStatic": false,
628623
"returnTypeTokenRange": {
@@ -718,7 +713,6 @@
718713
"text": ";"
719714
}
720715
],
721-
"isReadonly": false,
722716
"isOptional": false,
723717
"isStatic": false,
724718
"returnTypeTokenRange": {
@@ -830,7 +824,6 @@
830824
"text": ";"
831825
}
832826
],
833-
"isReadonly": false,
834827
"isOptional": false,
835828
"isStatic": true,
836829
"returnTypeTokenRange": {
@@ -877,7 +870,6 @@
877870
"text": ";"
878871
}
879872
],
880-
"isReadonly": false,
881873
"isOptional": false,
882874
"isStatic": false,
883875
"returnTypeTokenRange": {
@@ -1071,8 +1063,7 @@
10711063
"endIndex": 2
10721064
}
10731065
}
1074-
],
1075-
"isReadonly": false
1066+
]
10761067
},
10771068
{
10781069
"kind": "Enum",
@@ -1129,8 +1120,7 @@
11291120
"endIndex": 2
11301121
}
11311122
}
1132-
],
1133-
"isReadonly": false
1123+
]
11341124
},
11351125
{
11361126
"kind": "Namespace",
@@ -1523,7 +1513,6 @@
15231513
"text": ";"
15241514
}
15251515
],
1526-
"isReadonly": false,
15271516
"isOptional": false,
15281517
"returnTypeTokenRange": {
15291518
"startIndex": 1,
@@ -2004,7 +1993,6 @@
20041993
"text": ";"
20051994
}
20061995
],
2007-
"isReadonly": false,
20081996
"isOptional": false,
20091997
"returnTypeTokenRange": {
20101998
"startIndex": 3,
@@ -2285,7 +2273,6 @@
22852273
"text": ";"
22862274
}
22872275
],
2288-
"isReadonly": false,
22892276
"isOptional": true,
22902277
"returnTypeTokenRange": {
22912278
"startIndex": 1,
@@ -2488,7 +2475,6 @@
24882475
"text": ";"
24892476
}
24902477
],
2491-
"isReadonly": false,
24922478
"isOptional": false,
24932479
"isStatic": false,
24942480
"returnTypeTokenRange": {

‎build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,6 @@
201201
"text": ";"
202202
}
203203
],
204-
"isReadonly": false,
205204
"isOptional": false,
206205
"isStatic": false,
207206
"returnTypeTokenRange": {
@@ -255,7 +254,6 @@
255254
"text": ";"
256255
}
257256
],
258-
"isReadonly": false,
259257
"isOptional": false,
260258
"isStatic": false,
261259
"returnTypeTokenRange": {
@@ -303,7 +301,6 @@
303301
"text": ";"
304302
}
305303
],
306-
"isReadonly": false,
307304
"isOptional": false,
308305
"isStatic": false,
309306
"returnTypeTokenRange": {
@@ -394,8 +391,7 @@
394391
"endIndex": 2
395392
}
396393
}
397-
],
398-
"isReadonly": true
394+
]
399395
},
400396
{
401397
"kind": "Interface",
@@ -575,8 +571,7 @@
575571
"endIndex": 2
576572
}
577573
}
578-
],
579-
"isReadonly": false
574+
]
580575
},
581576
{
582577
"kind": "Class",
@@ -609,7 +604,6 @@
609604
"text": ";"
610605
}
611606
],
612-
"isReadonly": false,
613607
"isOptional": false,
614608
"isStatic": false,
615609
"returnTypeTokenRange": {
@@ -647,7 +641,6 @@
647641
"text": ";"
648642
}
649643
],
650-
"isReadonly": false,
651644
"isOptional": false,
652645
"isStatic": false,
653646
"returnTypeTokenRange": {

‎build-tests/api-extractor-scenarios/etc/test-outputs/docReferences/api-extractor-scenarios.api.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,6 @@
276276
"text": ";"
277277
}
278278
],
279-
"isReadonly": false,
280279
"isOptional": false,
281280
"isStatic": false,
282281
"returnTypeTokenRange": {

‎build-tests/api-extractor-scenarios/etc/test-outputs/docReferences2/api-extractor-scenarios.api.json

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,6 @@
201201
"text": ";"
202202
}
203203
],
204-
"isReadonly": false,
205204
"isOptional": false,
206205
"isStatic": false,
207206
"returnTypeTokenRange": {
@@ -231,7 +230,6 @@
231230
"text": ";"
232231
}
233232
],
234-
"isReadonly": false,
235233
"isOptional": false,
236234
"isStatic": false,
237235
"returnTypeTokenRange": {
@@ -277,7 +275,6 @@
277275
"text": ";"
278276
}
279277
],
280-
"isReadonly": false,
281278
"isOptional": false,
282279
"isStatic": false,
283280
"returnTypeTokenRange": {
@@ -307,7 +304,6 @@
307304
"text": ";"
308305
}
309306
],
310-
"isReadonly": false,
311307
"isOptional": false,
312308
"isStatic": false,
313309
"returnTypeTokenRange": {
@@ -353,7 +349,6 @@
353349
"text": ";"
354350
}
355351
],
356-
"isReadonly": false,
357352
"isOptional": false,
358353
"isStatic": false,
359354
"returnTypeTokenRange": {
@@ -383,7 +378,6 @@
383378
"text": ";"
384379
}
385380
],
386-
"isReadonly": false,
387381
"isOptional": false,
388382
"isStatic": false,
389383
"returnTypeTokenRange": {

‎build-tests/api-extractor-scenarios/etc/test-outputs/docReferences3/api-extractor-scenarios.api.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,6 @@
257257
"text": ";"
258258
}
259259
],
260-
"isReadonly": false,
261260
"isOptional": false,
262261
"isStatic": false,
263262
"returnTypeTokenRange": {

‎build-tests/api-extractor-scenarios/etc/test-outputs/excerptTokens/api-extractor-scenarios.api.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,6 @@
239239
"text": ";"
240240
}
241241
],
242-
"isReadonly": false,
243242
"isOptional": false,
244243
"isStatic": false,
245244
"returnTypeTokenRange": {

‎build-tests/api-extractor-scenarios/etc/test-outputs/functionOverload/api-extractor-scenarios.api.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,6 @@
397397
"text": ";"
398398
}
399399
],
400-
"isReadonly": false,
401400
"isOptional": false,
402401
"isStatic": false,
403402
"returnTypeTokenRange": {
@@ -460,7 +459,6 @@
460459
"text": ";"
461460
}
462461
],
463-
"isReadonly": false,
464462
"isOptional": false,
465463
"isStatic": false,
466464
"returnTypeTokenRange": {

‎build-tests/api-extractor-scenarios/etc/test-outputs/internationalCharacters/api-extractor-scenarios.api.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,6 @@
210210
"text": ";"
211211
}
212212
],
213-
"isReadonly": false,
214213
"isOptional": false,
215214
"isStatic": false,
216215
"returnTypeTokenRange": {
@@ -262,7 +261,6 @@
262261
"text": ";"
263262
}
264263
],
265-
"isReadonly": false,
266264
"isOptional": false,
267265
"isStatic": false,
268266
"returnTypeTokenRange": {
@@ -301,7 +299,6 @@
301299
"text": ";"
302300
}
303301
],
304-
"isReadonly": false,
305302
"isOptional": false,
306303
"isStatic": false,
307304
"returnTypeTokenRange": {

‎build-tests/api-extractor-scenarios/etc/test-outputs/spanSorting/api-extractor-scenarios.api.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,6 @@
234234
"text": ";"
235235
}
236236
],
237-
"isReadonly": false,
238237
"isOptional": false,
239238
"isStatic": false,
240239
"returnTypeTokenRange": {
@@ -288,7 +287,6 @@
288287
"text": ";"
289288
}
290289
],
291-
"isReadonly": false,
292290
"isOptional": false,
293291
"isStatic": false,
294292
"returnTypeTokenRange": {
@@ -343,7 +341,6 @@
343341
"text": ";"
344342
}
345343
],
346-
"isReadonly": false,
347344
"isOptional": false,
348345
"isStatic": false,
349346
"returnTypeTokenRange": {

‎build-tests/api-extractor-scenarios/etc/test-outputs/typeParameters/api-extractor-scenarios.api.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,6 @@
201201
"text": ";"
202202
}
203203
],
204-
"isReadonly": false,
205204
"isOptional": false,
206205
"isStatic": false,
207206
"returnTypeTokenRange": {

0 commit comments

Comments
 (0)