Sonar Nx

Created by Billy Briggs

This project adds native support for the Sonar Scanner to Nx.

This project has yet to be fully tested. Report any bugs if found.

Requirements

• Sonar Scanner binary installed in your Shell environment

Getting Started

It is suggested that you follow the given format of creating a sonar-project.properties file at the root of your project. This will consolidate the properties values into a given file and is easier to maintain.

    //project.json
    ...
    "sonar": {
      "executor": "@billy-briggs-dev/sonar:sonar",
      "options": {
        "project.settings": "./sonar-project.properties"
      }
    }

Below is a list of all Options supported by the Executors interface:

Options

• project.settings
  • The project settings file
  • Type: string
• sonar.host.url
  • The url of the SonarQube server
  • Type: string
• sonar.projectKey
  • The project key
  • Type: string
• sonar.projectName
  • The project name
  • Type: string
• sonar.projectVersion
  • The project version
  • Type: string
• sonar.login
  • The SonarQube username
  • Type: string
• sonar.password
  • The SonarQube password
  • Type: string
• sonar.ws.timeout
  • The timeout for the SonarQube API
  • Type: string
• sonar.projectDescription
  • The project description
  • Type: string
• sonar.links.homepage
  • The project homepage
  • Type: string
• sonar.links.ci
  • The project continuous integration
  • Type: string
• sonar.links.issue
  • The project issue tracker
  • Type: string
• sonar.links.scm
  • The project source code management
  • Type: string
• sonar.sources
  • The project source directories
  • Type: string
• sonar.tests
  • The project test directories
  • Type: string
• sonar.sourceEncoding
  • The project source encoding
  • Type: string
• sonar.externalIssuesReportPaths
  • The project external issues report paths
  • Type: string
• sonar.projectDate
  • The project date
  • Type: string
• sonar.projectBaseDir
  • The project base directory
  • Type: string
• sonar.working.directory
  • The project working directory
  • Type: string
• sonar.scm.provider
  • The project source code management provider
  • Type: string
• sonar.scm.forceReloadAll
  • The project source code management force reload all
  • Type: string
• sonar.scm.exclusions.disabled
  • The project source code management exclusions disabled
  • Type: string
• sonar.scm.revision
  • The project source code management revision
  • Type: string
• sonar.buildString
  • The project build string
  • Type: string
• sonar.newCode.referenceBranch
  • The project new code reference branch
  • Type: string
• sonar.log.level
  • The project log level
  • Type: string
  • path: #/properties/sonar.log.level
• sonar.verbose
  • The project verbose
  • Type: string
• sonar.scanner.dumpToFile
  • The project scanner dump to file
  • Type: string
• sonar.scanner.metadataFilePath
  • The project scanner metadata file path
  • Type: string
• sonar.qualitygate.wait
  • The project qualitygate wait
  • Type: string
• sonar.qualitygate.timeout
  • The project qualitygate timeout
  • Type: string