feat(examples): Implement markdown package #2912

sunspirit99 · 2024-10-05T12:59:27Z

I keep this PR open to see if I am on the right approach. If it's suitable, I'll investigate to make further improvements and provide implementation examples in the Render() functions of some current demo realms to demonstrate the use of this package

cc @moul

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

codecov · 2024-10-05T13:01:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

moul · 2024-10-08T08:11:19Z

It's heading in the right direction by avoiding HTML, unlike other recent PRs. However, the current implementation isn't complete or appealing enough for me yet, though it may be for others.

I believe it makes sense to view this PR not as a UI framework proposal but as a minimal md library. This library can be used by you or anyone else to build various UI frameworks. I'm fine with that direction. Therefore, you should rename markdown to md.

moul · 2024-10-08T08:15:46Z

examples/gno.land/p/demo/markdown/markdown.gno

+}
+
+// TodoList returns a list of todo items with checkboxes for markdown
+func TodoList(items []TodoItem) string {


not sure if it would be better, but it could be nice to find a solution that would avoid having to use custom types and avoid something like this:

tl := markdown.TodoList([]markdown.TodoItem{ // this line is the one I dislike {}, {}, // ... })

0aaf911 do u like this change ?

changed
func TodoList(items []TodoItem) string
to
func TodoList(items []string, done []bool) string

moul · 2024-10-08T08:17:55Z

examples/gno.land/p/demo/markdown/markdown.gno

+}
+
+// CodeBlock returns a code block for markdown, optionally specifying the language
+func CodeBlock(code string, language string) string {


Maybe we could create individual helpers for CodeBlock and LanguageCodeBlock. We don't need to adhere strictly to markdown specifications. Instead, we should aim for a good compromise regarding helper names and parameters that will facilitate effective documentation generation and autocompletion.

The current approach might be the best, but a more usage-based method could also be worth considering.

moul · 2024-10-08T08:20:01Z

examples/gno.land/p/demo/markdown/markdown.gno

+// Footnote returns a footnote for markdown
+func Footnote(reference, text string) string {
+	return ufmt.Sprintf("[%s]: %s", reference, text)
+}


missing func Paragraph, maybe?

moul · 2024-10-08T08:29:43Z

examples/gno.land/p/demo/markdown/markdown_test.gno

@@ -0,0 +1,118 @@
+package markdown


This package is a perfect example of something that would benefit from a realm-based demo r/demo/md. The demo should iterate over the available helpers, displaying their usage and the corresponding results.

renamed to md

moul · 2024-10-08T08:31:13Z

examples/gno.land/p/demo/markdown/table.gno

+}
+
+// NewTable creates a new Table instance, ensuring the header and rows match in size
+func NewTable(header []string, rows [][]string) (*Table, error) {


What is the advantage of having a NewTable that returns a Stringer? Wouldn't it be enough to just have a func Table?

It would be convenient to have this helper, or perhaps a second one that accepts Stringer or interface{} instead of string. Alternatively, we could keep this as a standalone package.

I personally enjoy this usage, which is compatible with ufmt: https://pkg.go.dev/text/tabwriter

not sure i understood your idea correctly, plz take a look at the last commit changes

moul

I provided some opinionated feedback. I believe the current library is similar to ufmt and can be merged early, allowing us to improve it over time.

I would prefer if you renamed it to md. Additionally, please create a demo realm to showcase its capabilities.

That said, I'm fine with merging early.

sunspirit99 · 2024-10-08T16:25:30Z

I provided some opinionated feedback. I believe the current library is similar to ufmt and can be merged early, allowing us to improve it over time.

I would prefer if you renamed it to md. Additionally, please create a demo realm to showcase its capabilities.

That said, I'm fine with merging early.

@moul thanks for reviewing, i've made some changes, hope these things make sense to go ahead. I also raise another PR to apply this package into current demo realms soon

gfanton · 2024-10-14T14:18:58Z

@moul I'm fine with merging this, but I'm hesitant about using the md module for now. Multiple ideas are emerging for an md framework. Should we consider moving this to a submodule instead, allowing others to submit their ideas? I'm concerned about having multiple libraries without coherence, all doing the same thing.

n0izn0iz · 2024-10-31T18:42:01Z

examples/gno.land/p/demo/md/md.gno

+func EscapeMarkdown(text string) string {
+	return ufmt.Sprintf("``%s``", text)
+}


can't this be bypassed by doing something like

text := "`` some-malicious-md ``"

?

Thanks for the catch, i tested the example with potential Markdown syntax, and it successfully retains the original text without rendering Markdown. The only effect is the removal of the outer backticks

leohhhn · 2024-11-07T13:47:24Z

@sunspirit99

Can you move this code to your personal/company namespace?

sunspirit99 · 2024-11-09T13:02:52Z

@sunspirit99

Can you move this code to your personal/company namespace?

752ebf3 i've moved to my new house

leohhhn

Let's merge and see how people use this lib; maybe it will need some iteration.

cc @moul

EDIT: awaiting some internal discussions; I'll remove the "don't merge" label after them.

Gno2D2 · 2024-12-12T10:28:15Z

🛠 PR Checks Summary

🔴 The pull request head branch must be up-to-date with its base (more info)

Manual Checks (for Reviewers):

SKIP: Do not block the CI for this PR
The pull request description provides enough details

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🔴 The pull request head branch must be up-to-date with its base (more info)

☑️ Contributor Actions:

Fix any issues flagged by automated checks.
Follow the Contributor Checklist to ensure your PR is ready for review.
- Add new tests, or document why they are unnecessary.
- Provide clear examples/screenshots, if necessary.
- Update documentation, if required.
- Ensure no breaking changes, or include BREAKING CHANGE notes.
- Link related issues/PRs, where applicable.

☑️ Reviewer Actions:

Complete manual checks for the PR, including the guidelines and additional checks if applicable.

📚 Resources:

Debug

Automated Checks
Maintainers must be able to edit this pull request (more info)
If
🟢 Condition met
└── 🟢 The pull request was created from a fork (head branch repo: sunspirit99/gno)
Then
🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request
The pull request head branch must be up-to-date with its base (more info)
If
🟢 Condition met
└── 🟢 On every pull request
Then
🔴 Requirement not satisfied
└── 🔴 Head branch (sunspirit99:implement-markdown-library) is up to date with base (master): behind by 105 / ahead by 33
Manual Checks
**SKIP**: Do not block the CI for this PR
If
🟢 Condition met
└── 🟢 On every pull request
Can be checked by

Any user with comment edit permission
The pull request description provides enough details
If
🟢 Condition met
└── 🟢 Not (🔴 Pull request author is a member of the team: core-contributors)
Can be checked by

team core-contributors

sunspirit99 added 3 commits October 5, 2024 17:07

first commit

6d57efa

fixup

6c89645

refactor

451b785

sunspirit99 requested review from a team as code owners October 5, 2024 12:59

sunspirit99 requested review from jaekwon and thehowl and removed request for a team October 5, 2024 12:59

Merge branch 'master' into implement-markdown-library

61a04b9

github-actions bot assigned sunspirit99 Oct 5, 2024

github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Oct 5, 2024

sunspirit99 and others added 4 commits October 5, 2024 20:02

gno mod tidy

3644ac0

fixup

7c7fa50

make fmt

6ac3db4

Merge branch 'master' into implement-markdown-library

b469e5e

moul reviewed Oct 8, 2024

View reviewed changes

moul approved these changes Oct 8, 2024

View reviewed changes

sunspirit99 added 7 commits October 8, 2024 18:47

rename to md & refactor TodoList

0aaf911

define Paragraph function

8674cf0

update Paragraph()

8a4103e

seperate table lib from md

3057bca

update Paragraph()

4064fd1

fix ci

cec705c

fix module name

b2a9bb0

sunspirit99 and others added 2 commits October 8, 2024 23:16

Merge branch 'master' into implement-markdown-library

3be4662

fix the unit tests

c472d9b

leohhhn changed the title ~~feat(gno.land): Implement markdown package~~ feat(examples): Implement markdown package Oct 10, 2024

sunspirit99 and others added 3 commits October 11, 2024 20:41

update new func

6e66be1

fixup

3a06294

Merge branch 'master' into implement-markdown-library

bc217a6

leohhhn mentioned this pull request Oct 22, 2024

feat: add Matija's Homepage realm to examples #2916

Merged

sunspirit99 added 2 commits October 23, 2024 19:21

improve render md

a3129fa

make fmt

c91d79b

n0izn0iz reviewed Oct 31, 2024

View reviewed changes

gfanton mentioned this pull request Nov 5, 2024

feat(examples): MDUI framework #2976

Open

6 tasks

sunspirit99 added 3 commits November 9, 2024 17:43

rename method

30a75e0

Merge branch 'master' into implement-markdown-library

8cf816a

move code to my namespace

752ebf3

sunspirit99 added 6 commits November 9, 2024 20:03

make fmt

ee3ee24

optional: enable making md document with buider

b05042a

make tidy

f04d0e6

make tidy

0ece7a7

make code more readable

bbbf75f

use variadic params for Add function

be3a999

leohhhn approved these changes Nov 12, 2024

View reviewed changes

leohhhn added the don't merge Please don't merge this functionality temporarily label Nov 12, 2024

thehowl added bounty and removed bounty labels Dec 12, 2024

thehowl added the bounty/candidate PR is candidate to receive a bounty. label Dec 12, 2024

feat(examples): Implement markdown package #2912

Are you sure you want to change the base?

feat(examples): Implement markdown package #2912

Conversation

sunspirit99 commented Oct 5, 2024 • edited Loading

codecov bot commented Oct 5, 2024 • edited Loading

Codecov Report

moul commented Oct 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunspirit99 Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moul Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moul left a comment

Choose a reason for hiding this comment

sunspirit99 commented Oct 8, 2024 • edited Loading

gfanton commented Oct 14, 2024

n0izn0iz Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leohhhn commented Nov 7, 2024

sunspirit99 commented Nov 9, 2024

leohhhn left a comment • edited Loading

Choose a reason for hiding this comment

Gno2D2 commented Dec 12, 2024 • edited Loading

🛠 PR Checks Summary

Manual Checks (for Reviewers):

✅ Automated Checks (for Contributors):

☑️ Contributor Actions:

☑️ Reviewer Actions:

📚 Resources:

If

Then

If

Then

If

Can be checked by

If

Can be checked by

sunspirit99 commented Oct 5, 2024 •

edited

Loading

codecov bot commented Oct 5, 2024 •

edited

Loading

sunspirit99 Oct 8, 2024 •

edited

Loading

moul Oct 8, 2024 •

edited

Loading

sunspirit99 commented Oct 8, 2024 •

edited

Loading

n0izn0iz Oct 31, 2024 •

edited

Loading

leohhhn left a comment •

edited

Loading

Gno2D2 commented Dec 12, 2024 •

edited

Loading