mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-09-28 21:24:26 +08:00
Jack Franklin
fd72c071cc
This CL adds the eslint-plugin-jsdoc plugin and enables just one rule, `jsdoc/check-alignment`, which ensures that all the lines in a comment are correctly aligned. For example: ``` /** * foo * bar */ ``` Would fail the check and be corrected to: ``` /** * foo * bar */ ``` DISABLE_THIRD_PARTY_CHECK=deliberate install + use of eslint-plugin-jsdoc node_module Bug: none Change-Id: I969983cd550653654a334ede3409b8c850467245 Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/4110906 Commit-Queue: Andres Olivares <andoli@chromium.org> Reviewed-by: Andres Olivares <andoli@chromium.org> Auto-Submit: Jack Franklin <jacktfranklin@chromium.org> Commit-Queue: Jack Franklin <jacktfranklin@chromium.org>
55 lines
1.2 KiB
TypeScript
55 lines
1.2 KiB
TypeScript
/** @deprecated */
|
|
export declare enum Markers {
|
|
start = "/**",
|
|
nostart = "/***",
|
|
delim = "*",
|
|
end = "*/"
|
|
}
|
|
export interface BlockMarkers {
|
|
start: string;
|
|
nostart: string;
|
|
delim: string;
|
|
end: string;
|
|
}
|
|
export interface Block {
|
|
description: string;
|
|
tags: Spec[];
|
|
source: Line[];
|
|
problems: Problem[];
|
|
}
|
|
export interface Spec {
|
|
tag: string;
|
|
name: string;
|
|
default?: string;
|
|
type: string;
|
|
optional: boolean;
|
|
description: string;
|
|
problems: Problem[];
|
|
source: Line[];
|
|
}
|
|
export interface Line {
|
|
number: number;
|
|
source: string;
|
|
tokens: Tokens;
|
|
}
|
|
export interface Tokens {
|
|
start: string;
|
|
delimiter: string;
|
|
postDelimiter: string;
|
|
tag: string;
|
|
postTag: string;
|
|
name: string;
|
|
postName: string;
|
|
type: string;
|
|
postType: string;
|
|
description: string;
|
|
end: string;
|
|
lineEnd: string;
|
|
}
|
|
export interface Problem {
|
|
code: 'unhandled' | 'custom' | 'source:startline' | 'spec:tag:prefix' | 'spec:type:unpaired-curlies' | 'spec:name:unpaired-brackets' | 'spec:name:empty-name' | 'spec:name:invalid-default' | 'spec:name:empty-default';
|
|
message: string;
|
|
line: number;
|
|
critical: boolean;
|
|
}
|