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

refactor(language-server): replace tab-based with arrow-based navigation #5312

Merged
merged 1 commit into from
Jun 13, 2024

Conversation

cat2608
Copy link
Contributor

@cat2608 cat2608 commented Jun 13, 2024

Pull Request Submission

What does this PR do?

This version of Language Server refactors the layout of fixed code examples for Code Issue by replacing the tab-based navigation with arrow-based navigation. It also includes several styling and script improvements.

  • Removed the Community Examples tab layout.
  • Implemented arrow-based navigation for fixed code examples.
  • Reorganised constants, variables, and functions.
  • Moved DOM-dependent functions inside DOMContentLoaded.

This functionality belong to the Code Issue panel rendered from LSP and it's behind a feature flag.

What are the relevant tickets?

https://snyksec.atlassian.net/browse/IDE-294


Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

Screenshots

image

@cat2608 cat2608 requested a review from a team as a code owner June 13, 2024 09:47
Copy link
Contributor

github-actions bot commented Jun 13, 2024

Warnings
⚠️

"refactor(language-server): replace tab-based with arrow-based navigation" is too long. Keep the first line of your commit message under 72 characters.

Generated by 🚫 dangerJS against d7d0f26

@PeterSchafer PeterSchafer enabled auto-merge (squash) June 13, 2024 10:31
@PeterSchafer PeterSchafer force-pushed the refactor/IDE-294-replace-tabs-with-arrows branch from c664dd0 to d7d0f26 Compare June 13, 2024 11:27
@PeterSchafer PeterSchafer merged commit 2bcffc6 into main Jun 13, 2024
12 checks passed
@PeterSchafer PeterSchafer deleted the refactor/IDE-294-replace-tabs-with-arrows branch June 13, 2024 12:04
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.

2 participants