typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star15.7k

docs: describe update steps for ESLint, Node, and TypeScript#6251

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

JoshuaKGoldberg merged 3 commits intotypescript-eslint:mainfromJoshuaKGoldberg:dependant-version-upgrades

Jan 30, 2023

Merged

docs: describe update steps for ESLint, Node, and TypeScript#6251

JoshuaKGoldberg merged 3 commits intotypescript-eslint:mainfromJoshuaKGoldberg:dependant-version-upgrades

Jan 30, 2023

Conversation

Copy link

Member

JoshuaKGoldberg commentedDec 18, 2022

PR Checklist

Addresses an existing open issue:fixesDocs: Maintenance > new TypeScript versions #5932
That issue was marked asaccepting prs
Steps inCONTRIBUTING.md were taken

Overview

Nests the docs as aDependant Version Upgrades page underVersioning. Proposes a slightly different process for TypeScript specifically.

docs: describe update steps for ESLint, Node, and TypeScript

39a30fd

Copy link

nx-cloudbot commentedDec 18, 2022•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit66708d7. 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 47 targets

Sent with 💌 fromNxCloud.

Copy link

Contributor

typescript-eslintbot commentedDec 18, 2022

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

netlifybot commentedDec 18, 2022•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`66708d7`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/639f80a525537300098731ab
😎 Deploy Preview	https://deploy-preview-6251--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

lil typo fix, and a heart

e83e01d

Josh-Cena reviewed

Dec 18, 2022

View reviewed changes

docs/maintenance/VERSIONING.md


		### ESLint

		> The version range of ESLint currently supported is `^6.0.0 \|\| ^7.0.0 \|\| ^8.0.0`.

Copy link

Member

Josh-CenaDec 18, 2022

Choose a reason for hiding this comment

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

Not introduced in this PR, but I strongly suggest using admonitions like:::info instead. Quotes should be used for quotes and not other things.

Copy link

MemberAuthor

JoshuaKGoldbergDec 18, 2022

Choose a reason for hiding this comment

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

Heh, an old habit from working in raw Markdown. +1 on thesemantics of switching away from quotes. But I do prefer thevisual of a quote because admonitions take the extra line to indicate their type.

Has there been any discussion about making single-line admonitions? My GitHub+Google searching is failing me, but I can make a Discussion if not.

Copy link

Member

Josh-CenaDec 18, 2022

Choose a reason for hiding this comment

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

No discussion yet, but IMO it's fine to make the doc page a bit less densely populated :)

Copy link

MemberAuthor

JoshuaKGoldbergDec 18, 2022

Choose a reason for hiding this comment

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

facebook/docusaurus#8458

Copy link

MemberAuthor

JoshuaKGoldbergJan 19, 2023

Choose a reason for hiding this comment

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

@Josh-Cena what do you think - should we stick with the larger admonitions, or smaller-but-semantically-off quotes? I'll defer to your suggestion 😄

Copy link

MemberAuthor

JoshuaKGoldbergJan 30, 2023

Choose a reason for hiding this comment

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

I'll go with the same quotes as before for now. But once we can use single-line admonitions perfacebook/docusaurus#8458 (comment) I would enthusiastically switch us over!