mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-01 01:38:07 +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>
25 lines
826 B
TypeScript
25 lines
826 B
TypeScript
import { Line } from '../primitives';
|
|
/**
|
|
* Groups source lines in sections representing tags.
|
|
* First section is a block description if present. Last section captures lines starting with
|
|
* the last tag to the end of the block, including dangling closing marker.
|
|
* @param {Line[]} block souce lines making a single comment block
|
|
*/
|
|
export declare type Parser = (block: Line[]) => Line[][];
|
|
/**
|
|
* Predicate telling if string contains opening/closing escaping sequence
|
|
* @param {string} source raw source line
|
|
*/
|
|
export declare type Fencer = (source: string) => boolean;
|
|
/**
|
|
* `Parser` configuration options
|
|
*/
|
|
export interface Options {
|
|
fence: string | Fencer;
|
|
}
|
|
/**
|
|
* Creates configured `Parser`
|
|
* @param {Partial<Options>} options
|
|
*/
|
|
export default function getParser({ fence, }?: Partial<Options>): Parser;
|