Skip to content
This repository has been archived by the owner on Mar 9, 2023. It is now read-only.

Commit

Permalink
Make it clearer that the scanner works with SonarCloud
Browse files Browse the repository at this point in the history
  • Loading branch information
bellingard committed Aug 2, 2017
1 parent 72dd68f commit 980ff73
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# NPM module to run SonarQube analyses
# NPM module to run SonarQube/SonarCloud analyses

`sonarqube-scanner` makes it very easy to trigger [SonarQube](http://www.sonarqube.org)
analyses on a JavaScript code base, without needing to install any specific tool
or (Java) runtime.
`sonarqube-scanner` makes it very easy to trigger [SonarQube](https://www.sonarqube.org)
/[SonarCloud](https://sonarcloud.io) analyses on a JavaScript code base, without needing
to install any specific tool or (Java) runtime.

This module is analyzed on [SonarCloud](https://sonarcloud.io) using
This module is analyzed on SonarCloud using
itself:
- See the [Gulp file](https://github.com/bellingard/sonar-scanner-npm/blob/master/gulpfile.js)
- See the [analysis results on SonarCloud](https://sonarcloud.io/dashboard?id=sonarqube-scanner)

[![Build status](https://travis-ci.org/bellingard/sonar-scanner-npm.svg?branch=master)](https://travis-ci.org/bellingard/sonar-scanner-npm) [![Quality Gate](https://sonarcloud.io/api/badges/gate?key=sonarqube-scanner)](https://sonarcloud.io/dashboard/index/sonarqube-scanner) [![Releases](https://img.shields.io/github/release/bellingard/sonar-scanner-npm.svg)](https://github.com/bellingard/sonar-scanner-npm/releases)
[![Build status](https://travis-ci.org/bellingard/sonar-scanner-npm.svg?branch=master)](https://travis-ci.org/bellingard/sonar-scanner-npm) [![Quality Gate on SonarCloud](https://sonarcloud.io/api/badges/gate?key=sonarqube-scanner)](https://sonarcloud.io/dashboard/index/sonarqube-scanner) [![Releases](https://img.shields.io/github/release/bellingard/sonar-scanner-npm.svg)](https://github.com/bellingard/sonar-scanner-npm/releases)


## Installation
Expand All @@ -22,9 +22,9 @@ npm install sonarqube-scanner

## Usage

The following example shows how to run a SonarQube analysis on a JavaScript
The following example shows how to run an analysis on a JavaScript
project using Gulp, and pushing the results to [SonarCloud](https://sonarcloud.io),
the online SonarQube service:
the online code-analysis service based on SonarQube:

```javascript
var gulp = require('gulp');
Expand Down
2 changes: 1 addition & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ gulp.task('default', ['test'], function (callback) {
sonarqubeScanner({
options: {
"sonar.organization": "default",
"sonar.projectName": "SonarQube Scanner for the JavaScript world",
"sonar.projectName": "SonarQube/SonarCloud Scanner for the JavaScript world",
"sonar.sources": "dist",
"sonar.tests": "specs",
"sonar.javascript.lcov.reportPath": "coverage/lcov.info"
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sonarqube-scanner",
"description": "SonarQube Scanner for the JavaScript world",
"description": "SonarQube/SonarCloud Scanner for the JavaScript world",
"version": "2.0.0",
"homepage": "https://github.com/bellingard/sonar-scanner-npm",
"author": {
Expand Down Expand Up @@ -37,6 +37,7 @@
},
"keywords": [
"sonarqube",
"sonarcloud",
"sonarqube-scanner",
"sonarqube-runner",
"sonar-scanner",
Expand Down

0 comments on commit 980ff73

Please sign in to comment.