Wikipedia:Wiki-to-Git

Wiki-to-Git (lub Wiki2Git) – narzędzie, które pomaga pobrać historię stron MediaWiki i zaimportować ją do repozytorium Git.

Wiki2Git można używać do eksportowania gadżetów Wikipedii (lub skryptów użytkownika) na dowolny serwer Git (np. GitHub, GitLab lub Gitea). W historii repozytorium Git zachowani zostaną autorzy i oryginalne opisy zmian. Czyli po imporcie każda edycja staje się commitem.

Od razu po zakończeniu tworzenia swojego repo możesz łatwiej rozwijać swój gadżet. Czyli możesz korzystać z bardziej standardowych narzędzi i tym samym wygodniej edytować kod, ale także analizować historię gadżetu (np. poprzez narzędzia takie jak VSCode, eslint i git blame). Tym samym sprawdzenie kiedy i po co coś zostało dodane stanie się dużo prostsze i szybsze!

Dodatkowo możesz także przerobić skrypt, żeby dodać automatyczne testy przed wdrożeniem, czyli np. skorzystać z bibliotek Mocha i Chai. Możesz także podzielić skrypt na zgrabniejsze moduły i użyć narzędzi do kompilacji, takich jak Browserify lub Webpack.

Będziesz musiał to jakoś potem wdrożyć na Wiki. Możesz to jednak łatwo zrobić dzięki Wikiploy. Wikiploy ułatwia sprawę, bo wstawia kod automatycznie na wiki. Czyli możesz to zintegrować z narzędziami do budowania. Dodatkowo możesz rozdzielić wdrażanie wersji do gadżetów oraz wersji deweloperskich/testowych.

Przykład użycia

Krok. 1. Instalacja. Instalację najłatwiej wykonać poprzez npm (Node.js):

npm i -g wiki-to-git

Krok. 2. Pobranie listy edycji. To załaduje historię edycji z Wikipedii do pliku:

wiki2git-load --site pl.wikipedia.org -p "MediaWiki:Gadget-NavFrame.js"

To utworzy plik history.json, który w razie potrzeby można edytować.

Krok. 3. Utworzenie commitów. Utworzenie nowego repo w folderze gadget-NavFrame, w którym utworzony zostanie plik NavFrame.js:

wiki2git-commit --site pl.wikipedia.org --repo "gadget-NavFrame" -o "NavFrame.js"

Na tym etapie narzędzie pobiera treści kolejnych wersji i dodaje je do repozytorium. Jeśli folder z repozytorium już istnieje, to historia zostanie uzupełniona (wg wersji podanych w pliku history.json). W ten sposób można również pobierać nowe wersje z wiki.

Dodatkowe pliki.

Kolejne pliki dodaje się tak samo jak pierwszy. Wystarczy po prostu dodać odpowiednie nazwy.

Dla przykładu tutaj dodajemy CSS (do pobranego wcześniej JS):

wiki2git-load --site pl.wikipedia.org -p "MediaWiki:Gadget-NavFrame.css"
wiki2git-commit --site pl.wikipedia.org --repo "gadget-NavFrame" -o "NavFrame.css"

Lista opcji

Jeśli chcesz możesz sprawdzić inne opcje w ten sposób:

wiki2git-load --help
wiki2git-commit --help

Zobacz też

• Wikipedia:Wikiploy — Wikiploy może być używany do wdrażania z Gita z powrotem do Wikipedii.

Linki zewnętrzne

• github: wiki-to-git - kod źródłowy, oficjalne miejsce do zgłaszania pomysłów i zgłaszania błędów.
• npm: wiki-to-git - oficjalny pakiet w repozytorium NPM .