maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

update CONTRIBUTING.md re: linting with VSCode (#37005)

Browse source 
Adds a note in the Linting section about updating VSCode settings to
see "live" linting for TypeScript.
This commit is contained in:
Patrick Mueller 2019-05-24 15:23:38 -04:00 committed by GitHub
parent 67dc8a45aa
commit 1ec734f715
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -279,6 +279,17 @@ IntelliJ | Settings » Languages & Frameworks » JavaScript » Code Quality To
Another tool we use for enforcing consistent coding style is EditorConfig, which can be set up by installing a plugin in your editor that dynamically updates its configuration. Take a look at the [EditorConfig](http://editorconfig.org/#download) site to find a plugin for your editor, and browse our [`.editorconfig`](https://github.com/elastic/kibana/blob/master/.editorconfig) file to see what config rules we set up.
Note that for VSCode, to enable "live" linting of TypeScript (and other) file types, you will need to modify your local settings, as shown below. The default for the ESLint extension is to only lint JavaScript file types.
```json
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
]
```
### Internationalization
All user-facing labels and info texts in Kibana should be internationalized. Please take a look at the [readme](packages/kbn-i18n/README.md) and the [guideline](packages/kbn-i18n/GUIDELINE.md) of the i18n package on how to do so.