Add comments to vanitymapv2

Fügt Kommentare hinzu. Diese müssen in " gesetzt werden, damit später theoretisch noch Argumente danach existieren könnten.

An allen Stellen sorgt die PR dafür, dass keine Breaking Changes existieren. Deswegen sind die Kommentare nur in der vanitymapv2.json. Auch die vanitymap.txt muss nicht verändert werden.

Beispiel für die Funktion:

Ausschnitt aus vanitymap.txt

/op /ophase "O-Phase Yuhu!"
/o-phase /ophase
/ophase https://[...]/o-phase "Die Phase der Os"
/erstiguide https://[...]/erstiinfo.pdf

Ausschnitt aus vanitymapv2.json

"/op": {
    "url": "https://[...]/o-phase",
    "comment": "O-Phase Yuhu!"
}
"/o-phase": {
    "url": "https://[...]/o-phase",
    "comment": "Die Phase der Os"
}
"/ophase": {
    "url": "https://[...]/o-phase",
    "comment": "Die Phase der Os"
}
"/erstiguide": {
    "url": "https://[...]/erstiinfo.pdf",
    "comment": "erstiguide"
}

Ausschnitt aus vanitymap.json

"/op": "https://[...]/o-phase"
"/o-phase": "https://[...]/o-phase"
"/ophase": "https://[...]/o-phase"
"/erstiguide": "https://[...]/erstiinfo.pdf"

Closes #6

requested review from @dmehren1 and @falk.rehse

assigned to @felix.strick

mentioned in issue oh14de-links#7 (closed)

mentioned in issue #7

Mehrere Anmerkungen:

• Ich würde keine vanitymapv2.json machen und dann noch die alte mitschleifen. Soweit ich weiß wird die aktuell nur in situ für die Fehlerseiten/Suche benutzt, das kann dann direkt entsprechend umgebaut werden. Die Kommentare können theoretisch auch bei der Suche dann beachtet werden, das würde ich aber in ein separates (und orthogonales, das braucht nicht fertig sein um das hier zu mergen) Ticket werfen.
• positional arguments, insbesondere für optionale Argumente, sind bäh. Wenn ihr jetzt schon überlegt Kategorien zusätzlich einzubauen und was weiß ich noch, sollten wir uns entweder insgesamt einmal Gedanken über die Struktur der Quelldatei machen, und ob Flat Text da noch gut ist, oder wenigstens die optionalen Argumenten argumente mit named arguments umsetzen. Also sowas wie /ophase https://[...]/o-phase kommentar="Die Phase der Os" kategorie=dings foo=bar. Sobald aber die Kategorien z.B. noch Metadaten (z.B. eine eigene Beschreibung) abkriegen sollen fällt das halt völlig auf die Fresse, wo wir wieder bei einer anderen Struktur für die Quelldatei wären.

Spontane Idee: Um Dinge in Kategorien zu sortieren, könnte sich INI bzw TOML gut eignen

Ja, ich hatte auch an TOML gedacht, das ist dann auch mittel-clunky.

[Meine Kategorie]
description=foo bar dolor sit amet

[Meine Kategorie./kurzlink/pfad]
comment=foo bar dolor sit amet

Ich befürchte wir wollen dann entweder (strict) yaml oder halt unseren eigenen Scheiß ähnlich wie oben beschrieben haben.

Anderer Punkt: Kategorien oder direkt Tags? Ich stelle mir vor manche Links könnte in mehrere Buckets fallen, und ich würde nur ungern in fine 2 Taxonomien einbauen.

@falk.rehse hatte eben auch die Idee mit YAML. Wenn man die mit der Tags Idee kombiniert, könnte da vermutlich was ganz gutes rauskommen. Nur hat das dann natürlich viele breaking changes.

closed