Skip to content

docs: add FAQ and docs around verbatimModuleSyntax and similar options #10588

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 16 commits into from
Jan 27, 2025
Merged

docs: add FAQ and docs around verbatimModuleSyntax and similar options #10588

merged 16 commits into from
Jan 27, 2025

Conversation

kirkwaiblinger
Copy link
Member

PR Checklist

Overview

just docs

@kirkwaiblinger kirkwaiblinger added the documentation Documentation ("docs") that needs adding/updating label Jan 1, 2025
@typescript-eslint
Copy link
Contributor

Thanks for the PR, @kirkwaiblinger!

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 Netlify
Copy link

netlify bot commented Jan 1, 2025 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit f7b8d24
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6797ab8b103cde00082f8178
😎 Deploy Preview https://deploy-preview-10588--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: 98 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 98 (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.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Jan 1, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit f7b8d24.

Command Status Duration Result
nx test eslint-plugin --coverage=false ✅ Succeeded 7m 30s View ↗
nx test eslint-plugin ✅ Succeeded 6m View ↗
nx test visitor-keys --coverage=false ✅ Succeeded <1s View ↗
nx run types:build ✅ Succeeded <1s View ↗
nx test scope-manager ✅ Succeeded <1s View ↗
nx run-many --target=build --exclude website --... ✅ Succeeded 30s View ↗
nx test typescript-eslint ✅ Succeeded 5s View ↗
nx test utils ✅ Succeeded <1s View ↗
Additional runs (24) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-01-27 16:14:09 UTC

JoshuaKGoldberg
JoshuaKGoldberg requested changes Jan 7, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Lovely! 🚀

Just some comments on phrasing, the overall flow and additions are very excellent.

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Jan 7, 2025
kirkwaiblinger and others added 5 commits January 7, 2025 13:50
@kirkwaiblinger @JoshuaKGoldberg
Update docs/troubleshooting/faqs/TypeScript.mdx
4c86e0c 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@kirkwaiblinger @JoshuaKGoldberg
Update packages/eslint-plugin/docs/rules/no-require-imports.mdx
09cdadd 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@kirkwaiblinger @JoshuaKGoldberg
Update docs/troubleshooting/faqs/TypeScript.mdx
d86958b 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@kirkwaiblinger
some feedback
b49d823
@kirkwaiblinger
Merge branch 'main' into verbatimModuleSyntax-docs
41b0b77
@codecov Codecov
Copy link

codecov bot commented Jan 7, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.22%. Comparing base (4f3f8cf) to head (f7b8d24).
Report is 6 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #10588      +/-   ##
==========================================
+ Coverage   87.18%   87.22%   +0.03%     
==========================================
  Files         450      450              
  Lines       15623    15667      +44     
  Branches     4565     4581      +16     
==========================================
+ Hits        13621    13665      +44     
  Misses       1645     1645              
  Partials      357      357
Flag Coverage Δ
unittest 87.22% <ø> (+0.03%) ⬆️

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

see 4 files with indirect coverage changes

@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Jan 7, 2025
JoshuaKGoldberg
JoshuaKGoldberg requested changes Jan 13, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Closer!

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Jan 13, 2025
kirkwaiblinger and others added 6 commits January 22, 2025 14:58
@kirkwaiblinger @JoshuaKGoldberg
Update docs/troubleshooting/faqs/TypeScript.mdx
5872dd1 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@kirkwaiblinger @JoshuaKGoldberg
Update packages/eslint-plugin/docs/rules/no-namespace.mdx
fd469b0 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@kirkwaiblinger @JoshuaKGoldberg
Update docs/troubleshooting/faqs/TypeScript.mdx
a4e8187 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@kirkwaiblinger
review feedback
52256c9
@kirkwaiblinger
tweak
2497e38
@kirkwaiblinger
typescript
84482b9
@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Jan 22, 2025
JoshuaKGoldberg
JoshuaKGoldberg previously approved these changes Jan 23, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

😭 This is such a great docs PR. Lots of cross-linking, very informative, and sprinkled with interesting+useful links to TypeScript docs and issues. I love it so much. Awesome @kirkwaiblinger!

@JoshuaKGoldberg JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jan 23, 2025
@kirkwaiblinger @JoshuaKGoldberg
Update packages/eslint-plugin/docs/rules/no-require-imports.mdx
807ac78 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@JoshuaKGoldberg JoshuaKGoldberg merged commit 9f0ce90 into typescript-eslint:main Jan 27, 2025
62 checks passed
@kirkwaiblinger kirkwaiblinger deleted the verbatimModuleSyntax-docs branch January 27, 2025 16:46
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg left review comments

Assignees
No one assigned
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Mention verbatimModuleSyntax in docs for rules that encourage ESM import syntax
2 participants
@kirkwaiblinger @JoshuaKGoldberg