Tri titre alphabétique dans catégorie

[satonotdead]

Je partage simplement une solution que j’utilisais depuis quelques semaines :

@satonotdead

J’ai fini par utiliser un composant de thème personnalisé pour cela :

// A-Z nécessite toute la catégorie : le cœur ne peut pas trier une liste de sujets par titre
// (TopicQuery::SORTABLE_MAPPING n'a pas de "title"), donc nous épuisons la liste paginée
// avant le tri. Limité — les catégories de documentation sont petites ; pour tout ce qui est plus grand, on retombe sur
// le tri de ce qui est chargé, ce que le MutationObserver ci-dessous maintient à jour.
// ponytail : supprimez cette boucle entière si le cœur fournit un jour un tri par titre côté serveur.
const MAX_DOC_PAGES = 12; // ~360 sujets à 30 par page
let docLoadRun = 0;

async function loadAllDocTopics(api) {
  const run = ++docLoadRun;

  // `controller:discovery/topics` est déprécié dans les versions actuelles de Discourse
  // (id de dépréciation : discourse.discovery-topics-controller). La découverte utilise désormais un
  // contrôleur dédié par filtre ; les catégories de documentation sont toujours la liste des sujets les plus récents,
  // donc nous cherchons directement ce contrôleur. Échouer ici signifie simplement que nous trions
  // la première page, donc chaque étape est chaînée en optionnel.
  const list = api.container.lookup("controller:discovery/latest")?.model;
  if (!list?.loadMore) {
    return;
  }

  for (let page = 0; page < MAX_DOC_PAGES; page++) {
    if (!list.more_topics_url) {
      return;
    }

    const before = list.topics?.length ?? 0;
    await list.loadMore();

    // Navigation ailleurs pendant le chargement, ou la liste a cessé de croître — dans les deux cas, on arrête.
    if (run !== docLoadRun || (list.topics?.length ?? 0) === before) {
      return;
    }
  }
}

// Trie la liste des sujets de la documentation de A à Z, en collationnant avec la langue de la page <html lang>.
let docSortObservers = new Map();

function docSortLocale() {
  const lang = document.documentElement.lang;
  if (!lang) {
    return undefined;
  }

  try {
    Intl.getCanonicalLocales(lang); // lève une RangeError pour une étiquette malformée
    return lang;
  } catch {
    return undefined; // retombe sur la langue par défaut du navigateur
  }
}

function sortDocTopicList(body, locale) {
  const rows = [...body.querySelectorAll(":scope > .topic-list-item")];
  if (rows.length < 2) {
    return;
  }

  const sorted = [...rows].sort((a, b) => {
    const titleA = a.querySelector(".title")?.textContent.trim() ?? "";
    const titleB = b.querySelector(".title")?.textContent.trim() ?? "";
    return titleA.localeCompare(titleB, locale);
  });

  if (sorted.every((row, i) => rows[i] === row)) {
    return; // déjà trié — empêche l'observateur de se réinjecter lui-même
  }

  // Insère avant ce qui suit les lignes, en gardant le sentinelle de chargement plus en dernier.
  const anchor = rows[rows.length - 1].nextSibling;

  // Épingler la première ligne visible pour que les insertions au-dessus ne fassent pas sauter le défilement.
  const pinned = rows.find((row) => row.getBoundingClientRect().bottom > 0);
  const pinnedTop = pinned?.getBoundingClientRect().top;

  // Observateur en pause pour que nos propres déplacements ne réactivent pas cette fonction.
  const observer = docSortObservers.get(body);
  observer?.disconnect();
  sorted.forEach((row) => body.insertBefore(row, anchor));
  observer?.observe(body, { childList: true });

  if (pinned) {
    window.scrollBy(0, pinned.getBoundingClientRect().top - pinnedTop);
  }
}

function sortDocCategoryTopicLists() {
  docSortObservers.forEach((observer) => observer.disconnect());
  docSortObservers = new Map();

  const locale = docSortLocale();

  // Ce n'est pas un conteneur flex/grid, donc le réordonnancement doit déplacer les nœuds DOM — CSS `order` est ignoré.
  document.querySelectorAll(".topic-list.doc-simple-mode .topic-list-body").forEach((body) => {
    // try/finally pour que la liste soit toujours révélée même si le tri lève une exception.
    try {
      sortDocTopicList(body, locale);
    } finally {
      body.classList.add("docs-sorted");
    }

    // Trier seulement une fois que le chargement est calme — le réordonnancement pendant le chargement bloquait le chargeur.
    let settleTimer = null;
    const observer = new MutationObserver(() => {
      window.clearTimeout(settleTimer);
      settleTimer = window.setTimeout(() => {
        sortDocTopicList(body, locale);
      }, 400);
    });
    observer.observe(body, { childList: true });
    docSortObservers.set(body, observer);
  });
}

Je pense que le code peut très probablement être amélioré, j’accepte volontiers des suggestions et/ou des PR.