Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
dd53b0c
Update index.ts
ShashiSubramanya Jun 30, 2025
4318858
Update typedocConverter.json
ShashiSubramanya Jun 30, 2025
37f2a6c
Update typedocConverter.json
ShashiSubramanya Jun 30, 2025
2387cda
Update index.ts
ShashiSubramanya Jun 30, 2025
92a58db
Update typedocConverter.json
ShashiSubramanya Jul 8, 2025
cfe486b
Update typedocConverter.json
ShashiSubramanya Jul 18, 2025
ed37a7e
Update typedocConverter.json
ShashiSubramanya Jul 22, 2025
9ae161c
Update typedocConverter.json
ShashiSubramanya Jul 24, 2025
523e5d5
Update typedocConverter.json
ShashiSubramanya Sep 24, 2025
8694c95
Update typedocConverter.json
ShashiSubramanya Oct 21, 2025
e659a72
Update typedocConverter.json
ShashiSubramanya Oct 24, 2025
9f4e061
Update typedocConverter.json
ShashiSubramanya Dec 17, 2025
8b791f4
Update typedocConverter.json
ShashiSubramanya Jan 11, 2026
34e5258
Update index.ts
ShashiSubramanya Jan 12, 2026
cc15709
typedoc link converter
ShashiSubramanya Jan 12, 2026
9d66810
Fix formatting issues in covertTypeDocText method
ShashiSubramanya Jan 12, 2026
48f14a9
Refactor TypeDocInternalParser methods for consistency
ShashiSubramanya Jan 12, 2026
ef8e843
Update typedocConverter.json
ShashiSubramanya Jan 12, 2026
e9f4c22
Fix regex replacement for closing braces in links
ShashiSubramanya Jan 12, 2026
c710e64
merge latest
ShashiSubramanya Jan 19, 2026
910736e
Update typeDocFilePath to new branch URL
ShashiSubramanya Jan 22, 2026
dff36ab
test branch
ShashiSubramanya Feb 4, 2026
279af90
test branch
ShashiSubramanya Feb 23, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 20 additions & 23 deletions scripts/Converter/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,33 +155,30 @@ const _indent = (

// All the parse functions are to be used internally (its used to get sub content)
class TypeDocInternalParser {
static convertToItalic = (name: string | undefined) =>
name ? `_${name}_` : '';
static convertToItalic = (name: string | undefined) => (name ? `_${name}_` : '');

static convertNameToLink: (
node: string | undefined,
includeParent?: boolean,
) => string;
static convertNameToLink: (node: string | undefined, includeParent?: boolean) => string;

static GITHUB_LINK =
'https://github.com/thoughtspot/visual-embed-sdk/blob/main/src';
static GITHUB_LINK = 'https://github.com/thoughtspot/visual-embed-sdk/blob/main/src';

static covertTypeDocText = (text: string) => {
// convert all {@link Name.hash}
// to xref:Name.adoc#hash[Name]
const matches = text.match(/{@link\s[^{]+}/g);
if (!matches) return text;
const updatedText = matches?.reduce((prevUpdatedText, curLinkText) => {
const linkTo = curLinkText.split(/\s/)[1].replace('}', '');
const newLinkText = this.convertNameToLink(linkTo, true);

if (!newLinkText) return prevUpdatedText;
static covertTypeDocText = (text: string) => {
// 1) Convert Markdown links -> AsciiDoc links
const updated = text.replace(
/\[([^\]]+)\]\((https?:\/\/[^)]+)\)/g,
'link:$2[$1]',
);

return prevUpdatedText.replace(curLinkText, newLinkText);
}, text);
// 2) Existing logic: convert {@link Name.hash} -> xref:...
const matches = updated.match(/{@link\s[^{]+}/g);
if (!matches) return updated;

return updatedText;
};
return matches.reduce((prevUpdatedText, curLinkText) => {
const linkTo = curLinkText.split(/\s/)[1].replace(/}/g, '');
const newLinkText = this.convertNameToLink(linkTo, true);
if (!newLinkText) return prevUpdatedText;
return prevUpdatedText.replace(curLinkText, newLinkText);
}, updated);
};

// function to parse a tag
static parseTag(tag: TypeDocCommentTag): string {
Expand All @@ -195,7 +192,7 @@ class TypeDocInternalParser {
if (tag.tag === 'example') return `${tag.text}\n`;

if (tag.tag === 'param') {
return `\nParameter::\n${tag.text}\n`;
return `\nParameter::\n${this.covertTypeDocText(tag.text)}\n`;
}
if (tag.tag === 'deprecated') {
return `[deprecated]#Deprecated : ${tag.text.replace(
Expand Down
4 changes: 2 additions & 2 deletions typedocConverter.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"branch": "main",
"typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/{branch}/static/typedoc/typedoc.json"
"branch": "version-fix",
"typeDocFilePath": "https://raw.githubusercontent.com/thoughtspot/visual-embed-sdk/refs/heads/SCAL-293438-SCAL-227101/static/typedoc/typedoc.json"
}