bfg-common 1.5.17 → 1.5.19

package/CODE_STYLE.md

@@ -0,0 +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
+}
+``` 

package/PROJECT_STRUCTURE.md

@@ -26,8 +26,35 @@
 
 ---
 
-## models
-Папка в которой хронятся interfaces, types и enums глобальные и к примеру те которые нельзя создавать в plugins и т.п.
+## lib
+Папка содержит глобальные утилиты, конфигурации и модели:
+
+### config
+В папке config хранятся файлы типа *.ts, в них находятся конфигурации.
+Название переменных в конфигурации заканчивается на Func, если это функция.
+```typescript
+const exempleFunc = (localization: UI_I_localization): I_Exemple => {...}
+
+const steps = [0, 1, 2, 3]
+```
+
+### models
+Содержит interfaces, types и enums, глобальные и те, которые нельзя создавать в pages, store, plugins и т.п.
+
+### utils
+Содержит вспомогательные утилиты и функции общего назначения
+
+Структура папки lib:
+```
+lib
+ |-config
+ |  |-someConfig.ts
+ |-models
+ |  |-interfaces.ts
+ |  |-types.ts
+ |  |-enums.ts
+ |-utils.ts
+```
 
 ---
 
@@ -40,3 +67,64 @@
 Можно ознакомится по документации nuxt 3
 
 ---
+
+## store (Vuex)
+Стор у нас модульный, модули создаются как минимум по роутингу.
+
+Основная структура такая:
+
+```
+lib
+ |-config
+ |  |-someConfig.ts
+ |-models
+ |  |-interfaces.ts
+ |  |-types.ts
+ |  |-enums.ts
+ |-utils.ts
+mappers
+ |-someMapper.ts
+actions.ts
+getters.ts
+mutations.ts
+state.ts
+store.ts
+```
+
+#### lib
+В папке lib находятся:
+- config - конфигурации store
+- models - интерфейсы и типы для store
+- utils.ts - вспомогательные функции
+
+#### mappers
+В папке mappers хранятся файлы .ts формата, в которых есть функции (мапперы), обрабатывающие ответ от бэка так, чтобы было удобно использовать на фронте.
+
+Мапперы вызываются только из файла actions.ts и после обработки через mutations.ts попадают в state.
+
+#### actions.ts
+В этом файле в основном делаются запросы на бэк и обработка данных.
+
+#### getters.ts
+В этом файле есть методы, которые возвращают данные из state.
+
+#### mutations.ts
+В этом файле изменяем/обновляем данные из state.
+
+#### state.ts
+В этом файле хранятся переменные.
+
+#### store.ts
+В этом файле все собирается воедино.
+
+---
+
+## Название папок/файлов
+
+Название всех папок пишем в camelCase.
+
+Название всех файлов кроме *.vue(компонент) пишем camelCase
+
+Название всех файлов в pages *.vue (компонент) пишем в kebab-case.
+
+Название всех файлов вне pages *.vue (компонент) пишем в PascalCase.

package/assets/localization/local_be.json

@@ -2327,7 +2327,8 @@
     "inDevelopment": "У распрацоўцы",
     "showAll": "Паказаць усе",
     "hideAll": "Схаваць усе",
-    "move": "Пасунуць"
+    "move": "Пасунуць",
+    "objectCantBeMovedIntoItself": "Аб'ект не можа быць перамешчаны сам па сабе. Калі ласка, абярыце падыходнае месцазнаходжанне."
   },
   "auth": {
     "welcomeTo": "Сардэчна запрашаем у",

package/assets/localization/local_en.json

@@ -2331,7 +2331,8 @@
     "inDevelopment": "In development",
     "showAll": "Show All",
     "hideAll": "Hide All",
-    "move": "Move"
+    "move": "Move",
+    "objectCantBeMovedIntoItself": "The object can’t be moved into itself. Please select a valid location."
   },
   "auth": {
     "welcomeTo": "Welcome to",

package/assets/localization/local_hy.json

@@ -2331,7 +2331,8 @@
     "inDevelopment": "Մշակման մեջ",
     "showAll": "Ցույց տալ բոլորը",
     "hideAll": "Թաքցնել բոլորը",
-    "move": "Տեղափոխել"
+    "move": "Տեղափոխել",
+    "objectCantBeMovedIntoItself": "Օբյեկտը չի կարող ինքնուրույն տեղափոխվել: Խնդրում ենք ընտրել համապատասխան վայրը:"
   },
   "auth": {
     "welcomeTo": "Բարի գալուստ",

package/assets/localization/local_kk.json

@@ -2330,7 +2330,8 @@
     "inDevelopment": "Даму",
     "showAll": "Барлығын Көрсету",
     "hideAll": "Барлығын Жасыру",
-    "move": "Жылжыту"
+    "move": "Жылжыту",
+    "objectCantBeMovedIntoItself": "Объектіні өзіне жылжыту мүмкін емес. Жарамды орынды таңдаңыз."
   },
   "auth": {
     "welcomeTo": "Қош келдіңіз",

package/assets/localization/local_ru.json

@@ -2332,7 +2332,8 @@
     "inDevelopment": "В разработке",
     "showAll": "Показать все",
     "hideAll": "Скрыть все",
-    "move": "Подвинут"
+    "move": "Подвинут",
+    "objectCantBeMovedIntoItself": "Объект не может быть перемещен сам по себе. Пожалуйста, выберите подходящее местоположение."
   },
   "auth": {
     "welcomeTo": "Добро пожаловать в",

package/assets/localization/local_zh.json

@@ -2328,7 +2328,8 @@
     "inDevelopment": "在开发中",
     "showAll": "全部展示",
     "hideAll": "全部隐藏",
-    "move": "移动"
+    "move": "移动",
+    "objectCantBeMovedIntoItself": "对象不能移动到自己。 请选择一个有效的位置."
   },
   "auth": {
     "welcomeTo": "欢迎来到",

package/components/common/layout/theHeader/TheHeaderOld.vue

@@ -67,7 +67,7 @@
           :new-view-local="props.newViewLocal"
           :project="props.project"
           :remote-console="props.remoteConsole"
-          :vm-cluster="props.vmClusters"
+          :vm-cluster="props.vmCluster"
           @show-preference="emits('show-preference')"
           @hide-preference="emits('hide-preference')"
           @change-theme-mode="emits('change-theme-mode')"

package/composables/useLocalStorage.ts

@@ -1,4 +1,4 @@
-const lastTimestamp = 1740651960445
+const lastTimestamp = 1744866033269
 
 export const useLocalStorage = (
   name: string,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bfg-common",
   "private": false,
-  "version": "1.5.17",
+  "version": "1.5.19",
   "scripts": {
     "build": "nuxt build",
     "dev": "nuxt dev --port=3002",
@@ -35,7 +35,7 @@
     "@vueuse/components": "^10.1.2",
     "date-fns": "^2.29.3",
     "bfg-nuxt-3-graph": "1.0.21",
-    "bfg-uikit": "1.0.375",
+    "bfg-uikit": "1.0.377",
     "html2canvas": "^1.4.1",
     "prettier-eslint": "^15.0.1"
   }