-
Notifications
You must be signed in to change notification settings - Fork 311
feat(web): render markdown files in browse #1382
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
Open
DivyamTalwar
wants to merge
9
commits into
sourcebot-dev:main
Choose a base branch
from
DivyamTalwar:divyamtalwar/feat-794-markdown-browse-preview
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c68cb67
Make Markdown browsing match reader expectations
DivyamTalwar a93e0fa
Record Markdown preview support for release notes
DivyamTalwar 0b7c029
Merge branch 'main' into divyamtalwar/feat-794-markdown-browse-preview
DivyamTalwar d859d06
Harden repository markdown browse previews
DivyamTalwar 1c10c0a
Handle markdown preview links conservatively
DivyamTalwar 12ad7be
Preserve markdown source navigation intent
DivyamTalwar c51a277
Keep preview close links in source mode
DivyamTalwar e546a37
Preserve source mode through history links
DivyamTalwar 7308207
Close markdown preview state gaps
DivyamTalwar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
90 changes: 90 additions & 0 deletions
90
...s/web/src/app/(app)/browse/[...path]/components/codePreviewPanel/blameViewToggle.test.tsx
This file contains hidden or 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,90 @@ | ||
| import { cleanup, fireEvent, render, screen } from '@testing-library/react'; | ||
| import { afterEach, describe, expect, test, vi } from 'vitest'; | ||
| import { BlameViewToggle } from './blameViewToggle'; | ||
|
|
||
| const mocks = vi.hoisted(() => ({ | ||
| push: vi.fn(), | ||
| })); | ||
|
|
||
| vi.mock('next/navigation', () => ({ | ||
| useRouter: () => ({ | ||
| push: mocks.push, | ||
| }), | ||
| })); | ||
|
|
||
| afterEach(() => { | ||
| cleanup(); | ||
| vi.clearAllMocks(); | ||
| }); | ||
|
|
||
| describe('BlameViewToggle', () => { | ||
| test('preserves source view when entering blame mode', () => { | ||
| render( | ||
| <BlameViewToggle | ||
| repoName="github.com/sourcebot-dev/sourcebot" | ||
| revisionName="main" | ||
| path="README.md" | ||
| blame={false} | ||
| viewMode="source" | ||
| /> | ||
| ); | ||
|
|
||
| fireEvent.click(screen.getByRole('radio', { name: 'View blame' })); | ||
|
|
||
| expect(mocks.push).toHaveBeenCalledWith( | ||
| '/browse/github.com/sourcebot-dev/sourcebot@main/-/blob/README.md?blame=true&view=source' | ||
| ); | ||
| }); | ||
|
|
||
| test('preserves source view when leaving blame mode', () => { | ||
| render( | ||
| <BlameViewToggle | ||
| repoName="github.com/sourcebot-dev/sourcebot" | ||
| revisionName="main" | ||
| path="README.md" | ||
| blame | ||
| viewMode="source" | ||
| /> | ||
| ); | ||
|
|
||
| fireEvent.click(screen.getByRole('radio', { name: 'View source code' })); | ||
|
|
||
| expect(mocks.push).toHaveBeenCalledWith( | ||
| '/browse/github.com/sourcebot-dev/sourcebot@main/-/blob/README.md?view=source' | ||
| ); | ||
| }); | ||
|
|
||
| test('does not add a view query when rendered preview mode enters blame', () => { | ||
| render( | ||
| <BlameViewToggle | ||
| repoName="github.com/sourcebot-dev/sourcebot" | ||
| revisionName="main" | ||
| path="README.md" | ||
| blame={false} | ||
| viewMode="rendered" | ||
| /> | ||
| ); | ||
|
|
||
| fireEvent.click(screen.getByRole('radio', { name: 'View blame' })); | ||
|
|
||
| expect(mocks.push).toHaveBeenCalledWith( | ||
| '/browse/github.com/sourcebot-dev/sourcebot@main/-/blob/README.md?blame=true' | ||
| ); | ||
| }); | ||
|
|
||
| test('supports markdown-specific non-blame labels', () => { | ||
| render( | ||
| <BlameViewToggle | ||
| repoName="github.com/sourcebot-dev/sourcebot" | ||
| revisionName="main" | ||
| path="README.md" | ||
| blame={false} | ||
| viewMode="rendered" | ||
| codeLabel="Preview" | ||
| codeAriaLabel="Preview rendered markdown" | ||
| /> | ||
| ); | ||
|
|
||
| expect(screen.getByRole('radio', { name: 'Preview rendered markdown' }).textContent).toBe('Preview'); | ||
| }); | ||
| }); |
This file contains hidden or 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 hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.