bfg-common 1.5.39 → 1.5.40

package/CODE_STYLE.md

@@ -1,109 +1,109 @@
-![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)
-## Javascript
-
-### Название переменных
-
-Используем camelCase:
-```javascript
-const theExample = 0
-```
-
-Название переменных должно быть содержательным:
-```javascript
-const desc = 'some description' // Плохо
-
-const description = 'some description' // Хорошо
-```
-
-Если переменная типа boolean, используем префиксы is или has:
-```javascript
-const isDisabled = true
-
-const hasName = false
-```
-
-Приоритетно используем стрелочные функции:
-```javascript
-const example = () => {...}
-```
-
----
-
-![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
-## Typescript
-
-### Interface
-Название интерфейсов начинаем с префикса **I_** (также есть **API_**, **UI_**, подробно об этом написано в файле PROJECT_STRUCTURE.md):
-```typescript
-interface I_Example
-```
-
-### Type
-Название типов начинаем с префикса **T_**:
-```typescript
-type T_Example
-```
-
-### Enum
-Название enum начинаем с префикса **E_**:
-```typescript
-enum E_Example
-```
-
-P.S. Нужно писать как можно более понятные типы.
-
----
-
-![Vue.js](https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vue.js&logoColor=4FC08D)
-## Vue
-
-### Название тегов
-Используем kebab-case:
-```html
-<the-button>Button</the-button>
-```
-
-### Название тега
-Название тега не должно состоять из одного слова:
-```html
-<example></example> // Плохо
-
-<the-example></the-example> // Хорошо
-```
-
-### Использование "the" в названии тега 
-Если название тега, к примеру, icon, должно быть так:
-```html
-<the-icon></the-icon>
-```
-
-### Использование самозакрывающихся тегов
-Если в тег ничего не передаем, то используем его как самозакрывающийся:
-```html
-<the-icon/>
-```
-
-### Props / Emits
-Props пишем в kebab-case:
-```html
-<the-example my-name="Name"/>
-```
-
-Emits пишем в kebab-case, ключ первого аргумента всегда "event", а второго - "value":
-```javascript
-const emits = defineEmits<{
-  (event: 'change-name', value: string): void
-}>()
-``` 
-
-### Composition API
-Так как у нас используется Composition API, нужно весь код группировать по блокам:
-```javascript
-const isShowModal = ref<boolean>(false)
-const toggleModal = (): void => isShowModal.value = !isShowModal.value
-
-const errors = ref<string[]>([])
-const updateErrors = (newErrors: string[]): void => {
-    errors.value = newErrors
-}
-``` 
+![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)
+## Javascript
+
+### Название переменных
+
+Используем camelCase:
+```javascript
+const theExample = 0
+```
+
+Название переменных должно быть содержательным:
+```javascript
+const desc = 'some description' // Плохо
+
+const description = 'some description' // Хорошо
+```
+
+Если переменная типа boolean, используем префиксы is или has:
+```javascript
+const isDisabled = true
+
+const hasName = false
+```
+
+Приоритетно используем стрелочные функции:
+```javascript
+const example = () => {...}
+```
+
+---
+
+![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+## Typescript
+
+### Interface
+Название интерфейсов начинаем с префикса **I_** (также есть **API_**, **UI_**, подробно об этом написано в файле PROJECT_STRUCTURE.md):
+```typescript
+interface I_Example
+```
+
+### Type
+Название типов начинаем с префикса **T_**:
+```typescript
+type T_Example
+```
+
+### Enum
+Название enum начинаем с префикса **E_**:
+```typescript
+enum E_Example
+```
+
+P.S. Нужно писать как можно более понятные типы.
+
+---
+
+![Vue.js](https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vue.js&logoColor=4FC08D)
+## Vue
+
+### Название тегов
+Используем kebab-case:
+```html
+<the-button>Button</the-button>
+```
+
+### Название тега
+Название тега не должно состоять из одного слова:
+```html
+<example></example> // Плохо
+
+<the-example></the-example> // Хорошо
+```
+
+### Использование "the" в названии тега 
+Если название тега, к примеру, icon, должно быть так:
+```html
+<the-icon></the-icon>
+```
+
+### Использование самозакрывающихся тегов
+Если в тег ничего не передаем, то используем его как самозакрывающийся:
+```html
+<the-icon/>
+```
+
+### Props / Emits
+Props пишем в kebab-case:
+```html
+<the-example my-name="Name"/>
+```
+
+Emits пишем в kebab-case, ключ первого аргумента всегда "event", а второго - "value":
+```javascript
+const emits = defineEmits<{
+  (event: 'change-name', value: string): void
+}>()
+``` 
+
+### Composition API
+Так как у нас используется Composition API, нужно весь код группировать по блокам:
+```javascript
+const isShowModal = ref<boolean>(false)
+const toggleModal = (): void => isShowModal.value = !isShowModal.value
+
+const errors = ref<string[]>([])
+const updateErrors = (newErrors: string[]): void => {
+    errors.value = newErrors
+}
+```