[js-apiview-parser] update CodeFile models from schemas (#9256)
* [js-apiview-parser] update CodeFile models from schemas * Update version and changelog * set SkipDiff: true for all dependency tokens * update code owners
This commit is contained in:
Родитель
b1536534cd
Коммит
18a51f2b59
|
@ -67,7 +67,7 @@
|
||||||
/tools/apiview/emitters/typespec-apiview @tjprescott
|
/tools/apiview/emitters/typespec-apiview @tjprescott
|
||||||
/tools/apiview/parsers/cpp-api-parser @LarryOsterman
|
/tools/apiview/parsers/cpp-api-parser @LarryOsterman
|
||||||
/tools/apiview/parsers/csharp-api-parser @christothes
|
/tools/apiview/parsers/csharp-api-parser @christothes
|
||||||
/tools/apiview/parsers/js-api-parser @maorleger
|
/tools/apiview/parsers/js-api-parser @jeremymeng @maorleger
|
||||||
/src/swift @tjprescott
|
/src/swift @tjprescott
|
||||||
/src/java/apiview-java-processor @JonathanGiles
|
/src/java/apiview-java-processor @JonathanGiles
|
||||||
/src/go @jhendrixMSFT @chlowell @RickWinter
|
/src/go @jhendrixMSFT @chlowell @RickWinter
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
# 2.0.4
|
||||||
|
|
||||||
|
- update models from latest CodeFile schemas
|
||||||
|
|
||||||
# 2.0.3
|
# 2.0.3
|
||||||
|
|
||||||
- add `SkipDiff: true` for dependency header line
|
- add `SkipDiff: true` for dependency header line
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "@azure-tools/ts-genapi",
|
"name": "@azure-tools/ts-genapi",
|
||||||
"version": "2.0.3",
|
"version": "2.0.4",
|
||||||
"description": "",
|
"description": "",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
|
|
|
@ -67,6 +67,7 @@ function buildDependencies(reviewLines: ReviewLine[], dependencies: Record<strin
|
||||||
const nameToken: ReviewToken = buildToken({
|
const nameToken: ReviewToken = buildToken({
|
||||||
Kind: TokenKind.StringLiteral,
|
Kind: TokenKind.StringLiteral,
|
||||||
Value: dependency,
|
Value: dependency,
|
||||||
|
SkipDiff: true,
|
||||||
});
|
});
|
||||||
const versionToken: ReviewToken = buildToken({
|
const versionToken: ReviewToken = buildToken({
|
||||||
Kind: TokenKind.StringLiteral,
|
Kind: TokenKind.StringLiteral,
|
||||||
|
@ -74,7 +75,11 @@ function buildDependencies(reviewLines: ReviewLine[], dependencies: Record<strin
|
||||||
SkipDiff: true,
|
SkipDiff: true,
|
||||||
});
|
});
|
||||||
const dependencyLine: ReviewLine = {
|
const dependencyLine: ReviewLine = {
|
||||||
Tokens: [nameToken, buildToken({ Kind: TokenKind.Punctuation, Value: ":" }), versionToken],
|
Tokens: [
|
||||||
|
nameToken,
|
||||||
|
buildToken({ Kind: TokenKind.Punctuation, Value: ":", SkipDiff: true }),
|
||||||
|
versionToken,
|
||||||
|
],
|
||||||
};
|
};
|
||||||
dependencyLines.push(dependencyLine);
|
dependencyLines.push(dependencyLine);
|
||||||
}
|
}
|
||||||
|
|
|
@ -24,9 +24,14 @@ export interface CodeFile {
|
||||||
/** Language variant is applicable only for java variants */
|
/** Language variant is applicable only for java variants */
|
||||||
LanguageVariant?: "None" | "Spring" | "Android";
|
LanguageVariant?: "None" | "Spring" | "Android";
|
||||||
CrossLanguagePackageId?: string;
|
CrossLanguagePackageId?: string;
|
||||||
ReviewLines: ReviewLine[];
|
ReviewLines: Array<ReviewLine>;
|
||||||
/** Add any system generated comments. Each comment is linked to review line ID */
|
/** Add any system generated comments. Each comment is linked to review line ID */
|
||||||
Diagnostics?: CodeDiagnostic[];
|
Diagnostics?: Array<CodeDiagnostic>;
|
||||||
|
/**
|
||||||
|
* Navigation items are used to create a tree view in the navigation panel. Each navigation item is linked to a review line ID. This is optional.
|
||||||
|
* If navigation items are not provided then navigation panel will be automatically generated using the review lines. Navigation items should be provided only if you want to customize the navigation panel.
|
||||||
|
*/
|
||||||
|
Navigation?: Array<NavigationItem>;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** ReviewLine object corresponds to each line displayed on API review. If an empty line is required then add a code line object without any token. */
|
/** ReviewLine object corresponds to each line displayed on API review. If an empty line is required then add a code line object without any token. */
|
||||||
|
@ -40,12 +45,12 @@ export interface ReviewLine {
|
||||||
LineId?: string;
|
LineId?: string;
|
||||||
CrossLanguageId?: string;
|
CrossLanguageId?: string;
|
||||||
/** list of tokens that constructs a line in API review */
|
/** list of tokens that constructs a line in API review */
|
||||||
Tokens: ReviewToken[];
|
Tokens: Array<ReviewToken>;
|
||||||
/**
|
/**
|
||||||
* Add any child lines as children. For e.g. all classes and namespace level methods are added as a children of namespace(module) level code line.
|
* Add any child lines as children. For e.g. all classes and namespace level methods are added as a children of namespace(module) level code line.
|
||||||
* Similarly all method level code lines are added as children of it's class code line.
|
* Similarly all method level code lines are added as children of it's class code line.
|
||||||
*/
|
*/
|
||||||
Children?: ReviewLine[];
|
Children?: Array<ReviewLine>;
|
||||||
/** Set current line as hidden code line by default. .NET has hidden APIs and architects don't want to see them by default. */
|
/** Set current line as hidden code line by default. .NET has hidden APIs and architects don't want to see them by default. */
|
||||||
IsHidden?: boolean;
|
IsHidden?: boolean;
|
||||||
/** Set current line as context end line. For e.g. line with token } or empty line after the class to mark end of context. */
|
/** Set current line as context end line. For e.g. line with token } or empty line after the class to mark end of context. */
|
||||||
|
@ -77,6 +82,8 @@ export interface ReviewToken {
|
||||||
IsDeprecated?: boolean;
|
IsDeprecated?: boolean;
|
||||||
/** Set this to false if there is no suffix space required before next token. For e.g, punctuation right after method name */
|
/** Set this to false if there is no suffix space required before next token. For e.g, punctuation right after method name */
|
||||||
HasSuffixSpace?: boolean;
|
HasSuffixSpace?: boolean;
|
||||||
|
/** Set this to true if there is a prefix space required before current token. For e.g, space before token for = */
|
||||||
|
HasPrefixSpace?: boolean;
|
||||||
/** Set isDocumentation to true if current token is part of documentation */
|
/** Set isDocumentation to true if current token is part of documentation */
|
||||||
IsDocumentation?: boolean;
|
IsDocumentation?: boolean;
|
||||||
/** Language specific style css class names */
|
/** Language specific style css class names */
|
||||||
|
@ -95,6 +102,13 @@ export interface CodeDiagnostic {
|
||||||
HelpLinkUri?: string;
|
HelpLinkUri?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface NavigationItem {
|
||||||
|
Text: string;
|
||||||
|
NavigationId: string;
|
||||||
|
ChildItems: Array<NavigationItem>;
|
||||||
|
Tags: Record<string, string>;
|
||||||
|
}
|
||||||
|
|
||||||
export enum TokenKind {
|
export enum TokenKind {
|
||||||
Text = 0,
|
Text = 0,
|
||||||
Punctuation = 1,
|
Punctuation = 1,
|
||||||
|
|
Загрузка…
Ссылка в новой задаче