org.sonar.l10n.web.rules.Web.LongJavaScriptCheck.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-web-plugin Show documentation

Enables scanning of HTML, and JSP/JSF files.

There is a newer version: 2.6.0.1053

Long pieces of JavaScript should be located in dedicated *.js source files. This makes maintenance of both the script and the pages that use it
easier. Additionally, it offers some efficiencies in serving the files, since it takes better advantage of browser caching to only re-serve the parts
of a web page that have actually changed.
Noncompliant Code Example
With the default parameter value of 5:
<head>
  ...
  <script type="text/javascript" language="JavaScript">  <!-- Noncompliant -->
    function doTheThing(arg1) {
      ...
      ...
    }

    function doTheOtherThing(arg1) {
      ...
    }

    function andSoOn() {
      ...
    }
  </script>
</head>

Compliant Solution
<head>
  ...
  <script type="text/javascript" language="JavaScript" src="myLongScript.js"> </script>
</head>