mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-05 19:41:12 +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>
21 lines
953 B
TypeScript
21 lines
953 B
TypeScript
import { Line, BlockMarkers, Markers } from '../../primitives';
|
|
import { Tokenizer } from './index';
|
|
/**
|
|
* Walks over provided lines joining description token into a single string.
|
|
* */
|
|
export declare type Joiner = (lines: Line[], markers?: BlockMarkers) => string;
|
|
/**
|
|
* Shortcut for standard Joiners
|
|
* compact - strip surrounding whitespace and concat lines using a single string
|
|
* preserve - preserves original whitespace and line breaks as is
|
|
*/
|
|
export declare type Spacing = 'compact' | 'preserve' | Joiner;
|
|
/**
|
|
* Makes no changes to `spec.lines[].tokens` but joins them into `spec.description`
|
|
* following given spacing srtategy
|
|
* @param {Spacing} spacing tells how to handle the whitespace
|
|
* @param {BlockMarkers} markers tells how to handle comment block delimitation
|
|
*/
|
|
export default function descriptionTokenizer(spacing?: Spacing, markers?: typeof Markers): Tokenizer;
|
|
export declare function getJoiner(spacing: Spacing): Joiner;
|