Skip to content
This repository was archived by the owner on Jul 15, 2025. It is now read-only.

feat: add dockerfile viewer with syntax highlighting #181

Merged
merged 3 commits into from
Apr 1, 2025

Conversation

kmendell
Copy link
Member

@kmendell kmendell commented Apr 1, 2025

Summary by Sourcery

Add a new Dockerfile viewer component with syntax highlighting and improved user experience

New Features:

  • Implement a new DockerfileEditor component with syntax highlighting for Dockerfile instructions
  • Add a switch to toggle sticky line numbers in the Dockerfile viewer

Enhancements:

  • Improve Dockerfile display with syntax highlighting and line numbering
  • Add copy functionality to the Dockerfile viewer

Chores:

  • Update bits-ui package to version 1.3.16

Copy link
Contributor

sourcery-ai bot commented Apr 1, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new DockerfileEditor component with syntax highlighting and copy functionality. It also adds a switch to toggle sticky line numbers. The bits-ui dependency was also updated.

Sequence diagram for copying the Dockerfile

sequenceDiagram
    participant User
    participant DockerfileEditor
    participant NavigatorClipboard

    User->>DockerfileEditor: Clicks 'Copy' button
    DockerfileEditor->>DockerfileEditor: copyDockerfile()
    alt dockerfile is not null
        DockerfileEditor->>NavigatorClipboard: writeText(dockerfile)
        NavigatorClipboard-->>DockerfileEditor: Promise (success or failure)
        alt Success
            DockerfileEditor->>DockerfileEditor: copied = true
            DockerfileEditor->>DockerfileEditor: setTimeout(() => copied = false, 2000)
        else Failure
            DockerfileEditor->>console: error('Failed to copy: ', err)
        end
    else dockerfile is null
        DockerfileEditor->>DockerfileEditor: return
    end
Loading

Updated class diagram for DockerfileEditor component

classDiagram
  class DockerfileEditor {
    -dockerfile: string | null | undefined
    -maxHeight: string
    -showLineNumbers: boolean
    -stickyLineNumbers: boolean
    -highlightLines: number[]
    -theme: 'light' | 'dark' | 'auto'
    -showCopyButton: boolean
    -lines: string[]
    -copied: boolean
    +copyDockerfile()
    +highlightLine(line: string): string
    +applyHighlighting()
  }
  note for DockerfileEditor "Added stickyLineNumbers property and related logic"
Loading

File-Level Changes

Change Details Files
Introduced a new DockerfileEditor component for viewing Dockerfiles with syntax highlighting and copy functionality.
  • Created a DockerfileEditor component with syntax highlighting.
  • Added a copy button to the DockerfileEditor component.
  • Implemented sticky line numbers in the DockerfileEditor component.
  • Integrated the DockerfileEditor component into the details page to display Dockerfile content.
src/routes/details/[repo]/[image]/[tag]/+page.svelte
src/lib/components/docker-metadata/DockerFileViewer.svelte
Added a switch component to toggle sticky line numbers in the Dockerfile viewer.
  • Added a switch component from bits-ui.
  • Implemented logic to toggle sticky line numbers in the DockerfileEditor component based on the switch state.
  • Added a label for the switch component.
src/routes/details/[repo]/[image]/[tag]/+page.svelte
src/lib/components/ui/switch/switch.svelte
src/lib/components/ui/switch/index.ts
Updated dependencies in package.json and package-lock.json.
  • Updated bits-ui from version 1.3.15 to 1.3.16.
package.json
package-lock.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @kmendell - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using a more specific name than DockerFileViewer for the component, perhaps something like DockerfileViewerWithHighlighting.
  • The stickyLineNumbers feature is a nice touch for usability.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@kmendell kmendell merged commit 9ee0d9a into main Apr 1, 2025
4 checks passed
@kmendell kmendell deleted the feat/dockerfileviewer branch April 1, 2025 22:36
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant