Skip to content

Commit 4f3e786

Browse files
docs: added friendly explainer on top of ESLint config (#414)
## PR Checklist - [x] Addresses an existing open issue: fixes #413 - [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 Adds a nice and friendly notice on top of the ESLint config, with links to a couple of core docs. Also removes that notice in the setup script - I figure consuming repos likely don't want my notices.
1 parent b19f51f commit 4f3e786

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

.eslintrc.cjs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/*
2+
👋 Hi! This ESLint configuration contains a lot more stuff than many repos'!
3+
You can read from it to see all sorts of linting goodness, but don't worry -
4+
it's not something you need to exhaustively understand immediately. 💙
5+
6+
If you're interested in learning more, see the 'getting started' docs on:
7+
- ESLint: https://eslint.org
8+
- typescript-eslint: https://typescript-eslint.io
9+
*/
10+
111
/** @type {import("@types/eslint").Linter.Config} */
212
module.exports = {
313
env: {

script/setup.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,7 @@ try {
363363
[/Template TypeScript Node Package/g, title],
364364
[/JoshuaKGoldberg/g, owner],
365365
[/template-typescript-node-package/g, repository],
366+
[/\/\*\n.+\*\/\n\n/gs, ``, ".eslintrc.cjs"],
366367
[/"setup": ".*",/g, ``, "./package.json"],
367368
[/"setup:test": ".*",/g, ``, "./package.json"],
368369
[/"author": ".+"/g, `"author": "${npmAuthor}"`, "./package.json"],

0 commit comments

Comments
 (0)