Resolve issue CRJVM204 [Team 1.5]

[nouk-pl]

Resolved issue CRJVM204

Summary

Because SVGs are generally smaller than other image format, they’re less taxing on your server despite needing to render on load. So we recommended, when it is possible, to use svg format image over other image format.

SVG are vector image, they can be compress without any loss, witch means that they're compressible to smaller file sizes at no cost to their definition, detail, or quality. PNGs also benefit from lossless compression of 5-20%, which can help make up for their large file size. However, they're still likely to be larger than an SVG.

SVGs are also scalable and will render pixel-perfect at any resolution whereas JPEGs, PNGs and GIFs will not.

How it work ?

To check if a not recommended image format are used in Java code, we check string literal to verify if a not recommended extension is used. If so, an issue is raised.

On SonarQube

The render of an issue explanation :

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

92.3% Coverage
0.0% Duplication

[MP-Aubay]

Issue #105

[github-actions]

This PR has been automatically marked as stale because it has no activity for 30 days.
Please add a comment if you want to keep the issue open. Thank you for your contributions!

[dedece35]

hi @nouk-pl,
please resolve conflicts and check DoD list here : https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/starter-pack.md#definition-of-done-of-a-pr

[github-actions]

This PR has been automatically marked as stale because it has no activity for 30 days.
Please add a comment if you want to keep the issue open. Thank you for your contributions!

[dedece35]

HI @utarwyn, @jhertout, @glalloue,

what do you think about this PR ?
I have a doubt about implementation that constraints strongly the use of all image formats.

[dedece35]

core-team decision : not applicable as described
argumentation to do by @jycr, please.

[jycr]

Sorry, I'm coming late to the discussion of this proposed rule.

Imposing SVG as the only valid format is not relevant.

Indeed, SVG can only be used for specific kind of images (those presenting drawings or solid colors: e.g. icons, logos).

A photographic illustration will be of much better quality for a lower size by remaining in a “bitmap” format (eg: JPG, WebP).
Vectorizing a bitmap image will degrade the quality and increase its weight.

Here is an example with the image used on the home page of https://www.greenpeace.fr/ :

Original Bitmap image in JPG (75 ko -> 73 ko through HTTP GZIP) :

Vectorized Image in SVG (2,3 Mo -> 1,9 Mo through HTTP GZIP) :

The context and applicability of this rule need to be much better clarified.
Based on the applicability criteria, we need to see if it is possible to automatically determine whether this rule can apply.
In any case, we should not apply this rule systematically

[dedece35]

PR (and linked issue) closed, for now, because not applicable like that : see explanation above.
Feel free to reopen linked issue and this PR once work done (measures, clarification).