From bd35b0c212798e86c7d0093784254498a4612430 Mon Sep 17 00:00:00 2001 From: Eugene Serb <46799701+eugene-serb@users.noreply.github.com> Date: Mon, 17 Jun 2024 18:25:45 +0300 Subject: [PATCH 01/17] #119 delete all @description --- src/components/molecules/MDiagnosticPanel.vue | 2 +- src/components/organisms/OManual.vue | 2 +- src/models/Vibrator.ts | 2 +- src/store/useGamepadsStore.ts | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/components/molecules/MDiagnosticPanel.vue b/src/components/molecules/MDiagnosticPanel.vue index 3d2fe42..8cca957 100644 --- a/src/components/molecules/MDiagnosticPanel.vue +++ b/src/components/molecules/MDiagnosticPanel.vue @@ -21,7 +21,7 @@ const props = defineProps({ /** * Временная метка. * - * @description Нужна для обновления состояния геймпадов и компонента, + * Нужна для обновления состояния геймпадов и компонента, * т.к. сами они это не делают. */ timestamp: { diff --git a/src/components/organisms/OManual.vue b/src/components/organisms/OManual.vue index b98a653..66fa2fd 100644 --- a/src/components/organisms/OManual.vue +++ b/src/components/organisms/OManual.vue @@ -79,7 +79,7 @@ function stop(): void { /** * Запустить или остановить вибрацию. * - * @description Останавливает вибрацию, если нет блокировки интенсивности, + * Останавливает вибрацию, если нет блокировки интенсивности, * иначе продолжает вибрировать до следующей проверки. */ function handle(): void { diff --git a/src/models/Vibrator.ts b/src/models/Vibrator.ts index 8fcbf1e..4c124d0 100644 --- a/src/models/Vibrator.ts +++ b/src/models/Vibrator.ts @@ -123,7 +123,7 @@ export interface IVibrator { /** * Отрицательный временной сдвиг между запуском шаблонов. * - * @description Чтобы при воспроизведении дорожки вибрации не было + * Чтобы при воспроизведении дорожки вибрации не было * затухания перед выполнением новой вибрации, нужно из суммарной * продолжительности выполнения шаблона вибрации вычесть * немного времени, которое задаётся в этой константе. diff --git a/src/store/useGamepadsStore.ts b/src/store/useGamepadsStore.ts index a616d14..e685997 100644 --- a/src/store/useGamepadsStore.ts +++ b/src/store/useGamepadsStore.ts @@ -22,7 +22,7 @@ export const useGamepadsStore = defineStore('gamepads', () => { /** * Временная метка. * - * @description Нужна для обновления состояния геймпадов, т.к. сами они это не делают. + * Нужна для обновления состояния геймпадов, т.к. сами они это не делают. */ const timestamp = ref(0); @@ -36,7 +36,7 @@ export const useGamepadsStore = defineStore('gamepads', () => { /** * Геймпады. * - * @description Просто массив с геймпадами. Нужен для того, + * Просто массив с геймпадами. Нужен для того, * чтобы на его основе получить обновлённый список геймпадов. * @see gamepads * @private @@ -158,7 +158,7 @@ export const useGamepadsStore = defineStore('gamepads', () => { /** * Запустить работу приложения. * - * @description Запускает слушатели событий для добавления и удаления геймпадов, + * Запускает слушатели событий для добавления и удаления геймпадов, * а также, их обновления. */ function initialize(): void { @@ -169,7 +169,7 @@ export const useGamepadsStore = defineStore('gamepads', () => { /** * Завершить работу приложения. * - * @description Удаляет слушатели событий для добавления и удаления геймпадов, + * Удаляет слушатели событий для добавления и удаления геймпадов, * а также, их обновления. */ function terminate(): void { From 44f42ed32f50ed17524c37af2620bda27aec9e5c Mon Sep 17 00:00:00 2001 From: Eugene Serb <46799701+eugene-serb@users.noreply.github.com> Date: Mon, 17 Jun 2024 18:44:13 +0300 Subject: [PATCH 02/17] #119 update @returns --- src/composables/useMobileVibration.ts | 2 +- src/models/Vibrator.ts | 18 ------------------ src/storage/core/types.ts | 2 +- src/storage/models/announcements.ts | 4 ++-- src/utils/async.ts | 2 +- 5 files changed, 5 insertions(+), 23 deletions(-) diff --git a/src/composables/useMobileVibration.ts b/src/composables/useMobileVibration.ts index b6995ec..a36464e 100644 --- a/src/composables/useMobileVibration.ts +++ b/src/composables/useMobileVibration.ts @@ -14,7 +14,7 @@ type MobileVibrationComposable = { /** * Композабл для управления вибрацией телефона. * - * @returns MobileVibrationComposable + * @returns MobileVibrationComposable. */ export function useMobileVibration(): MobileVibrationComposable { /** diff --git a/src/models/Vibrator.ts b/src/models/Vibrator.ts index 4c124d0..4ec2424 100644 --- a/src/models/Vibrator.ts +++ b/src/models/Vibrator.ts @@ -31,8 +31,6 @@ export type TVibrator = { /** * Обновить информацию об устройстве. - * - * @returns */ update(): void; @@ -40,7 +38,6 @@ export type TVibrator = { * Воспроизвести и повторять дорожку вибрации. * * @param track - Дорожка вибрации. - * @returns */ loop(track: GamepadEffectParameters[]): Promise; @@ -48,14 +45,11 @@ export type TVibrator = { * Воспроизвести вибрацию. * * @param params - Шаблон вибрации - * @returns */ vibrate(params: GamepadEffectParameters): void; /** * Отключить вибрацию устройства. - * - * @returns */ reset(): void; }; @@ -91,8 +85,6 @@ export interface IVibrator { /** * Обновить информацию об устройстве. - * - * @returns */ update(): void; @@ -100,7 +92,6 @@ export interface IVibrator { * Воспроизвести и повторять дорожку вибрации. * * @param track - Дорожка вибрации. - * @returns */ loop(track: GamepadEffectParameters[]): Promise; @@ -108,14 +99,11 @@ export interface IVibrator { * Воспроизвести вибрацию. * * @param params - Шаблон вибрации - * @returns */ vibrate(params: GamepadEffectParameters): void; /** * Отключить вибрацию устройства. - * - * @returns */ reset(): void; } @@ -162,8 +150,6 @@ export class Vibrator implements IVibrator { /** * Обновить информацию об устройстве. - * - * @returns */ update(): void { const gamepads = navigator.getGamepads(); @@ -182,7 +168,6 @@ export class Vibrator implements IVibrator { * Воспроизвести и повторять вибрацию на устройстве по последовательности шаблонов. * * @param track - Последовательность шаблонов параметров вибрации. - * @returns */ async loop(track: GamepadEffectParameters[]): Promise { this.isVibrating = true; @@ -207,7 +192,6 @@ export class Vibrator implements IVibrator { * Воспроизвести вибрацию на устройстве по шаблону. * * @param params - Шаблон параметров вибрации. - * @returns */ vibrate(params: GamepadEffectParameters): void { if (!this.device.vibrationActuator) { @@ -219,8 +203,6 @@ export class Vibrator implements IVibrator { /** * Отключить вибрацию устройства. - * - * @returns */ reset(): void { this.isVibrating = false; diff --git a/src/storage/core/types.ts b/src/storage/core/types.ts index dee91ac..8983ee8 100644 --- a/src/storage/core/types.ts +++ b/src/storage/core/types.ts @@ -12,7 +12,7 @@ export interface CommonStorageModel { * Сериализатор данных. * * @param data - Данные. - * @returns DTO + * @returns DTO. */ serializer: (data: T) => string; /** diff --git a/src/storage/models/announcements.ts b/src/storage/models/announcements.ts index 8e56df8..36b3a6d 100644 --- a/src/storage/models/announcements.ts +++ b/src/storage/models/announcements.ts @@ -4,7 +4,7 @@ import type { AnnouncementSavedData } from '@/models'; /** * Модель данных хранилища Announcements. * - * @returns + * @returns Модель хранилища данных. */ export function announcementStorage(): CommonStorageModel { return { @@ -16,7 +16,7 @@ export function announcementStorage(): CommonStorageModel { return new Promise((resolve) => setTimeout(resolve, ms)); From 04f27e1f0c320e5faca9c46fac942940f9129777 Mon Sep 17 00:00:00 2001 From: Eugene Serb <46799701+eugene-serb@users.noreply.github.com> Date: Mon, 17 Jun 2024 19:02:06 +0300 Subject: [PATCH 03/17] #119 update @template --- src/storage/core/types.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/storage/core/types.ts b/src/storage/core/types.ts index 8983ee8..bffa2c7 100644 --- a/src/storage/core/types.ts +++ b/src/storage/core/types.ts @@ -55,6 +55,7 @@ export interface Fetcher { /** * Извлечь данные. * + * @template T - Модель данных. * @param store - Модель данных хранилища. * @returns Данные. */ @@ -62,6 +63,7 @@ export interface Fetcher { /** * Записать данные. * + * @template T - Модель данных. * @param data - Данные. * @param store - Модель данных хранилища. */ @@ -69,6 +71,7 @@ export interface Fetcher { /** * Удалить данные. * + * @template T - Модель данных. * @param store - Модель данных хранилища. */ remove: (store: CommonStorageModel) => void; From cdf897a6ff32d646b303437304f957db61902015 Mon Sep 17 00:00:00 2001 From: Eugene Serb <46799701+eugene-serb@users.noreply.github.com> Date: Mon, 17 Jun 2024 19:02:36 +0300 Subject: [PATCH 04/17] #119 update @constant --- src/constants/contacts.ts | 6 ++++++ src/constants/urls.ts | 18 ++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/src/constants/contacts.ts b/src/constants/contacts.ts index 0a1d22e..9317515 100644 --- a/src/constants/contacts.ts +++ b/src/constants/contacts.ts @@ -1,5 +1,7 @@ /** * Публичный Email для связи. + * + * @constant */ export const PUBLIC_EMAIL = { text: 'eugene.serb@gmail.com', @@ -8,6 +10,8 @@ export const PUBLIC_EMAIL = { /** * Ссылка на персональную страницу. + * + * @constant */ export const PERSONAL_PAGE = { text: 'eugene-serb.github.io', @@ -16,6 +20,8 @@ export const PERSONAL_PAGE = { /** * Ссылка на Bitcoin кошелёк. + * + * @constant */ export const BITCOIN_ADDRESS = { text: 'bc1qe53gsp0t5ehlvtgsxc952ujmxtvp6zj9zyh29d', diff --git a/src/constants/urls.ts b/src/constants/urls.ts index 666f4bf..8963b91 100644 --- a/src/constants/urls.ts +++ b/src/constants/urls.ts @@ -1,44 +1,62 @@ /** * Путь на домашнюю страницу. + * + * @constant */ export const URL_TO_HOME = '/'; /** * Путь на страницу FAQ. + * + * @constant */ export const URL_TO_FAQ = '/faq'; /** * Путь на страницу About. + * + * @constant */ export const URL_TO_ABOUT = '/about'; /** * Путь на страницу Donate. + * + * @constant */ export const URL_TO_DONATE = '/donate'; /** * Путь на страницу Custom. + * + * @constant */ export const URL_TO_CUSTOM = '/custom'; /** * Путь на страницу Manual. + * + * @constant */ export const URL_TO_MANUAL = '/manual'; /** * Путь на страницу Diagnostic. + * + * @constant */ export const URL_TO_DIAGNOSTIC = '/diagnostic'; /** * Путь на страницу Mobile. + * + * @constant */ export const URL_TO_MOBILE = '/mobile'; /** * Путь на страницу Mobile Custom. + * + * @constant */ export const URL_TO_MOBILE_CUSTOM = '/mobile-custom'; From daab390fe6f0213cc60c9bbb71df7de2e2720d14 Mon Sep 17 00:00:00 2001 From: Eugene Serb <46799701+eugene-serb@users.noreply.github.com> Date: Mon, 17 Jun 2024 19:04:28 +0300 Subject: [PATCH 05/17] #119 update jsdoc --- src/composables/useAnnouncements.ts | 8 +++++++- src/composables/useLayouts.ts | 6 ++++++ src/composables/useMobileVibration.ts | 17 ++++++++++++++++- src/models/Pattern.ts | 6 ------ src/models/Router.ts | 3 --- src/models/Vibrator.ts | 17 +---------------- src/models/common.ts | 2 -- 7 files changed, 30 insertions(+), 29 deletions(-) diff --git a/src/composables/useAnnouncements.ts b/src/composables/useAnnouncements.ts index d612e4c..758209f 100644 --- a/src/composables/useAnnouncements.ts +++ b/src/composables/useAnnouncements.ts @@ -8,7 +8,13 @@ import type { Announcement, AnnouncementSavedData } from '@/models'; * Результат работы композабла управления анонсами. */ type AnnouncementComposable = { + /** + * Анонсы. + */ announcements: Ref; + /** + * Сбросить конфигурацию колонок. + */ resetAnnouncements: () => void; }; @@ -42,7 +48,7 @@ export function useAnnouncements(originAnnouncements: Ref): Anno ); /** - * Сбросить конфигурацию колонок + * Сбросить конфигурацию колонок. */ function resetAnnouncements(): void { announcements.value = originAnnouncements.value; diff --git a/src/composables/useLayouts.ts b/src/composables/useLayouts.ts index b58e070..71e0e76 100644 --- a/src/composables/useLayouts.ts +++ b/src/composables/useLayouts.ts @@ -8,6 +8,9 @@ import type { Component } from 'vue'; * Лейауты. */ type Layouts = { + /** + * Компонент лейаута. + */ [index: string]: Component; }; @@ -15,6 +18,9 @@ type Layouts = { * Результат работы композабла лейаутов. */ type LayoutsComposable = { + /** + * Компонент лейаута. + */ layout: Component; }; diff --git a/src/composables/useMobileVibration.ts b/src/composables/useMobileVibration.ts index a36464e..9fb283a 100644 --- a/src/composables/useMobileVibration.ts +++ b/src/composables/useMobileVibration.ts @@ -6,8 +6,19 @@ import type { Ref } from 'vue'; * Результат работы композабла управления вибрацией телефона. */ type MobileVibrationComposable = { + /** + * Запустить вибрацию телефона по шаблону. + * + * @param pattern - Шаблон вибрации. + */ startVibrateLoop: (pattern: number | number[]) => void; + /** + * Остановить вибрацию. + */ stopVibrate: () => void; + /** + * Вибрация активна? + */ isActive: Ref; }; @@ -19,6 +30,8 @@ type MobileVibrationComposable = { export function useMobileVibration(): MobileVibrationComposable { /** * Интервал. + * + * @private */ let _vibrateInterval: number = 0; @@ -30,6 +43,7 @@ export function useMobileVibration(): MobileVibrationComposable { /** * Запустить вибрацию. * + * @private * @param pattern - Шаблон вибрации. */ function _startVibrate(pattern: number | number[]): void { @@ -39,6 +53,7 @@ export function useMobileVibration(): MobileVibrationComposable { /** * Запустить интервал с вибрацией. * + * @private * @param pattern - Шаблон вибрации. * @param duration - Продолжительность вибрации. */ @@ -61,7 +76,7 @@ export function useMobileVibration(): MobileVibrationComposable { } /** - * Запустить вибрацию. + * Запустить вибрацию телефона по шаблону. * * @param pattern - Шаблон вибрации. */ diff --git a/src/models/Pattern.ts b/src/models/Pattern.ts index 87d4115..673e809 100644 --- a/src/models/Pattern.ts +++ b/src/models/Pattern.ts @@ -6,17 +6,14 @@ export type TGamepadPattern = { * Название дорожки вибрации. */ name: string; - /** * Тип дорожки. */ type: string; - /** * Иконка дорожки. */ icon: string; - /** * Дорожка вибрации геймпада. */ @@ -31,17 +28,14 @@ export type TMobilePattern = { * Название дорожки вибрации. */ name: string; - /** * Тип дорожки. */ type: string; - /** * Иконка дорожки. */ icon: string; - /** * Дорожка вибрации мобильного устройства. */ diff --git a/src/models/Router.ts b/src/models/Router.ts index 9c7ec93..ce0aaca 100644 --- a/src/models/Router.ts +++ b/src/models/Router.ts @@ -16,12 +16,10 @@ export interface IMeta { * Заголовок страницы. */ title: string; - /** * Мета теги meta. */ metaTags: Array; - /** * Мета теги link. */ @@ -36,7 +34,6 @@ export interface IRouteMeta { * Путь. */ path: string; - /** * Мета информации страницы. */ diff --git a/src/models/Vibrator.ts b/src/models/Vibrator.ts index 4ec2424..938faf0 100644 --- a/src/models/Vibrator.ts +++ b/src/models/Vibrator.ts @@ -8,46 +8,38 @@ export type TVibrator = { * Устройство. */ device: Gamepad; - /** * ID устройства. */ readonly id: number; - /** * Может ли устройство вибрировать. */ readonly canVibrate: boolean; - /** * Вибрирует ли оно в данный момент? */ isVibrating: boolean; - /** * Интервал. */ interval: number; - /** * Обновить информацию об устройстве. */ update(): void; - /** * Воспроизвести и повторять дорожку вибрации. * * @param track - Дорожка вибрации. */ loop(track: GamepadEffectParameters[]): Promise; - /** * Воспроизвести вибрацию. * * @param params - Шаблон вибрации */ vibrate(params: GamepadEffectParameters): void; - /** * Отключить вибрацию устройства. */ @@ -62,46 +54,38 @@ export interface IVibrator { * Устройство. */ device: Gamepad; - /** * ID устройства. */ readonly id: number; - /** * Может ли устройство вибрировать. */ readonly canVibrate: boolean; - /** * Вибрирует ли оно в данный момент? */ isVibrating: boolean; - /** * Интервал. */ interval: number; - /** * Обновить информацию об устройстве. */ update(): void; - /** * Воспроизвести и повторять дорожку вибрации. * * @param track - Дорожка вибрации. */ loop(track: GamepadEffectParameters[]): Promise; - /** * Воспроизвести вибрацию. * * @param params - Шаблон вибрации */ vibrate(params: GamepadEffectParameters): void; - /** * Отключить вибрацию устройства. */ @@ -168,6 +152,7 @@ export class Vibrator implements IVibrator { * Воспроизвести и повторять вибрацию на устройстве по последовательности шаблонов. * * @param track - Последовательность шаблонов параметров вибрации. + * @async */ async loop(track: GamepadEffectParameters[]): Promise { this.isVibrating = true; diff --git a/src/models/common.ts b/src/models/common.ts index c51f925..90ca006 100644 --- a/src/models/common.ts +++ b/src/models/common.ts @@ -11,12 +11,10 @@ export type Link = { * Текст ссылки. */ text: string; - /** * Куда ведёт ссылка. */ to: string; - /** * Как открывать ссылку. */ From e3767c1ca08eb62722807e90663026beb3862b46 Mon Sep 17 00:00:00 2001 From: Eugene Serb <46799701+eugene-serb@users.noreply.github.com> Date: Mon, 17 Jun 2024 19:08:46 +0300 Subject: [PATCH 06/17] #119 update jsdoc --- src/components/molecules/MDiagnosticPanel.vue | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/components/molecules/MDiagnosticPanel.vue b/src/components/molecules/MDiagnosticPanel.vue index 8cca957..7849f40 100644 --- a/src/components/molecules/MDiagnosticPanel.vue +++ b/src/components/molecules/MDiagnosticPanel.vue @@ -32,16 +32,22 @@ const props = defineProps({ /** * Статус отражающий доступность. + * + * @constant */ const STATUS_AVAILABLE = 'Available'; /** * Статус отражающий недоступность. + * + * @constant */ const STATUS_MISSING = 'Missing'; /** * Класс отражающий нажатие. + * + * @constant */ const CLASS_PRESSED = 'pressed'; From 60abf7cedfc3925fa7f83a2a27d4a49889509f86 Mon Sep 17 00:00:00 2001 From: Eugene Serb <46799701+eugene-serb@users.noreply.github.com> Date: Mon, 17 Jun 2024 19:09:01 +0300 Subject: [PATCH 07/17] #119 update spelling --- .vscode/settings.json | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 29e89c2..7ccbf81 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -17,6 +17,15 @@ "Wavemaster", "webvisor", "Вибро", - "геймпада" + "геймпада", + "геймпадами", + "геймпадов", + "Десериализатор", + "Композабл", + "композабла", + "лейаута", + "лейаутов", + "Лейауты", + "Сериализатор" ] } From d6c78f77ae0c8bcd6f38250aa3dfdf7a16c44996 Mon Sep 17 00:00:00 2001 From: Eugene Serb <46799701+eugene-serb@users.noreply.github.com> Date: Mon, 17 Jun 2024 19:27:01 +0300 Subject: [PATCH 08/17] #120 delete defineComponent, defineProps and defineEmits from imports, delete defineComponent usage --- src/App.vue | 6 +----- src/components/atoms/AAnnouncement.vue | 6 ------ src/components/atoms/AGamepad.vue | 8 -------- src/components/atoms/AMessage.vue | 8 -------- src/components/atoms/ATextLogo.vue | 5 ----- src/components/molecules/MAnnouncement.vue | 6 +----- src/components/molecules/MDiagnosticPanel.vue | 6 +----- src/components/molecules/MFooter.vue | 6 +----- src/components/molecules/MGamepadList.vue | 5 ----- src/components/molecules/MHeader.vue | 5 ----- src/components/molecules/MHeaderMenu.vue | 5 ----- src/components/molecules/MPattern.vue | 6 +----- src/components/molecules/MPatternList.vue | 5 ----- src/components/molecules/MToolsMenu.vue | 5 ----- src/components/organisms/OCustom.vue | 6 +----- src/components/organisms/ODiagnostic.vue | 5 ----- src/components/organisms/OManual.vue | 6 +----- src/components/organisms/OMobile.vue | 5 ----- src/components/organisms/OMobileCustom.vue | 6 +----- src/components/organisms/OPatterns.vue | 5 ----- src/layouts/LDefault.vue | 5 ----- src/layouts/LGamepad.vue | 5 ----- src/layouts/LMobile.vue | 5 ----- src/views/AboutView.vue | 5 ----- src/views/CustomView.vue | 5 ----- src/views/DiagnosticView.vue | 5 ----- src/views/DonateView.vue | 5 ----- src/views/FaqView.vue | 5 ----- src/views/ManualView.vue | 5 ----- src/views/MobileCustomView.vue | 5 ----- src/views/MobileView.vue | 5 ----- src/views/NotFoundView.vue | 8 -------- src/views/PatternsView.vue | 5 ----- 33 files changed, 8 insertions(+), 175 deletions(-) diff --git a/src/App.vue b/src/App.vue index 562bf45..7944e2e 100644 --- a/src/App.vue +++ b/src/App.vue @@ -1,13 +1,9 @@ -