Skip to content
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.

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

[Feature]: Skip STL generation and the GitHub Skyline ascii art text #36

Open
3 tasks
mattr- opened this issue Dec 9, 2024 · 2 comments
Open
3 tasks
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@mattr-
Copy link

mattr- commented Dec 9, 2024

Description

I'd like the ability to generate only the ascii art portion of the skyline without the GitHub Skyline ASCII art and without generating an STL file. Why? I'd like to include the skyline as part of an overall dashboard I'm working on for my terminal setup.

Requirements

Provide CLI flag (--only-art?) that does the following:

  • Removes the ASCII art for GitHub Skyline
  • Prevents the generation of an STL file on disk.

I'd like to run something like gh skyline --art-only --year 2023 and have

                                                ╻
 ╻               ╻      ╻ ╻╻                   ╻░
 ░  ╻╻  ╻   ╽┃  ╻░╻ ╻   ░ ░░ ╻    ╻    ╻╻╻╻ ╻ ╻░░
╻░┃╻▒░╻╻░  ╻░░╻╻░░░╻░╻ ╻░ ░░╻░╻  ╻░ ╻╻╻░░░░ ░ ░░░
░░░░░░░░░  ░░▓░░░░░░░░ ░░ ░░░░░  ░░╻░░░░░░░╻░╻░░░╻╻
░░░░░▒░░░ ╻░░▒░░░░░░░░╻░░ ░░░░░╻ ░░░░░░░░░░░░░░░░░░╻
░░░░░▒░░░░░▒░▒░▓░▓░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░

be the only output. (This is my real skyline from the year 2023 😄)

Definition of Done

  • The request is fulfilled
  • Relevant documentation is updated
  • Unit tests are updated/written and passing

Additional Notes

@mattr- mattr- added enhancement New feature or request triage Issues to be triaged labels Dec 9, 2024
@github-project-automation github-project-automation bot moved this to Needs Review in gh-skyline Dec 9, 2024
@chrisreddington
Copy link
Collaborator

Thanks for the feature request @mattr- 😄 This is an interesting request, as Skyline has typically centered around the 3D printing of the STL models. I added the ASCII art as a new addition for this CLI format, so I'm glad to see that you're enjoying that ❤️ (It brings me joy when I see it appear!)

Overall, I'm seeing a few GitHub Issues with a similar theme of 'customisability' (e.g. being able to customise the STL a bit more, or only have ASCII art, and no STL generated). This is an interesting request, and I think could be explored further.

For now, I'll unassigned this issue, so consider it triaged 🎉 😄 If anyone might be interested in taking a look, please do let me know!

@chrisreddington chrisreddington removed their assignment Dec 10, 2024
@chrisreddington chrisreddington removed the triage Issues to be triaged label Dec 10, 2024
@chrisreddington chrisreddington moved this from Needs Review to Ready to Start in gh-skyline Dec 10, 2024
@chrisreddington chrisreddington added good first issue Good for newcomers help wanted Extra attention is needed labels Dec 10, 2024
@ephyran
Copy link

ephyran commented Dec 11, 2024

Hi! I'm interested in working on this issue. As requested, just letting you know I'll be taking a look at this and working on a PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: Ready to Start
Development

No branches or pull requests

3 participants