Skip to content

docs(website): fix node to originalNode in type checking example #4245

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 2 commits into from
Dec 3, 2021
Merged

docs(website): fix node to originalNode in type checking example #4245

merged 2 commits into from
Dec 3, 2021

Conversation

GalenWong
Copy link
Contributor

PR Checklist

Overview

Correct the example in the type checking section. The type that checker.getTypeAtLocation accepts is a TS Node not a ES Node.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @GalenWong!

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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@netlify
Copy link

netlify bot commented Dec 2, 2021 •
edited
Loading

✔️ Deploy Preview for typescript-eslint ready!

🔨 Explore the source changes: de8059d

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/61a95fd51daa8d000869bf88

😎 Browse the preview: https://deploy-preview-4245--typescript-eslint.netlify.app

@nx-cloud
Copy link

nx-cloud bot commented Dec 2, 2021 •
edited
Loading

Nx Cloud Report

CI ran the following commands for commit de8059d. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

Status Command
#000000 Node 12.x - nx run-many --target=typecheck --all --parallel
#000000 Node 16.x - nx test @typescript-eslint/eslint-plugin-tslint
#000000 Node 16.x - nx test @typescript-eslint/eslint-plugin
#000000 Node 16.x - nx test @typescript-eslint/parser
#000000 Node 16.x - nx test @typescript-eslint/experimental-utils
#000000 Node 16.x - nx test @typescript-eslint/scope-manager
#000000 Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
#000000 Node 16.x - nx test @typescript-eslint/visitor-keys
#000000 Node 16.x - nx test @typescript-eslint/typescript-estree
#000000 Node 16.x - nx run-many --target=build --all --parallel --exclude website --exclude website
#000000 Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
#000000 Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint
#000000 Node 12.x - nx prebuild @typescript-eslint/types
#000000 Node 12.x - nx test @typescript-eslint/eslint-plugin
#000000 Node 12.x - nx test @typescript-eslint/parser
#000000 Node 12.x - nx test @typescript-eslint/experimental-utils
#000000 Node 12.x - nx test @typescript-eslint/scope-manager
#000000 Node 16.x - nx prebuild @typescript-eslint/types
#000000 Node 12.x - nx test @typescript-eslint/visitor-keys
#000000 Node 12.x - nx prebuild @typescript-eslint/types

Sent with 💌 from NxCloud.

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Dec 2, 2021
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.

Aha, you're totally right. Thanks for the catch @GalenWong!

@JoshuaKGoldberg
Copy link
Member

Hmm, I think the semantic pull request bot doesn't like the ` starting the name...

@JoshuaKGoldberg JoshuaKGoldberg changed the title docs(website): node to originalNode in type checking example docs(website): fix node to originalNode in type checking example Dec 3, 2021
@GalenWong
Copy link
Contributor Author

@JoshuaKGoldberg I just pushed an empty commit so the semantics PR bot check passes. Today I learned that you can create empty commits 😂

@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) December 3, 2021 00:19
@JoshuaKGoldberg
Copy link
Member

Haha, glad we were able to learn together today! 😄 🤝

@bradzacher bradzacher disabled auto-merge December 3, 2021 05:14
@bradzacher bradzacher merged commit 6e159ee into typescript-eslint:main Dec 3, 2021
@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Dec 3, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 3, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@GalenWong @JoshuaKGoldberg @bradzacher