Skip to content
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

[documentation] config eslint to check typescript code #8388

Closed
aladdin-add opened this issue Apr 2, 2017 · 8 comments
Closed

[documentation] config eslint to check typescript code #8388

aladdin-add opened this issue Apr 2, 2017 · 8 comments
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion question This issue asks a question about ESLint

Comments

@aladdin-add
Copy link
Member

No description provided.

@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label Apr 2, 2017
@not-an-aardvark not-an-aardvark added documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Apr 2, 2017
@not-an-aardvark
Copy link
Member

Based on the description you've given, it's hard to tell what you're suggesting. However, feel free to make a pull request with suggested changes.

@aladdin-add
Copy link
Member Author

How to config eslint to check typescript code? I didn't see any guide about it, Can we add it?

@aladdin-add aladdin-add changed the title [documentation] add Configuring ESLint about typescript. [documentation] config eslint to check typescript code Apr 3, 2017
@not-an-aardvark not-an-aardvark added question This issue asks a question about ESLint and removed documentation Relates to ESLint's documentation labels Apr 3, 2017
@not-an-aardvark
Copy link
Member

Thanks for clarifying. I would recommend taking a look at typescript-eslint-parser.

@aladdin-add
Copy link
Member Author

Thanks for your patience. Many developers may not be aware of this. we can add it to eslint docs. you recon?

@platinumazure
Copy link
Member

@aladdin-add The typescript-eslint-parser is still experimental at this point, so I would rather defer to the developers there with regard to whether we should add an FAQ or documentation entry at this point.

@JamesHenry @soda0289 Any thoughts on this?

cc @nzakas

@soda0289
Copy link
Member

soda0289 commented Apr 3, 2017

I'm concerned about adding the typescript parser to the docs since there are several known issues. This includes recommended rules not working as expected and some plugins causing infinite loops. The more users the parser has the faster bugs can be found and fixed. If we did add it we would have to place a note warning of it's experimental/alpha state. As well we should keep a list of known issues on the typescript parser README to warn users of potential issues.

@ilyavolodin
Copy link
Member

While typescript-eslint-parser is part of ESLint org, it's a stand-alone project, and I'm not sure it should be advertised in ESLint documentation. By default ESLint works only with stage 4+ features of EcmaScript. Everything else is customization. We can definitely add a link to the site to typescript parser, just like we have a link to babel-eslint, but creating documentation for it on the site is probably an overkill.

@not-an-aardvark
Copy link
Member

Closing because this question has been answered.

ilyavolodin pushed a commit that referenced this issue May 5, 2017
* docs: add typescript-eslint-parser

* Update configuring.md
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion question This issue asks a question about ESLint
Projects
None yet
Development

No branches or pull requests

6 participants