Wikipedia:Wikiploy

Wikiploy – narzędzie do wdrażanie skryptów użytkownika i gadżetów dla Wikipedii (i ogólniej dla wiki opartych na MediaWiki). Z tym narzędziem jednym przyciskiem wdrożysz swoje JS, CSS itp. z repozytorium git na dowolną liczbę wiki.
Narzędzie miało uprzednio dwie wersje – pierwotną, opartą na Puppeteer działającym w przeglądarce i lekką opartą na zmianach przez API (bardziej bezpośrednio). W wersji 2.0 wersja pierwotna została porzucona na rzecz szybkości API i lżejszych zależności.
Sposób użycia
[edytuj | edytuj kod]Szerszy opis sposobów użycia rozpisany jest w przykładowym repozytorium kodu: DEV-usage – wikiploy rollout example.
Działanie Wikiploy jest podobne do botów, ale nie są wymagane specjalne uprawnienia. Musisz jedynie skonfigurować hasło bota (na stronie Special:BotPasswords). To nie jest tak trudne, jak mogłoby się wydawać, ponieważ możesz to zrobić na dowolnej wiki projektu Wikimedia, a będzie działać na wszystkich wiki WMF.
Konfiguracja hasła bota:
- Skonfiguruj na dowolnej wiki, np.: test.wikipedia: Special:BotPasswords.
- Lista zalecanych uprawnień na zrzucie tutaj: Bot passwords - Test Wikipedia.png.
- Przykładowy plik konfiguracyjny znajdziesz tutaj: przykładowy bot.config.js.
Ostrzeżenie! Nigdy, przenigdy nie publikuj swojego hasła bota. W żadnym repo, nawet „prywatnym”. Jeśli jednak hasło się wyda, to niezwłocznie zresetuj lub usuń hasło (na stronie Special:BotPasswords).
Alternatywne witryny
[edytuj | edytuj kod]Wikiploy domyślnie wdraża na pl.wiki. Aby wdrożyć na inną witrynę użyj tego kodu:
const ployBot = new Wikiploy();
ployBot.site = "meta.wikimedia.org";
Więcej informacji o używaniu site i nie tylko w wikiploy rollout example.
Zobacz też
[edytuj | edytuj kod]Linki zewnętrzne
[edytuj | edytuj kod]- GitHub: Wikiploy – kod źródłowy, oficjalne miejsce na zgłaszanie pomysłów i błędów.
- NPM: Wikiploy – oficjalny pakiet w repozytorium NPM.
Projekty szablonowe:
- GitHub: Wikiploy rollout example – szablonowy kod gadżetu, czyli przykładowy projekt z wdrażaniem skryptów i instrukcją (w tym omówienie przykładowego kodu).
- GitHub: Wikiploy ES Linter Edit – prostszy projekt szablonowy, stworzony do ominięcia utrudnień powtórnej autoryzacji stworzonych w ramach phab:T197137. Dzięki temu edytowanie JS jest szybsze i mniej uciążliwe.
Przykłady (JS, Less-css, Lua):
- GitHub: veAutocorrect – praktyczny przykład wykorzystania Wikiploy z wieloma wdrożeniami.
- GitHub: wiki-pendingChangesHelper – przykład używający buildera z Wikiploy (transpilator służy tutaj do przygotowania zarówno gadżetu, jak i skryptu użytkownika Tampermonkey).
- GitHub: wiki-global-scripts — tworzenie osobistego pliku global.css z Less.
- GitHub: wiki-lua-piechart – Lua dla Module:Piechart z kilkoma testami i wdrożeniem w środowisku testowym (Lua i CSS). Zawiera Lua MW mock (zestaw narzędzi MW) umożliwiający testowanie w trybie offline.