Cos'è la convenzione di denominazione del nome file javascript? [chiuso]

I file devono essere denominati qualcosa-con-hyphens.js, camelCased.js o qualcos'altro?

Non ho trovato la risposta a questa domanda qui .

Una possibile convenzione di denominazione consiste nell'utilizzare qualcosa di simile allo schema di denominazione utilizzato da jQuery. Non è universalmente adottato ma è abbastanza comune.

product-name.plugin-ver.sion.filetype.js

dove la coppia product-name+ pluginpuò anche rappresentare uno spazio dei nomi e un modulo . Il versionefiletype di solito sono opzionali.

filetypepuò essere qualcosa rispetto a come è il contenuto del file. Spesso visti sono:

• min per file minimizzati
• custom per file personalizzati o modificati

Esempi:

• jquery-1.4.2.min.js
• jquery.plugin-0.1.js
• myapp.invoice.js

Non sono a conoscenza di alcuna convenzione particolare per i file javascript in quanto non sono davvero unici sul Web rispetto ai file CSS o file HTML o qualsiasi altro tipo di file come quello. Ci sono alcune cose "sicure" che puoi fare che rendono meno probabile che ti imbatterai accidentalmente in un problema multipiattaforma:

1. Usa tutti i nomi di file minuscoli. Esistono alcuni sistemi operativi che non fanno distinzione tra maiuscole e minuscole per i nomi dei file e l'uso di tutte le lettere minuscole impedisce inavvertitamente l'uso di due file che differiscono solo nel caso in cui potrebbero non funzionare su alcuni sistemi operativi.
2. Non utilizzare spazi nel nome file. Mentre questo può essere tecnicamente fatto funzionare, ci sono molte ragioni per cui gli spazi nei nomi dei file possono causare problemi.
3. Un trattino è OK per un separatore di parole. Se si desidera utilizzare una sorta di separatore per più parole anziché uno spazio o una camelcase come in various-scripts.js, un trattino è un separatore sicuro, utile e comunemente usato.
4. Pensa all'utilizzo dei numeri di versione nei nomi dei file. Quando si desidera aggiornare gli script, pianificare gli effetti della cache del browser o della CDN. Il modo più semplice di utilizzare la memorizzazione nella cache a lungo termine (per velocità ed efficienza), ma aggiornamenti immediati e sicuri quando si aggiorna un file JS è includere un numero di versione nel nome file o percorso distribuito (come jQuery fa con jquery-1.6.2.js ), quindi si esegue il bump / modifica del numero di versione ogni volta che si aggiorna / modifica il file. Ciò garantirà che nessuna pagina che richiede la versione più recente sia mai stata pubblicata da una cache.

Non esiste una convenzione ufficiale, universale , per la denominazione dei file JavaScript.

Ci sono alcune varie opzioni:

• scriptName.js
• script-name.js
• script_name.js

sono tutte le convenzioni di denominazione validi, però io preferisco il jQuery suggerito convenzione di denominazione (per i plugin jQuery, anche se funziona per qualsiasi JS)

• jquery.pluginname.js

Il bello di questa convenzione di denominazione è che descrive esplicitamente l'inquinamento dello spazio dei nomi globale che viene aggiunto.

• foo.js Aggiunge window.foo
• foo.bar.js Aggiunge window.foo.bar

Perché ho lasciato fuori il controllo delle versioni: dovrebbe venire dopo il nome completo, preferibilmente separato da un trattino, con punti tra le versioni principali e secondarie:

• foo-1.2.1.js
• foo-1.2.2.js
• ...
• foo-2.1.24.js

La domanda nel link che hai dato parla della denominazione delle variabili JavaScript, non della denominazione dei file, quindi dimentica quello per il contesto in cui fai la tua domanda.

Per quanto riguarda la denominazione dei file, è puramente una questione di preferenze e gusti. Preferisco nominare i file con trattini perché non devo raggiungere il tasto Maiusc, come faccio quando ho a che fare con i nomi dei file camelCase; e poiché non devo preoccuparmi delle differenze tra i nomi dei file Windows e Linux (i nomi dei file Windows non fanno distinzione tra maiuscole e minuscole, almeno tramite XP).

Quindi la risposta, come tante, è "dipende" o "dipende da te".

L'unica regola da seguire è quella di essere coerenti con la convenzione scelta.

Preferisco generalmente trattini con lettere minuscole, ma una cosa non ancora menzionata è che a volte è bello che il nome del file corrisponda esattamente al nome di un singolo modulo o funzione istantanea contenuta all'interno.

Ad esempio, ho un modulo rivelatore dichiarato var knockoutUtilityModule = function() {...}all'interno del suo file chiamato knockoutUtilityModule.js, anche se oggettivamente preferisco knockout-utility-module.js.

Allo stesso modo, dal momento che sto usando un meccanismo di raggruppamento per combinare gli script, ho preso la definizione di funzioni istanziabili (modelli di vista con modelli ecc.) Ciascuno nel proprio file, stile C #, per manutenibilità. Ad esempio, ProductDescriptorViewModel vive da solo all'interno di ProductDescriptorViewModel.js (utilizzo maiuscole per funzioni istantanee).