Skip to content

fix: Lowercase all characters on github #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kevin-david merged 2 commits into from
Dec 19, 2025
Merged

fix: Lowercase all characters on github #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccce32b
Fix regex to escape additional characters in header
thompson-tomo Dec 13, 2025
527774d
Github lowercases all text
thompson-tomo Dec 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions anchor-markdown-header.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ function basicGithubId(text) {
// escape codes
.replace(/%([abcdef]|\d){2,2}/ig, '')
// single chars that are removed
.replace(/[\/?!:\[\]`.,()*"';{}+=<>~\$|#@&–—]/g,'')
.replace(/[\/\\?!%:\[\]`.,()*"';{}+=<>~\$|#@&–—]/g,'')
// CJK punctuations that are removed
.replace(/[。？！，、；：“”【】（）〔〕［］﹃﹄“ ”‘’﹁﹂—…－～《》〈〉「」]/g, '')
;
Expand Down Expand Up @@ -117,6 +117,7 @@ module.exports = function anchorMarkdownHeader(header, mode, repetition, moduleN
mode = mode || 'github.com';
var replace;
var customEncodeURI = encodeURI;
var customCasing = asciiOnlyToLowerCase;

switch(mode) {
case 'github.com':
Expand All @@ -129,6 +130,10 @@ module.exports = function anchorMarkdownHeader(header, mode, repetition, moduleN
// github doesn't URL encode them, so we replace them after url encoding to preserve the zwj character.
return newURI.replace(/%E2%80%8D/g, '\u200D');
};
customCasing = function(input) {
// GitHub prefers to lowercase all characters, not just ASCII ones. Previously this was not the case.
return input.toLowerCase();
}
break;
case 'bitbucket.org':
replace = getBitbucketId;
Expand Down Expand Up @@ -161,7 +166,7 @@ module.exports = function anchorMarkdownHeader(header, mode, repetition, moduleN
return result;
}

var href = replace(asciiOnlyToLowerCase(header.trim()), repetition);
var href = replace(customCasing(header.trim()), repetition);

return '[' + header + '](#' + customEncodeURI(href) + ')';
};
16 changes: 8 additions & 8 deletions test/anchor-markdown-header.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,14 +173,14 @@ test('\ngenerating anchor for non-english header', function (t) {
, [ '标题', 1, '#%E6%A0%87%E9%A2%98-1']
, [ '中间有空格 和.符号.的(标题)', null, '#%E4%B8%AD%E9%97%B4%E6%9C%89%E7%A9%BA%E6%A0%BC-%E5%92%8C%E7%AC%A6%E5%8F%B7%E7%9A%84%E6%A0%87%E9%A2%98']
, [ '存在，【中文】；《标点》、符号！的标题？', null, '#%E5%AD%98%E5%9C%A8%E4%B8%AD%E6%96%87%E6%A0%87%E7%82%B9%E7%AC%A6%E5%8F%B7%E7%9A%84%E6%A0%87%E9%A2%98']
, [ 'Заголовок', null, '#%D0%97%D0%B0%D0%B3%D0%BE%D0%BB%D0%BE%D0%B2%D0%BE%D0%BA']
, [ 'NECHŤ JIŽ HŘÍŠNÉ SAXOFONY ĎÁBLŮ ROZZVUČÍ SÍŇ ÚDĚSNÝMI TÓNY WALTZU, TANGA A QUICKSTEPU.', null, '#nech%C5%A4-ji%C5%BD-h%C5%98%C3%8D%C5%A0n%C3%89-saxofony-%C4%8E%C3%81bl%C5%AE-rozzvu%C4%8C%C3%8D-s%C3%8D%C5%87-%C3%9Ad%C4%9Asn%C3%9Dmi-t%C3%93ny-waltzu-tanga-a-quickstepu']
, [ 'PÓJDŹŻE, KIŃ TĘ CHMURNOŚĆ W GŁĄB FLASZY!', null, '#p%C3%93jd%C5%B9%C5%BBe-ki%C5%83-t%C4%98-chmurno%C5%9A%C4%86-w-g%C5%81%C4%84b-flaszy']
, [ 'FLYGANDE BÄCKASINER SÖKA STRAX HWILA PÅ MJUKA TUVOR.', null, '#flygande-b%C3%84ckasiner-s%C3%96ka-strax-hwila-p%C3%85-mjuka-tuvor']
, [ 'LYNX C.Q. VOS PRIKT BH: DAG ZWEMJUF! VICTOR JAGT ZWÖLF BOXKÄMPFER QUER ÜBER DEN GROßEN SYLTER DEICH.', null, '#lynx-cq-vos-prikt-bh-dag-zwemjuf-victor-jagt-zw%C3%96lf-boxk%C3%84mpfer-quer-%C3%9Cber-den-gro%C3%9Fen-sylter-deich']
, [ 'EL VELOZ MURCIÉLAGO HINDÚ COMÍA FELIZ CARDILLO Y KIWI. LA CIGÜEÑA TOCABA EL SAXOFÓN DETRÁS DEL PALENQUE DE PAJA.', null, '#el-veloz-murci%C3%89lago-hind%C3%9A-com%C3%8Da-feliz-cardillo-y-kiwi-la-cig%C3%9Ce%C3%91a-tocaba-el-saxof%C3%93n-detr%C3%81s-del-palenque-de-paja']
, [ 'DO BẠCH KIM RẤT QUÝ NÊN SẼ DÙNG ĐỂ LẮP VÔ XƯƠNG', null, '#do-b%E1%BA%A0ch-kim-r%E1%BA%A4t-qu%C3%9D-n%C3%8An-s%E1%BA%BC-d%C3%99ng-%C4%90%E1%BB%82-l%E1%BA%AEp-v%C3%94-x%C6%AF%C6%A0ng']
, [ 'ΞΕΣΚΕΠΆΖΩ ΤΗΝ ΨΥΧΟΦΘΌΡΑ ΒΔΕΛΥΓΜΊΑ', null, '#%CE%9E%CE%95%CE%A3%CE%9A%CE%95%CE%A0%CE%86%CE%96%CE%A9-%CE%A4%CE%97%CE%9D-%CE%A8%CE%A5%CE%A7%CE%9F%CE%A6%CE%98%CE%8C%CE%A1%CE%91-%CE%92%CE%94%CE%95%CE%9B%CE%A5%CE%93%CE%9C%CE%8A%CE%91']
, [ 'Заголовок', null, '#%D0%B7%D0%B0%D0%B3%D0%BE%D0%BB%D0%BE%D0%B2%D0%BE%D0%BA']
, [ 'NECHŤ JIŽ HŘÍŠNÉ SAXOFONY ĎÁBLŮ ROZZVUČÍ SÍŇ ÚDĚSNÝMI TÓNY WALTZU, TANGA A QUICKSTEPU.', null, '#nech%C5%A5-ji%C5%BE-h%C5%99%C3%AD%C5%A1n%C3%A9-saxofony-%C4%8F%C3%A1bl%C5%AF-rozzvu%C4%8D%C3%AD-s%C3%AD%C5%88-%C3%BAd%C4%9Bsn%C3%BDmi-t%C3%B3ny-waltzu-tanga-a-quickstepu']
, [ 'PÓJDŹŻE, KIŃ TĘ CHMURNOŚĆ W GŁĄB FLASZY!', null, '#p%C3%B3jd%C5%BA%C5%BCe-ki%C5%84-t%C4%99-chmurno%C5%9B%C4%87-w-g%C5%82%C4%85b-flaszy']
, [ 'FLYGANDE BÄCKASINER SÖKA STRAX HWILA PÅ MJUKA TUVOR.', null, '#flygande-b%C3%A4ckasiner-s%C3%B6ka-strax-hwila-p%C3%A5-mjuka-tuvor']
, [ 'LYNX C.Q. VOS PRIKT BH: DAG ZWEMJUF! VICTOR JAGT ZWÖLF BOXKÄMPFER QUER ÜBER DEN GROßEN SYLTER DEICH.', null, '#lynx-cq-vos-prikt-bh-dag-zwemjuf-victor-jagt-zw%C3%B6lf-boxk%C3%A4mpfer-quer-%C3%BCber-den-gro%C3%9Fen-sylter-deich']
, [ 'EL VELOZ MURCIÉLAGO HINDÚ COMÍA FELIZ CARDILLO Y KIWI. LA CIGÜEÑA TOCABA EL SAXOFÓN DETRÁS DEL PALENQUE DE PAJA.', null, '#el-veloz-murci%C3%A9lago-hind%C3%BA-com%C3%ADa-feliz-cardillo-y-kiwi-la-cig%C3%BCe%C3%B1a-tocaba-el-saxof%C3%B3n-detr%C3%A1s-del-palenque-de-paja']
, [ 'DO BẠCH KIM RẤT QUÝ NÊN SẼ DÙNG ĐỂ LẮP VÔ XƯƠNG', null, '#do-b%E1%BA%A1ch-kim-r%E1%BA%A5t-qu%C3%BD-n%C3%AAn-s%E1%BA%BD-d%C3%B9ng-%C4%91%E1%BB%83-l%E1%BA%AFp-v%C3%B4-x%C6%B0%C6%A1ng']
, [ 'ΞΕΣΚΕΠΆΖΩ ΤΗΝ ΨΥΧΟΦΘΌΡΑ ΒΔΕΛΥΓΜΊΑ', null, '#%CE%BE%CE%B5%CF%83%CE%BA%CE%B5%CF%80%CE%AC%CE%B6%CF%89-%CF%84%CE%B7%CE%BD-%CF%88%CF%85%CF%87%CE%BF%CF%86%CE%B8%CF%8C%CF%81%CE%B1-%CE%B2%CE%B4%CE%B5%CE%BB%CF%85%CE%B3%CE%BC%CE%AF%CE%B1']
].forEach(function (x) { check(x[0], x[1], x[2]) });
t.end();
})