# Copyright Kevin Deldycke <kevin@deldycke.com> and contributors.
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
"""Utilities to generate extra labels to use for GitHub issues and PRs."""
from __future__ import annotations
import json
from pathlib import Path
from typing import Dict, FrozenSet
from boltons.iterutils import flatten
from extra_platforms import Group
from .inventory import MAIN_PLATFORMS
from .pool import pool
LABELS: list[tuple[str, str, str]] = [
(
"🔌 bar-plugin",
"#fef2c0",
"Xbar/SwiftBar plugin code, documentation and features",
),
]
"""Global registry of all labels used in the project.
Structure:
.. code-block:: python
("label_name", "color", "optional_description")
"""
TLabelSet = FrozenSet[str]
TLabelGroup = Dict[str, TLabelSet]
[docs]
def generate_labels(
all_labels: TLabelSet,
groups: TLabelGroup,
prefix: str,
color: str,
) -> dict[str, str]:
"""Generate labels.
A dedicated label is produced for each entry of the ``all_labels`` parameter,
unless it is part of a ``group``. In which case a dedicated label for that group
will be created.
"""
# Check all labels to group are referenced in the full label set.
grouped_labels = set(flatten(groups.values()))
assert grouped_labels.issubset(all_labels)
label_map = {}
# Create a dedicated label for each non-grouped entry.
standalone_labels = all_labels - grouped_labels
for label_id in standalone_labels:
label_name = f"{prefix}{label_id}"
# Check the addition of the prefix does not collide with an existing label.
assert label_name not in all_labels
label_map[label_id] = label_name
# Register label to the global registry.
LABELS.append((label_name, color, label_id))
# Create a dedicated label for each group.
for group_id, label_ids in groups.items():
label_name = f"{prefix}{group_id}"
# Check the addition of the prefix does not collide with an existing label.
assert label_name not in all_labels
for label_id in label_ids:
label_map[label_id] = label_name
# Build a description that is less than 100 characters.
description = ""
truncation_mark = ", …"
for item_id in sorted(label_ids, key=str.casefold):
new_item = f", {item_id}" if description else item_id
if len(description) + len(new_item) <= 100 - len(truncation_mark):
description += new_item
else:
description += truncation_mark
break
# Register label to the global registry.
LABELS.append((label_name, color, description))
# Sort label_map by their name.
return dict(sorted(label_map.items(), key=lambda i: str.casefold(i[1])))
MANAGER_PREFIX = "📦 manager: "
MANAGER_LABEL_GROUPS: TLabelGroup = {
"dnf-based": frozenset({"dnf", "dnf5", "yum"}),
"dpkg-based": frozenset({"apt", "apt-mint", "opkg"}),
"homebrew": frozenset({"brew", "cask"}),
"npm-based": frozenset({"npm", "yarn"}),
"pacman-based": frozenset({"pacman", "pacaur", "paru", "yay"}),
"pip-based": frozenset({"pip", "pipx"}),
"vscode-based": frozenset({"vscode", "vscodium"}),
}
"""Managers sharing some origin or implementation are grouped together under the same
label."""
all_manager_label_ids = frozenset(set(pool.all_manager_ids) | {"mpm"})
"""Adds ``mpm`` as its own manager alongside all those implemented."""
# Check group IDs do not collide with original labels.
assert all_manager_label_ids.isdisjoint(MANAGER_LABEL_GROUPS.keys())
MANAGER_LABELS = generate_labels(
all_manager_label_ids,
MANAGER_LABEL_GROUPS,
MANAGER_PREFIX,
"#bfdadc",
)
"""Maps all manager IDs to their labels."""
PLATFORM_PREFIX = "🖥 platform: "
PLATFORM_LABEL_GROUPS: TLabelGroup = {}
for p_obj in MAIN_PLATFORMS:
PLATFORM_LABEL_GROUPS[p_obj.name] = frozenset(
p.name for p in Group._extract_platforms(p_obj)
)
"""Similar platforms are grouped together under the same label."""
all_platform_label_ids = frozenset(flatten(PLATFORM_LABEL_GROUPS.values()))
PLATFORM_LABELS = generate_labels(
all_platform_label_ids,
PLATFORM_LABEL_GROUPS,
PLATFORM_PREFIX,
"#bfd4f2",
)
"""Maps all platform names to their labels."""
# Force sorting of labels.
LABELS = sorted(LABELS, key=lambda i: str.casefold(i[0]))
[docs]
def write_labels():
"""Write down labels into JSON file."""
json_file = (
Path(__file__)
.parent.joinpath("../.github/labels-extra.json")
.resolve(strict=True)
)
# Debug messages.
for label_name, _, _ in LABELS:
print(f"Generated label: {label_name}")
print(f"{len(LABELS)} labels generated.")
print(f"Saving to: {json_file}")
# Save to json definition file.
label_defs = [
dict(zip(["name", "color", "description"], label)) for label in LABELS
]
json_file.write_text(
json.dumps(
label_defs,
indent=2,
separators=(",", ": "),
ensure_ascii=False,
),
)