Commit 22f1339d authored by Filipa Lacerda's avatar Filipa Lacerda

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

Make naming imports more clear

Closes #38795

See merge request gitlab-org/gitlab-ce!14761
parents 43b692cb 30e02628
...@@ -88,16 +88,31 @@ followed by any global declarations, then a blank newline prior to any imports o ...@@ -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 1. Use ES module syntax to import modules
```javascript ```javascript
// bad // bad
require('foo'); const SomeClass = require('some_class');
// good // good
import Foo from 'foo'; import SomeClass from 'some_class';
// bad // bad
module.exports = Foo; module.exports = SomeClass;
// good // 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 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. ...@@ -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. **Extensions**: Use `.vue` extension for Vue components.
1. **Reference Naming**: Use camelCase for their instances: 1. **Reference Naming**: Use camelCase for their instances:
```javascript ```javascript
// bad
import CardBoard from 'cardBoard'
components: {
CardBoard:
};
// good // good
import cardBoard from 'cardBoard' import cardBoard from 'cardBoard'
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment