Конфигурационный файл для klavotools about kgscripts

[ocrest]

Fenex/klavotools-kango#4

[Fenex]

global по факту отвечает за состояние "вкл\выкл по-умолчанию", я правильно понял? Тогда может назвать его enable?

Ещё я считаю надо ввести дополнительное свойство force, которое будет указывать КТС интерпретировать скрипт как по-умолчанию включённое и неотображаемое в настройках (этот скрипт будет невозможно отключить). Таких скриптов в КТС-1 было много, тот же BB-Tools, например. Смысла в опции вкл\выкл для этого скрипта никакого, только дополнительная бесполезная строка в настройках. А этих строк там много и они даже меня пугают своим количеством. В крайнем случае сделаю комбинацию горячих клавиш для отображения всех настроек.

Сейчас я делаю запрос чтобы получить количество скриптов, их имена и описание. Возможно, стоит добавить в нашу конфигурацию такие же параметры, а именно

• url (хотя, по идеи его можно точно определить по имени вроде как);
• description описание скрипта

Из плюсов, правда, только экономия одного запроса, плюс код будет проще и очевиднее. Хотя, в перспективе открывается ещё одна довольно клёвая вещь: можно будет пользователям самостоятельно указывать путь к конфигурационному файлу.
Из минусов: придётся поддерживать актуальность данных и там, и тут.

[Fenex]

Про теги.
Думаю, надо сделать теги в соответствии с названиями разделов на сайте.

• _general_ - executable everywhere (затрудняюсь по-русски сказать)
• _профиль_
• _заезд_ а также возможно указание дополнительных: _соревнование_ (заезды, создающиеся автоматически), _событие_ (заезды, создаваемые пользователями)
• _форум_
• _словари_
• _чат_

Теги важны. Надо придумать названия покороче, но при этом постараться избежать двусмысленностей.

[ocrest]

global по факту отвечает за состояние "вкл\выкл по-умолчанию", я правильно понял? Тогда может назвать его enable?

Да, так будет логичнее. Но может, тогда лучше использовать disabled? Просто скриптов, которые будут включены по умолчанию, вроде как получается больше тех, что будут отключены.

Ещё я считаю надо ввести дополнительное свойство force, которое будет указывать КТС интерпретировать скрипт как по-умолчанию включённое и неотображаемое в настройках

Хорошая идея, только может, стоит назвать это поле не force, а integrated? Последнее, на мой взгляд, лучше отражает его назначение.

А этих строк там много и они даже меня пугают своим количеством. В крайнем случае сделаю комбинацию горячих клавиш для отображения всех настроек.

Как вариант — можно сделать что-то вроде форумного спойлера, который будет скрывать такие «интегрированные» скрипты. Кстати, а где можно взять список последних? (Добавил пункт в список задач).

Хотя, в перспективе открывается ещё одна довольно клёвая вещь: можно будет пользователям самостоятельно указывать путь к конфигурационному файлу.

Безусловно, это очень полезная фича (те, кто используют несколько браузеров, думаю, оценят).

Из минусов: придётся поддерживать актуальность данных и там, и тут.

Как вариант, можно написать вспомогательный скрипт, который будет генерировать общий список юзерскриптов для README.md (и возможно, сразу модифицировать его), используя этот конфиг. Не знаю, оценит ли такое @voidmain02 :)

[ocrest]

Про теги.
Думаю, надо сделать теги в соответствии с названиями разделов на сайте.

Согласен, но только лучше тег «Профиль» разбить на несколько более точных: «Сводка», «Достижения», «Гараж», «Бортжурнал», «Друзья», «Статистика», «Сообщения» и «Настройки».

general - executable everywhere (затрудняюсь по-русски сказать)

Как насчет «Сайт» или «Прочее»?

[voidmain02]

Двумя руками за! Собственно, этот репозиторий и затевался с целью навести порядок...

Как вариант, можно написать вспомогательный скрипт, который будет генерировать общий список юзерскриптов для README.md (и возможно, сразу модифицировать его), используя этот конфиг.

Честно говоря, не вижу в этом особого смысла... На мой взгляд не сложно и руками поменять при добавлении нового скрипта.

И еще... Думаю лучше обернуть конфиг в массив, а не в объект:

[
    {
        "name": "BB-Tools",
        "integrated": true,
        "tags": [ "Форум", "Словари" ],
        "description": "Добавляет дополнительные bb-кнопки для форматирования сообщений на форуме, описания и комментариев словарей"
    },
    {
        "name": "KG_ClearProfile",
        "disabled": true,
        "tags": [ "Сводка" ],
        "conflicts": [ "KG_GlasslessBio" ],
        "description": "Изменяет стилевое оформление профиля"
    }
]

[ocrest]

Честно говоря, не вижу в этом особого смысла... На мой взгляд не сложно и руками поменять при добавлении нового скрипта.

Ну в принципе да, но можно пойти дальше, и помимо добавления новой строки в README.md генерировать также «макет» описания нового скрипта в docs/ (если таковой *.md файл там отсутствует)

И еще... Думаю лучше обернуть конфиг в массив, а не в объект:

Да, безусловно, это будет лучше. Но раз уж у нас для каждой записи перечисляется практически вся информация об отдельном скрипте, то может, стоит также указывать и авторов (и, возможно, тестеров)?

[
    {
        "name": "BB-Tools",
        "authors": [ "Fenex" ],
        "integrated": true,
        "tags": [ "Форум", "Словари" ],
        "description": "Добавляет дополнительные bb-кнопки для форматирования сообщений на форуме, описания и комментариев словарей"
    },
    {
        "name": "KG_ClearProfile",
        "authors": [ "voidmain" ],
        "disabled": true,
        "tags": [ "Сводка" ],
        "conflicts": [ "KG_GlasslessBio" ],
        "description": "Изменяет стилевое оформление профиля"
    }
]

[ocrest]

Список интегрированных в KlavoTools скриптов:

• KlavoEvents
• klavogonki: Sort results
• DelGameButton
• Klavogonki: save race in logbook
• klavogonki - hide cars
• IgnoreList
• Klavogonki: average size of the books part
• QuickVocsStart
• Klavogonki: klavostats links
• Klavogonki: recent games
• Klavogonki: daily scores
• BB-Tools
• klavogonki: tag hide
• PostOptions+
• klavogonki: BigTextarea
• Error Control Mode
• NEC (no-error counter)
• chat2BBCode

@Fenex, я ничего не забыл?

[Fenex]

Если речь идёт о КТС-1, то вот здесь хранится список:
https://github.com/Fenex/KTS/blob/master/lib/opt.dat#L29-L170

P.S. бгг, я только сейчас понял, что мы изобрели то же, что уже было сделано в КТС-1 :D

[ocrest]

@Fenex, да, спасибо. Если я правильно понял, в этом репозитории нет следующих скриптов:

• hideUserList
• hideAllGamesInGamelist
• ProfileTools
• AntiBackspace
• timeout_alert
• usergroups

— @voidmain02, они еще где-нибудь сохранились? (да, в репозитории КТС-1 :D) И если да, то рабочие? )

P.S. бгг, я только сейчас понял, что мы изобрели то же, что уже было сделано в КТС-1 :D

Ну, новое — это хорошо забытое старое :) Структура да, очень похожая получилась (впрочем, это неудивительно)

[voidmain02]

@FilippovDaniil, по поводу этих скриптов ничего сказать не могу. Нужно смотреть, а у меня пока совсем нет времени(

Я тут еще подумал, что одни скрипты могут зависеть от других. Информацию об этом можно добавить в наш конфигурационный файл.

[
    {
        "name": "KG_ClearProfile",
        "version": "1.4",
        "authors": [ "voidmain" ],
        "disabled": true,
        "tags": [ "Сводка" ],
        "conflicts": [ "KG_GlasslessBio" ],
        "description": "Изменяет стилевое оформление профиля"
    },
    {
        "name": "KG_ClearProfileRedTheme",
        "version": "1.0",
        "authors": [ "voidmain" ],
        "disabled": true,
        "tags": [ "Сводка" ],
        "dependencies" : {
            "KG_ClearProfile": ">= 1.2"
        },
        "description": "Изменяет стилевое оформление профиля"
    },
]

[ocrest]

по поводу этих скриптов ничего сказать не могу. Нужно смотреть, а у меня пока совсем нет времени(

@voidmain02, ясно, ну тогда я их поковыряю, как руки дойдут :)

Я тут еще подумал, что одни скрипты могут зависеть от других. Информацию об этом можно добавить в наш конфигурационный файл.

Ну это нужно у @Fenex спросить, как он на это смотрит :) С версиями зависимостей, имхо, проблем будет дофига — сейчас кто-то использует при указании версий три цифры, кто-то две (т.е. нужно все стандартизировать по принципу semver). И версия 2.0 может кардинально отличаться от 1.x, т.е. запись >= 1.2 может наделать проблем... Да и вообще, у нас уже есть примеры таких сложных скриптов?

[ocrest]

Составил список скриптов, которые будут отключены по умолчанию:

• KG_CancelRaceShortcut
• KG_CenterAlignment
• KG_ChatHotkey
• KG_ClearProfile
• KG_DialogLink
• KG_ErrorWork
• KG_FastDialog
• KG_GameLog
• KG_InlineFriendsList
• KG_PointsSender
• KG_SaveGameResult
• KG_YandexTranslator
• klavogonki_hide_text
• translator

— есть какие-нибудь возражения/дополнения?

[P-h-e-m-m-e-r]

KG_PointsSender, KG_DialogLink я бы оставил, удобные вещи, ни с чем не конфликтуют, ничего привычного не вырезают.

[Fenex]

KG_PointsSender очень специфичен и нужен узкому кругу лиц, можно отключать я считаю.
Я бы ещё отключил KG_InfiniteScroll

[Fenex]

КТС-1 когда-то собирал статистику (а может и сейчас даже собирает), вот такие результаты в базе:

Enabled	UserJS
823	CustomHide
823	sortResults
822	QuickVocsStart
821	restoreChat
819	AntiBackspace
817	KlavoEvents
817	IgnoreList
815	ProfileTools
807	ECM
807	chat2BBCode
807	HideCars
807	NEC
799	DelGameButton
796	hideAllGamesInGamelist
782	DailyScores
781	RecentGames
742	chatLeftLinks
710	hideUserList
707	klavostats_links
706	save_race_in_blog
672	usergroups
606	best5_results_in_profile
567	timeout_alert

Count	Theme
642	beige
74	blue
66	green
35	gray
9	pink

[ocrest]

@P-h-e-m-m-e-r, KG_PointsSender нужен разве что организаторам соревнований. Остальным людям, на мой взгляд, он вряд ли пригодится.

Что касается KG_DialogLink — в принципе, его еще можно оставить, но сомневаюсь, что добавляемой этим скриптом «решеткой» будет пользоваться большое количество людей (полагаю, подавляющее большинство ее просто не заметит).

Я бы ещё отключил KG_InfiniteScroll

Да, согласен. Вполне могут найтись люди, которым эта автоматическая загрузка не понравится (как уже не понравился автоматический перевод английских текстов).

КТС-1 когда-то собирал статистику (а может и сейчас даже собирает), вот такие результаты в базе:

Enabled — число уникальных пользователей этих скриптов?

[Fenex]

К сожалению не уникальных пользователей, а аккаунтов.

[ocrest]

А, ясно. Но даже если так — этими скриптами все равно пользуется большое число людей, так что отключать какие-либо из них, думаю, смысла нет. Да и все они уже сейчас отмечены как «интегрированные» в KlavoTools.

P.S. Останавливаемся на таком варианте?

• KG_CancelRaceShortcut
• KG_CenterAlignment
• KG_ChatHotkey
• KG_ClearProfile
• KG_DialogLink
• KG_ErrorWork
• KG_FastDialog
• KG_GameLog
• KG_InfiniteScroll
• KG_InlineFriendsList
• KG_PointsSender
• KG_SaveGameResult
• KG_YandexTranslator
• klavogonki_hide_text
• translator

[P-h-e-m-m-e-r]

скрипт translator давно не работает. Если я не ошибаюсь, он использует промежуточный сервер, который давно не работает, автор скрипта ушел с клавогонок и вряд ли появится и починит. Может быть его удалить вовсе, ведь есть же отличная замена в виде KG_YandexTranslator?

filippovdaniil, я не вижу в этом списке отличного скрипта KG_GlasslessBio. Он включен по умолчанию или забыт совсем? :)

[ocrest]

скрипт translator давно не работает. Если я не ошибаюсь, он использует промежуточный сервер, который давно не работает, автор скрипта ушел с клавогонок и вряд ли появится и починит. Может быть его удалить вовсе, ведь есть же отличная замена в виде KG_YandexTranslator?

@P-h-e-m-m-e-r, ммм, да, я и забыл, что он нерабочий... Да, в таком случае его нужно убрать из репозитория.

filippovdaniil, я не вижу в этом списке отличного скрипта KG_GlasslessBio. Он включен по умолчанию или забыт совсем? :)

Уже ответил в лс, но продублирую и сюда: нет, не забыт ) Будет добавлен в репозиторий (и будет отключен по умолчанию), но не раньше чем KlavoTools будет использовать конфиг, про который мы здесь и говорим :)

[P-h-e-m-m-e-r]

По моему мнению эти два скрипта я бы предложил скрыть:
KG_DisableTab
KG_EnterToSpace
первый может не понравиться недоездунам, которые табом + ctrl вправо сбрасывают заезд, второй - тем, кто ошибается на буквах э, х,ъ и попадает по энтеру, будут ошибки :)
Вот мне кажется, они больше изменяют глобального, чем те же KG_ErrorWork, KG_DialogLink.
но в принципе все это настраиваемое несколькими нажатиями, так что настроить хоть так хоть так не проблема.

[ocrest]

Первый может не понравиться недоездунам, которые табом + ctrl вправо сбрасывают заезд

А точно комбинацией с [Tab]? Не просто [Ctrl] + [→]?

второй - тем, кто ошибается на буквах э, х,ъ и попадает по энтеру, будут ошибки :)

Ок, здесь согласен, имеет смысл отключить.

Вот мне кажется, они больше изменяют глобального, чем те же KG_ErrorWork, KG_DialogLink.

В целом — да, но еще нужно учитывать актуальность этих скриптов для большинства людей. Тот же KG_DialogLink добавляет всего лишь малозаметную ссылку для диалога (и по этой причине ей вряд ли кто-то будет пользоваться, если нет определенной и узкой потребности открывать диалоги в отдельных вкладках), но его код — целый набор жутких костылей, которых хотелось бы избегать: https://github.com/voidmain02/KgScripts/blob/master/scripts/KG_DialogLink.user.js

[P-h-e-m-m-e-r]

Просто в строке набора [Ctrl] + [→] ничего не дает. нужно выйти из нее, например кнопкой [Tab].
Вопрос целевой аудитории - доездунам он понравится, я думаю, недоездунам - нет.

[ocrest]

А, точно. Ок, тогда имеет смысл отключить и KG_DisableTab.

Обновленный список:

• KG_CancelRaceShortcut
• KG_CenterAlignment
• KG_ChatHotkey
• KG_ClearProfile
• KG_DialogLink
• KG_DisableTab
• KG_EnterToSpace
• KG_ErrorWork
• KG_FastDialog
• KG_GameLog
• KG_InfiniteScroll
• KG_InlineFriendsList
• KG_PointsSender
• KG_SaveGameResult
• KG_YandexTranslator
• klavogonki_hide_text