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 an API usage example in create and initialize modes #785

Closed
3 tasks done
JoshuaKGoldberg opened this issue Sep 4, 2023 · 1 comment · Fixed by #882
Closed
3 tasks done

🚀 Feature: Add an API usage example in create and initialize modes #785

JoshuaKGoldberg opened this issue Sep 4, 2023 · 1 comment · Fixed by #882
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

Back before #668, this template used to include a nice little ## Usage section in the README.md:

Usage

npm i template-typescript-node-package
import { greet } from "template-typescript-node-package";

It would be included in the find-and-replace that switched template-typescript-node-package (now, create-typescript-app) to the user's new package name.

I removed that bit because it doesn't make much sense with --mode migrate. But for --mode create and --mode initialize it'd be really nice. So let's add it back in for just those modes.

Additional Info

Let's tackle this after #749.
@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: blocked Waiting for something else to be resolved labels Sep 4, 2023
@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Please, send a pull request to resolve this! and removed status: blocked Waiting for something else to be resolved labels Sep 22, 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 23, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Sep 23, 2023
@JoshuaKGoldberg
feat: add back Usage example to create and initialize (#882)
b465f78 
## PR Checklist

- [x] Addresses an existing open issue: fixes #785
- [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

Also adds `mode` to `Options` because it was getting annoying passing it
around explicitly too.
@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: add back Usage example to create and initialize JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg