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.

Sign up for GitHub

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: use shared html resource and add checks to keep resources in sync #258

Merged
merged 9 commits into from
Feb 10, 2025
Merged

feat: use shared html resource and add checks to keep resources in sync #258

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
82cf1b4
use shared html resource and add checks to keep resources in sync
andrewrobinsonhodges-snyk Feb 6, 2025
be936fb
switch to sha512sum for file hashing in resource checks
andrewrobinsonhodges-snyk Feb 6, 2025
fa3717f
switch to sha512sum for file hashing in resource checks
andrewrobinsonhodges-snyk Feb 6, 2025
abfe66a
Merge branch 'main' into feat/static-resource-checks
andrewrobinsonhodges-snyk Feb 10, 2025
cfb502d
fix: calculate html font size from Eclipse defaults
andrewrobinsonhodges-snyk Feb 10, 2025
459d05b
fix: whitespace
andrewrobinsonhodges-snyk Feb 10, 2025
d183695
fix: remove unused import
andrewrobinsonhodges-snyk Feb 10, 2025
2d15d02
fix: fall back to default font registry if workspace is not available
andrewrobinsonhodges-snyk Feb 10, 2025
c2fa611
fix: fall back to default font size if workspace is not available
andrewrobinsonhodges-snyk Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/resource-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Static Resource Checking
on:
push:
branches: [ master ]
pull_request:

jobs:
static-resource-checks:
runs-on: ubuntu-latest
steps:
- name: Fetch Sources
uses: actions/checkout@v4

- name: Check Static Resources
run: |
declare -A resources
# Add each resource as a key, value pair, mapping the local resource to the reference file (which should be stored in the lanaguage server repository). For example:
# resources["<path_to_local_file>"]="<url_of_reference_file>"
resources["plugin/src/main/resources/ui/html/ScanSummaryInit.html"]="https://raw.githubusercontent.com/snyk/snyk-ls/refs/heads/main/shared_ide_resources/ui/html/ScanSummaryInit.html"
for key in ${!resources[@]}; do
candidate=$(sha512sum $key | awk {'print $1'})
candidate=${candidate:="null"}
reference=$(curl -s ${resources[$key]} | sha512sum | awk {'print $1'})
echo "Candidate file $key has sha512sum $candidate"
echo "Reference file ${resources[$key]} has sha512sum $reference"
[[ $candidate == $reference ]]
done

13 changes: 12 additions & 1 deletion plugin/src/main/java/io/snyk/eclipse/plugin/html/BaseHtmlProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@

import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.resource.ColorRegistry;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.FontData;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.themes.ITheme;
Expand Down Expand Up @@ -102,6 +104,7 @@
htmlStyled = htmlStyled.replace("<style nonce=\"ideNonce\" data-ide-style></style>", css);
htmlStyled = htmlStyled.replace("var(--default-font)",
" ui-sans-serif, \"SF Pro Text\", \"Segoe UI\", \"Ubuntu\", Tahoma, Geneva, Verdana, sans-serif;");
htmlStyled = htmlStyled.replace("var(--main-font-size)", getScaledFontSize());

// Replace CSS variables with actual color values
htmlStyled = htmlStyled.replace("var(--text-color)",
Expand Down Expand Up @@ -132,6 +135,14 @@
return htmlStyled;
}

private String getScaledFontSize() {
int defaultHeight = getCurrentTheme().getFontRegistry().getFontData(JFaceResources.TEXT_FONT)[0].getHeight();
// Language server HTML assumes a base font size of 10px. The default Eclipse font size is 17px (13pt), so we
// apply a scaling factor here. This ensures that HTML fonts scale correctly if the user changes the text size.
int scaledHeight = (int) (defaultHeight / 1.7);
return String.valueOf(scaledHeight) + "pt";

Check warning on line 143 in plugin/src/main/java/io/snyk/eclipse/plugin/html/BaseHtmlProvider.java

View workflow job for this annotation

GitHub Actions / build (ubuntu-latest)

No need to call String.valueOf to append to a string. 

No need to call String.valueOf to append to a string; just use the valueOf() argument directly.

UselessStringValueOf (Priority: 3, Ruleset: Performance)
https://docs.pmd-code.org/pmd-doc-7.10.0/pmd_rules_java_performance.html#uselessstringvalueof

Check warning

Code scanning / PMD

No need to call String.valueOf to append to a string. Warning

No need to call String.valueOf to append to a string.
}

public String getColorAsHex(String colorKey, String defaultColor) {
if (Preferences.getInstance().isTest()) {
return "";
Expand Down Expand Up @@ -161,7 +172,7 @@
}
ITheme currentTheme = getCurrentTheme();
colorRegistry = currentTheme.getColorRegistry();
return colorRegistry;
return colorRegistry;
}

private ITheme currentTheme;
Expand Down
Loading