Molto spesso scegliamo un plugin di jQuery nel bel mezzo dello sviluppo di un progetto perché il cliente ci chiama e ci chiede di aggiungere l'effetto X al sito. In seguito ci accorgiamo che il plugin da noi scelto manca di alcune funzionalità o che non è possibile fargli eseguire delle routine che deviano leggermente dalle specifiche con le quali è stato creato. In questo post cercherà di fornire delle indicazioni di massima per potersi orientare nella scelta di un plugin basandomi sulla mia esperienza e sui tanti (troppi!) errori da me commessi.
Funzionalità
Un plugin jQuery dovrebbe non solo avere le funzionalità che ci interessano, ma anche contemplare la possibilità di poter usufruire di queste funzionalità in modo diverso a seconda del tipo di progetto da noi sviluppato. In altre parole, non conta solo cosa fa un plugin, ma anche come lo fa.
Per esempio, esistono moltissimi plugin per Twitter, ma solo pochi permettono di gestire completamente i dati restituiti dal feed JSON di Twitter. Alcuni non formattano i link testuali (trasformandoli cioè in link HTML), altri non gestiscono le date e così via.
Occorre sempre considerare attentamente le funzionalità di un plugin per poter non solo usufruirne nel presente, ma anche per pianificarne un uso diverso nel futuro. Per esempio, oggi mi serve che i link di Twitter siano trasformati in elementi <a>, domani vorrei gestire le date in formato gg/mm/aaaa o sapere quanto tempo è passato dall'ultimo tweet.
Flessibilità
Un plugin lavora sugli elementi HTML presenti nell'albero DOM del documento. Un plugin flessibile è un plugin che ci permette di usare più tipi di elementi. Per esempio, se scegliamo di creare uno slideshow di immagini, vorremmo poter essere in grado di usare sia dei semplici div che delle liste non ordinate (ul).
Un plugin flessibile dovrebbe contemplare almeno due casi di utilizzo della marcatura. Questo perché molto spesso noi lavoriamo sulla marcatura scelta da chi implementa la parte lato server, e quindi il nostro codice jQuery si deve adattare alle scelte fatte da chi sviluppa il sistema di template del sito. Ovviamente se siamo noi a gestire anche questa parte il problema non si pone, ma resta comunque qualcosa da considerare con attenzione.
Documentazione
Un plugin dovrebbe essere ben documentato. Un plugin ben documentato non è semplicemente un plugin che elenca le opzioni del plugin con i relativi valori di default, ma soprattutto è un plugin che fornisce per ogni opzione (o gruppo di opzioni) una pagina di esempio (o più esempi) da consultare.
Un plugin mal documentato è un plugin da evitare. Questo perché una carenza di documentazione ci costringe a dover perdere del tempo prima di riuscire finalmente a far funzionare il plugin nel modo voluto. Un esempio è il plugin scrollTo, sicuramente molto potente, ma che richiede un certo periodo di tempo prima di poter ottenere i risultati sperati.
Questo perché il plugin fornisce solo una pagina di esempio in cui vengono messe insieme tutte le opzioni possibili e alcuni esempi di sintassi nei commenti JavaScript del sorgente. In realtà le pagine di esempio dovrebbero essere più d'una e soprattutto dovrebbero essere atomiche, nel senso che è inutile mettere tutto insieme perchè così facendo si confonde l'utente del plugin.
Il codice jQuery andrebbe inserito nella pagina di esempio, senza dover costringere l'utente a visualizzare il sorgente della pagina (altro tempo perso). Soprattutto, la documentazione dovrebbe essere dettagliata, contemplando non solo i casi base di utilizzo, ma anche quelli più complessi e avanzati.