kibana/STYLEGUIDE.md

# Kibana Style Guide

This guide applies to all development within the Kibana project and is
recommended for the development of all Kibana plugins.

- [JavaScript](style_guides/js_style_guide.md)
- [Angular](style_guides/angular_style_guide.md)
- [React](style_guides/react_style_guide.md)
- [SASS](https://elastic.github.io/eui/#/guidelines/sass)
- [HTML](style_guides/html_style_guide.md)
- [API](style_guides/api_style_guide.md)
- [Architecture](style_guides/architecture_style_guide.md)
- [Accessibility](style_guides/accessibility_guide.md)

## Filenames

All filenames should use `snake_case`.

*Right:*
  - `src/kibana/index_patterns/index_pattern.js`

*Wrong:*
  - `src/kibana/IndexPatterns/IndexPattern.js`

## TypeScript vs JavaScript

Whenever possible, write code in TypeScript instead of javascript, especially if it's new code.  Check out [TYPESCRIPT.md](TYPESCRIPT.md) for help with this process.
Current styleguide conventions with modern JS (#7435) The existing styleguide was in great need of a rewrite as it did not reflect the conventions we're using in the codebase or even the best practices that we follow. In some cases, the guidance it provided was outright contrary to our current practices. 2016-11-02 02:22:59 +01:00			`# Kibana Style Guide`

			`This guide applies to all development within the Kibana project and is`
			`recommended for the development of all Kibana plugins.`
added style guide, based on node style guide 2014-09-15 23:23:48 +02:00
Make links in STYLEGUIDE relative. 2016-06-10 04:03:19 +02:00			`- [JavaScript](style_guides/js_style_guide.md)`
Current styleguide conventions with modern JS (#7435) The existing styleguide was in great need of a rewrite as it did not reflect the conventions we're using in the codebase or even the best practices that we follow. In some cases, the guidance it provided was outright contrary to our current practices. 2016-11-02 02:22:59 +01:00			`- [Angular](style_guides/angular_style_guide.md)`
Moving React styleguide next to other style guides (#12361) * Moving React styleguide next to other style guides * Adding React style guide to style guides index file 2017-06-15 16:42:35 +02:00			`- [React](style_guides/react_style_guide.md)`
Point to EUI for SASS/CSS guidelines (#27415) 2018-12-18 20:39:38 +01:00			`- [SASS](https://elastic.github.io/eui/#/guidelines/sass)`
Make links in STYLEGUIDE relative. 2016-06-10 04:03:19 +02:00			`- [HTML](style_guides/html_style_guide.md)`
			`- [API](style_guides/api_style_guide.md)`
Fix architecture style guide link 2017-04-19 15:19:26 +02:00			`- [Architecture](style_guides/architecture_style_guide.md)`
Fix typo in accessibility styleguide link (#14718) 2017-11-02 12:28:22 +01:00			`- [Accessibility](style_guides/accessibility_guide.md)`
added style guide, based on node style guide 2014-09-15 23:23:48 +02:00
[styleguide] added api and filename sections 2015-11-23 20:00:32 +01:00			`## Filenames`
added section for module names/paths 2014-09-16 01:06:26 +02:00
Current styleguide conventions with modern JS (#7435) The existing styleguide was in great need of a rewrite as it did not reflect the conventions we're using in the codebase or even the best practices that we follow. In some cases, the guidance it provided was outright contrary to our current practices. 2016-11-02 02:22:59 +01:00			All filenames should use `snake_case`.
added section for module names/paths 2014-09-16 01:06:26 +02:00
			`Right:`
[styleguide] added api and filename sections 2015-11-23 20:00:32 +01:00			- `src/kibana/index_patterns/index_pattern.js`
added section for module names/paths 2014-09-16 01:06:26 +02:00
			`Wrong:`
[styleguide] added api and filename sections 2015-11-23 20:00:32 +01:00			- `src/kibana/IndexPatterns/IndexPattern.js`
Add a typescript readme (#23841) * Add a typescript readme * some clean up * Correct capitalization of typescript and javascript * Incorporate review suggestions 2018-10-17 14:10:48 +02:00
			`## TypeScript vs JavaScript`

			`Whenever possible, write code in TypeScript instead of javascript, especially if it's new code. Check out [TYPESCRIPT.md](TYPESCRIPT.md) for help with this process.`