Skip to content

docs(eslint-plugin): update link to deprecation rule in roadmap #1611

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

Merged
merged 2 commits into from
Feb 18, 2020

Conversation

gund
Copy link
Contributor

@gund gund commented Feb 17, 2020

This resolves #1223 and updates link to deprecation plugin rule.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @gund!

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.

@@ -112,7 +112,7 @@ It lists all TSLint rules along side rules from the ESLint ecosystem that are th
| TSLint rule | | ESLint rule |
| ---------------------------- | :-: | -------------------------------------------------- |
| [`cyclomatic-complexity`] | 🌟 | [`complexity`][complexity] |
| [`deprecation`] | 🌓 | [`import/no-deprecated`] <sup>[1]</sup> |
Copy link
Member

Choose a reason for hiding this comment

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

you need to add this link to the bottom section.

Copy link
Contributor Author

@gund gund Feb 17, 2020

Choose a reason for hiding this comment

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

But it does not apply anymore, since the rule applies not only to imports but to all deprecated references just like the original tslint rule...

Copy link
Member

Choose a reason for hiding this comment

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

You need to add the link to the bottom section so that this line renders as a link

image

Bottom section:
https://github.com/gund/typescript-eslint/blob/patch-1/packages/eslint-plugin/ROADMAP.md#L677-L688

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh I see, will update

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@bradzacher bradzacher changed the title [Docs] Update deprecation rule docs(eslint-plugin): update link to deprecation rule in roadmap Feb 17, 2020
@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Feb 17, 2020
@bradzacher bradzacher merged commit 7452e7d into typescript-eslint:master Feb 18, 2020
@gund gund deleted the patch-1 branch February 18, 2020 10:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 20, 2020
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.

[deprecation] Warns when deprecated APIs are used.
2 participants