Skip to content

fix: avoid crash when contributors tag is at the start of a file #521

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

Open
davidpavlovschi wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −1
Open

fix: avoid crash when contributors tag is at the start of a file #521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions src/generate/__tests__/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,3 +277,20 @@ test('validate if cell width attribute is floored correctly', () => {

expect(result).toMatchSnapshot()
})

test('inject the table when the ALL-CONTRIBUTORS-LIST tag starts the file', () => {
const {kentcdodds, bogas04} = contributors
const {options} = fixtures()
const contributorList = [kentcdodds, bogas04]
const content = [
'<!-- ALL-CONTRIBUTORS-LIST:START -->FOO BAR BAZ<!-- ALL-CONTRIBUTORS-LIST:END -->',
'',
'Thanks a lot everyone!',
].join('\n')

const result = generate(options, contributorList, content)

expect(result).toContain('<table>')
expect(result).toContain('<!-- ALL-CONTRIBUTORS-LIST:END -->')
expect(result).not.toContain('FOO BAR BAZ')
})
2 changes: 1 addition & 1 deletion src/generate/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ function injectListBetweenTags(newContent) {
previousContent.slice(0, endOfOpeningTagIndex + closingTag.length),
'\n<!-- prettier-ignore-start -->',
'\n<!-- markdownlint-disable -->',
newContent.replace('\n', `\n${' '.repeat(nbSpaces - 1)}`),
newContent.replace('\n', `\n${' '.repeat(Math.max(0, nbSpaces - 1))}`),
'<!-- markdownlint-restore -->',
'\n<!-- prettier-ignore-end -->',
'\n\n',
Expand Down