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: Add a --bin option for projects with a bin runner #938

Closed
3 tasks done
JoshuaKGoldberg opened this issue Oct 3, 2023 · 1 comment · Fixed by #1068
Closed
3 tasks done

🚀 Feature: Add a --bin option for projects with a bin runner #938

JoshuaKGoldberg opened this issue Oct 3, 2023 · 1 comment · Fixed by #1068
Assignees
@JoshuaKGoldberg
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

  • 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

Quite a few of the repositories I've created with this template have a "bin": ... entry in package.json. That way you can npx <package-name> them.

It's been a little inconvenient having to always manually add to template tooling to get support for bin. Plus sometimes there are bugs (e.g. #934).

Let's add a --bin option. That way templates can:

  • Add the bin package.json entry and minimal bin/index.js
  • Include some brief docs in the README.md by default

Additional Info

Packages might be able to avoid running pnpm build before pnpm lint if there's no bin? Not sure, haven't looked into it.
@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Oct 3, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Oct 3, 2023
Closed
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 1, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 1, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Dec 1, 2023
@JoshuaKGoldberg
feat: add --bin option (#1068)
21c8529 
## PR Checklist

- [x] Addresses an existing open issue: fixes #938
- [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 the `--bin` option with auto-detection from existing `package.json`
contents.

Doesn't do anything about investigating whether to adjust `pnpm build`
before `pnpm lint` & similar. That can be a followup.
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 1, 2023

🎉 This is included in version v1.48.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
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add --bin option JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg