lib/lint
lib/lint.js
Functions(15)
Signature
hasAnyBlock(sym: any): any
Signature
push(issues: any, symbol: any, rule: any, message: any, line: any)
Signature
lintParams(issues: any, symbol: any, params: any, jsdocParams: any, line: any)
| Parameter | Type | Optional | Description |
|---|---|---|---|
issues | any | ||
symbol | any | ||
returnType | any | ||
returns | any | ||
line | any |
Signature
lintReturns(issues: any, symbol: any, returnType: any, returns: any, line: any)
Signature
lintDescription(issues: any, symbol: any, description: any, line: any)
Full structural family for a function/method: require-jsdoc gates everything else.
| Parameter | Type | Optional | Description |
|---|---|---|---|
issues | any | ||
symbol | any | ||
sym | any | ||
skipReturns | any |
Signature
lintFunctionLike(issues: any, symbol: any, sym: any, skipReturns: any)
Signature
lintTagNames(issues: any, symbol: any, rawComment: any, line: any)
Given a `^@tag\s*(.*)$` regex match against an already-stripped ("/"/"*"
prefix removed) @tag line, returns the tag's trailing text with any
trailing comment-closer (asterisk-slash) removed and whitespace trimmed.
Shared by lintEmptyTags() below and lightFixGenericBlock()'s empty-tags fix
(lib/fix.js) -- both need exactly this string; previously each had its
own independently-written (equivalent, but needlessly divergent -- one
used a slice-offset trick to reach the same result) expression for it.
| Parameter | Type | Optional | Description |
|---|---|---|---|
tagMatch | RegExpMatchArray | - result of stripped.match(/^@([a-zA-Z][\w-]*)\s*(.*)$/) |
Returns:
string Signature
tagTrailingText(tagMatch: any): any
Signature
lintEmptyTags(issues: any, symbol: any, rawComment: any, line: any)
Signature
lintMultiAsterisks(issues: any, symbol: any, rawComment: any, line: any)
Signature
lintBlankBlock(issues: any, symbol: any, rawComment: any, line: any)
Signature
lintBadBlock(issues: any, symbol: any, badComment: any, line: any)
Signature
lintTextLevel(issues: any, symbol: any, sym: any)
Signature
lintGeneric(issues: any, symbol: any, sym: any)
Variables & Constants(21)
let KNOWN_TAGS: Set
varlib/lint.js
----------------------------------------
Pure, synchronous JSDoc validation over the shape extractModule() already
returns (lib/extractor.js), now including each symbol's rawComment /
badComment text. No ESLint, no new npm dependency, no type-checker —
reuses exactly the AST + parsed-JSDoc data the rest of the tool already
builds. See docs/backlog/adr-011-native-lint-engine.md for the LintIssue
schema and the rule-scope decisions (structural vs. text-level, what's
deferred to a later sprint).
Signature
let KNOWN_TAGS: Set