Skip to content

script changes for link handling #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShashiSubramanya wants to merge 1 commit into
base: main
Choose a base branch
from
Open

script changes for link handling #394

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 27 additions & 30 deletions scripts/Converter/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,35 +153,32 @@ const _indent = (
return updateLines.join('\n');
};

// 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 convertNameToLink: (
node: string | undefined,
includeParent?: boolean,
) => string;

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;

return prevUpdatedText.replace(curLinkText, newLinkText);
}, text);

return updatedText;
};
// 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 convertNameToLink: (node: string | undefined, includeParent?: boolean) => string;

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

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

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

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
Loading