RULEAPI-706: Add quick fixes metadata

This commit is contained in:
Arseniy Zaostrovnykh 2021-10-07 11:23:15 +02:00 committed by GitHub
parent b2303fd35f
commit 6a0ec99e78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2659 changed files with 5388 additions and 2662 deletions

View File

@ -219,6 +219,16 @@ It is infeasible to synchronize the implementation of the rule for all the langu
.. Bob merges the rule implementation in Cobol analyzer.
.. If Bob had opened an RSPEC PR with changes, he merges it once the rule is implemented in the analyzer.
== Quickfix field
Every active rule that is not a security hotspot must specify the availability of a quickfix for its issues.
`metadata.json` must feature a `quickfix` field with one of the following values:
* `unknown`: the feasibility of producing a quickfix is not evaluated.
* `infeasible`: it is not feasible to propose a quickfix for any of the issues, for whatever reason.
* `targeted`: it is possible to implement quickfixes for this rule, but none are implemented right now.
* `partial`: some of the issues produced by the rule propose a quickfix, but not all.
* `covered`: all the issues produced by the rule propose a quickfix.
== Comment a rule
Comments and links that were created on Jira have been gathered in a `comments-and-links.adoc` file for each concerned rule. +

View File

@ -14,5 +14,6 @@
"ruleSpecification": "RSPEC-${RSPEC_ID}",
"sqKey": "S${RSPEC_ID}",
"scope": "All",
"defaultQualityProfiles": ["Sonar way"]
"defaultQualityProfiles": ["Sonar way"],
"quickfix": "unknown"
}

View File

@ -12,5 +12,6 @@
"ruleSpecification": "RSPEC-${RSPEC_ID}",
"sqKey": "S${RSPEC_ID}",
"scope": "All",
"defaultQualityProfiles": ["Sonar way"]
"defaultQualityProfiles": ["Sonar way"],
"quickfix": "unknown"
}

View File

@ -184,6 +184,17 @@
"type": "array",
"items": { "type": "string"},
"uniqueItems": true
},
"quickfix": {
"type": "string",
"enum": [
"unknown",
"covered",
"partial",
"infeasible",
"targeted"
],
"description": "Can issues of the rule have a quick fix?"
}
},
"if": {
@ -200,7 +211,7 @@
"required": ["title","type","status","tags","defaultSeverity","ruleSpecification","sqKey","scope"]
},
"else": {
"required": ["title","type","status","remediation","tags","defaultSeverity","ruleSpecification","sqKey","scope"]
"required": ["title","type","status","remediation","tags","defaultSeverity","ruleSpecification","sqKey","scope", "quickfix"]
}
},
"definitions": {

View File

@ -20,5 +20,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix":"unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -20,5 +20,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -20,5 +20,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -31,5 +31,6 @@
"defaultQualityProfiles": [
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"MISRA C++ 2008"
]
],
"quickfix": "unknown"
}

View File

@ -25,5 +25,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "All",
"defaultQualityProfiles": [
"MISRA C++ 2008"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"defaultQualityProfiles": [
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"defaultQualityProfiles": [
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -25,5 +25,6 @@
"defaultQualityProfiles": [
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -29,5 +29,6 @@
},
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "All",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -25,5 +25,6 @@
"MISRA C++ 2008",
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -32,5 +32,6 @@
"defaultQualityProfiles": [
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"defaultQualityProfiles": [
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -25,5 +25,6 @@
"scope": "All",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"defaultQualityProfiles": [
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -29,5 +29,6 @@
},
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -31,5 +31,6 @@
"MISRA C++ 2008",
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -32,5 +32,6 @@
"MISRA C++ 2008",
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -25,5 +25,6 @@
"MISRA C++ 2008",
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -26,5 +26,6 @@
"MISRA C++ 2008",
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "All",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"MISRA C++ 2008"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -30,5 +30,6 @@
},
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -29,5 +29,6 @@
},
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -29,5 +29,6 @@
},
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -25,5 +25,6 @@
"scope": "All",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -25,5 +25,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -36,5 +36,6 @@
"defaultQualityProfiles": [
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -39,5 +39,6 @@
"defaultQualityProfiles": [
"Sonar way",
"MISRA C++ 2008 recommended"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -25,5 +25,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

View File

@ -24,5 +24,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -23,5 +23,6 @@
"scope": "Main",
"defaultQualityProfiles": [
]
],
"quickfix": "unknown"
}

View File

@ -25,5 +25,6 @@
"scope": "All",
"defaultQualityProfiles": [
"Sonar way"
]
],
"quickfix": "unknown"
}

Some files were not shown because too many files have changed in this diff Show More