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 an addon for comments on top of the ESLint config #1849

Closed
2 tasks done
JoshuaKGoldberg opened this issue Jan 14, 2025 · 0 comments · Fixed by #1864
Closed
2 tasks done

🚀 Feature: Add an addon for comments on top of the ESLint config #1849

JoshuaKGoldberg opened this issue Jan 14, 2025 · 0 comments · Fixed by #1864
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 Jan 14, 2025

Bug Report Checklist

Overview

I've intentionally kept this warning on top of the eslint.config.js file for a while:

/*
👋 Hi! This ESLint configuration contains a lot more stuff than many repos'!
You can read from it to see all sorts of linting goodness, but don't worry -
it's not something you need to exhaustively understand immediately. 💙
If you're interested in learning more, see the 'getting started' docs on:
- ESLint: https://eslint.org
- typescript-eslint: https://typescript-eslint.io
*/

I think it's good for this template to have it because I use this repo as a reference for other people. I don't want everyone to read the file and think all ESLint configs must be as thorough as it.

But, I don't want that comment to exist in generated repos. I would assume most people are using the Common base/preset - which isn't quite so intense. And if someone has opted into the Everything base/preset, then they probably don't need it.

Resolution: I'll add an addon for the ESLint block so that it can be added if a create.config.js wants it.

Additional Info

I don't plan on adding this to the legacy engine, just create blocks.

Prototyped in #1839.

💖

@JoshuaKGoldberg JoshuaKGoldberg added type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Jan 14, 2025
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jan 14, 2025
JoshuaKGoldberg added a commit that referenced this issue Jan 15, 2025

Verified

This commit was signed with the committer’s verified signature.
weswigham Wesley Wigham
## PR Checklist

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

💖
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