Skip to content
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.

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

feat(gnoweb): add hyperlinks to import p/*and r/* in source code viewer #3759

Open
wants to merge 35 commits into
base: master
Choose a base branch
from

Conversation

mous1985
Copy link
Contributor

@mous1985 mous1985 commented Feb 15, 2025

This PR adds hyperlinks to package and realm imported in the source code viewer on gnoweb.

Image
  • Context and Goal:
    When users view source code on gnoweb, they often need to explore dependencies and related code. the goal was to make this easier by making imports linkable for example, when you see import "gno.land/p/demo/avl", you should be able to click it to see that package's source code.

thanks to @gfanton for the help

@github-actions github-actions bot added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Feb 15, 2025
@Gno2D2 Gno2D2 requested a review from a team February 15, 2025 13:00
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Feb 15, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Feb 15, 2025

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
  • The pull request description provides enough details (checked by @thehowl)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🟢 Changes related to gnoweb must be reviewed by its codeowners
🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. 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:
  1. 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
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: mous1985/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Changes related to gnoweb must be reviewed by its codeowners

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 A changed file matches this pattern: ^gno.land/pkg/gnoweb/ (filename: gno.land/pkg/gnoweb/webclient_html.go)

Then

🟢 Requirement satisfied
└── 🟢 Or
    ├── 🟢 This user reviewed pull request: alexiscolin
    └── 🔴 This user reviewed pull request: gfanton

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

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
└── 🟢 And
    ├── 🟢 Not (🔴 Pull request author is a member of the team: core-contributors)
    └── 🟢 Not (🔴 Pull request author is user: dependabot[bot])

Can be checked by

  • team core-contributors

@mous1985 mous1985 marked this pull request as draft February 15, 2025 13:08
@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Feb 15, 2025
@gfanton
Copy link
Member

gfanton commented Feb 17, 2025

@mous1985 before any reviews, can you add tests, especially testing:

  • single one line import import "abc.yx/a/b/c"
  • multi import:
import (
                 "abc.yx/a/b/c"
                 "abc.yx/a/b/c"
                 "abc.yx/a/b/c"
)
  • named import:
import (
                 hello "abc.yx/a/b/c"
)
  • empty named import:
import (
                 _ "abc.yx/a/b/c"
)

thanks

@github-actions github-actions bot added the 📦 🤖 gnovm Issues or PRs gnovm related label Feb 17, 2025
Copy link

codecov bot commented Feb 17, 2025

Codecov Report

Attention: Patch coverage is 82.60870% with 4 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
gno.land/pkg/gnoweb/webclient_html.go 82.60% 2 Missing and 2 partials ⚠️

📢 Thoughts on this report? Let us know!

@alexiscolin alexiscolin self-requested a review February 19, 2025 10:33
@@ -344,3 +344,12 @@
scrollbar-width: none;
}
}
/* Styling for import links */
.gno-import {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please try to use Tailwind and its config theme instead of using a new classes, new colors etc?

Copy link
Contributor Author

@mous1985 mous1985 Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fffb7f4
It's good if i use <a href="/%s$source" class="text-blue-600 hover:underline">&#34;%s&#34;</a> the same color as the original import ?

@mous1985 mous1985 marked this pull request as ready for review February 25, 2025 15:31
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Feb 25, 2025
@thehowl thehowl requested a review from alexiscolin February 28, 2025 11:38
Copy link
Member

@notJoon notJoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍 I've left a few points related to refactoring things

Copy link
Member

@notJoon notJoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

remove: review/triage-pending flag

@notJoon notJoon removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Mar 7, 2025
Copy link
Member

@alexiscolin alexiscolin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice feature 👍
Nit: Could using a regex help by robustly matching import tokens, so we are not relying on fixed strings and specific newline formatting? But maybe it's a picky safeguard against potential changes in output format.

@Gno2D2 Gno2D2 requested a review from gfanton March 7, 2025 19:11
@mous1985
Copy link
Contributor Author

mous1985 commented Mar 7, 2025

Nice feature 👍 Nit: Could using a regex help by robustly matching import tokens, so we are not relying on fixed strings and specific newline formatting? But maybe it's a picky safeguard against potential changes in output format.

3d25c38

return nil
formatted := buf.String()

// Process .gno files to add links
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a hack

We have an extensible markdown engine, we should implement this as an extension there, unless you can show it's impossible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 ⛰️ gno.land Issues or PRs gno.land package related 📦 🤖 gnovm Issues or PRs gnovm related
Projects
Status: In Progress
Status: In Review
Development

Successfully merging this pull request may close these issues.

7 participants