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.

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

Jump to bottom

🚀 Feature: Allow an optional image for a repo #739

Closed
3 tasks done
JoshuaKGoldberg opened this issue Aug 31, 2023 · 1 comment · Fixed by #851
Closed
3 tasks done

🚀 Feature: Allow an optional image for a repo #739

JoshuaKGoldberg opened this issue Aug 31, 2023 · 1 comment · Fixed by #851
Assignees
@JoshuaKGoldberg
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Milestone
Post-Rename Migra...

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Aug 31, 2023 •
edited
Loading

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

A few of my repositories have images embedded in their README.md files. For example, TypeStat: https://github.com/JoshuaKGoldberg/TypeStat/blob/1cef5e7fd5c4c2541fe29a1372a8950a5ba72545/README.md

TypeStat logo: the TypeScript blue square with rounded corners, but a plus sign instead of 'TS'

Usage

TypeStat is a CLI utility that modifies TypeScript types in existing code.
The built-in mutators will only ever add or remove types and will never change your runtime behavior.
TypeStat can:
...

I'll add an values to Options that can be specified on the CLI as ... maybe, --image-alt and --image-src? If one is provided the other must be as well?

Additional Info

I'm going to use an image in this repo!
@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Aug 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Aug 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg changed the title 🚀 Feature: Allow an optional image for the repo 🚀 Feature: Allow an optional image for a repo Aug 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg added this to the Post-Rename Migration milestone Sep 2, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Sep 20, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Sep 21, 2023
@JoshuaKGoldberg
feat: added --logo and --logo-alt (#851)
72c6d99 
## PR Checklist

- [x] Addresses an existing open issue: fixes #739
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Adds in options to put an image in the README.md, and uses them in this
repo with the "new" logo. (it's really
[TypeStat](https://github.com/JoshuaKGoldberg/TypeStat)'s old logo)

While I'm in the area, fills in test coverage for `readOptions.test.ts`.
I also noticed it was taking >500ms to run sometimes. Turns out it
wasn't mocking `readOptionDefaults`! 😱
@github-actions
Copy link

github-actions bot commented Oct 2, 2023

🎉 This is included in version v1.32.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Projects
None yet
Milestone
Post-Rename Migration
Development

Successfully merging a pull request may close this issue.

feat: added --logo and --logo-alt JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg