Skip to content

Commit d18fcb2

Browse files
committed
feat: add support from \n
1 parent c44a588 commit d18fcb2

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "why",
3-
"version": "0.4.0",
3+
"version": "0.5.0",
44
"description": "A tool to document you package.json scripts",
55
"main": "src/index.js",
66
"bin": "src/index.js",

src/index.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,14 @@ if (!arg) {
2222

2323
for (const scriptName of Object.keys(packageScripts)) {
2424
const desc = whyScriptsDesc[scriptName];
25+
const descWithLineBreaks = desc.split("\\n").join("\n ");
2526
const packageScript = packageScripts[scriptName];
2627

2728
console.log(`\n\x1b[32m${scriptName}\x1b[0m:`);
2829
console.log(
2930
"\x1b[33m%s\x1b[0m",
3031
`\n ${
31-
desc ||
32+
descWithLineBreaks ||
3233
`Description for '${scriptName}' not found in package-why.json, please ask maintainer to add it`
3334
}\n`
3435
);
@@ -82,11 +83,11 @@ if (scriptDesc) {
8283
fs.writeFileSync(packageWhyPath, JSON.stringify(whyObj, undefined, 2));
8384
}
8485
const desc = scriptDesc || whyObj["scripts"][scriptName];
85-
86+
const descWithLineBreaks = desc.split("\\n").join("\n ");
8687
console.log(
8788
"\x1b[33m%s\x1b[0m",
8889
`\n ${
89-
desc ||
90+
descWithLineBreaks ||
9091
`Description for '${scriptName}' not found in package-why.json, please ask maintainer to add it`
9192
}\n`
9293
);

0 commit comments

Comments
 (0)