Skip to content

docs: add 'Typed Linting' blog post #10025

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

Merged

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Adds a ~10 minute read explaining:

  1. What typed linting is
  2. Common uses for it
  3. Enabling it
  4. Drawbacks

I'm planning on using this as a springboard for our more in-depth, rule-specific blog posts soon (#6415, #8517, #9103).

💖

@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.

Copy link

netlify bot commented Sep 20, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 3f29422
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/66fac8ab3f96eb00086404dd
😎 Deploy Preview https://deploy-preview-10025--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

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

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review September 20, 2024 01:28
@JoshuaKGoldberg JoshuaKGoldberg requested a review from a team September 20, 2024 01:28
@@ -16,6 +16,8 @@ To tap into TypeScript's additional powers, there are two small changes you need
2. Add `languageOptions.parserOptions` to tell our parser how to find the TSConfig for each source file.

```js title="eslint.config.mjs"
import tseslint from 'typescript-eslint';
Copy link
Member Author

Choose a reason for hiding this comment

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

Tangent: It's been bugging me that you can't copy & paste the full code snippet from this page. 😄


const filePath = './data.json';

readFromCache(filePath);)
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
readFromCache(filePath);)
readFromCache(filePath);

Something should fail the build on this...

Copy link

codecov bot commented Sep 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.02%. Comparing base (036e7e3) to head (3f29422).
Report is 33 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10025      +/-   ##
==========================================
- Coverage   88.69%   86.02%   -2.68%     
==========================================
  Files         426      428       +2     
  Lines       14829    14921      +92     
  Branches     4313     4327      +14     
==========================================
- Hits        13153    12836     -317     
- Misses       1533     1741     +208     
- Partials      143      344     +201     
Flag Coverage Δ
unittest 86.02% <ø> (-2.68%) ⬇️

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

see 114 files with indirect coverage changes

JoshuaKGoldberg and others added 2 commits September 30, 2024 11:48
Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>
@JoshuaKGoldberg JoshuaKGoldberg merged commit 16f4d90 into typescript-eslint:main Sep 30, 2024
61 of 62 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Blog post on the benefits of typed linting
2 participants