[js-api-parser] Property and property signature generator #13711

KarishmaGhiya · 2026-01-24T01:33:36Z

No description provided.

Copilot

Pull request overview

This PR adds a new token generator for handling API properties and property signatures in the JavaScript API parser. It enables the parser to process both ApiProperty (for class properties) and ApiPropertySignature (for interface/type properties) and generate appropriate review tokens for them.

Changes:

Added property token generator implementation with support for static, readonly, and optional modifiers
Added comprehensive test coverage for property and property signature generation
Integrated the new generator into the token generator registry

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 7 comments.

File	Description
`tools/apiview/parsers/js-api-parser/src/tokenGenerators/property.ts`	Implements the property token generator with logic to handle modifiers (static, readonly, optional) and type information
`tools/apiview/parsers/js-api-parser/test/tokenGenerators/property.spec.ts`	Comprehensive test suite covering various property configurations including static, readonly, optional, and deprecated properties
`tools/apiview/parsers/js-api-parser/src/tokenGenerators/index.ts`	Adds property generator to the registry and exports it for use

Copilot · 2026-01-24T01:38:48Z

tools/apiview/parsers/js-api-parser/src/tokenGenerators/property.ts

+
+    tokens.push({ Kind: TokenKind.Punctuation, Value: ":", HasSuffixSpace: true });
+
+    tokens.push({ Kind: TokenKind.TypeName, Value: item.propertyTypeExcerpt.text.trim(), IsDeprecated: deprecated });


The property type should use processExcerptTokens(item.propertyTypeExcerpt.spannedTokens, tokens, deprecated) instead of directly using .text.trim(). This is consistent with how method generators handle return types (method.ts:119) and function generators handle return types (function.ts:101). Using processExcerptTokens provides proper handling of type references with navigation links and correctly processes complex types.

yes, for example, types with generic type parameters x: Record<string, string>

tools/apiview/parsers/js-api-parser/src/tokenGenerators/property.ts

Copilot · 2026-01-24T01:38:49Z

tools/apiview/parsers/js-api-parser/src/tokenGenerators/property.ts

+        tokens.push({ Kind: TokenKind.Punctuation, Value: "?" });
+    }
+
+    tokens.push({ Kind: TokenKind.Punctuation, Value: ":", HasSuffixSpace: true });


Punctuation tokens are missing the IsDeprecated flag. When the property is deprecated, all tokens including punctuation should be marked with IsDeprecated: deprecated for consistency with how other generators handle deprecated items.

Suggested change

tokens.push({ Kind: TokenKind.Punctuation, Value: "?" });

}

tokens.push({ Kind: TokenKind.Punctuation, Value: ":", HasSuffixSpace: true });

tokens.push({ Kind: TokenKind.Punctuation, Value: "?", IsDeprecated: deprecated });

}

tokens.push({ Kind: TokenKind.Punctuation, Value: ":", HasSuffixSpace: true, IsDeprecated: deprecated });

Copilot · 2026-01-24T01:38:49Z

tools/apiview/parsers/js-api-parser/test/tokenGenerators/property.spec.ts

+        it("should mark tokens as deprecated when deprecated flag is set", () => {
+            const mockItem = {
+                kind: ApiItemKind.Property,
+                displayName: "deprecatedProp",
+                isReadonly: false,
+                isOptional: false,
+                propertyTypeExcerpt: { text: "string" },
+            } as unknown as ApiProperty;
+
+            const tokens = propertyTokenGenerator.generate(mockItem, true);
+
+            expect(tokens[0]).to.deep.include({ Kind: TokenKind.MemberName, Value: "deprecatedProp", IsDeprecated: true });
+        });
+
+        it("should throw error for invalid item kind", () => {
+            const mockItem = {
+                kind: ApiItemKind.Method,
+                displayName: "invalidItem",
+            } as any;
+
+            expect(() => propertyTokenGenerator.generate(mockItem)).to.throw();
+        });
+    });


Missing test coverage for deprecated optional properties. The tests should verify that when a deprecated optional property is generated, the "?" punctuation token also has IsDeprecated set to true.

Copilot · 2026-01-24T01:38:49Z

tools/apiview/parsers/js-api-parser/test/tokenGenerators/property.spec.ts

+        it("should mark property signature tokens as deprecated", () => {
+            const mockItem = {
+                kind: ApiItemKind.PropertySignature,
+                displayName: "deprecatedSignature",
+                isReadonly: false,
+                isOptional: false,
+                propertyTypeExcerpt: { text: "string" },
+            } as unknown as ApiPropertySignature;
+
+            const tokens = propertyTokenGenerator.generate(mockItem, true);
+
+            expect(tokens[0]).to.deep.include({ Kind: TokenKind.MemberName, Value: "deprecatedSignature", IsDeprecated: true });
+            expect(tokens[2]).to.deep.include({ Kind: TokenKind.TypeName, Value: "string", IsDeprecated: true });
+        });


Incomplete test coverage for deprecated tokens. The test should verify that all tokens (including punctuation at index 1) have IsDeprecated set to true when the property is deprecated, not just the MemberName and TypeName tokens.

Copilot · 2026-01-24T01:38:50Z

tools/apiview/parsers/js-api-parser/src/tokenGenerators/index.ts

+  propertyTokenGenerator,
 ];
+
+export { propertyTokenGenerator } from "./property";


The explicit export of propertyTokenGenerator is inconsistent with the pattern used for other token generators (method, class, function, interface, enum). Other generators are only imported and added to the generators array, but not re-exported. This export should be removed unless there's a specific need for it.

Copilot · 2026-01-24T01:38:50Z

tools/apiview/parsers/js-api-parser/src/tokenGenerators/property.ts

+function generate(item: ApiPropertyItem, deprecated?: boolean): ReviewToken[] {
+    const tokens: ReviewToken[] = [];
+    if (item.kind !== ApiItemKind.Property && item.kind !== ApiItemKind.PropertySignature) {
+        throw new Error(`Invalid item ${item.displayName} of kind ${item.kind} for Property token generator.`);
+    }
+
+    if (item instanceof ApiProperty && item.isStatic) {
+        tokens.push({ Kind: TokenKind.Keyword, Value: "static", HasSuffixSpace: true, IsDeprecated: deprecated });
+    }
+
+    if (item.isReadonly) {
+        tokens.push({ Kind: TokenKind.Keyword, Value: "readonly", HasSuffixSpace: true, IsDeprecated: deprecated });
+    }
+
+    tokens.push({ Kind: TokenKind.MemberName, Value: item.displayName, IsDeprecated: deprecated });
+
+    if (item.isOptional) {
+        tokens.push({ Kind: TokenKind.Punctuation, Value: "?" });
+    }
+
+    tokens.push({ Kind: TokenKind.Punctuation, Value: ":", HasSuffixSpace: true });
+
+    tokens.push({ Kind: TokenKind.TypeName, Value: item.propertyTypeExcerpt.text.trim(), IsDeprecated: deprecated });
+
+    return tokens;


The property token generator should use the createToken helper function for consistency with other token generators (method, function, class, interface). This ensures consistent token creation and reduces code duplication.

jeremymeng · 2026-01-26T17:10:04Z

tools/apiview/parsers/js-api-parser/src/tokenGenerators/property.ts

+
+    tokens.push({ Kind: TokenKind.Punctuation, Value: ":", HasSuffixSpace: true });
+
+    tokens.push({ Kind: TokenKind.TypeName, Value: item.propertyTypeExcerpt.text.trim(), IsDeprecated: deprecated });


yes, for example, types with generic type parameters x: Record<string, string>

tools/apiview/parsers/js-api-parser/test/tokenGenerators/property.spec.ts

…iewLine" This reverts commit a0e5246.

This reverts commit 98313d0.

KarishmaGhiya added 5 commits November 25, 2025 16:48

update api

3acc3c4

Merge branch 'main' of https://github.com/KarishmaGhiya/azure-sdk-tools

eca604e

Merge remote-tracking branch 'upstream/main'

9f1951f

Merge remote-tracking branch 'upstream/main'

6b3b70c

property and property signature types

b1c4dbc

Copilot AI review requested due to automatic review settings January 24, 2026 01:33

KarishmaGhiya requested review from jeremymeng and maorleger as code owners January 24, 2026 01:33

Copilot started reviewing on behalf of KarishmaGhiya January 24, 2026 01:34 View session

Copilot AI reviewed Jan 24, 2026

View reviewed changes

KarishmaGhiya added 2 commits January 23, 2026 17:40

fixed spacing for optional properties

fabff11

fixed spacing for optional properties

b399de9

jeremymeng reviewed Jan 26, 2026

View reviewed changes

fixed usage

2412d24

KarishmaGhiya changed the title ~~[ja-api-parser] Property and property signature generator~~ [js-api-parser] Property and property signature generator Jan 27, 2026

jeremymeng approved these changes Jan 27, 2026

View reviewed changes

KarishmaGhiya added 8 commits January 28, 2026 17:03

fixed indentation and preserves whitespace and newlines for tokens

a8c13d0

fixed indentation and preserves whitespace and newlines for tokens

a199a1d

fixing 2

642af46

fixing by changing token split chars and reviewToken[] to reviewLine

a0e5246

Revert "fixing by changing token split chars and reviewToken[] to rev…

d9015a0

…iewLine" This reverts commit a0e5246.

trying a formatting fix and undo the review line thing

98313d0

Revert "trying a formatting fix and undo the review line thing"

d874ddc

This reverts commit 98313d0.

add fixes for nested properties and ;

495d1f5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[js-api-parser] Property and property signature generator #13711

[js-api-parser] Property and property signature generator #13711

KarishmaGhiya commented Jan 24, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

jeremymeng Jan 26, 2026

Uh oh!

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

jeremymeng Jan 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		tokens.push({ Kind: TokenKind.Punctuation, Value: ":", HasSuffixSpace: true });

		tokens.push({ Kind: TokenKind.TypeName, Value: item.propertyTypeExcerpt.text.trim(), IsDeprecated: deprecated });

[js-api-parser] Property and property signature generator #13711

Are you sure you want to change the base?

[js-api-parser] Property and property signature generator #13711

Conversation

KarishmaGhiya commented Jan 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

jeremymeng Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

jeremymeng Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants