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

release: v0.3.0 #101

Merged
merged 6 commits into from
Jan 31, 2025
Merged

release: v0.3.0 #101

merged 6 commits into from
Jan 31, 2025

Conversation

Tohrusky
Copy link
Member

@Tohrusky Tohrusky commented Jan 31, 2025

  • feat: auto remove line break in Encode Param

Summary by Sourcery

New Features:

  • Automatically remove line breaks in Encode Param.

Copy link

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new feature that automatically removes line breaks from the encode parameter, enhancing user experience by preventing errors caused by line breaks. Additionally, the version of the package has been updated to 0.3.0.

Sequence diagram for encode parameter handling

sequenceDiagram
    participant User
    participant UI
    participant Template

    User->>UI: Select FFmpeg template
    UI->>Template: getGitHubTemplateContent()
    Template-->>UI: Return template content
    Note over UI: Remove line breaks with trimEnd()
    UI-->>User: Display cleaned template

    User->>UI: Change encode parameter
    alt Contains line breaks
        UI-->>User: Show error notification
    end
Loading

Flow diagram for encode parameter validation

flowchart TD
    A[Start] --> B{User inputs encode parameter}
    B --> C{Contains line breaks?}
    C -->|Yes| D[Show error notification]
    C -->|No| E[Accept input]
    D --> B
    E --> F[End]
Loading

File-Level Changes

Change Details Files
Automatically remove line breaks from the encode parameter.
  • Added .trimEnd() to remove trailing line breaks when fetching template content.
  • Modified the error message to 'Encode Param cannot contain line break!!!' when line breaks are detected.
src/views/Code.vue
Updated the package version.
  • Updated the version from 0.2.1 to 0.3.0.
package.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

@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 @Tohrusky - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider aligning the UX approach: currently the code both auto-removes line breaks in one place and shows an error for them in another, which might be confusing for users. Consider either auto-removing them consistently or preventing them consistently.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

src/views/Code.vue Outdated Show resolved Hide resolved
@Tohrusky
Copy link
Member Author

@sourcery-ai review

Copy link

@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 @Tohrusky - I've reviewed your changes and they look great!

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.

@Tohrusky Tohrusky merged commit 555e6d6 into TensoRaws:main Jan 31, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant