Skip to content

docs: flesh out tips for typed linting and .eslintrc.cjs #6919

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

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Doesn't provide an explicit "here's the right way to do this!" because I don't think there is one 🥲. At least not unless ESLint configs eventually could be written in TypeScript!

Instead, adds an explicit caution note and bolsters the FAQ entry to explicitly handle the idea of a root-level .cjs/.js file and typed linting.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

@netlify
Copy link

netlify bot commented Apr 16, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 3de2d52
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/644a9a623b2cc300083ecfca
😎 Deploy Preview https://deploy-preview-6919--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Jutanium would love your input on this if you have time 😇

@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Apr 17, 2023
JoshuaKGoldberg and others added 2 commits April 18, 2023 10:08
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
@codecov
Copy link

codecov bot commented Apr 18, 2023

Codecov Report

Merging #6919 (87117c7) into main (1944d42) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 87117c7 differs from pull request most recent head 3de2d52. Consider uploading reports for the commit 3de2d52 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6919      +/-   ##
==========================================
- Coverage   87.37%   87.37%   -0.01%     
==========================================
  Files         386      386              
  Lines       13195    13192       -3     
  Branches     3867     3867              
==========================================
- Hits        11529    11526       -3     
  Misses       1300     1300              
  Partials      366      366              
Flag Coverage Δ
unittest 87.37% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

bradzacher
bradzacher previously approved these changes Apr 18, 2023
Josh-Cena
Josh-Cena previously approved these changes Apr 25, 2023
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me 😀

bradzacher
bradzacher previously approved these changes Apr 26, 2023
@JoshuaKGoldberg JoshuaKGoldberg dismissed stale reviews from bradzacher and Josh-Cena via 3de2d52 April 27, 2023 15:53
@JoshuaKGoldberg JoshuaKGoldberg merged commit cf045f2 into typescript-eslint:main Apr 27, 2023
@JoshuaKGoldberg JoshuaKGoldberg deleted the typed-linting-eslint-cjs-help branch April 27, 2023 16:05
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Typed Linting guide causes ESLint complaints in .eslintrc.(c)js
3 participants