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.

Sign up for GitHub

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

Jump to bottom

Adding "setting up prettier" in CONTRIBUTING.md #46310

Merged
merged 8 commits into from
Oct 14, 2019
Merged

Adding "setting up prettier" in CONTRIBUTING.md #46310

Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4ffbfad
Added prettier documentation.
sainthkh Sep 21, 2019
c656469
Removed prettier parts.
sainthkh Sep 23, 2019
022f8ac
Fixed for better grammar.
sainthkh Sep 23, 2019
09a18ec
Merge branch 'master' into doc-prettier
elasticmachine Sep 23, 2019
00572b7
Added prettier plugin warning.
sainthkh Sep 24, 2019
b3a74ab
Merge branch 'master' into doc-prettier
elasticmachine Sep 26, 2019
ffc0280
Merge branch 'master' into doc-prettier
elasticmachine Sep 26, 2019
b9db950
Merge branch 'master' into doc-prettier
elasticmachine Oct 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,8 @@ 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.

#### Setup Guide for VS Code Users

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
Expand All @@ -317,6 +319,14 @@ Note that for VSCode, to enable "live" linting of TypeScript (and other) file ty
]
```

`eslint` can automatically fix trivial lint errors when you save a file by adding this line in your setting.

```json
"eslint.autoFixOnSave": true,
```

It is **not** recommended to use `prettier` plugin on Kibana project. Because settings are in `eslintrc.js` file and it is applied to too many files that shouldn't be prettier-ized.

### 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.
Expand Down