summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhil Hughes <me@iamphill.com>2018-02-09 10:29:54 +0000
committerPhil Hughes <me@iamphill.com>2018-02-09 10:29:54 +0000
commitd997fe135be7ec0be4aea974c556902303cf8bed (patch)
tree4373eed5ae143351f26ba0c34af80ca4d9343ac5
parent7534f7a892d6e8c50475720e387b8689c94582da (diff)
parent469148b23184a1dd2d5ce6ceedcce48c2b02a7d1 (diff)
downloadgitlab-ce-d997fe135be7ec0be4aea974c556902303cf8bed.tar.gz
Merge branch 'docs/update-vue-naming-guidelines' into 'master'
Update vue component naming guidelines See merge request gitlab-org/gitlab-ce!17018
-rw-r--r--changelogs/unreleased/docs-update-vue-naming-guidelines.yml5
-rw-r--r--doc/development/fe_guide/style_guide_js.md10
2 files changed, 10 insertions, 5 deletions
diff --git a/changelogs/unreleased/docs-update-vue-naming-guidelines.yml b/changelogs/unreleased/docs-update-vue-naming-guidelines.yml
new file mode 100644
index 00000000000..95bfd212370
--- /dev/null
+++ b/changelogs/unreleased/docs-update-vue-naming-guidelines.yml
@@ -0,0 +1,5 @@
+---
+title: Update vue component naming guidelines
+merge_request: 17018
+author: George Tsiolis
+type: other
diff --git a/doc/development/fe_guide/style_guide_js.md b/doc/development/fe_guide/style_guide_js.md
index 02773162801..cd26baa4243 100644
--- a/doc/development/fe_guide/style_guide_js.md
+++ b/doc/development/fe_guide/style_guide_js.md
@@ -302,20 +302,20 @@ Please check this [rules][eslint-plugin-vue-rules] for more documentation.
#### Naming
1. **Extensions**: Use `.vue` extension for Vue components.
-1. **Reference Naming**: Use camelCase for their instances:
+1. **Reference Naming**: Use PascalCase for their instances:
```javascript
// bad
- import CardBoard from 'cardBoard'
+ import cardBoard from 'cardBoard.vue'
components: {
- CardBoard:
+ cardBoard,
};
// good
- import cardBoard from 'cardBoard'
+ import CardBoard from 'cardBoard.vue'
components: {
- cardBoard:
+ CardBoard,
};
```