RULEAPI-855 Allow to make robust links to commonly used external resources #5972
Conversation
loic-joly-sonarsource
commented
Dec 17, 2025
loic-joly-sonarsource
commented
- Parse C++ Core Guidelines to generate a list of asciidoc attributes
- Automatically include external references attributes at the start of each rule description
- Unresolved attribute entries are now an error
…urces * Parse C++ Core Guidelines to generate a list of asciidoc attributes * Automatically include external references attributes at the start of each rule description * Unresolved attribute entries are now an error
loic-joly-sonarsource
added
the
rspec system
| if asciidoctor --failure-level=WARNING -o /dev/null rules/*/*/tmp*.adoc; then | ||
| if asciidoctor -a rspecator-view --failure-level=WARNING -o /dev/null rules/*/*/tmp*.adoc; then | ||
| if asciidoctor -a attribute-missing=warn --failure-level=WARNING --verbose --trace -o /dev/null rules/*/*/tmp*.adoc; then | ||
| if asciidoctor -a rspecator-view --failure-level=WARNING --verbose --trace -o /dev/null rules/*/*/tmp*.adoc; then |
There was a problem hiding this comment.
| if asciidoctor -a rspecator-view --failure-level=WARNING --verbose --trace -o /dev/null rules/*/*/tmp*.adoc; then | |
| if asciidoctor -a rspecator-view --failure-level=WARNING --verbose --trace -o /dev/null rules/*/*/tmp*.adoc; then |
There was a problem hiding this comment.
The good thing is that everything is homogeneous now. The bad thing is that it is all homogeneously broken, because the markdown anchors you used do not work in Github. We instead need to use the anchors based on the text of the title.
For example, the first link should be https://github.com/isocpp/CppCoreGuidelines/blob/e49158a/CppCoreGuidelines.md#in0-dont-panic
I'm not sure if the simplest solution is to take the text of the title, replace spaces with - and remove everything that is not [A-Za-z0-9_]; or if we should rather download the html version and look at the generated ids.
frederic-tingaud-sonarsource
force-pushed
the
lj/externalReferences
branch
from
d8d1a6c to
c45e2fe
Compare
frederic-tingaud-sonarsource
force-pushed
the
lj/externalReferences
branch
from
c45e2fe to
bac0bb3
Compare
|
|
2 participants
