Skip to content

docs: add landing page for rules #4114

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 8 commits into from
Nov 15, 2021
Merged

docs: add landing page for rules #4114

merged 8 commits into from
Nov 15, 2021

Conversation

armano2
Copy link
Collaborator

@armano2 armano2 commented Nov 9, 2021 •
edited
Loading

Overview

  • basic root /rules/ page for rules
    • navigation url has been updated
  • deprecated / removed rules will be present in different subcategory
  • Minor fixes to plugin docs

Fixes #4121

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @armano2!

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 Nov 9, 2021 •
edited
Loading

✔️ Deploy Preview for typescript-eslint ready!

🔨 Explore the source changes: ecc2c5f

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

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

@nx-cloud
Copy link

nx-cloud bot commented Nov 9, 2021 •
edited
Loading

Nx Cloud Report

CI ran the following commands for commit ecc2c5f. 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 test @typescript-eslint/eslint-plugin-tslint
#000000 Node 12.x - nx test @typescript-eslint/eslint-plugin
#000000 Node 12.x - nx test @typescript-eslint/eslint-plugin-internal
#000000 Node 12.x - nx test @typescript-eslint/eslint-plugin-tslint
#000000 Node 12.x - nx test @typescript-eslint/eslint-plugin
#000000 Node 16.x - nx test @typescript-eslint/eslint-plugin-tslint
#000000 Node 16.x - nx test @typescript-eslint/eslint-plugin
#000000 Node 14.x - nx test @typescript-eslint/eslint-plugin-tslint
#000000 Node 14.x - nx test @typescript-eslint/eslint-plugin
#000000 Node 12.x - nx run-many --target=typecheck --all --parallel
#000000 Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
#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 12.x - nx test @typescript-eslint/visitor-keys
#000000 Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
#000000 Node 12.x - nx test @typescript-eslint/typescript-estree
#000000 Node 12.x - nx test @typescript-eslint/parser
#000000 Node 12.x - nx run-many --target=build --all --parallel --exclude website --exclude website
#000000 Node 12.x - nx test @typescript-eslint/experimental-utils

Sent with 💌 from NxCloud.

@codecov
Copy link

codecov bot commented Nov 10, 2021 •
edited
Loading

Codecov Report

Merging #4114 (ecc2c5f) into master (87cfc6a) will increase coverage by 0.21%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4114      +/-   ##
==========================================
+ Coverage   93.14%   93.35%   +0.21%     
==========================================
  Files         157      152       -5     
  Lines        8251     8037     -214     
  Branches     2640     2580      -60     
==========================================
- Hits         7685     7503     -182     
+ Misses        192      180      -12     
+ Partials      374      354      -20
Flag Coverage Δ
unittest 93.35% <ø> (+0.21%) ⬆️

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

Impacted Files Coverage Δ
...s/eslint-plugin/src/util/collectUnusedVariables.ts 91.94% <0.00%> (ø)
...internal/src/rules/no-typescript-default-import.ts
...gin-internal/src/rules/no-poorly-typed-ts-props.ts
...plugin-internal/src/rules/prefer-ast-types-enum.ts
...-internal/src/rules/no-typescript-estree-import.ts
...lugin-internal/src/rules/plugin-test-formatting.ts
packages/eslint-plugin/src/util/isTypeReadonly.ts 94.44% <0.00%> (+0.07%) ⬆️

@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Nov 11, 2021
bradzacher
bradzacher reviewed Nov 11, 2021
View reviewed changes
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.

LGTM!

deprecated / removed rules will be present different subcategory

We should add a "note" to the no-implicit-any-catch docs that mentions why it was deprecated. Something like this will do

This rule has been deprecated because TypeScript 4.4 introduced the useUnknownInCatchVariables compiler option which automatically types all catch variables as unknown - meaning a lint rule for manual unknown annotations is no longer necessary.

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Nov 11, 2021
JoshuaKGoldberg
JoshuaKGoldberg previously approved these changes Nov 11, 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.

Awesome! 🔥

@armano2 armano2 changed the title docs: add basic preview for configs docs: add landing page for rules Nov 11, 2021
@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Nov 14, 2021
Closed
@armano2
Copy link
Collaborator Author

armano2 commented Nov 15, 2021 •
edited
Loading

We should add a "note" to the no-implicit-any-catch docs that mentions why it was deprecated. Something like this will do

This rule has been deprecated because TypeScript 4.4 introduced the useUnknownInCatchVariables compiler option which automatically types all catch variables as unknown - meaning a lint rule for manual unknown annotations is no longer necessary.

i agree with adding deprecation notice, but that change is unrelated to what this PR aims to do

i already did to much changes to rules docs in here (fixed JSON)

@armano2
docs(eslint-plugin): add links to packages
1e49dbb 
Co-authored-by: Josh Goldberg <joshuakgoldberg@outlook.com>
@armano2 armano2 requested a review from bradzacher November 15, 2021 01:08
@bradzacher bradzacher merged commit b0138a4 into master Nov 15, 2021
@bradzacher bradzacher deleted the docs/plugin-configs branch November 15, 2021 08:11
@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Nov 15, 2021
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bradzacher bradzacher bradzacher approved these changes

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg left review comments

Assignees
No one assigned
Labels
awaiting response Issues waiting for a reply from the OP or another party documentation Documentation ("docs") that needs adding/updating
Projects
No open projects
Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create a landing page for Rules
3 participants
@armano2 @JoshuaKGoldberg @bradzacher