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

Docathon: review of the JavaScript section #1420

Closed
egamma opened this issue Feb 19, 2018 · 2 comments
Closed

Docathon: review of the JavaScript section #1420

egamma opened this issue Feb 19, 2018 · 2 comments
Assignees
Milestone

Comments

@egamma
Copy link
Member

egamma commented Feb 19, 2018

Doc review #1396

The document links to a description of the JavaScript language service:

image

This is a great document, but the issue is that this document includes VS specific information (e.g. https://github.com/Microsoft/TypeScript/wiki/JavaScript-Language-Service-in-Visual-Studio#whats-new-in-the-javascript-language-service-in-visual-studio-2017), which is confusing for a reader coming from VS Code. The best would be that the JavaScript language service document is refactored so that it is IDE neutral or includes both information on VS and VS Code.


VS Code provides support for entering JSDoc comments and this should be mentioned in the doc. I suggest a separate section on entering JSDoc comments. Explain that entering /** fills in a template (best shown in an animated gif)

This was in the release notes and could be promoted
https://code.visualstudio.com/updates/v1_10#_auto-jsdoc-comments


https://code.visualstudio.com/docs/languages/javascript#_javascript-project-jsconfigjson

It should be mentioned that you can have mixed JS/TS projects, which is useful when migrating from JS to TS. In this case you enable JS in TS project by adding the settings allowJS to true. More details here https://www.typescriptlang.org/docs/handbook/migrating-from-javascript.html


The debug section feels out of place it comes in between language service features like jsconfig.con/type checking). I suggest to move it to the end.


Doc review #1396

There should be a section on refactoring and it should explain that the refactorings are available in the light bulb when you make a selection

image


The most popular JS linter is eslint, but it isn´t shown in the list?

image


@gregvanl
Copy link

aea39f2
Switch to curated JavaScript Linter extension list
Move Debug section down
Add JSDoc support section

@gregvanl
Copy link

In contact with the TypeScript team about making their JavaScript Language Service wiki page more IDE/editor agnostic.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants