Merge pull request #11804 from michaelnebel/csharp/alignqueryids

michaelnebel · web-flow · commit 1729319ebe7c · 2023-01-10T10:14:07.000+01:00
C#: Align query IDs.
diff --git a/csharp/ql/lib/change-notes/2023-01-03-queryids.md b/csharp/ql/lib/change-notes/2023-01-03-queryids.md
@@ -0,0 +1,4 @@
+---
+category: minorAnalysis
+---
+* Query id's have been aligned such that they are prefixed with `cs` instead of `csharp`.
diff --git a/csharp/ql/src/Metrics/Summaries/FrameworkCoverage.ql b/csharp/ql/src/Metrics/Summaries/FrameworkCoverage.ql
@@ -1,5 +1,5 @@
 /**
- * @id csharp/summary/framework-coverage
+ * @id cs/summary/framework-coverage
  * @name Metrics of framework coverage
  * @description Expose metrics for the number of API endpoints covered by CSV models.
  * @kind metric
diff --git a/csharp/ql/src/Metrics/internal/ExtractorDiagnostics.ql b/csharp/ql/src/Metrics/internal/ExtractorDiagnostics.ql
@@ -2,7 +2,7 @@
  * @name Extractor diagnostics
  * @description This query is for internal use only and may change without notice.
  * @kind table
- * @id csharp/extractor-diagnostics
+ * @id cs/extractor-diagnostics
  */
 
 import csharp
diff --git a/csharp/ql/src/Telemetry/ExternalLibraryUsage.ql b/csharp/ql/src/Telemetry/ExternalLibraryUsage.ql
@@ -3,7 +3,7 @@
  * @description A list of external libraries used in the code given by their namespace.
  * @kind metric
  * @tags summary telemetry
- * @id csharp/telemetry/external-libs
+ * @id cs/telemetry/external-libs
  */
 
 private import csharp
diff --git a/csharp/ql/src/Telemetry/SupportedExternalApis.ql b/csharp/ql/src/Telemetry/SupportedExternalApis.ql
@@ -3,7 +3,7 @@
  * @description A list of supported 3rd party APIs used in the codebase. Excludes APIs exposed by test libraries.
  * @kind metric
  * @tags summary telemetry
- * @id csharp/telemetry/supported-external-api
+ * @id cs/telemetry/supported-external-api
  */
 
 private import csharp
diff --git a/csharp/ql/src/Telemetry/SupportedExternalSinks.ql b/csharp/ql/src/Telemetry/SupportedExternalSinks.ql
@@ -3,7 +3,7 @@
  * @description A list of 3rd party APIs detected as sinks. Excludes APIs exposed by test libraries.
  * @kind metric
  * @tags summary telemetry
- * @id csharp/telemetry/supported-external-api-sinks
+ * @id cs/telemetry/supported-external-api-sinks
  */
 
 private import csharp
diff --git a/csharp/ql/src/Telemetry/SupportedExternalSources.ql b/csharp/ql/src/Telemetry/SupportedExternalSources.ql
@@ -3,7 +3,7 @@
  * @description A list of 3rd party APIs detected as sources. Excludes APIs exposed by test libraries.
  * @kind metric
  * @tags summary telemetry
- * @id csharp/telemetry/supported-external-api-sources
+ * @id cs/telemetry/supported-external-api-sources
  */
 
 private import csharp
diff --git a/csharp/ql/src/Telemetry/SupportedExternalTaint.ql b/csharp/ql/src/Telemetry/SupportedExternalTaint.ql
@@ -3,7 +3,7 @@
  * @description A list of 3rd party APIs detected as flow steps. Excludes APIs exposed by test libraries.
  * @kind metric
  * @tags summary telemetry
- * @id csharp/telemetry/supported-external-api-taint
+ * @id cs/telemetry/supported-external-api-taint
  */
 
 private import csharp
diff --git a/csharp/ql/src/Telemetry/UnsupportedExternalAPIs.ql b/csharp/ql/src/Telemetry/UnsupportedExternalAPIs.ql
@@ -3,7 +3,7 @@
  * @description A list of 3rd party APIs used in the codebase. Excludes APIs exposed by test libraries.
  * @kind metric
  * @tags summary telemetry
- * @id csharp/telemetry/unsupported-external-api
+ * @id cs/telemetry/unsupported-external-api
  */
 
 private import csharp
diff --git a/csharp/ql/src/meta/frameworks/UnsupportedExternalAPIs.ql b/csharp/ql/src/meta/frameworks/UnsupportedExternalAPIs.ql
@@ -4,7 +4,7 @@
  * @kind problem
  * @problem.severity recommendation
  * @tags meta
- * @id csharp/meta/unsupported-external-api
+ * @id cs/meta/unsupported-external-api
  * @precision very-low
  */
 
diff --git a/csharp/ql/src/utils/model-generator/CaptureDiscardedSummaryModels.ql b/csharp/ql/src/utils/model-generator/CaptureDiscardedSummaryModels.ql
@@ -1,7 +1,7 @@
 /**
  * @name Capture discarded summary models.
  * @description Finds summary models that are discarded as handwritten counterparts exist.
- * @id csharp/utils/model-generator/discarded-summary-models
+ * @id cs/utils/model-generator/discarded-summary-models
  */
 
 import semmle.code.csharp.dataflow.ExternalFlow
diff --git a/csharp/ql/src/utils/modelconverter/ExtractNeutrals.ql b/csharp/ql/src/utils/modelconverter/ExtractNeutrals.ql
@@ -1,7 +1,7 @@
 /**
  * @name Extract MaD neutral model rows.
  * @description This extracts the Models as data neutral model rows.
- * @id csharp/utils/modelconverter/generate-data-extensions-neutral
+ * @id cs/utils/modelconverter/generate-data-extensions-neutral
  */
 
 import csharp

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +---
 +category: minorAnalysis
 +---
 +* Query id's have been aligned such that they are prefixed with `cs` instead of `csharp`.