Preserve rfc section links #3956
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -266,34 +266,51 @@ for (let l in lines) { | |
| if (!inCodeBlock) { | ||
|
|
||
| // minor fixups to get RFC links to work properly | ||
| line = line.replace('RFC [','[RFC'); | ||
| line = line.replace('[Authorization header as defined in ','Authorization header as defined in ['); | ||
| line = line.replace('[JSON Pointer]','JSON Pointer [RFC6901]'); // only in 2.0.md | ||
|
|
||
| //TODO: more "hidden" RFC references in older specs, for example | ||
| // [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) | ||
| // [ABNF](https://tools.ietf.org/html/rfc5234) | ||
|
|
||
| //TODO: unconventional references to RFCs in 3.0.4 and 3.1.1, for example | ||
| // [RFC3986 §5.1.2 – 5.1.4](https://tools.ietf.org/html/rfc3986#section-5.1.2) | ||
| // RFC6570 [mentions](https://www.rfc-editor.org/rfc/rfc6570.html#section-2.4.2) | ||
| // [are not](https://datatracker.ietf.org/doc/html/rfc3986#appendix-A) | ||
| // [special behavior](https://www.rfc-editor.org/rfc/rfc1866#section-8.2.1) | ||
| // [RFC6570 considers to be _undefined_](https://datatracker.ietf.org/doc/html/rfc6570#section-2.3) | ||
|
|
||
| if (line.indexOf('[RFC')>=0) { | ||
| // also detect [RFC4648 §3.2] etc. in 3.0.4.md and 3.1.1.md | ||
| line = line.replace(/\[RFC ?([0-9]{1,5})( §[0-9 .-]+)?\]/g,function(match,group1){ | ||
| // console.warn('Fixing RFC reference',match,group1); | ||
| return '[[RFC'+group1+']]'; | ||
| }); | ||
| } | ||
|
|
||
| //TODO: non-link mentions of RFCs in 3.0.4 and 3.1.1, for example | ||
| // RFC3986's definition of [reserved](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2) | ||
|
Comment on lines
+292
to
+293
There was a problem hiding this comment. Also fine with these being made more typical. |
||
|
|
||
| // harmonize RFC URLs | ||
| line = line.replace('http://www.ietf.org/rfc/rfc2119.txt','https://tools.ietf.org/html/rfc2119'); // only in 2.0.md | ||
| line = line.replace(/https:\/\/www.rfc-editor.org\/rfc\/rfc([0-9]{1,5})(\.html)?/g,'https://tools.ietf.org/html/rfc$1'); | ||
| line = line.replaceAll('https://datatracker.ietf.org/doc/html/rfc','https://tools.ietf.org/html/rfc'); | ||
| line = line.replaceAll('http://tools.ietf.org','https://tools.ietf.org'); | ||
|
|
||
| // handle url fragments in RFC links and construct section titles links as well as RFC links | ||
| line = line.replace(/\]\]\(https:\/\/tools.ietf.org\/html\/rfc([0-9]{1,5})\/?(\#[^)]*)?\)/g, function(match, rfcNumber, fragment) { | ||
| if (fragment) { | ||
| // Extract section title from the fragment | ||
| let sectionTitle = fragment.replace('#', '').replace(/-/g, ' '); | ||
| sectionTitle = sectionTitle.charAt(0).toUpperCase() + sectionTitle.slice(1); // Capitalize the first letter | ||
| return `]] [${sectionTitle}](https://datatracker.ietf.org/doc/html/rfc${rfcNumber}${fragment})`; | ||
| } else { | ||
| return ']]'; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| if (!inCodeBlock && line.indexOf('](../') >= 0) { | ||
| const regExp = /\((\.\.[^)]+)\)/g; | ||
| line = line.replace(regExp,function(match,group1){ | ||
|
|
@@ -306,9 +323,10 @@ for (let l in lines) { | |
| let heading = 0; | ||
| while (line[heading] === '#') heading++; | ||
| let delta = heading-prevHeading; | ||
| if (delta>1) console.warn(delta,line); | ||
| if (delta>0) delta = 1; | ||
| //if (delta<0) delta = -1; | ||
| // if (Math.abs(delta)>1) console.warn(delta,line); | ||
|
Comment on lines
-311
to
+329
There was a problem hiding this comment. Any particular reason to keep this line as a comment instead of delete? There was a problem hiding this comment. Reverence for @MikeRalphson 😄 There was a problem hiding this comment. Will remove them in a future PR |
||
| let prefix = ''; | ||
| let newSection = '<section>'; | ||
| if (line.includes('## Version ')) { | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm entirely fine with making these more normal rather than working around them in the build script.