mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-09-28 13:13:37 +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>
24 lines
550 B
JavaScript
24 lines
550 B
JavaScript
const { parse, inspect } = require('../../lib/index.cjs');
|
|
|
|
const source = `
|
|
/** Multi-line typedef for an options object type.
|
|
*
|
|
* @typedef {{
|
|
* prop: number
|
|
* }} MyOptions description text
|
|
*/`;
|
|
|
|
test('name after multiline tag', () => {
|
|
const parsed = parse(source);
|
|
// console.log(inspect(parsed[0]));
|
|
|
|
expect(parsed[0].problems).toEqual([]);
|
|
expect(parsed[0].tags[0]).toMatchObject({
|
|
tag: 'typedef',
|
|
name: 'MyOptions',
|
|
type: '{prop: number}',
|
|
description: 'description text',
|
|
problems: [],
|
|
});
|
|
});
|