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: Add CLI prompt for removing parts of the template #694

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

🚀 Feature: Add CLI prompt for removing parts of the template #694

JoshuaKGoldberg opened this issue Aug 23, 2023 · 1 comment · Fixed by #695
Assignees
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Aug 23, 2023

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

Right now, there are two CLI flags for opting out of part of the package:

https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/edd4d8fdccc44ae77dd8a6c15b6d5cf26024f80a/docs/Migration.md#L35-L36

Additionally:

https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/edd4d8fdccc44ae77dd8a6c15b6d5cf26024f80a/docs/Migration.md#L49

I think that before this package gets targeted as a more broadly used builder (#671), it should become easier to exclude parts of the template. I'm thinking of standardizing them as --exclude-*.

Existing ones would become:

  • --exclude-contributors
  • --exclude-releases
  • --exclude-tests

New ones:

  • --exclude-lint-json (within ESLint)
  • --exclude-lint-knip
  • --exclude-lint-md
  • --exclude-lint-perfectionist (within ESLint)
  • --exclude-lint-yml (within ESLint)
  • --exclude-lint-packages
  • --exclude-lint-package
  • --exclude-lint-spelling
@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Aug 23, 2023
@JoshuaKGoldberg JoshuaKGoldberg added this to the Ready to Launch milestone Aug 23, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Aug 23, 2023
JoshuaKGoldberg added a commit that referenced this issue Aug 25, 2023
## PR Checklist

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

## Overview

Drastically streamlines and simplifies the way defaults/overrides are
provided to `readInputs`. In fact, they're no longer take in at all -
all three setup scripts now use the same kinds of default gathering!
This way they all use whatever information is available to them. Updates
the docs to reflect this standardization.

Renames `lint:package` to `lint:package-json`. `--exclude-lint-package`
was too visually similar to `--exclude-lint-packages` for comfort.

Adds a `--base` CLI flag that can be set as `"everything"`, `"minimal"`,
or `"prompt"`.
@github-actions
Copy link

🎉 This is included in version v1.29.4 🎉

The release is available on:

Cheers! 📦🚀

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

Successfully merging a pull request may close this issue.

1 participant