3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-21 23:46:21 +01:00

Copy the README tagline to the npm description at publish; name Jira and Confluence in it

This commit is contained in:
2026-11-08 10:52:48 +01:00
committed by Lillem4n
parent db243b6d73
commit c3f10b5175
7 changed files with 65 additions and 3 deletions
+12
View File
@@ -0,0 +1,12 @@
const markup = /[`[\]*_<>]/
// The README's first paragraph after the title and the badges.
export function readmeTagline(readme) {
const lines = readme.split('\n').filter((line) => !line.startsWith('# ') && !line.startsWith('[!['))
const start = lines.findIndex((line) => line.trim() !== '')
if (start === -1 || lines[start].startsWith('#')) return { error: 'README.md has no tagline paragraph before its first section', ok: false }
const end = lines.findIndex((line, index) => index > start && line.trim() === '')
const tagline = lines.slice(start, end === -1 ? undefined : end).map((line) => line.trim()).join(' ')
if (markup.test(tagline)) return { error: `the README tagline is plain text, since npm shows it as is: ${tagline}`, ok: false }
return { ok: true, value: tagline }
}