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: Prompt for keywords in package.json #526

Closed
3 tasks done
JoshuaKGoldberg opened this issue Jun 11, 2023 · 1 comment · Fixed by #886
Closed
3 tasks done

🚀 Feature: Prompt for keywords in package.json #526

JoshuaKGoldberg opened this issue Jun 11, 2023 · 1 comment · Fixed by #886
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

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

https://docs.npmjs.com/cli/v9/configuring-npm/package-json#keywords are a commonly used part of projects. In addition to fields such as --repository, let's give users the ability to pnpm run setup a repository with package.json keywords!

pnpm run setup --keyword javascript --keyword "static analysis"

...which will then create (along with all the other package.json fields):

// package.json
{
  "keywords": ["javascript", "static analysis"]
}

Additional Info

Setup is described here: https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/ad3d34a3a898f4bb5d8ec7de82409def50c99463/README.md#L46

After this feature is merged, I'll want to a followup issue for using the GitHub API to set the repository's topics based on those keywords. That should be a followup - no need to also do that as part of this issue's feature request.
@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Jun 11, 2023
@JoshuaKGoldberg JoshuaKGoldberg added this to the Post-Rename Migration milestone Sep 22, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Sep 22, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Sep 25, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Sep 29, 2023
@JoshuaKGoldberg
feat: support package.json keywords (#886)
1399071 
## PR Checklist

- [x] Addresses an existing open issue: fixes #526
- [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 `keywords` as an allowed arg. I set it to plural instead of the
singular `keyword` because I expect I'll be specifying many, multiple,
keywords.
@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: support package.json keywords JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg