Contesto della riga per i link GitHub in onebox

Supporto
1

Se viene specificata una singola riga per un link GitHub, onebox mostra quella riga con il contesto:

https://github.com/guildai/guildai/blob/master/examples/get-started/mnist_mlp.py#L16

Se vengono specificate più righe, onebox le mostra senza contesto:

https://github.com/guildai/guildai/blob/master/examples/get-started/mnist_mlp.py#L16-L18

Capisco la logica alla base di questa differenza. Tuttavia, vorrei mostrare il contesto anche per l’intervallo di righe. Esiste qualche trucco particolare per farlo?

Inoltre, è possibile configurare il numero di righe di contesto visualizzate?

2

Immagino dipenda da quante righe stai specificando (5? 500?), ma concordo che sia un po’ incoerente.

3

Al momento non è configurabile. Mi chiedo però: a cosa serve il contesto se puoi semplicemente richiedere L12-L20?

È un po’ come due richieste di funzionalità in una :slight_smile: Immagino tu voglia “evidenziare” le righe e poi aggiungere il contesto intorno? Immagino che possa essere utile per una selezione di 2-5 righe, ma un enorme blocco giallo risulterebbe piuttosto invadente.

4

In questo caso, accompagno il lettore attraverso una serie di modifiche apportate a un file. Il contesto è importante in ogni caso, sia che io stia evidenziando una riga o molte.

Il componente evidenzia già una riga con contesto. Il caso che ho qui vorrebbe applicare lo stesso comportamento a più righe.

Riconosco la logica dello schema attuale, ma ritengo che ci siano solide ragioni per supportare anche evidenziazioni multi-riga con contesto.

Se Onebox non è già configurabile oltre al link stesso, dovrebbe esserlo. Forse qualcosa del genere?

<span
  data-onebox-highlight="true"
  data-onebox-context="5"
  >https://github.com/.../get-started/mnist_mlp.py#L16-L18</span>

Non c’è molto di nuovo qui, oltre alla configurazione di ciò che il componente formatta e visualizza.

In modo ingenuo, sembra che si tratti di una modifica solo lato backend. Considera le differenze tra queste due risposte onebox.json:

Come ci si potrebbe aspettare, una ha il contesto con una riga highlight e l’altra no.

Se il backend fosse configurabile per richiesta, si tratterebbe di applicare le regole di formattazione esistenti. Vedo che l’implementazione presuppone una riga da evidenziare. La modifica per supportare un intervallo di righe è minima (ad esempio, utilizzare un array di righe da evidenziare e verificare l’appartenenza).

5

Forse qualcosa del genere potrebbe funzionare in questi casi, se si tratta di casi completamente anomali; il problema è che entra in conflitto con GitHub, il che non è ideale.

https://github.com/.../get-started/mnist_mlp.py?#L16-L18-context-3

O forse si potrebbe semplicemente includere il contesto di default se la regione è di 4 righe o meno.

6

Personalmente eviterei un comportamento implicito. Ho già un esempio che ne evidenzia cinque righe :slight_smile:

Ho implementato una soluzione alternativa che utilizza un componente tema alla ricerca di un div contenitore con la configurazione per il link GitHub avvolto. Il componente attende l’evento di modifica del DOM per sapere quando il link viene sostituito con le righe di codice, quindi opera sullo stato li.selected per la selezione. Questo trucco non modifica le righe recuperate, quindi non può aggiungere o rimuovere contesto.

Penso che un metodo esplicito per controllare il comportamento sia meglio rispetto al modificare i valori predefiniti o cercare di rendere il componente più intelligente.

Trasmettere la configurazione/impostazioni direttamente nell’URL potrebbe funzionare, ma mina il significato semantico del link. Se non è possibile utilizzare un tag di avvolgimento, suppongo che vorresti almeno rimuovere la configurazione specifica per la onebox.