Skip to content

docs(website): blog post on consistent-type-(exports|imports) #6238

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

Adds a blog post and links to it in the rule docs.

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

@nx-cloud
Copy link

nx-cloud bot commented Dec 17, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 4ffa209. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 46 targets

Sent with 💌 from NxCloud.

@netlify
Copy link

netlify bot commented Dec 17, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 4ffa209
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/63f707488798620008acc52d
😎 Deploy Preview https://deploy-preview-6238--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.

nicknisi
nicknisi previously approved these changes Dec 17, 2022
Copy link

@nicknisi nicknisi 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, and a great explanation of why this is useful. Thanks!

@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Jan 30, 2023
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

This blog post should also probably mention the new verbatimModuleSyntax compiler option (and why you might not want to use it).

We also might want to wait for this new rule before publishing this:
#6382
Which would help explain to people what they can do about the footgun in verbatimModuleSyntax.

We also probably want to include mention of other rules that help ensure consistency in your imports:

In conjunction with consistent-type-imports, the rules can enforce your imports are always properly qualified and are written in a standard, predictable style (eg always top-level type qualifier or always inline type-qualifier).

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Jan 30, 2023
Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
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.

Frankly, I'd be much more interested in knowing how import type and import { type } play with each other and everything else. But I get they are probably not in scope of these rules anyway. We could wait for verbatimModuleSyntax before writing a follow-up post about all the different type import syntaxes.

JoshuaKGoldberg and others added 2 commits February 5, 2023 01:30
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
@JoshuaKGoldberg JoshuaKGoldberg removed the awaiting response Issues waiting for a reply from the OP or another party label Feb 5, 2023
@bradzacher
Copy link
Member

ICYMI - there were some things I mentioned in my earlier comment WDYT?

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Feb 20, 2023
@JoshuaKGoldberg
Copy link
Member Author

Ah I'd missed that comment, sorry! Re-drafting.

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as draft February 21, 2023 03:40
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review February 21, 2023 20:42
@JoshuaKGoldberg JoshuaKGoldberg requested review from bradzacher, nicknisi and Josh-Cena and removed request for bradzacher, Josh-Cena and nicknisi February 23, 2023 06:28
@JoshuaKGoldberg JoshuaKGoldberg removed the awaiting response Issues waiting for a reply from the OP or another party label Feb 23, 2023
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

this LGTM - there's lots of good content in there!

@bradzacher bradzacher added this pull request to the merge queue Mar 1, 2023
Merged via the queue into typescript-eslint:main with commit 315374c Mar 1, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 9, 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: Fill out docs for consistent-type-(imports|exports)
4 participants