Tjek JavaScript-filer ES version mod en specificeret ES version 🏆
ES Check kontrollerer JavaScript-filer mod en bestemt version af ECMAScript (ES) med en shell-kommando. Hvis en bestemt fils ES-version ikke stemmer overens med ES-versionsargumentet, der er bestået i kommandoen ES Check, kaster ES Check en fejl og logger de filer, der ikke matchede kontrollen.
det er vigtigt at sikre, at JavaScript-filer kan bestå ES-kontrol i en modulopbygget og samlet verden. Læs mere om hvorfor.
kom i gang hvorfor es Check? Brug gå gennem API Debugging bidragende problemer
kom i gang
installere
npm i es-check --save-dev # locallynpm i es-check -g # or globally
Kontroller, om et array eller et antal filer matcher en specificeret ES-version.
- Bemærk: tilføjer citat omkring globs. Globs er mønstre som sådan,
<something>/*.js
.
es-check es5 './vendor/js/*.js' './dist/**/*.js'
- es Check script (ovenfor) kontrollerer
/dist/*.js
filer for at se, om de er ES5. Det kaster en fejl og logfiler filer er, der ikke passerer checken.
hvorfor es kontrollere?
i moderne JavaScript-builds samles filer, så de kan serveres på en optimeret måde. Det antages af udviklere, at fremtidig JavaScript-lignende ES8 vil blive transpileret (ændret fra fremtidig JavaScript til nuværende JavaScript) korrekt af et værktøj som Babel. Nogle gange er der et problem, hvor filer ikke transpileres. Der var ingen effektiv måde at teste for filer, der ikke blev transpileret—indtil nu. Det er hvad ES Check gør.
gå igennem
billederne nedenfor viser kommandolinjeskripter og deres tilsvarende loggede resultater.
Pass
Fail
ES Check køres ovenfor med node kommandoer. Det kan også køres inden npm scripts, ci værktøjer eller test suiter.
API
ES Check giver fornødenheder. Det accepterer sin plads som en JavaScript matcher/tester.
generel Information
# USAGEindex.js es-check <ecmaVersion>
argumenter
<ecmaVersion> 'define the ECMAScript version to check for against a glob of JavaScript files' required 'a glob of files to test the ECMAScript version against' required
indstillinger
moduler Flag
--module use ES modules, default false
Tillad Hash Bang
--allow-hash-bang supports files that start with hash bang, default false
ikke
--not=folderName1,folderName2 An array of file/folder names or globs that you would like to ignore. Defaults to ``.
globale muligheder
-h, --help Display help-V, --version Display version--no-color Disable colors--quiet Quiet mode - only displays warn and error messages-v, --verbose Verbose mode - will also output debug messages
anvendelse
ES Check er en shell kommando CLI. Det køres i shell Værktøj som Terminal, ITerm eller Hyper. Det tager i to argumenter: en ECMAScript version (<ECMAScript version>
) og filer () i globs.
her er nogle eksempler på es check scripts, der kunne køres:
# globses-check ./js/*.js# array of argumentses-check ./js/*.js ./dist/*.js
konfiguration
hvis du bruger en ensartet konfiguration, kan du oprette en .escheckrc
fil i JSON-format med argumenterne ecmaVersion
og files
, så du nemt kan køre es-check
standalone fra kommandolinjen.
her er et eksempel på, hvordan en .escheckrc
fil vil se ud:
{ "ecmaVersion": "es6", "module": false, "files": "./dist/**/*.js", "not": }
⚠️ Bemærk: Brug af kommandolinjeargumenter, mens der er en .escheckrc
– fil i projektmappen, tilsidesætter konfigurationsværdierne i .escheckrc
.
Debugging
fra ES-Check version 2.0.2, en bedre debugging grænseflade er tilvejebragt. Når en fil fejl, vil en fejl objekt logges med:
- fejlen
- fejlen
- fejlstakken
⚠️ Bemærk: fejllogfiler er fra Acorn-parseren, mens du analyserer JavaScript relateret til specifikke versioner af ECMAScript. Dette betyder, at fejlmeddelelser ikke er specifikke for ECMAScript-versionen. Det tilbyder stadig kontekst i parsing spørgsmål!
anerkendelser
ES Check er et lille værktøj, der bruger kraftfulde værktøjer, som Isaac Schlueter, Marijn Haverbeke og Matthias Etienne byggede. ES Checker af Ruan YiFeng kontrollerer JavaScript-versionen understøttes inden for en bro.ser på kørselstidspunktet. ES Check tilbyder lignende feedback til ES Checker, men på byggetid og er specifik for det produkt, der bruger det. ES Check blev startet efter at have læst dette indlæg om af Philip Valton.
bidragende
ES Check har 3 hovedafhængigheder: acorn, glob og caporal. For at bidrage skal du indsende et problem eller indsende en pull-anmodning.
Contributors
- Jon Ong
- Suhas Karanth
- Ben Junya
- Jeff Bartsevski
- Brandon Casey