Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 2.04 KB

README.md

File metadata and controls

41 lines (23 loc) · 2.04 KB

SLang

Build Status Quality Gate Coverage

SLang (SonarSource Language) is a framework to quickly develop code analyzers for SonarQube to help developers write Clean Code.

SLang defines language-agnostic AST. Using this AST we can develop simple syntax-based rules. Then we use a parser for real language to create this AST.

Have questions or feedback?

To provide feedback (request a feature, report a bug, etc.) use the SonarQube Community Forum. Please do not forget to specify the language, plugin version, and SonarQube version.

Building

Setup

Install Java 17.

Build

Build and run Unit Tests:

./gradlew build

License headers

License headers are automatically updated by the spotless plugin but only for Java files. Furthermore, there are files such as package-info.java and module-info.java that spotless ignores. For those files use a manual script like below to update the license. E.g., for Go files (on Mac):

`find . -type f -name "*.go" -exec sed -i '' 's/2018-2023/2018-2024/' "{}" \;`

License

Copyright 2018-2024 SonarSource

SonarQube analyzers released after November 29, 2024, including patch fixes for prior versions, are published under the Sonar Source-Available License Version 1 (SSALv1).

See individual files for details that specify the license applicable to each file. Files subject to the SSALv1 will be noted in their headers.