sonar-prop

Creates a basic sonar-project.properties file from environment variables, arguments and the package.json file.

Usage no npm install needed!

<script type="module">
  import sonarProp from 'https://cdn.skypack.dev/sonar-prop';
</script>

README

sonar-prop

helper to create sonar-project.properties files

Features

  • Arguments
  • Environment variables
  • Read name and version from package.json
  • Extend properties file '.sonar-project.properties'

Usage

Using npx

$ npx sonar-prop --help
$ npx sonar-prop --id=MyID --paths="src/js/app,src/js/modules" --name=MyName --url=https://sonar.url --token=SECRETTOKEN --version=1.2.3

Installing globaly

npm i sonar-prop -g
$ sonar-prop --help
$ sonar-prop --id=MyID --paths="src/js/app,src/js/modules" --name=MyName --url=https://sonar.url --token=SECRETTOKEN --version=1.2.3

Arguments

  • id - UID The SONAR_ID environment variable can be used. The SONAR_ID environment variable can be used.
  • paths - Quoted paths for the SonarQube analysis comma separated. The SONAR_PATHS environment variable canb e used.
  • name - Name of the application. Defaults to package.json name. The SONAR_NAME environment variable can be used.
  • url - URL of the SonarQube server. The SONAR_URL environment variable can be used.
  • token - Secret token for SonarQube authentication. The SONAR_TOKEN environment variable can be used.
  • version - Version of the application. Defaults to package.json version. The SONAR_VERSION environment variable can be used.