mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-05 03:21:16 +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>
40 lines
1.6 KiB
JavaScript
40 lines
1.6 KiB
JavaScript
import { Markers } from '../primitives.js';
|
|
import { splitLines } from '../util.js';
|
|
import blockParser from './block-parser.js';
|
|
import sourceParser from './source-parser.js';
|
|
import specParser from './spec-parser.js';
|
|
import tokenizeTag from './tokenizers/tag.js';
|
|
import tokenizeType from './tokenizers/type.js';
|
|
import tokenizeName from './tokenizers/name.js';
|
|
import tokenizeDescription, { getJoiner as getDescriptionJoiner, } from './tokenizers/description.js';
|
|
export default function getParser({ startLine = 0, fence = '```', spacing = 'compact', markers = Markers, tokenizers = [
|
|
tokenizeTag(),
|
|
tokenizeType(spacing),
|
|
tokenizeName(),
|
|
tokenizeDescription(spacing),
|
|
], } = {}) {
|
|
if (startLine < 0 || startLine % 1 > 0)
|
|
throw new Error('Invalid startLine');
|
|
const parseSource = sourceParser({ startLine, markers });
|
|
const parseBlock = blockParser({ fence });
|
|
const parseSpec = specParser({ tokenizers });
|
|
const joinDescription = getDescriptionJoiner(spacing);
|
|
return function (source) {
|
|
const blocks = [];
|
|
for (const line of splitLines(source)) {
|
|
const lines = parseSource(line);
|
|
if (lines === null)
|
|
continue;
|
|
const sections = parseBlock(lines);
|
|
const specs = sections.slice(1).map(parseSpec);
|
|
blocks.push({
|
|
description: joinDescription(sections[0], markers),
|
|
tags: specs,
|
|
source: lines,
|
|
problems: specs.reduce((acc, spec) => acc.concat(spec.problems), []),
|
|
});
|
|
}
|
|
return blocks;
|
|
};
|
|
}
|