# Style Guide

The style guide for this project is mainly based on the official style guide . It is recommended to read the guide before you start using the project, which will help you write more standardized and unified code. Most of these rules are also configured in eslint-plugin-vue. When the rules are not followed, will throw an error. For details, see eslint section.

Of course, there are some special specifications that cannot be verified by eslint. You need to pay attention to yourself and follow. The most important thing is the naming rules for files. Take the example of vue-element-admin here.

# Component

All Component files start with uppercase (PascalCase), which is also official recommended。

But except for index.vue.

Example:

• @/src/components/BackToTop/index.vue
• @/src/components/Charts/Line.vue
• @/src/views/example/components/Button.vue

# JS files

All .js files follow kebab-case.

Example:

• @/src/utils/open-window.js
• @/src/views/svg-icons/require-icons.js
• @/src/components/MarkdownEditor/default-options.js

# Views

Under the views file, the .vue files representing the routes path all use kebab-case, and the same rules are used for folders.

Example:

• @/src/views/svg-icons/index.vue
• @/src/views/svg-icons/require-icons.js

The use of a kebab-case to name views is mainly due to the following considerations.

• kebab-case is also one of the officially recommended naming conventions Document
• The .vue file under views represents a route, so it needs to be distinguished from component (components are PascalCase)
• The url of the page is follow kebab-case , such as https://www.xxx.admin/export-excel. So the view corresponding to the route should be kept uniform.
• No case sensitive issues