Gathering detailed insights and metrics for grunt-sonar-runner
Installations
npm install grunt-sonar-runnerDeveloper Guide
BETA
Typescript
No
Module System
N/A
Min. Node Version
>= 0.10
Node Version
15.1.0
NPM Version
7.0.8
Releases
Unable to fetch releases
Contributors
9
Unable to fetch Contributors
Languages
2
JavaScript
Shell
JavaScript (87.01%)
Shell (12.99%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
skhatri
Download Statistics
Total Downloads
1,473,578
Last Day
206
Last Week
1,003
Last Month
6,108
Last Year
105,587
GitHub Statistics
21 Stars
62 Commits
27 Forks
5 Watching
3 Branches
9 Contributors
Maintainers
1
Package Meta Information
Latest Version
3.0.2
Package Id
grunt-sonar-runner@3.0.2
Unpacked Size
670.87 kB
Size
584.35 kB
File Count
18
NPM Version
7.0.8
Node Version
15.1.0
Total Downloads
Cumulative downloads
Total Downloads
1,473,578
Last day
-20.8%
206
Compared to previous day
Last week
-28%
1,003
Compared to previous week
Last month
-15.1%
6,108
Compared to previous month
Last year
23.4%
105,587
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
1
Dev Dependencies
6
Versions
grunt-sonar-runner
Sonar Analysis Runner from grunt
Getting Started
This plugin requires Grunt ~0.4.5
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
1npm install grunt-sonar-runner --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
1grunt.loadNpmTasks('grunt-sonar-runner');The "sonarRunner" task
Overview
In your project's Gruntfile, add a section named sonarRunner to the data object passed into grunt.initConfig().
1grunt.initConfig({
2sonarRunner: {
3 analysis: {
4 options: {
5 debug: true,
6 separator: '\n',
7 sonar: {
8 login: 'admin',
9 password: 'admin',
10 host: {
11 url: 'http://localhost:9000'
12 },
13 jdbc: {
14 url: 'jdbc:mysql://localhost:3306/sonar',
15 username: 'sonar',
16 password: 'sonar'
17 },
18
19 projectKey: 'sonar:grunt-sonar-runner:0.1.0',
20 projectName: 'Grunt Sonar Runner',
21 projectVersion: '0.10',
22 sources: ['test'].join(','),
23 language: 'js',
24 sourceEncoding: 'UTF-8'
25 }
26 }
27 }
28 }
29});Options
options.debug
Type: Boolean
Default value: 'false'
A Boolean value to display debug information when preparing sonar analysis.
options.separator
Type: String
Default value: os.EOL
A string value representing a new line character to separate individual sonar properties
options.dryRun
Type: Boolean
Default value: 'false'
A flag to run it in dry mode. The configuration is checked but not execute
options.maxBuffer
Type: Number
Default value: 'null'
maxBuffer specifies the largest amount of data allowed on stdout or stderr - if this value is exceeded then the child process is killed and an error returned from sonar-runner. See: child_process.exec()
options.projectHome
Type: String
Default value: ''
A string value representing a root path from the project, if configured it will create a project configuration file based on options.sonar without override default runner configuration file. If the root path contains a file named sonar-project.properties, this file will be considered instead
options.sonar.host.url
Type: String
Default value: 'http://localhost:9000'
Sonar Dashboard URL
options.sonar.jdbc.url
Type: String
Default value: ''
JDBC connection url
options.sonar.jdbc.username
Type: String
Default value: ''
JDBC connection username
options.sonar.jdbc.password
Type: String
Default value: ''
JDBC connection password
options.sonar.sources
Type: String
Default value: ''
comma separated list of directories to analyse. All js files in the provided directories will be included.
options.sonar.projectKey
Type: String
Default value: ''
project key usually of form group:artifactId:version
options.sonar.projectName
Type: String
Default value: ''
Project Summary
options.sonar.projectVersion
Type: String
Default value: ''
Current project build version
options.sonar.language
Type: String
Default value: null
Sets the project language. A list of language plugins can be found here. If this property is undefined, a multi language project will be assumed and the sources searched for valid/supported languages.
options.sonar.javascript.lcov.reportPath
Type: String
Default value: -
Path to the LCOV Code Coverage File to be used in Sonar
options.sonar.exclusions
Type: String or [String]
Default value: null
A list of directories and files that should be excluded from Sonar analysis. A list of wildcards that can be use can be found here.
Usage Examples
The configuration code below shows all possible options that are currently supported by the plugin. Any additional sonar properties can be added right inside the sonar object literal.
1grunt.initConfig({
2 sonarRunner: {
3 analysis: {
4 options: {
5 debug: true,
6 separator: '\n',
7 dryRun: false,
8 sonar: {
9 login: 'admin',
10 password: 'admin',
11 host: {
12 url: 'http://localhost:9000'
13 },
14 jdbc: {
15 url: 'jdbc:mysql://localhost:3306/sonar',
16 username: 'sonar',
17 password: 'sonar'
18 },
19
20 projectKey: 'sonar:grunt-sonar-runner:0.1.0',
21 projectName: 'Grunt Sonar Runner',
22 projectVersion: '0.10',
23 sources: ['test'].join(','),
24 language: 'js',
25 sourceEncoding: 'UTF-8'
26 }
27 }
28 }
29 }
30});To run
grunt sonarRunner:analysis
Release History
No vulnerabilities found.
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
binaries present in source code
Details
- Warn: binary detected: sonar-scanner-4.5/lib/sonar-scanner-cli-4.5.0.2216.jar:1
Reason
Found 9/26 approved changesets -- score normalized to 3
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 13 are checked with a SAST tool
Score
3.3
/10
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More