Skip to content

Correctly detect frontmatter to avoid mangling document (fixes #180, fixes #189) #190

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Correctly detect frontmatter to avoid mangling document (fixes #180, fixes #189) #190

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
0e290ef
fix: Correctly detect frontmatter to avoid mangling document
gregdan3 Sep 17, 2023
76a76dc
fix: Trim empty sections before joining to avoid spare newlines in do…
gregdan3 Sep 17, 2023
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
5 changes: 4 additions & 1 deletion lib/insert.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module.exports = function insert(str, options) {
if (m) newlines = m[0];

// does the file have front-matter?
if (/^---/.test(str)) {
if (/^---\n.*\n---\n/.test(str)) {
// extract it temporarily so the syntax
// doesn't get mistaken for a heading
obj = utils.matter(str);
Expand All @@ -50,6 +50,9 @@ module.exports = function insert(str, options) {
sections.splice(1, 0, open + toc(last, options).content + '\n\n' + close);
}

// Trim empty sections to avoid adding newlines to document in join
sections = sections.filter((section) => section.length > 0);

var resultString = sections.join('\n\n') + newlines;
// if front-matter was found, put it back now
if (obj) {
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"David Mohl (https://dvcrn.github.io)",
"Federico Soave (https://github.com/Feder1co5oave)",
"Gary Green (https://github.com/garygreen)",
"Gregory Danielson III (https://gregdan3.dev)",
"Jon Schlinkert (http://twitter.com/jonschlinkert)",
"Josh Duff (https://tehshrike.github.io)",
"Matt Ellis (http://sticklebackplastic.com)",
Expand Down
5 changes: 5 additions & 0 deletions test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,4 +426,9 @@ describe('toc.insert', function() {
assert.equal(strip(toc.insert(str, { linkify: true })), read('test/expected/insert.md'));
assert.equal(strip(toc.insert(str, { linkify: false })), read('test/expected/insert-no-links.md'));
});

it('should not mangle a file with an initial horizontal rule', function() {
assert.equal(toc.insert('---\nExample\n'), '---\nExample\n');
})

});