Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


Version 4.2 introduces a major feature that required deep internal refactoring : support of multiple languages in the same project or sub-project. No new API was developed but it requires some changes on existing plugins. Some usages of API must be replaced. It does not require to upgrade the minimum required version of SonarQube. It can still be 3.7 for example. By following these rules, a plugin should be compatible with SonarQube 3.7+ and should support multi-language feature. The only exception is for plugins working on Java files. For these plugins there is no way to support at the same time 4.2 and prior versions because JavaFile/JavaPackage are no more supported in 4.2:


(error) Before
(tick) After
Implementations of org.sonar.api.resources.Language could depend on module components (Project, Settings, ...). Example :
FooLanguage -> FooSettings -> Settings
Language implementations and their dependencies (FooLanguage and FooSettings in the example) must be flagged with @InstantiationStrategy(InstantiationStrategy.PER_BATCH)
Check project language, for example:

Check existence of source files of the given language, for example:

// 3.7 or greater
"php".equals(project.getLanguageKey()) || (project.getLanguageKey()==null && !fileSystem.files(FileQuery.onSource().onLanguage("php")).isEmpty())

// 4.0 or greater



Extend org.sonar.api.resources.File to handle its own tree of resources (for example ex-FlexFile)Use org.sonar.api.resources.File but never extend it
Use source directories :
File.fromIOFile( file, List<> sourceDirs)
Replace with:
File.fromIOFile( file, Project module)

Notes :
  • ProjectFileSystem#getSourceFiles(Language...) and getTestFiles(Language...) can also be used, but it's recommend to replace by ModuleFileSystem.
  • (warning) File.fromIOFile( file, Project module) has different behaviors in 4.2 and lower versions. It returns null on test files in SQ < 4.2. In order to be compatible with SQ 3.7 or greater, then the exact code should be :

    org.sonar.api.resources.File sonarFile = org.sonar.api.resources.File.fromIOFile(file, module);
    if (sonarFile == null) {
            // support SQ<4.2
            sonarFile = org.sonar.api.resources.File.fromIOFile(file, module.getFileSystem().getTestDirs());

Use constructors of org.sonar.api.resources.FileUse File.fromIOFile( file, Project module)
Check language of Quality profile:
Search for the active rules that relate to your rule repository:
Use org.sonar.api.resources.Directory

(warning) No alternative before 4.2. Use org.sonar.api.resources.Directory#fromIOFile(file, Project).

Consequence : it's not possible to directly store measures or issues on a directory before 4.2.

Use sonar-commons-rules 1.1 or lowerUpgrade to sonar-commons-rules 1.2 : provide basic implementations of org.sonar.commonrules.api.CommonRulesEngine and CommonRulesDecorator.
See sources of Flex plugin.
Use resource scopes PGU (Scopes.PROGRAM_UNIT) and BLU (Scopes.BLOCK_UNIT), associated to classes org.sonar.api.resources.Method and JavaMethodDo not register classes, methods, functions and paragraphs. Keep these concepts internal to your plugin.
Use org.sonar.api.utils.CoberturaReportParserUtilsImplement your own Cobertura report parser in order to control way to locate files.
Java only - Use classes org.sonar.api.resources.JavaFile and JavaPackageUse classes org.sonar.api.resources.File and org.sonar.api.resources.Directory