Gibt es Regeln (Best Practice) für den Bibliotheksnamen?

Ich überarbeite gerade das Roborock Modul und dabei fällt mir auf dass ich persönlich den bisherigen Bibliotheksnamen „IPSymconRoborock“ für nicht so schön halte.

Eine Regel für die Namensvergabe habe ich nicht gefunden, meine mich aber zu erinnern, irgendwo gelesen zu haben, dass in Namen kein IPS, Symcon, IPSymcon etc auftauchen sollte. Finde es nur leider nicht mehr.

Spricht etwas dagegen, eine Bibliothek umzubenennen? Mir schwebt da ein kürzerer Name wie „Roborock“ vor.

Du kannst Module ohne Probleme umbennen.
Du musst nur darauf achten, wenn du die module.json anpasst, dass du auch die Klassennamen anpasst. :wink:

Grüße,
Kai

Ich habe da für dich gesucht und kann dir sagen:
Ja, steht unter Review bei Punkt 9 und im dort verlinkten Best practices.

Mir geht es um den Bibliotheksnamen :slight_smile:

Ja genau unter Punkt 9 steht es, in den Best practices steht es jedoch nicht :slight_smile:

  1. „IPSymcon“, „IPS“ oder vergleichbares darf nicht Teil eines in einer Lokalisierung gewählten Namens sein.

Was ist denn ein „in einer Lokalisierung gewählter Name“? Ich verstehe darunter, dass es in der locale.json nicht auftauchen darf.
Damit wäre der Bibliotheksname zwar außen vor, aber ich denke man kann auch ihn ohne Probleme umbenennen.

Ja, einfach umbenennen.
Solange die GUID gleich bleibt, sollte Symcon das auch erkennen.
Michael

Ich habe damals alle meine Module angepasst, weil ich überall nen IPS- vor hatte. Das hat ohne Probleme funktioniert, so lange die GUID die selbe bleibt.

Grüße,
Kai

Mit in der Lokalisierung gewählt sind die Namen gemeint, die du beim Einreichen im Reiter „Lokalisierung“ eingibst. Prinzipiell würde ich aber empfehlen, das bei allen Namen anzuwenden, die ein Benutzer sehen kann.

Achso, verstehe.

Dann taucht strenggenommen der Bibliotheksname üblicherweise im Link zur Dokumentation auf.

Ich werde dann auch beim Bibliotheksnamen darauf achten. Vielen Dank.