Shopify / Shopify/roast

Abbreviate nested cog prefixes

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

Nobody has claimed this yet.

enhancement
Dominant language
Ruby
Stars
1.2k
Forks
76
PR merge metrics
No merged PRs in 30d

Description

Currently, nested cogs can end up having really long names, causing them to take a lot of terminal space.

Example:
Image

The goal is to reduce the length of displayed names to allow for better readability and cleaner output.

This is especially important as #876 and #877 will make the prefix appear before every line of a cog's output, so reducing the length of the prefix will allow for more information per line.

Contributor guide

Open the contributing guide

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

The issue names no file or test. Start by tracing where nested cog names and output prefixes are assembled, using the example image and the prefix behavior described for #876 and #877 as references. Done means displayed nested prefixes are shorter and the terminal output is easier to read.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.