De ce aveți nevoie de cod Sniffers pentru dezvoltarea web

Optimizarea codului este comparabilă cu faza de editare a unei scrieri. Este posibil să fie necesar mai întâi să obțineți ideile în cod, dar codul dvs. ar trebui să fie optimizat cu instrumente cum ar fi sniffers de cod pentru a produce cel mai bun produs posibil.

Sniffingul de cod este un termen care descrie verificarea conformității cu standardele de reglementare. Aceste regulamente ar putea specifica numărul de spații pe care să le folosească pentru indentare, plasarea coaselor curbate sau cum să numești variabilele. Standardele nu sunt vitale pentru a construi o aplicație web, dar standardele sunt importante pentru consistența internă și întreținerea codurilor.

Acesta este locul unde sniffing-ul de cod vine la îndemână pentru toți dezvoltatorii, frontend pentru backend. mi-ar placea examinați procesul de sniffing de cod și să oferiți unii utilitare care ajută la analizarea standardelor de cod.

Ce este sniffing codul?

Acțiunea de sniffing de cod este de obicei automată la economisiți timp și reduceți erorile. Codul de sniffers va verificați codurile sursă pentru respectarea standardelor stabilite de echipe de dezvoltare interne sau de organisme de reglementare.

Sniffingul de coduri este similar cu codul de lingușire, dar mai pedant. Linting în primul rând verifică erorile și erorile de sintaxă în timp ce sniffing caută problemele în este scris codul. Un fișier PHP poate funcționa corect, dar va eșua un test de snifare a codului dacă un nume de variabilă nu respectă standardele (de ex. $ myVariable vs $ my_variable).

O terminologie similară este mirosul de cod care verifică defectele de proiectare în codul care poate duce la bug-uri mai mari. Aceasta se referă la standardele de cod, dar include și ele arhitecturi de nivel superior pentru scrierea de coduri omogene.

Toate aceste zone sunt în valoare de acoperire și sunt relevante pentru sniffing cod. Doar ține minte codul ăla nu va găsi întotdeauna bug-uri runtime deoarece prioritatea este menținând respectarea strictă a standardelor.

Până acum s-ar putea să te întrebi dacă e vorba de standarde? Adevărul este că ele contează, dar mai mult pentru optimizare și curățarea proiectelor. Mulți dezvoltatori sunt de acord că standardele sunt vitale pentru programarea și dezvoltarea web - în special pentru proiectele mari de echipe.

Iată un citat din partea dezvoltatorului Paul Jones, care explică de ce sunt folositoare standardele de cod.

“Punctul unui standard de stil de codare nu este acela de a spune că un stil este în mod obiectiv mai bun decât altul ... În schimb, punctul este acela de a stabili așteptări cunoscute privind modul în care codul va arăta.”

Dacă construiți un mic webapp pentru dvs., este posibil să nu merită să vă petreceți timp pe standardele WCAG 2.0 sau PSR-2. Dar ia în considerare sutele de dezvoltatori care lucrează la codul sursă al Adobe Photoshop. Ar fi haotic dacă fiecare persoană și-a scris propriul stil și le-a combinat.

Deși echipele se bazează în mare măsură pe standarde, aceste reguli pot fi totuși utile dezvoltatorilor singuri. Puteți găsi standarde de cod pentru tot, de la CSS la WordPress, astfel încât nu există nicio scuză pentru a nu încerca să vedeți dacă calitatea codului dvs. se îmbunătățește.

Valoarea standardelor de cod

Standardele vor fi în mod natural țineți codul curat și organizat. Dezvoltatorii știu exact cum să scrie cod și cum să urmeze împreună cu munca celuilalt.

Standardele de cod contribuie, de asemenea, la dezvoltarea open source, oferind reguli pe care ceilalți trebuie să le urmeze. Fișierele pot fi preluate de oricine luni sau ani mai târziu și pot fi ușor de citit.

Un stil strict de codificare este o idee bună chiar dacă alegeți să vă creați propria dvs.. Acest lucru necesită mult efort, dar, pe măsură ce proiectele cresc, acest tip de documentație este de neprețuit.

Iată câteva standarde de codare pentru a lua în considerare faptul că acoperă gama de diferite limbi web.

• Codurile de codare PEAR (PHP)
• Standardele Google pentru HTML / CSS
• Standardele Google pentru JavaScript
• Stilul de codificare Django (Python)
• Ghid de stil Rails (Ruby)
• WCAG 2.0 (UX)

Cele mai bune resurse de sniffing de cod

Acum este posibil să găsiți coduri gratuite de sniffers pentru orice, de la HTML / CSS la limbi de backend cum ar fi PHP și SQL. Este posibil să nu fi nevoie să utilizați aceste sniffers sau să urmați standardele pentru fiecare limbă, dar merită investigat posibilitățile de a vedea ce ar putea îmbunătăți performanța.

Cadouri de cod Sniffers

Deși HTML nu nevoie un sniffer de cod care nu a împiedicat Squiz să construiască unul. Este complet open source și găzduiește pe GitHub cu opțiunile de copiere / inserare a codului în browser sau de salvare a unui marcaj pentru a rula pe pagini web individuale.

Această verificare controlează cele trei niveluri ale standardelor de accesibilitate A, AA și AAA de la WCAG, împreună cu secțiunea 508, care se aplică în principal pe site-urile guvernului.

Dezvoltatorii CSS ar putea plăcea acest sniffer gratuit pentru codul CSS, care este, de asemenea, open source, găzduit prin Node Package Manager.

utilizatorii jQuery ar trebui să verifice JSCodeSniffer construit de Dmitry Sheiko. Acesta este un alt webapp gratuit găzduit pe GitHub care respectă ghidul de stil cod al jQuery.

În mod alternativ, vă recomandăm să încercați să vă lămâieți codul JS cu JavaScript Lint sau JS Lint. Aceste instrumente verifică erorile în sintaxă, mai degrabă decât standardele de cod, dar sunt, de asemenea, foarte utile atunci când vine vorba de optimizarea codului frontend.

Pentru înregistrare este de asemenea posibil să verificați standardele JS / CSS direct cu PHP_CodeSniffer.

Codul Sniffer PHP

PHP_CodeSniffer este un instrument care trebuie să aibă în toolbelt-ul dvs. dacă doriți să respectați standardele de cod PHP. Pachetul conține câteva Script-uri PHP care analizează codul PHP, JS și CSS pentru conformitate cu alegerea documentației stilului de cod.

Creatorul PHP_CodeSniffer Greg Sherwood a scris o poveste minunată despre modul în care a venit ideea și despre problemele pe care încearcă să le rezolve (merită să citești dacă ai timp).

În concluzie, Greg lucra cu o echipă de învățare a JavaScript construită într-o aplicație PHP. Scopul lor a fost să structureze JS într-un mod care să respecte standardele de cod ale PHP pentru a face viața mai ușoară schimbarea înainte și înapoi. Astfel sa născut PHP_CodeSniffer.

Acest lucru este grozav pentru dezvoltatorii PHP pentru că limba este foarte slabă, cu cerințe de stil obligatoriu. Cadrele precum Laravel sunt mai stricte, însă dezvoltatorii pot (și ar trebui) să-și configureze propriile standarde de cod fără a se baza pe un cadru terț.

Diferite standarde precum PSR-0, PSR-1 și PSR-2 sunt toate populare și sunt împachetate cu biblioteca sniffing PHP.

Dar puteți găsi o mulțime de alte standarde de cod pre-fabricate pentru PHP CMS 'cum ar fi WordPress, Magento și Drupal. Dezvoltatorii de pe nucleul Drupal au lansat chiar și un modul oficial codificat codificat Coder.

PHP este, fără îndoială, cea mai ușoară limbă de optimizat cu sniffers de cod. Dacă căutați o listă de standarde de cod PHP verificați această intrare GitHub.

Alte sniffers cod de backend

Dezvoltatorii de backend lucrează cu o varietate de limbi dincolo de PHP, iar numerele cresc în fiecare an. Cu alte limbi, avem și alte biblioteci de sniffing de cod, cum ar fi cod-sniffer pentru Python.

Este posibil să verificați alte script-uri online sau să folosiți instrumente precum PyLint. Dar aceasta este o altă metodologie care necesită răbdare să lucreze în fluxul de dezvoltare.

Ruby devs au, de asemenea, o serie de opțiuni atunci când vine vorba codificarea și analizarea codurilor. Cele mai bune sunt întotdeauna gratuite și open source, cum ar fi Ruby Lint, un analizor de coduri statice construit pentru codul Ruby modern.

Am găsit încă un cod dedicat Node.js, dar sper că un proiect va apărea cu timpul. Există sniffere de cod JS care suportă standardele Node, dar este încă o limbă de backend mai nouă și necesită timp pentru a crește.

În sfârșit, avem o sintaxă SQL folosită pentru baze de date. Acest cod poate fi mai dificil, deoarece este dificil să găsiți standarde de sintaxă bine susținute pentru codul sursă SQL. Dar am găsit un webapp de formatare SQL care ar trebui să se dovedească extraordinar de util atunci când se optimizează interogările bazei de date.

Învelire

Cel mai bun loc pentru a începe sniffing cod este cu o limbă și un standard. HTML / CSS este un loc ușor de pornit pentru dezvoltatorii de frontend, în timp ce PHP este adesea o alegere preferată printre dezvoltatorii backend (în special WordPress devs).

Și dacă doriți să aflați mai multe, verificați aceste postări legate de codul de sniffing, linging și analiza automatizată a codului pentru optimizare.

• De ce aveți nevoie de standarde de codificare
• Cod Miroase de Jeff Atwood
• PHP Code Sniffer: Instalare și configurare
• Introducere în CodeSniffer (Partea 1)
• Prezentare GitHub: Lintere cu cod curat