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: Default --description to repo's description if the in-repository one is the default #1363

Open
2 tasks done
JoshuaKGoldberg opened this issue Mar 2, 2024 · 0 comments
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

Overview

Right now, --description defaults to the description in a package.json file:

description: async () => (await packageData()).description,

...but, in a repository newly created from the template, that description will likely be the default create-typescript-app one:

┌  ✨ Welcome to create-typescript-app 1.57.8! ✨
│
│  ⚠️ This template is early stage, opinionated, and not endorsed by the TypeScript team. ⚠️
│  ⚠️ If any tooling it sets displeases you, you can always remove that portion manually. ⚠️
│
◇  What organization or user will the repository be under?
│  JoshuaKGoldberg
│
◇  What will the kebab-case name of the repository be?
│  github-notifications-prune
│
◇  ✅ Passed checking GitHub authentication.
│
◆  How would you describe the new package?
│  Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 💝
└

If the package.json description is the same default description as create-typescript-app's as seen in that code block, then it's not likely a good suggestion for a newly created package. Let's have the logic also check the GitHub repository's About as second thing:

Screenshot of a GitHub repository's About: 'Prunes GitHub notifications you don't care about, such as automated dependency bumps. 🧹'

...and don't include a suggestion if both are the default description.

Additional Info

No response

@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Mar 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Projects
None yet
Development

No branches or pull requests

1 participant