jsdoczoom 0.4.15 → 0.4.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/jsdoc-parser.js +3 -3
- package/package.json +1 -1
- package/types/jsdoc-parser.d.ts +4 -1
package/dist/jsdoc-parser.js
CHANGED
|
@@ -17,9 +17,9 @@ import { appendText, DESCRIPTION_TAGS } from "./types.js";
|
|
|
17
17
|
* Returns the raw JSDoc text without the leading `/**` and trailing `*/` delimiters,
|
|
18
18
|
* or null if no file-level JSDoc is found.
|
|
19
19
|
*/
|
|
20
|
-
export function extractFileJsdoc(sourceText) {
|
|
20
|
+
export function extractFileJsdoc(sourceText, fileName = "input.tsx") {
|
|
21
21
|
const sourceFile = ts.createSourceFile(
|
|
22
|
-
|
|
22
|
+
fileName,
|
|
23
23
|
sourceText,
|
|
24
24
|
ts.ScriptTarget.Latest,
|
|
25
25
|
true,
|
|
@@ -222,7 +222,7 @@ export function parseFileSummaries(filePath) {
|
|
|
222
222
|
} catch {
|
|
223
223
|
throw new JsdocError("FILE_NOT_FOUND", `File not found: ${filePath}`);
|
|
224
224
|
}
|
|
225
|
-
const jsdocText = extractFileJsdoc(sourceText);
|
|
225
|
+
const jsdocText = extractFileJsdoc(sourceText, filePath);
|
|
226
226
|
if (jsdocText === null) {
|
|
227
227
|
return {
|
|
228
228
|
path: filePath,
|
package/package.json
CHANGED
package/types/jsdoc-parser.d.ts
CHANGED
|
@@ -14,7 +14,10 @@ import { type ParsedFileInfo } from "./types.js";
|
|
|
14
14
|
* Returns the raw JSDoc text without the leading `/**` and trailing `*/` delimiters,
|
|
15
15
|
* or null if no file-level JSDoc is found.
|
|
16
16
|
*/
|
|
17
|
-
export declare function extractFileJsdoc(
|
|
17
|
+
export declare function extractFileJsdoc(
|
|
18
|
+
sourceText: string,
|
|
19
|
+
fileName?: string,
|
|
20
|
+
): string | null;
|
|
18
21
|
/**
|
|
19
22
|
* Parse a TypeScript file and extract its summary and description from file-level JSDoc.
|
|
20
23
|
*
|