Merge branch 'winh-clarify-naming-imports-docs' into 'master'

Make naming imports more clear

Closes #38795

See merge request gitlab-org/gitlab-ce!14761
This commit is contained in:
Filipa Lacerda 2017-10-10 09:05:55 +00:00
commit 22f1339d47
1 changed files with 26 additions and 4 deletions

View File

@ -88,16 +88,31 @@ followed by any global declarations, then a blank newline prior to any imports o
1. Use ES module syntax to import modules
```javascript
// bad
require('foo');
const SomeClass = require('some_class');
// good
import Foo from 'foo';
import SomeClass from 'some_class';
// bad
module.exports = Foo;
module.exports = SomeClass;
// good
export default Foo;
export default SomeClass;
```
Import statements are following usual naming guidelines, for example object literals use camel case:
```javascript
// some_object file
export default {
key: 'value',
};
// bad
import ObjectLiteral from 'some_object';
// good
import objectLiteral from 'some_object';
```
1. Relative paths: when importing a module in the same directory, a child
@ -285,6 +300,13 @@ A forEach will cause side effects, it will be mutating the array being iterated.
1. **Extensions**: Use `.vue` extension for Vue components.
1. **Reference Naming**: Use camelCase for their instances:
```javascript
// bad
import CardBoard from 'cardBoard'
components: {
CardBoard:
};
// good
import cardBoard from 'cardBoard'