CudaText: реестр плагинов

cyber_banat
Posts: 23
Joined: 16.01.2021 23:04

CudaText: реестр плагинов

Post by cyber_banat »

Придумайте что-нибудь с плагинами. Я хотел бы видеть публичный список плагинов который гуглится и в который можно попасть. Например, по типу awesome списков - репозиторий с readme.md файлом, принимающий PR.

Это нужно для того, что бы любой желающий не из вашей тусовки (например я) мог написать плагин и послать его в публичный список, а любой пользователь мог почитать его и выбрать себе плагин или (что возможно даже более важно) нагуглить плагин по описанию. И при этом не скачивать сразу все плагины.

Как именно вы это сделаете - не имеет значения, сделайте хоть реестр расширений с поиском, хоть readme файл
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

предлагаю вам начать это делать. а мы посмотрим что у вас вышло.
Shovel
Posts: 141
Joined: 31.12.2019 10:16

Post by Shovel »

Товарищ Кибер Еб*нат, что-то такое? github
cyber_banat
Posts: 23
Joined: 16.01.2021 23:04

Post by cyber_banat »

Shovel wrote:Товарищ Кибер Еб*нат, что-то такое? github
Да, что-то вроде этого. Но кажется, этот текст сгенерирован автоматически, а значит его будет сложно поддерживать.

Я представляю себе что-то по типу awesome list репозиториев. Пример: https://github.com/vinta/awesome-python
То есть список названий с ссылками на плагины и коротким описанием.

- [Find in Files 4](ссылка на репозиторий) - Gives dialog to search for multiple files containing some string/regex, like in file managers
- [Highlight Occurrences](ссылка на репозиторий) - Highlights/Marks all occurrences of current/selected word/fragment

Улучшать это можно группировкой заголовками по типу плагина (лексер, тема, поиск, работа с git, удалённая/совместная работа и т.д.).

Что делать, если у вас нет репозитория для каждого плагина? Ссылаться на место в репозитории, где лежит плагин, вместо ссылки просто на репозиторий.
Ничего страшного, моно репозитории - нормальная практика. Пример такой ссылки на emmet: https://github.com/Alexey-T/CudaText/tr ... cuda_emmet

Что делать, если у вас нет репозитория с плагинами, а есть только ссылки на zip архивы? Создать такие репозитории или моно репозиторий с директориями с названием плагина, readme файлом, исходниками и если его нельзя просто взять и поставить руками, то ещё с инструкциями как именно его устанавливать.

Суть в том, что бы я мог прочитать описание плагина, перейти в его репозиторий, почитать подробности, посмотреть исходники и убедиться что там нет взлома жопы и прочитать о том как установить этот плагин (может быть кто-то не добавил его в ваш реестр и мне придётся делать это вручную, всякое может быть)

Что это даст?
Удобство поиска плагинов для пользователей.

Я пишу в гугл "CudaText awesome list" и попадаю на репозиторий, где в привычном мне, интернет пользователю, виде получаю список всего что есть для редактора. Возможно я сам не знаю чего я хочу, но просмотрев такой список я могу захотеть что-нибудь попробовать.

Или я могу написать "CudaText plugin for search in files" и попасть в этот же репозиторий или сразу в readme плагина "Find in files 4".

Такие списки есть для чего угодно в интернете, вот например для vscode: https://github.com/viatsko/awesome-vscode

Ещё это даст привлечение аудитории. Вот я сделал свой плагин. Что делать дальше? Как мне поделиться им с друзьями, похвастаться на работе и продвинуть ваш редактор? CudaText awesome list - это отличный способ сделать это. Я читаю правила контрибуции в ваш репозиторий, делаю pull request или завожу issue с рассказом о своем плагине и ссылкой на нормально оформленный репозиторий, вы эту информацию руками проверяете, добавляете и люди узнают о моём плагине.

Очень удобный механизм для всех.
- У опытных пользователей есть желание писать плагины
- У пользователей которым нужна фича прямо сейчас, есть удобные механизмы поиска
- У разработчиков CudaText есть представление о требованиях аудитории к их ПО, о том на разработке чего следует сфокусироваться прямо сейчас, а что уже сделали пользователи
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

@Shovel
могу добавитть ссылку на этот список в Вики. между этими п-тами например добавить пункт "Short description of all plugins".
6 Major plugins
7 Tech topics
сначала жду когда доделаете список. там все плагины которые есть в AddonManager?
Shovel
Posts: 141
Joined: 31.12.2019 10:16

Post by Shovel »

Да, сгенерирован автоматически, я просто сделал "Addons Manager > Download All..." и достал информацию питон-скриптом из плагинов. Так что наверное все плагины есть.

Из 118 плагинов только 5 без репозиториев.
plugin.HTML_Tidy.zip
plugin.Sum_Lines.zip
plugin.Testing_of_Code_Tree_API.zip
plugin.Testing_of_dialog_API.zip
plugin.Testing_of_gaps_API.zip

@uvviewsoft
Установка плагина всегда заключается только в копировании папки в '/py/'? - т.е. может ли такой список существовать независимо с такой простенькой инструкцией установки и со ссылками на репозитории для скачивания?
(мне тоже кажется, что этот список очень хорошая идея - для новых пользователей как минимум)

@uvviewsoft, вы бы взяли на себя управление этим списком когда скрипт его создания будет готов (скрипт очень маленький и только дефолтные импорты)? Может это действительно мог бы быть официальным путем добавления плагинов?
(потому что я категорически не квалифицирован :D )

Что из этого желательно иметь в списке?

Code: Select all

codetreeicons
filetypeicons
formatter
lexer
linter
package
plugintranslation
projtoolbaricons
sidebartheme
snippets_ct
theme
toolbartheme
toolbarxicons
translation
treehelper
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

plugin.HTML_Tidy.zip
plugin.Sum_Lines.zip

поправил в этих 2х файлы install.inf. обновил в SF.net.
другие 3 штуки живут в репо Куды, у них нет дома.
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

>Установка плагина всегда заключается только в копировании папки в '/py/'?
еще в записи инфы в файл settings/packages.ini. Не обязятально.

>управление этим списком когда скрипт его создания будет готов
наверное да. посмотрим попозже.
Shovel
Posts: 141
Joined: 31.12.2019 10:16

Post by Shovel »

Как-то так. Пару маленьких багов еще исправлю завтра и мне кажется хорошее начало получилось.

@uvviewsoft гифки демонстрации работы плагинов приветствовались бы в репозиториях?
cyber_banat
Posts: 23
Joined: 16.01.2021 23:04

Post by cyber_banat »

Shovel wrote:Как-то так. Пару маленьких багов еще исправлю завтра и мне кажется хорошее начало получилось.

@uvviewsoft гифки демонстрации работы плагинов приветствовались бы в репозиториях?
Да, здорово. Только добавь ещё CONTRIBUTING.md файл с описанием что делать, что бы пополнить список.
Правила оформления запросов, требования к репозиториям и запросам (хорошо бы требовать readme файл в репозитории, с описанием плагина)
Post Reply