diff --git a/README.md b/README.md index 6fda9882..1c3344b1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Z PL/SQL Analyzer - ZPA +# ZPA [![Latest release](https://img.shields.io/github/release/felipebz/zpa.svg) ](https://github.com/felipebz/zpa/releases/latest) [![Build](https://github.com/felipebz/zpa/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/felipebz/zpa/actions/workflows/build.yml) [![Quality Gate Status](https://sonarqube.felipebz.com/api/project_badges/measure?project=com.felipebz.zpa%3Azpa&metric=alert_status)](https://sonarqube.felipebz.com/dashboard?id=com.felipebz.zpa%3Azpa) -The Z PL/SQL Analyzer (or simply ZPA) is a code analyzer for PL/SQL and Oracle SQL code. +ZPA is parser and static code analysis tool for PL/SQL and Oracle SQL. You can use it in a [SonarQube](https://www.sonarqube.org) on-premise instance. SonarQube is an open platform to manage code quality. @@ -16,7 +16,7 @@ Do you want to use this analyzer in a project hosted on [SonarCloud](https://son - Download the [latest sonar-zpa-plugin release](https://github.com/felipebz/zpa/releases/latest) and copy to the SONARQUBE_HOME/extensions/plugins directory; - Restart your SonarQube server; -- Navigate to the Marketplace (SONARQUBE_URL/marketplace?filter=installed). It should list "Z PL/SQL Analyzer" on the tab "Installed Plugins"; +- Navigate to the Marketplace (SONARQUBE_URL/marketplace?filter=installed). It should list "ZPA" on the tab "Installed Plugins"; - Run an analysis with [SonarScanner](https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/overview/). ## Compatibility matrix diff --git a/build.gradle.kts b/build.gradle.kts index d225a143..9546b74c 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -171,7 +171,7 @@ subprojects { jreleaser { project { - description.set("Z PL/SQL Analyzer") + description.set("ZPA - Parser and static code analysis tool for PL/SQL and Oracle SQL") authors.set(listOf("felipebz")) license.set("LGPL-3.0") links { @@ -218,6 +218,6 @@ jreleaser { sonarqube { properties { - property("sonar.projectName", "Z PL/SQL Analyzer") + property("sonar.projectName", "ZPA") } } diff --git a/sonar-zpa-plugin/build.gradle.kts b/sonar-zpa-plugin/build.gradle.kts index 05249968..e78f78d6 100644 --- a/sonar-zpa-plugin/build.gradle.kts +++ b/sonar-zpa-plugin/build.gradle.kts @@ -72,7 +72,7 @@ val shadowJar = tasks.named("shadowJar") { "Plugin-IssueTrackerUrl" to "https://github.com/felipebz/zpa/issues", "Plugin-Key" to "plsqlopen", "Plugin-License" to "GNU LGPL 3", - "Plugin-Name" to "Z PL/SQL Analyzer", + "Plugin-Name" to "ZPA Plugin for SonarQube", "Plugin-Organization" to "Felipe Zorzo", "Plugin-OrganizationUrl" to "https://felipezorzo.com.br", "Plugin-SourcesUrl" to "https://github.com/felipebz/zpa", @@ -111,4 +111,4 @@ publishing { } } -description = "Z PL/SQL Analyzer for SonarQube" +description = "ZPA Plugin for SonarQube" diff --git a/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlPlugin.kt b/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlPlugin.kt index a81e6577..147b6104 100644 --- a/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlPlugin.kt +++ b/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlPlugin.kt @@ -107,7 +107,7 @@ class PlSqlPlugin : Plugin { } companion object { - private const val DEFAULT_CATEGORY = "Z PL/SQL Analyzer" + private const val DEFAULT_CATEGORY = "ZPA" private const val GENERAL = "General" private const val TEST_AND_COVERAGE = "Tests and Coverage" internal const val FILE_SUFFIXES_KEY = "sonar.plsqlopen.file.suffixes" diff --git a/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlRuleRepository.kt b/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlRuleRepository.kt index ed63b8c6..3bb3bda0 100644 --- a/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlRuleRepository.kt +++ b/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlRuleRepository.kt @@ -29,7 +29,7 @@ class PlSqlRuleRepository : RulesDefinition { override fun define(context: RulesDefinition.Context) { val repository = context .createRepository(KEY, PlSql.KEY) - .setName("Z PL/SQL Analyzer") + .setName("ZPA") CustomAnnotationBasedRulesDefinition.load(SonarQubeRepositoryAdapter(repository), PlSql.KEY, CheckList.checks, SonarQubeRuleMetadataLoader()) repository.done() } diff --git a/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlSquidSensor.kt b/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlSquidSensor.kt index 543b3700..5eef2b17 100644 --- a/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlSquidSensor.kt +++ b/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/PlSqlSquidSensor.kt @@ -56,7 +56,7 @@ class PlSqlSquidSensor @JvmOverloads constructor(activeRules: ActiveRules, setti .orElse(null)) override fun describe(descriptor: SensorDescriptor) { - descriptor.name("Z PL/SQL Analyzer").onlyOnLanguage(PlSql.KEY) + descriptor.name("ZPA").onlyOnLanguage(PlSql.KEY) } override fun execute(context: SensorContext) { diff --git a/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/utplsql/UtPlSqlSensor.kt b/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/utplsql/UtPlSqlSensor.kt index a519ca4a..574a6d29 100644 --- a/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/utplsql/UtPlSqlSensor.kt +++ b/sonar-zpa-plugin/src/main/kotlin/org/sonar/plsqlopen/utplsql/UtPlSqlSensor.kt @@ -32,7 +32,7 @@ class UtPlSqlSensor(objectLocator: ObjectLocator, analysisWarnings: AnalysisWarn private val coverageResultImporter = CoverageResultImporter(objectLocator, analysisWarnings) override fun describe(descriptor: SensorDescriptor) { - descriptor.name("Z PL/SQL Analyzer - utPLSQL Report Importer").onlyOnLanguage(PlSql.KEY) + descriptor.name("ZPA - utPLSQL Report Importer").onlyOnLanguage(PlSql.KEY) } override fun execute(context: SensorContext) { diff --git a/sonar-zpa-plugin/src/test/kotlin/org/sonar/plsqlopen/PlSqlSquidSensorTest.kt b/sonar-zpa-plugin/src/test/kotlin/org/sonar/plsqlopen/PlSqlSquidSensorTest.kt index 7979dabc..1f62be16 100644 --- a/sonar-zpa-plugin/src/test/kotlin/org/sonar/plsqlopen/PlSqlSquidSensorTest.kt +++ b/sonar-zpa-plugin/src/test/kotlin/org/sonar/plsqlopen/PlSqlSquidSensorTest.kt @@ -67,7 +67,7 @@ class PlSqlSquidSensorTest { fun testDescriptor() { val descriptor = DefaultSensorDescriptor() sensor.describe(descriptor) - assertThat(descriptor.name()).isEqualTo("Z PL/SQL Analyzer") + assertThat(descriptor.name()).isEqualTo("ZPA") assertThat(descriptor.languages()).containsOnly(PlSql.KEY) } diff --git a/sonar-zpa-plugin/src/test/kotlin/org/sonar/plsqlopen/utplsql/UtPlSqlSensorTest.kt b/sonar-zpa-plugin/src/test/kotlin/org/sonar/plsqlopen/utplsql/UtPlSqlSensorTest.kt index 236bd130..ac417410 100644 --- a/sonar-zpa-plugin/src/test/kotlin/org/sonar/plsqlopen/utplsql/UtPlSqlSensorTest.kt +++ b/sonar-zpa-plugin/src/test/kotlin/org/sonar/plsqlopen/utplsql/UtPlSqlSensorTest.kt @@ -56,7 +56,7 @@ class UtPlSqlSensorTest { fun testDescriptor() { val descriptor = DefaultSensorDescriptor() sensor.describe(descriptor) - assertThat(descriptor.name()).isEqualTo("Z PL/SQL Analyzer - utPLSQL Report Importer") + assertThat(descriptor.name()).isEqualTo("ZPA - utPLSQL Report Importer") assertThat(descriptor.languages()).containsOnly(PlSql.KEY) } diff --git a/zpa-checks-testkit/build.gradle.kts b/zpa-checks-testkit/build.gradle.kts index 37f5c728..c77cce70 100644 --- a/zpa-checks-testkit/build.gradle.kts +++ b/zpa-checks-testkit/build.gradle.kts @@ -2,4 +2,4 @@ dependencies { compileOnly(project(":zpa-core")) } -description = "Z PL/SQL Analyzer :: Checks TestKit" +description = "ZPA Checks TestKit" diff --git a/zpa-checks/build.gradle.kts b/zpa-checks/build.gradle.kts index 85125f0b..ee5c9ba6 100644 --- a/zpa-checks/build.gradle.kts +++ b/zpa-checks/build.gradle.kts @@ -44,4 +44,4 @@ testing { } } -description = "Z PL/SQL Analyzer :: Checks" +description = "ZPA Checks" diff --git a/zpa-core/build.gradle.kts b/zpa-core/build.gradle.kts index aab45d2c..770b19e9 100644 --- a/zpa-core/build.gradle.kts +++ b/zpa-core/build.gradle.kts @@ -4,4 +4,4 @@ dependencies { testImplementation(libs.flr.testing.harness) } -description = "Z PL/SQL Analyzer :: Core" +description = "ZPA Core" diff --git a/zpa-toolkit/build.gradle.kts b/zpa-toolkit/build.gradle.kts index 30502d63..b13cc679 100644 --- a/zpa-toolkit/build.gradle.kts +++ b/zpa-toolkit/build.gradle.kts @@ -39,4 +39,4 @@ publishing { } } -description = "Z PL/SQL Analyzer :: SSLR Toolkit" +description = "ZPA Toolkit"