Skip to content
This repository has been archived by the owner on Jul 15, 2023. It is now read-only.

Use the same processes to generate documentation as TSLint core #575

Closed
JoshuaKGoldberg opened this issue Oct 23, 2018 · 2 comments
Closed
Assignees
Labels
Difficulty: Hard Only someone with heavy experience in TSLint should be able to send a pull request for this issue. Domain: Documentation Rules or repository tasks related to how to document code. Domain: Tooling Repository tasks around improving source tooling. 💀 R.I.P. 💀

Comments

@JoshuaKGoldberg
Copy link

JoshuaKGoldberg commented Oct 23, 2018

Following #573, it's a bit annoying manually crafting a README.md table. If TSLint itself makes the processes it uses to build docs extensible such that we could use it, that'd make it much easier for general community folks to have custom rulesets with good documentation.

As part of this, we should move the detailed explanations from the wiki into rule metadata and samples.

@JoshuaKGoldberg JoshuaKGoldberg added Difficulty: Hard Only someone with heavy experience in TSLint should be able to send a pull request for this issue. Domain: Tooling Repository tasks around improving source tooling. labels Oct 23, 2018
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Oct 23, 2018
@JoshuaKGoldberg JoshuaKGoldberg added the Domain: Documentation Rules or repository tasks related to how to document code. label Nov 6, 2018
@JoshuaKGoldberg
Copy link
Author

JoshuaKGoldberg commented Nov 26, 2018

Huh, Codelyzer does this: http://codelyzer.com/rules/

...and has a snazzy playground. Nice.

@JoshuaKGoldberg
Copy link
Author

💀 It's time! 💀

TSLint is being deprecated; therefore, it and tslint-microsoft-contrib are no longer accepting pull requests for major new changes or features. See palantir/tslint#4534. 😱

If you'd like to see this change implemented, you have two choices:

  • Recommended: Check if this is available in ESLint + typescript-eslint
  • Not Recommended: Fork TSLint or tslint-microsoft-contrib locally 🤷‍♂️

👋 It was a pleasure open sourcing with you!

If you believe this message was posted here in error, please comment so we can re-open the issue!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Difficulty: Hard Only someone with heavy experience in TSLint should be able to send a pull request for this issue. Domain: Documentation Rules or repository tasks related to how to document code. Domain: Tooling Repository tasks around improving source tooling. 💀 R.I.P. 💀
Projects
None yet
Development

No branches or pull requests

1 participant