This repository has been archived by the owner on Sep 19, 2024. It is now read-only.
feat: change to markdown and map html to markdown #688
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| declare module "mdast-util-gfm"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,11 @@ | ||
| import { getWalletAddress } from "../../adapters/supabase"; | ||
| import { getBotConfig, getBotContext, getLogger } from "../../bindings"; | ||
| import { addCommentToIssue, generatePermit2Signature, getAllIssueComments, getIssueDescription, getTokenSymbol, parseComments } from "../../helpers"; | ||
| import { Incentives, MarkdownItem, MarkdownItems, Payload, StateReason, UserType } from "../../types"; | ||
| import { commentParser } from "../comment"; | ||
| import Decimal from "decimal.js"; | ||
| import { bountyInfo } from "../wildcard"; | ||
| import { HTMLItem } from "../../types/html"; | ||
|
|
||
| const ItemsToExclude: string[] = [MarkdownItem.BlockQuote]; | ||
| /** | ||
|
|
@@ -62,7 +63,7 @@ export const incentivizeComments = async () => { | |
| return; | ||
| } | ||
|
|
||
| const issueComments = await getAllIssueComments(issue.number); | ||
| logger.info(`Getting the issue comments done. comments: ${JSON.stringify(issueComments)}`); | ||
| const issueCommentsByUser: Record<string, string[]> = {}; | ||
| for (const issueComment of issueComments) { | ||
|
|
@@ -73,14 +74,14 @@ export const incentivizeComments = async () => { | |
| logger.info(`Skipping to parse the comment because it contains commands. comment: ${JSON.stringify(issueComment)}`); | ||
| continue; | ||
| } | ||
| if (!issueComment.body) { | ||
| logger.info(`Skipping to parse the comment because body is undefined. comment: ${JSON.stringify(issueComment)}`); | ||
| continue; | ||
| } | ||
| if (!issueCommentsByUser[user.login]) { | ||
| issueCommentsByUser[user.login] = []; | ||
| } | ||
| issueCommentsByUser[user.login].push(issueComment.body); | ||
| } | ||
| const tokenSymbol = await getTokenSymbol(paymentToken, rpc); | ||
| logger.info(`Filtering by the user type done. commentsByUser: ${JSON.stringify(issueCommentsByUser)}`); | ||
|
|
@@ -172,7 +173,7 @@ export const incentivizeCreatorComment = async () => { | |
| return; | ||
| } | ||
|
|
||
| const description = await getIssueDescription(issue.number); | ||
| if (!description) { | ||
| logger.info(`Skipping to generate a permit url because issue description is empty. description: ${description}`); | ||
| return; | ||
|
|
@@ -243,28 +244,63 @@ const generatePermitForComments = async ( | |
| * @param incentives - The basic price table for reward calculation | ||
| * @returns - The reward value | ||
| */ | ||
| const calculateRewardValue = (comments: Record<MarkdownItem, string[]>, incentives: Incentives): Decimal => { | ||
| let sum = new Decimal(0); | ||
| for (const item of MarkdownItems) { | ||
| const value = comments[item]; | ||
|
|
||
| // if it's a text node calculate word count and multiply with the reward value | ||
| if (item === MarkdownItem.Text) { | ||
| if (!incentives.comment.totals.word) { | ||
| continue; | ||
| } | ||
| const wordReward = new Decimal(incentives.comment.totals.word); | ||
| const reward = wordReward.mul(value.map((str) => str.trim().split(" ").length).reduce((totalWords, wordCount) => totalWords + wordCount, 0)); | ||
| sum = sum.add(reward); | ||
| } else { | ||
| const htmlTag = MarkdownItemToHTMLTag[item]; | ||
| if (!htmlTag || !incentives.comment.elements[htmlTag]) { | ||
| continue; | ||
| } | ||
| const rewardValue = new Decimal(incentives.comment.elements[htmlTag]); | ||
| const reward = rewardValue.mul(value.length); | ||
| sum = sum.add(reward); | ||
| } | ||
| } | ||
|
|
||
| return sum; | ||
| }; | ||
|
|
||
| const MarkdownItemToHTMLTag: Record<MarkdownItem, string> = { | ||
| [MarkdownItem.Text]: HTMLItem.P, | ||
| [MarkdownItem.Paragraph]: HTMLItem.P, | ||
| [MarkdownItem.Heading]: HTMLItem.H1, | ||
| [MarkdownItem.Heading1]: HTMLItem.H1, | ||
| [MarkdownItem.Heading2]: HTMLItem.H2, | ||
| [MarkdownItem.Heading3]: HTMLItem.H3, | ||
| [MarkdownItem.Heading4]: HTMLItem.H4, | ||
| [MarkdownItem.Heading5]: HTMLItem.H5, | ||
| [MarkdownItem.Heading6]: HTMLItem.H6, | ||
| [MarkdownItem.ListItem]: HTMLItem.LI, | ||
| [MarkdownItem.List]: HTMLItem.UL, | ||
| [MarkdownItem.Link]: HTMLItem.A, | ||
| [MarkdownItem.Image]: HTMLItem.IMG, | ||
| [MarkdownItem.BlockQuote]: HTMLItem.BLOCKQUOTE, | ||
| [MarkdownItem.Code]: HTMLItem.PRE, | ||
| [MarkdownItem.Emphasis]: HTMLItem.EM, | ||
| [MarkdownItem.Strong]: HTMLItem.STRONG, | ||
| [MarkdownItem.Delete]: HTMLItem.DEL, | ||
| [MarkdownItem.HTML]: HTMLItem.HTML, | ||
| [MarkdownItem.InlineCode]: HTMLItem.CODE, | ||
| [MarkdownItem.LinkReference]: HTMLItem.A, | ||
| [MarkdownItem.ImageReference]: HTMLItem.IMG, | ||
| [MarkdownItem.FootnoteReference]: HTMLItem.SUP, | ||
| [MarkdownItem.FootnoteDefinition]: HTMLItem.P, | ||
|
There was a problem hiding this comment. I'm not sure how can we represent footnote reference and definition by HTML? @pavlovcik Example of footnote1 Footnotes
There was a problem hiding this comment. Very cool. I didn't know about this but I guess we can just file an issue and kick the can down the road? |
||
| [MarkdownItem.Table]: HTMLItem.TABLE, | ||
| [MarkdownItem.TableCell]: HTMLItem.TD, | ||
| [MarkdownItem.TableRow]: HTMLItem.TR, | ||
| [MarkdownItem.ThematicBreak]: HTMLItem.HR, | ||
| [MarkdownItem.Break]: HTMLItem.BR, | ||
| [MarkdownItem.Root]: HTMLItem.HTML, | ||
| [MarkdownItem.Definition]: HTMLItem.DL, | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,89 @@ | ||
| import { MarkdownItem } from "../types"; | ||
| import fromMarkdown from "mdast-util-from-markdown"; | ||
| import gfmFromMarkdown from "mdast-util-gfm"; | ||
| import gfm from "micromark-extension-gfm"; | ||
|
|
||
| type Node = { | ||
| type: MarkdownItem; | ||
| value: string; | ||
| depth?: number; | ||
| children: Node[]; | ||
| }; | ||
|
|
||
| const traverse = (result: Record<MarkdownItem, string[]>, node: Node, itemsToExclude: string[]): Record<MarkdownItem, string[]> => { | ||
| if (!result[node.type]) { | ||
| result[node.type] = []; | ||
| } | ||
|
|
||
| if (node.type === MarkdownItem.Heading) { | ||
| node.type = `heading${node.depth}` as MarkdownItem; | ||
| } | ||
|
|
||
| result[node.type].push(node.value?.trim() ?? ""); | ||
|
|
||
| if (itemsToExclude.includes(node.type)) { | ||
| return result; | ||
| } | ||
|
|
||
| if (node.children && node.children.length > 0) { | ||
| node.children.forEach((child) => traverse(result, child, itemsToExclude)); | ||
| } | ||
|
|
||
| return result; | ||
| }; | ||
|
|
||
| export const parseComments = async (comments: string[], itemsToExclude: string[]): Promise<Record<MarkdownItem, string[]>> => { | ||
| const result: Record<MarkdownItem, string[]> = { | ||
| [MarkdownItem.Text]: [], | ||
| [MarkdownItem.Paragraph]: [], | ||
| [MarkdownItem.Heading]: [], | ||
| [MarkdownItem.Heading1]: [], | ||
| [MarkdownItem.Heading2]: [], | ||
| [MarkdownItem.Heading3]: [], | ||
| [MarkdownItem.Heading4]: [], | ||
| [MarkdownItem.Heading5]: [], | ||
| [MarkdownItem.Heading6]: [], | ||
| [MarkdownItem.ListItem]: [], | ||
| [MarkdownItem.List]: [], | ||
| [MarkdownItem.Link]: [], | ||
| [MarkdownItem.Image]: [], | ||
| [MarkdownItem.BlockQuote]: [], | ||
| [MarkdownItem.Code]: [], | ||
| [MarkdownItem.Emphasis]: [], | ||
| [MarkdownItem.Strong]: [], | ||
| [MarkdownItem.Delete]: [], | ||
| [MarkdownItem.HTML]: [], | ||
| [MarkdownItem.InlineCode]: [], | ||
| [MarkdownItem.LinkReference]: [], | ||
| [MarkdownItem.ImageReference]: [], | ||
| [MarkdownItem.FootnoteReference]: [], | ||
| [MarkdownItem.FootnoteDefinition]: [], | ||
| [MarkdownItem.Table]: [], | ||
| [MarkdownItem.TableCell]: [], | ||
| [MarkdownItem.TableRow]: [], | ||
| [MarkdownItem.ThematicBreak]: [], | ||
| [MarkdownItem.Break]: [], | ||
| [MarkdownItem.Root]: [], | ||
| [MarkdownItem.Definition]: [], | ||
| }; | ||
|
|
||
| for (const comment of comments) { | ||
| const tree = fromMarkdown(comment, { | ||
| extensions: [gfm()], | ||
| mdastExtensions: [gfmFromMarkdown.fromMarkdown], | ||
| }); | ||
| console.log(`Comment Mdast Tree: ${JSON.stringify(tree, null, 2)}`); | ||
| traverse(result, tree as Node, itemsToExclude); | ||
| } | ||
|
|
||
| console.log(`Comment Parsed: ${JSON.stringify(result, null, 2)}`); | ||
|
|
||
| // remove empty values | ||
| if (result[MarkdownItem.Text]) { | ||
| result[MarkdownItem.Text] = result[MarkdownItem.Text].filter((str) => str.length > 0); | ||
| } | ||
|
|
||
| console.log(`Comment Parsed Cleaned: ${JSON.stringify(result, null, 2)}`); | ||
|
|
||
| return result; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| export enum HTMLItem { | ||
| P = "p", | ||
| H1 = "h1", | ||
| H2 = "h2", | ||
| H3 = "h3", | ||
| H4 = "h4", | ||
| H5 = "h5", | ||
| H6 = "h6", | ||
| UL = "ul", | ||
| A = "a", | ||
| IMG = "img", | ||
| BLOCKQUOTE = "blockquote", | ||
| CODE = "code", | ||
| EM = "em", | ||
| STRONG = "strong", | ||
| DEL = "del", | ||
| HTML = "html", | ||
| SUP = "sup", | ||
| LI = "li", | ||
| TABLE = "table", | ||
| TR = "tr", | ||
| TD = "td", | ||
| HR = "hr", | ||
| BR = "br", | ||
| DL = "dl", | ||
| PRE = "pre", | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,70 @@ | ||
| // All types supported by standard Markdown and GFM | ||
| export enum MarkdownItem { | ||
| // Standard Markdown | ||
| BlockQuote = "blockquote", | ||
| Break = "break", | ||
| Code = "code", | ||
| Definition = "definition", | ||
| Emphasis = "emphasis", | ||
| Heading = "heading", | ||
| HTML = "html", | ||
| Image = "image", | ||
| ImageReference = "imageReference", | ||
| InlineCode = "inlineCode", | ||
| Link = "link", | ||
| LinkReference = "linkReference", | ||
| List = "list", | ||
| ListItem = "listItem", | ||
| Paragraph = "paragraph", | ||
| Root = "root", | ||
| Strong = "strong", | ||
| Text = "text", | ||
| ThematicBreak = "thematicBreak", | ||
| // GFM | ||
| Delete = "delete", | ||
| FootnoteDefinition = "footnoteDefinition", | ||
| FootnoteReference = "footnoteReference", | ||
| Table = "table", | ||
| TableCell = "tableCell", | ||
| TableRow = "tableRow", | ||
| // Our custom types to make it compatible with HTML | ||
| Heading1 = "heading1", | ||
| Heading2 = "heading2", | ||
| Heading3 = "heading3", | ||
| Heading4 = "heading4", | ||
| Heading5 = "heading5", | ||
| Heading6 = "heading6", | ||
| } | ||
| export const MarkdownItems = [ | ||
| MarkdownItem.BlockQuote, | ||
| MarkdownItem.Break, | ||
| MarkdownItem.Code, | ||
| MarkdownItem.Definition, | ||
| MarkdownItem.Emphasis, | ||
| MarkdownItem.Heading, | ||
| MarkdownItem.HTML, | ||
| MarkdownItem.Image, | ||
| MarkdownItem.ImageReference, | ||
| MarkdownItem.InlineCode, | ||
| MarkdownItem.Link, | ||
| MarkdownItem.LinkReference, | ||
| MarkdownItem.List, | ||
| MarkdownItem.ListItem, | ||
| MarkdownItem.Paragraph, | ||
| MarkdownItem.Root, | ||
| MarkdownItem.Strong, | ||
| MarkdownItem.Text, | ||
| MarkdownItem.ThematicBreak, | ||
| MarkdownItem.Delete, | ||
| MarkdownItem.FootnoteDefinition, | ||
| MarkdownItem.FootnoteReference, | ||
| MarkdownItem.Table, | ||
| MarkdownItem.TableCell, | ||
| MarkdownItem.TableRow, | ||
| MarkdownItem.Heading1, | ||
| MarkdownItem.Heading2, | ||
| MarkdownItem.Heading3, | ||
| MarkdownItem.Heading4, | ||
| MarkdownItem.Heading5, | ||
| MarkdownItem.Heading6, | ||
| ] as const; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if it's gonna be clear to partners that
<pre>refers toand
<code>refers toinline code