semantic-release / semantic-release/exec

default error output formatting isn't ergonomic

Open
#114 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
164
Forks
28
PR merge metrics
No merged PRs in 30d

Description

I know I can provide a failCmd, and I'll do that, but it seems to me the default failure output could be improved. It prints the stdout stringified, which is an assault on the eyes...

Aside from that it's not 100% straightforward how to deal with quoting in making a failCmd that will print the output as-is.

  shortMessage: 'Command failed with exit code 1: ./run release 7.0.0',
  command: './run release 7.0.0',
  exitCode: 1,
  signal: undefined,
  signalDescription: undefined,
  stdout:
   'Login Succeeded\nmaster\njcore/clarity\n*********************************************\nSuccessfully compiled 414 files with Babel.\nSuccessfully compiled 714 files with Babel.\nHappy[1]: Version: 5.0.1. Threads: 4\nHappy[1]: All set; signaling webpack to proceed.\nHash: \u001b[1m8a4bddc52b72ec4bb568\u001b[39m\u001b[22m\nVersion: webpack \u001b[1m4.28.0\u001b[39m\u001b[22m\nTime: \u001b[1m64663\u001b[39m\u001b[22mms\nBuilt at: 09/30/2020 \u001b[1m10:20:58 PM\u001b[39m\u001b[22m\n                               \u001b[1mAsset\u001b[39m\u001b[22m       \u001b[1mSize\u001b[39m\u001b[22m  \u001b[1mChunks\u001b[39m\u001b[22m  \u001b[1m\u001b[39m\u001b[22m           \u001b[1m\u001b[39m\u001b[22m       \u001b[1mChunk Names\u001b[39m\u001b[22m\n           \u001b[1m\u001b[32m0_e0568fa039ca1be3a035.js\u001b[39m\u001b[22m   46.9 KiB       \u001b[1m0\u001b[39m\u001b[22m  \u001b[1m\u001b[32m[emitted]\u001b[39m\u001b[22m         \n       \u001b[1m\u001b[32m0_e0568fa039ca1be3a035.js.map\u001b[39m\u001b[22m    123 KiB       \u001b[1m0\u001b[39m\u001b[22m  \u001b[1m\u001b[32m[emitted]\u001b[39m\u001b[22m         \n          \u001b[1m\u001b[32m11_5b4b19d4d23cb7309e43.js\u001b[39m\u001b[22m   71.6 KiB      \u001b[1m11\u001b[39m\u001b[22m  \u001b[1m\u001b[32m[emitted]\u001b[39m\u001b[22m         \n      \u001b[1m\u001b[32m11_5b4b19d4d23cb7309e43.js.map\u001b[39m\u001b[22m    300 KiB      \u001b[1m11\u001b[39m\u001b[22m  \u001b[1m\u001b[32m[emitted]\u001b[39m\u001b[22m         \n          \u001b[1m\u001b[32m12_1530a720f145ffeffdf4.js\u001b[39m\u001b[22m   26.1 KiB      \u001b[1m12\u001b[39m\u001b[22m  \u001b[1m\u001b[32m[emitted]\u001b[39m\u001b[22m         \n      \u001b[1m\u001b[32m12_1530a720f145ffeffdf4.js.map\u001b[39m\u001b[22m   56.2 KiB      \u001b[1m12\u001b[39m\u001b[22m  \u001

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the default failure-output formatting and the failCmd handling in semantic-release/exec, then reproduce a failed command whose stdout contains multiline text and ANSI escape sequences. Done means the default output is readable and the issue's quoting concern is addressed without requiring a custom failCmd.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, shell
Domain
cli, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.