Jest CLI Options
Comanda jest
are mai multe opţiuni utile. Puteţi executa jest --help
pentru a vizualiza toate opţiunile disponibile. De asemenea, multe dintre opţiunile de mai jos pot fi folosite împreună, pentru a rula testele exact aşa cum doriţi. Fiecare dintre opţiunile de configurare Jest pot fi specificate, de asemenea, prin intermediul CLI.
Aici este o scurtă prezentare:
Rularea din linia de comandă
Execută toate testele (implicit):
jest
Execută doar testele care s-au specificat cu un model sau cu un nume de fişier:
jest my-test #or
jest path/to/my-test.js
Execută testele legate de fişierele modificate în hg/git (fişiere pentru care nu s-a facut commit):
jest -o
Execută testele legate de fișierele path/to/fileA.js
şi path/to/fileB.js
:
jest --findRelatedTests path/to/fileA.js path/to/fileB.js
Execută teste care se potrivesc cu acest nume (caută în textele din blocurile describe
sau test
).
jest -t name-of-spec
Execută în mod de veghe:
jest --watch #runs jest -o by default
jest --watchAll #runs all tests
Modul de veghe permite să specificaţi numele sau calea către un fișier pentru a vă concentra pe un anumit set de teste.
Using with yarn
If you run Jest via yarn test
, you can pass the command line arguments directly as Jest arguments.
Instead of:
jest -u -t="ColorPicker"
puteţi scrie:
yarn test -u -t="ColorPicker"
Folosind script-uri npm
If you run Jest via npm test
, you can still use the command line arguments by inserting a --
between npm test
and the Jest arguments.
Instead of:
jest -u -t="ColorPicker"
puteţi scrie:
npm test -- -u -t="ColorPicker"
Camelcase & dashed args support
Jest supports both camelcase and dashed arg formats. The following examples will have an equal result:
jest --collect-coverage
jest --collectCoverage
Arguments can also be mixed:
jest --update-snapshot --detectOpenHandles
Opțiuni
Note: CLI options take precedence over values from the Configuration.
jest <regexForTestFiles>
--bail
--cache
--changedFilesWithAncestor
--changedSince
--ci
--clearCache
--collectCoverageFrom=<glob>
--colors
--config=<path>
--coverage[=<boolean>]
--coverageProvider=<provider>
--debug
--detectOpenHandles
--env=<environment>
--errorOnDeprecated
--expand
--findRelatedTests <spaceSeparatedListOfSourceFiles>
--forceExit
--help
--init
--injectGlobals
--json
--outputFile=<filename>
--lastCommit
--listTests
--logHeapUsage
--maxConcurrency=<num>
--maxWorkers=<num>|<string>
--noStackTrace
--notify
--onlyChanged
--passWithNoTests
--projects <path1> ... <pathN>
--reporters
--roots
--runInBand
--selectProjects <project1> ... <projectN>
--runTestsByPath
--setupTestFrameworkScriptFile=<file>
--showConfig
--silent
--testNamePattern=<regex>
--testLocationInResults
--testPathPattern=<regex>
--testPathIgnorePatterns=[array]
--testRunner=<path>
--testSequencer=<path>
--testTimeout=<number>
--updateSnapshot
--useStderr
--verbose
--version
--watch
--watchAll
--watchman
Referințe
jest <regexForTestFiles>
Când executaţi jest
cu un argument, el este tratat ca o expresie regulată pentru a căuta fișierele din proiect. Este posibilă rularea testelor prin furnizarea unui tipar. Numai fişierele care se potrivesc tiparului vor fi preluate şi executate. Depending on your terminal, you may need to quote this argument: jest "my.*(complex)?pattern"
. On Windows, you will need to use /
as a path separator or escape \
as \
.
--bail
Alias: -b
. Exit the test suite immediately upon n
number of failing test suite. Defaults to 1
.
--cache
Dacă se utilizează memoria cache. Setarea implicită este true. Se poate dezactiva cache-ul folosind --no-cache
. Notă: cache-ul ar trebui dezactivat numai dacă vă confruntaţi cu probleme legate de caching. În medie, dezactivarea cache-ul face ca Jest să fie de cel puţin două ori mai lent.
If you want to inspect the cache, use --showConfig
and look at the cacheDirectory
value. If you need to clear the cache, use --clearCache
.
--changedFilesWithAncestor
Runs tests related to the current changes and the changes made in the last commit. Behaves similarly to --onlyChanged
.
--changedSince
Runs tests related to the changes since the provided branch or commit hash. If the current branch has diverged from the given branch, then only changes made locally will be tested. Behaves similarly to --onlyChanged
.
--ci
Când această opţiune este folosită, Jest va presupune că se execută într-un mediu de CI. Acest lucru schimbă comportamentul atunci când un nouă imagine instantaneu este întâlnită. În locul comportamentului normal de a stoca automat un nou instantaneu, acesta va eşua testul şi va cere ca Jest să fie executat cu --updateSnapshot
.
--clearCache
Deletes the Jest cache directory and then exits without running tests. Will delete cacheDirectory
if the option is passed, or Jest's default cache directory. The default cache directory can be found by calling jest --showConfig
. Note: clearing the cache will reduce performance.
--collectCoverageFrom=<glob>
A glob pattern relative to rootDir
matching the files that coverage info needs to be collected from.
--colors
Forţează afișarea rezultatelor testelor să fie colorate chiar dacă stdout nu este un TTY.
--config=<path>
Alias: -c
. The path to a Jest config file specifying how to find and execute tests. If no rootDir
is set in the config, the directory containing the config file is assumed to be the rootDir
for the project. Acest lucru poate fi, de asemenea, o valoare codificată JSON pe care Jest o va folosi pe post de configurare.
--coverage[=<boolean>]
Alias: --collectCoverage
. Indică faptul că informaţiile de acoperire a codului vor fi colectate și afișate. Optionally pass <boolean>
to override option set in configuration.
--coverageProvider=<provider>
Indicates which provider should be used to instrument code for coverage. Allowed values are babel
(default) or v8
.
Note that using v8
is considered experimental. This uses V8's builtin code coverage rather than one based on Babel. It is not as well tested, and it has also improved in the last few releases of Node. Using the latest versions of node (v14 at the time of this writing) will yield better results.
--debug
Print debugging info about your Jest config.
--detectOpenHandles
Attempt to collect and print open handles preventing Jest from exiting cleanly. Use this in cases where you need to use --forceExit
in order for Jest to exit to potentially track down the reason. This implies --runInBand
, making tests run serially. Implemented using async_hooks
. This option has a significant performance penalty and should only be used for debugging.
--env=<environment>
Mediul de testare utilizat pentru toate testele. Acest lucru poate indica orice fişier sau modul node. Exemple: jsdom
, node
sau path/to/my-environment.js
.
--errorOnDeprecated
Make calling deprecated APIs throw helpful error messages. Useful for easing the upgrade process.
--expand
Alias: -e
. Folosiţi acest indicator pentru a afișa diff-uri şi erori complete în locul unui patch.
--findRelatedTests <spaceSeparatedListOfSourceFiles>
Find and run the tests that cover a space separated list of source files that were passed in as arguments. Useful for pre-commit hook integration to run the minimal amount of tests necessary. Can be used together with --coverage
to include a test coverage for the source files, no duplicate --collectCoverageFrom
arguments needed.
--forceExit
Forţează ieșirea din Jest după ce toate testele și-au finalizat rularea. Acest lucru este util atunci când resursele setate din codul de test nu pot fi curăţate în mod adecvat. Notă: această funcționalitate este o soluție de evadare. Dacă Jest nu returnează la sfârşitul rulării unui test, înseamnă că resurse externe sunt încă în execuție sau cronometrele sunt încă în aşteptare în codul rulat. Este recomandat să curățați resursele externe, după fiecare test pentru a vă asigura că Jest își poate încheia rularea în mod curat. You can use --detectOpenHandles
to help track it down.
--help
Afișează informaţii ajutătoare, similar cu această pagină.
--init
Generate a basic configuration file. Based on your project, Jest will ask you a few questions that will help to generate a jest.config.js
file with a short description for each option.
--injectGlobals
Insert Jest's globals (expect
, test
, describe
, beforeEach
etc.) into the global environment. If you set this to false
, you should import from @jest/globals
, e.g.
import {expect, jest, test} from '@jest/globals';
jest.useFakeTimers();
test('some test', () => {
expect(Date.now()).toBe(0);
});
Note: This option is only supported using the default jest-circus
. test runner
--json
Afișează rezultatele testelor în JSON. Acest mod va trimite toate celelalte informații de ieşire şi utilizator către stderr.
--outputFile=<filename>
Scrie rezultatele testelor într-un fișier atunci când este specificată și opţiunea --json
. The returned JSON structure is documented in testResultsProcessor.
--lastCommit
Run all tests affected by file changes in the last commit made. Behaves similarly to --onlyChanged
.
--listTests
Listează în format JSON toate testele pe care Jest va rula luând în considerare argumentele, şi returnează. Acest lucru poate fi folosit împreună cu --findRelatedTests
pentru a știi ce teste Jest va rula.
--logHeapUsage
Loghează utilizarea memoriei heap după fiecare test. Util pentru a depana scurgeri de memorie. Utilizaţi împreună cu --runInBand
şi --expune-gc
în node.
--maxConcurrency=<num>
Prevents Jest from executing more than the specified amount of tests at the same time. Only affects tests that use test.concurrent
.
--maxWorkers=<num>|<string>
Alias: -w
. Specifică numărul maxim de workeri ce vor fi instanțiați pentru teste. In single run mode, this defaults to the number of the cores available on your machine minus one for the main thread. In watch mode, this defaults to half of the available cores on your machine to ensure Jest is unobtrusive and does not grind your machine to a halt. It may be useful to adjust this in resource limited environments like CIs but the defaults should be adequate for most use-cases.
For environments with variable CPUs available, you can use percentage based configuration: --maxWorkers=50%
--noStackTrace
Dezactivează urmărirea stivei de execuție în afișarea rezultatelor testelor.
--notify
Activează notificări pentru rezultatele testelor. Util atunci când aveți nevoie să vă concentrați și pe alte lucruri în afară de testarea JavaScript.
--onlyChanged
Alias: -o
. Încearcă să identifice care teste trebuie rulate pe baza fişierelor care s-au modificat în proiectul curent. Funcţionează numai dacă rulaţi testele într-un proiect git/hg în acest moment şi necesită un grafic de dependinţe statice (adică. fără import-uri dinamice).
--passWithNoTests
Allows the test suite to pass when no files are found.
--projects <path1> ... <pathN>
Run tests from one or more projects, found in the specified paths; also takes path globs. This option is the CLI equivalent of the projects
configuration option. Note that if configuration files are found in the specified paths, all projects specified within those configuration files will be run.
--reporters
Run tests with specified reporters. Reporter options are not available via CLI. Example with multiple reporters:
jest --reporters="default" --reporters="jest-junit"
--roots
O listă de căi de directoare pe care Jest ar trebui să le utilizeze pentru a căuta fișiere.
--runInBand
Alias: -i
. Execută toate testele serial în procesul curent, decât crearea unui bazin de workeri cu procese copil care vor executa testele in paralel. Acest lucru poate fi util pentru depanare.
--selectProjects <project1> ... <projectN>
Run only the tests of the specified projects. Jest uses the attribute displayName
in the configuration to identify each project. If you use this option, you should provide a displayName
to all your projects.
--runTestsByPath
Run only the tests that were specified with their exact paths.
Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files
--setupTestFrameworkScriptFile=<file>
Calea spre un modul care ruleaza ceva cod de configurare sau setează framework-ul de testare înainte de fiecare test. Țineți minte că fişierele importate de către scriptul de configurare nu vor fi mock-uite în timpul testării.
--showConfig
Afișează configurarea Jest şi apoi returnează.
--silent
Împiedică afișarea mesajelor prin consolă.
--testNamePattern=<regex>
Alias: -t
. Run only tests with a name that matches the regex. For example, suppose you want to run only tests related to authorization which will have names like "GET /api/posts with auth"
, then you can use jest -t=auth
.
Note: The regex is matched against the full name, which is a combination of the test name and all its surrounding describe blocks.
--testLocationInResults
Adds a location
field to test results. Useful if you want to report the location of a test in a reporter.
Note that column
is 0-indexed while line
is not.
{
"column": 4,
"line": 5
}
--testPathPattern=<regex>
Execută doar testele al din fișierele al caror cale se potriveşte cu expresia regulată specificată. On Windows, you will need to use /
as a path separator or escape \
as \
.
--testPathIgnorePatterns=[array]
An array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to --testPathPattern
, it will only run those tests with a path that does not match with the provided regexp expressions.
--testRunner=<path>
Vă permite să specificaţi un framework de testare personalizat.
--testSequencer=<path>
Lets you specify a custom test sequencer. Please refer to the documentation of the corresponding configuration property for details.
--testTimeout=<number>
Default timeout of a test in milliseconds. Default value: 5000.
--updateSnapshot
Alias: -u
. Folosiţi această opțiune pentru re-înregistrarea fiecărei imagini instantaneu care eșuează în timpul rulării. Poate fi utilizat împreună cu un tipar de suite de teste sau cu --testNamePattern
.
--useStderr
Redirecţionează toate afișările către stderr.
--verbose
Afişează rezultatele testelor individuale cu ierarhia suitei de teste.
--version
Alias: -v
. Afișează versiunea şi returnează.
--watch
Urmărește fișierele pentru modificări şi rulează din nou testele legate de fişierele modificate. Dacă doriţi să re-rulați toate testele, atunci când s-a schimbat un fişier, utilizaţi opţiunea --watchAll
în schimb.
--watchAll
Urmărește fișierele pentru modificări și rulează din nou toate testele, atunci când un fișier este modificat. Dacă doriţi să re-rulați doar testele care depind de fişierele modificate, utilizați opţiunea --watch
.
Use --watchAll=false
to explicitly disable the watch mode. Note that in most CI environments, this is automatically handled for you.
--watchman
Whether to use watchman
for file crawling. Defaults to true
. Disable using --no-watchman
.