Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/racodond/sonar-json-plugin

SonarQube JSON Analyzer
https://github.com/racodond/sonar-json-plugin

code-quality guidelines json linter sonarqube sonarqube-plugin static-analysis static-analyzer styleguide

Last synced: 16 days ago
JSON representation

SonarQube JSON Analyzer

Host: GitHub
URL: https://github.com/racodond/sonar-json-plugin
Owner: racodond
License: lgpl-3.0
Created: 2015-08-15T19:38:11.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2022-06-28T23:26:57.000Z (over 2 years ago)
Last Synced: 2024-10-12T05:29:07.813Z (about 1 month ago)
Topics: code-quality, guidelines, json, linter, sonarqube, sonarqube-plugin, static-analysis, static-analyzer, styleguide
Language: Java
Homepage:
Size: 408 KB
Stars: 11
Watchers: 6
Forks: 18
Open Issues: 13
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

[![Release](https://img.shields.io/github/release/racodond/sonar-json-plugin.svg)](https://github.com/racodond/sonar-json-plugin/releases/latest)
[![Build Status](https://api.travis-ci.org/racodond/sonar-json-plugin.svg?branch=master)](https://travis-ci.org/racodond/sonar-json-plugin)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/imfckm45thk6vvh4/branch/master?svg=true)](https://ci.appveyor.com/project/racodond/sonar-json-plugin/branch/master)

[![Quality Gate status](https://sonarcloud.io/api/project_badges/measure?project=org.codehaus.sonar-plugins.json%3Ajson&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.codehaus.sonar-plugins.json%3Ajson)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=org.codehaus.sonar-plugins.json%3Ajson&metric=ncloc)](https://sonarcloud.io/dashboard?id=org.codehaus.sonar-plugins.json%3Ajson)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=org.codehaus.sonar-plugins.json%3Ajson&metric=coverage)](https://sonarcloud.io/dashboard?id=org.codehaus.sonar-plugins.json%3Ajson)

# SonarQube JSON Analyzer

## Disclaimer
I don't want to keep maintaining this plugin. Feel free to ping me if you want to take over.

## Description
This [SonarQube](http://www.sonarqube.org) plugin analyzes [JSON](http://json.org/) files and:

* Computes metrics: lines of code, statements, etc.
* Checks various guidelines to find out potential bugs and code smells through more than [12 checks](#available-rules)
* Provides the ability to write your own checks

## Usage
1. [Download ad install](http://docs.sonarqube.org/display/SONAR/Setup+and+Upgrade) SonarQube
1. Install the JSON plugin by a [direct download](https://github.com/racodond/sonar-json-plugin/releases). The latest version is compatible with SonarQube 6.7+
1. Install your [favorite scanner](http://docs.sonarqube.org/display/SONAR/Analyzing+Source+Code#AnalyzingSourceCode-RunningAnalysis) (SonarQube Scanner, Maven, Ant, etc.)
1. [Analyze your code](http://docs.sonarqube.org/display/SONAR/Analyzing+Source+Code#AnalyzingSourceCode-RunningAnalysis)

## Custom Checks
You're thinking of new valuable rules? Version 2.0 or greater provides an API to write your own custom checks.
A sample plugin with detailed explanations is available [here](https://github.com/racodond/sonar-json-custom-rules-plugin).
If your custom rules may benefit the community, feel free to create a pull request in order to make the rule available in the JSON analyzer.

You're thinking of new rules that may benefit the community but don't have the time or the skills to write them? Feel free to create an [issue](https://github.com/racodond/sonar-json-plugin/issues) for your rules to be taken under consideration.

## Troubleshooting
If a JSON file is containing some heavily nested objects (more than a hundred nested levels), you may face a `StackOverflowError` looking like:
```
Exception in thread "main" java.lang.StackOverflowError
at com.sonar.sslr.impl.typed.SyntaxTreeCreator.convertChildren(SyntaxTreeCreator.java:128)
at com.sonar.sslr.impl.typed.SyntaxTreeCreator.visitNonTerminal(SyntaxTreeCreator.java:119)
at com.sonar.sslr.impl.typed.SyntaxTreeCreator.visit(SyntaxTreeCreator.java:72)
at com.sonar.sslr.impl.typed.SyntaxTreeCreator.visitNonTerminal(SyntaxTreeCreator.java:89)
at com.sonar.sslr.impl.typed.SyntaxTreeCreator.visit(SyntaxTreeCreator.java:72)
at com.sonar.sslr.impl.typed.SyntaxTreeCreator.convertChildren(SyntaxTreeCreator.java:129)
at com.sonar.sslr.impl.typed.SyntaxTreeCreator.visitNonTerminal(SyntaxTreeCreator.java:119)
...
```

Increasing the JVM stack size should fix your issue.

If you are running your analysis with:

* The SonarQube Scanner, set the `SONAR_SCANNER_OPTS` environment variable to `-Xss10m` for instance
* Maven, set the `MAVEN_OPTS` environment variable to `-Xss10m` for instance

and rerun your analysis.

## Available Rules

### Generic
* BOM should not be used for UTF-8 files
* File names should comply with a naming convention
* Files should contain an empty new line at the end
* Regular expression on key
* Tabulation characters should not be used

### Puppet
* "author" should match the required value in Puppet "metadata.json" files
* "license" should be valid in Puppet "metadata.json" files
* "license" should match the required value in Puppet "metadata.json" files
* "version" should be a semantic version in Puppet "metadata.json" files
* Deprecated keys should be removed from Puppet "metadata.json" files
* Duplicated dependencies should be removed from Puppet "metadata.json" files
* Puppet "metadata.json" files should define all the required keys