
Research
Security News
The Growing Risk of Malicious Browser Extensions
Socket researchers uncover how browser extensions in trusted stores are used to hijack sessions, redirect traffic, and manipulate user behavior.
jest-docblock
Advanced tools
The jest-docblock package is used to parse and manipulate docblocks - comments at the top of a file that are often used to provide metadata about the file, such as descriptions, authors, and licenses. It is commonly used in the Jest testing framework to handle such metadata in test files.
Parsing docblocks
This feature allows you to parse the contents of a file to extract the metadata contained within a docblock. The parse function returns an object where each key is a tag from the docblock.
const { parse } = require('jest-docblock');
const contents = `/**
* This is a docblock
*
* @flow
*/
const foo = 'bar';`;
const docblock = parse(contents);
console.log(docblock);
Extracting docblock
This feature allows you to extract the raw docblock as a string from the contents of a file. This can be useful if you want to manipulate the docblock as a whole or use it for documentation purposes.
const { extract } = require('jest-docblock');
const contents = `/**
* This is a docblock
*
* @flow
*/
const foo = 'bar';`;
const docblockString = extract(contents);
console.log(docblockString);
Printing docblock
This feature allows you to take an object representing a docblock and print it back into the docblock format. This is useful for modifying or adding new metadata to a file's docblock.
const { print } = require('jest-docblock');
const docblock = { flow: '' };
const newContents = print(docblock);
console.log(newContents);
The comment-parser package is similar to jest-docblock in that it is used to parse comments in code. It supports parsing of block comments in various formats and is not tied to any specific testing framework, making it more flexible for different use cases.
Doctrine is another JSDoc parsing library that can extract type information and other metadata from JSDoc comments. It is more focused on the JSDoc standard and provides a detailed AST of the parsed comments, which can be more powerful but also more complex than jest-docblock.
jsdoc-to-markdown is a package that takes JSDoc comments and converts them into markdown documentation. While it is not a direct alternative to jest-docblock, it serves a related purpose by transforming code comments into user-friendly documentation.
jest-docblock
is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.
A docblock looks like this:
/**
* Stuff goes here!
*/
Docblocks can contain pragmas, which are words prefixed by @
:
/**
* Pragma incoming!
*
* @flow
*/
Pragmas can also take arguments:
/**
* Check this out:
*
* @myPragma it is so cool
*/
jest-docblock
can:
# with yarn
$ yarn add jest-docblock
# with npm
$ npm install jest-docblock
const code = `
/**
* Everything is awesome!
*
* @everything is:awesome
* @flow
*/
export const everything = Object.create(null);
export default function isAwesome(something) {
return something === everything;
}
`;
const {
extract,
strip,
parse,
parseWithComments,
print,
} = require('jest-docblock');
const docblock = extract(code);
console.log(docblock); // "/**\n * Everything is awesome!\n * \n * @everything is:awesome\n * @flow\n */"
const stripped = strip(code);
console.log(stripped); // "export const everything = Object.create(null);\n export default function isAwesome(something) {\n return something === everything;\n }"
const pragmas = parse(docblock);
console.log(pragmas); // { everything: "is:awesome", flow: "" }
const parsed = parseWithComments(docblock);
console.log(parsed); // { comments: "Everything is awesome!", pragmas: { everything: "is:awesome", flow: "" } }
console.log(print({pragmas, comments: 'hi!'})); // /**\n * hi!\n *\n * @everything is:awesome\n * @flow\n */;
extract(contents: string): string
Extracts a docblock from some file contents. Returns the docblock contained in contents
. If contents
did not contain a docblock, it will return the empty string (""
).
strip(contents: string): string
Strips the top docblock from a file and return the result. If a file does not have a docblock at the top, then return the file unchanged.
parse(docblock: string): {[key: string]: string | string[] }
Parses the pragmas in a docblock string into an object whose keys are the pragma tags and whose values are the arguments to those pragmas.
parseWithComments(docblock: string): { comments: string, pragmas: {[key: string]: string | string[]} }
Similar to parse
except this method also returns the comments from the docblock. Useful when used with print()
.
print({ comments?: string, pragmas?: {[key: string]: string | string[]} }): string
Prints an object of key-value pairs back into a docblock. If comments
are provided, they will be positioned on the top of the docblock.
30.0.0
[*]
Renamed globalsCleanupMode
to globalsCleanup
and --waitNextEventLoopTurnForUnhandledRejectionEvents
to --waitForUnhandledRejections
[expect]
Add ArrayOf
asymmetric matcher for validating array elements. (#15567)[babel-jest]
Add option excludeJestPreset
to allow opting out of babel-preset-jest
(#15164)[expect]
Revert #15038 to fix expect(fn).toHaveBeenCalledWith(expect.objectContaining(...))
when there are multiple calls (#15508)[jest-circus, jest-cli, jest-config]
Add waitNextEventLoopTurnForUnhandledRejectionEvents
flag to minimise performance impact of correct detection of unhandled promise rejections introduced in #14315 (#14681)[jest-circus]
Add a waitBeforeRetry
option to jest.retryTimes
(#14738)[jest-circus]
Add a retryImmediately
option to jest.retryTimes
(#14696)[jest-circus, jest-jasmine2]
Allow setupFilesAfterEnv
to export an async function (#10962)[jest-circus, jest-test-result]
Add startedAt
timestamp in TestCaseResultObject
within onTestCaseResult
(#15145)[jest-cli]
Export buildArgv
(#15310)[jest-config]
[BREAKING] Add mts
and cts
to default moduleFileExtensions
config (#14369)[jest-config]
[BREAKING] Update testMatch
and testRegex
default option for supporting mjs
, cjs
, mts
, and cts
(#14584)[jest-config]
Loads config file from provided path in package.json
(#14044)[jest-config]
Allow loading jest.config.cts
files (#14070)[jest-config]
Show rootDir
in error message when a preset
fails to load (#15194)[jest-config]
Support loading TS config files using esbuild-register
via docblock loader (#15190)[jest-config]
Allow passing TS config loader options via docblock comment (#15234)[jest-config]
If Node is running with type stripping enabled, do not require a TS loader (#15480)[@jest/core]
Group together open handles with the same stack trace (#13417, & #14789)[@jest/core]
Add perfStats
to surface test setup overhead (#14622)[@jest/core]
[BREAKING] Changed --filter
to accept an object with shape { filtered: Array<string> }
to match documentation (#13319)[@jest/core]
Support --outputFile
option for --listTests
(#14980)[@jest/core]
Stringify Errors properly with --json
flag (#15329)[@jest/core, @jest/test-sequencer]
[BREAKING] Exposes globalConfig
& contexts
to TestSequencer
(#14535, & #14543)[jest-each]
Introduce %$
option to add number of the test to its title (#14710)[@jest/environment]
[BREAKING] Remove deprecated jest.genMockFromModule()
(#15042)[@jest/environment]
[BREAKING] Remove unnecessary defensive code (#15045)[jest-environment-jsdom]
[BREAKING] Upgrade JSDOM to v22 (#13825)[@jest/environment-jsdom-abstract]
Introduce new package which abstracts over the jsdom
environment, allowing usage of custom versions of JSDOM (#14717)[jest-environment-node]
Update jest environment with dispose symbols Symbol
(#14888 & #14909)[expect, @jest/expect]
[BREAKING] Add type inference for function parameters in CalledWith
assertions (#15129)[@jest/expect-utils]
Properly compare all types of TypedArray
s (#15178)[@jest/fake-timers]
[BREAKING] Upgrade @sinonjs/fake-timers
to v13 (#14544 & #15470)[@jest/fake-timers]
Exposing new modern timers function advanceTimersToFrame()
which advances all timers by the needed milliseconds to execute callbacks currently scheduled with requestAnimationFrame
(#14598)[jest-matcher-utils]
Add SERIALIZABLE_PROPERTIES
to allow custom serialization of objects (#14893)[jest-mock]
Add support for the Explicit Resource Management proposal to use the using
keyword with jest.spyOn(object, methodName)
(#14895)[jest-reporters]
Add support for DEC mode 2026 (#15008)[jest-resolver]
Support file://
URLs as paths (#15154)[jest-resolve,jest-runtime,jest-resolve-dependencies]
Pass the conditions when resolving stub modules (#15489)[jest-runtime]
Exposing new modern timers function jest.advanceTimersToFrame()
from @jest/fake-timers
(#14598)[jest-runtime]
Support import.meta.filename
and import.meta.dirname
(available from Node 20.11) (#14854)[jest-runtime]
Support import.meta.resolve
(#14930)[jest-runtime]
[BREAKING] Make it mandatory to pass globalConfig
to the Runtime
constructor (#15044)[jest-runtime]
Add unstable_unmockModule
(#15080)[jest-runtime]
Add onGenerateMock
transformer callback for auto generated callbacks (#15433 & #15482)[jest-runtime]
[BREAKING] Use vm.compileFunction
over vm.Script
(#15461)[@jest/schemas]
Upgrade @sinclair/typebox
to v0.34 (#15450)[@jest/types]
test.each()
: Accept a readonly (as const
) table properly (#14565)[@jest/types]
Improve argument type inference passed to test
and describe
callback functions from each
tables (#14920)[jest-snapshot]
[BREAKING] Add support for Error causes in snapshots (#13965)[jest-snapshot]
Support Prettier 3 (#14566)[@jest/util-snapshot]
Extract utils used by tooling from jest-snapshot
into its own package (#15095)[pretty-format]
[BREAKING] Do not render empty string children (''
) in React plugin (#14470)[expect]
Show AggregateError
to display (#15346)[*]
Replace exit
with exit-x
(#15399)[babel-plugin-jest-hoist]
Use denylist
instead of the deprecated blacklist
for Babel 8 support (#14109)[babel-plugin-jest-hoist]
Do not rely on buggy Babel behaviour (#15415)[expect]
Check error instance type for toThrow/toThrowError
(#14576)[expect]
Improve diff for failing expect.objectContaining
(#15038)[expect]
Use Array.isArray
to check if an array is an Array
(#15101)[expect]
Fix Error cause
assertion errors (#15339)[jest-changed-files]
Print underlying errors when VCS commands fail (#15052)[jest-changed-files]
Abort sl root
call if output resembles a steam locomotive (#15053)[jest-circus]
[BREAKING] Prevent false test failures caused by promise rejections handled asynchronously (#14315)[jest-circus]
Replace recursive makeTestResults
implementation with iterative one (#14760)[jest-circus]
Omit expect.hasAssertions()
errors if a test already has errors (#14866)[jest-circus, jest-expect, jest-snapshot]
Pass test.failing
tests when containing failing snapshot matchers (#14313)[jest-circus]
Concurrent tests now emit jest circus events at the correct point and in the expected order. (#15381)[jest-cli]
[BREAKING] Validate CLI flags that require arguments receives them (#14783)[jest-config]
Make sure to respect runInBand
option (#14578)[jest-config]
Support testTimeout
in project config (#14697)[jest-config]
Support coverageReporters
in project config (#14697)[jest-config]
Allow reporters
in project config (#14768)[jest-config]
Allow Node16/NodeNext/Bundler moduleResolution
in project's tsconfig (#14739)[@jest/create-cache-key-function]
Correct the return type of createCacheKey
(#15159)[jest-each]
Allow $keypath
templates with null
or undefined
values (#14831)[@jest/expect-utils]
Fix comparison of DataView
(#14408)[@jest/expect-utils]
[BREAKING] exclude non-enumerable in object matching (#14670)[@jest/expect-utils]
Fix comparison of URL
(#14672)[@jest/expect-utils]
Check Symbol
properties in equality (#14688)[@jest/expect-utils]
Catch circular references within arrays when matching objects (#14894)[@jest/expect-utils]
Fix not addressing to Sets and Maps as objects without keys (#14873)[jest-haste-map]
Fix errors or clobbering with multiple hasteImplModulePath
s (#15522)[jest-leak-detector]
Make leak-detector more aggressive when running GC (#14526)[jest-runtime]
Properly handle re-exported native modules in ESM via CJS (#14589)[jest-runtime]
Refactor _importCoreModel
so required core module is consistent if modified while loading (#15077)[jest-schemas, jest-types]
[BREAKING] Fix type of testFailureExitCode
config option(#15232)[jest-util]
Make sure isInteractive
works in a browser (#14552)[pretty-format]
[BREAKING] Print ArrayBuffer
and DataView
correctly (#14290)[pretty-format]
Fixed a bug where "anonymous custom elements" were not being printed as expected. (#15138)[jest-cli]
When specifying paths on the command line, only match against the relative paths of the test files (#12519)
testPathPattern
configuration option to testPathPatterns
, which now takes a list of patterns instead of the regex.--testPathPattern
is now --testPathPatterns
testPathPatterns
when programmatically calling watch
must be specified as new TestPathPatterns(patterns)
, where TestPathPatterns
can be imported from @jest/pattern
[jest-reporters, jest-runner]
Unhandled errors without stack get correctly logged to console (#14619)[jest-util]
Always load mjs
files with import
(#15447)[jest-worker]
Properly handle a circular reference error when worker tries to send an assertion fails where either the expected or actual value is circular (#15191)[jest-worker]
Properly handle a BigInt when worker tries to send an assertion fails where either the expected or actual value is BigInt (#15191)[expect]
Resolve issue where ObjectContaining
matched non-object values. ([#15463])(https://github.com/jestjs/jest/pull/15463).
conditional/check
to ensure the argument passed to expect
is an object.ObjectContaining
behavior.invalid/wrong
test case assertions for ObjectContaining
.[jest-worker]
Addresses incorrect state on exit (#15610)[*]
[BREAKING] Bundle all of Jest's modules into index.js
(#12348, #14550 & #14661)[jest-haste-map]
Only spawn one process to check for watchman
installation (#14826)[jest-runner]
Better cleanup source-map-support
after test to resolve (minor) memory leak (#15233)[jest-circus, jest-environment-node, jest-repl, jest-runner, jest-util]
Cleanup global variables on environment teardown to reduce memory leaks (#15215 & #15636 & #15643)[jest-environment-jsdom, jest-environment-jsdom-abstract]
Increased version of jsdom to ^26.0.0
(#15325CVE-2024-37890)[*]
Increase version of micromatch
to ^4.0.7
(#15082)[*]
[BREAKING] Drop support for Node.js versions 14, 16, 19, 21 and 23 (#14460, #15118, #15623, #15640)[*]
[BREAKING] Drop support for typescript@4.3
, minimum version is now 5.4
(#14542, #15621)[*]
Depend on exact versions of monorepo dependencies instead of ^
range (#14553)[*]
[BREAKING] Add ESM wrapper for all of Jest's modules (#14661)[*]
[BREAKING] Upgrade to glob@10
(#14509)[*]
Use TypeError
over Error
where appropriate (#14799)[docs]
Fix typos in CHANGELOG.md
and packages/jest-validate/README.md
(#14640)[docs]
Don't use alias matchers in docs (#14631)[babel-jest, babel-preset-jest]
[BREAKING] Increase peer dependency of @babel/core
to ^7.11
(#14109)[babel-jest, @jest/transform]
Update babel-plugin-istanbul
to v6 (#15156)[babel-plugin-jest-hoist]
Move unnecessary dependencies
to devDependencies
(#15010)[expect]
[BREAKING] Remove .toBeCalled()
, .toBeCalledTimes()
, .toBeCalledWith()
, .lastCalledWith()
, .nthCalledWith()
, .toReturn()
, .toReturnTimes()
, .toReturnWith()
, .lastReturnedWith()
, .nthReturnedWith()
and .toThrowError()
matcher aliases (#14632)[jest-cli, jest-config, @jest/types]
[BREAKING] Remove deprecated --init
argument (#14490)[jest-config, @jest/core, jest-util]
Upgrade ci-info
(#14655)[jest-mock]
[BREAKING] Remove MockFunctionMetadataType
, MockFunctionMetadata
and SpyInstance
types (#14621)[@jest/reporters]
Upgrade istanbul-lib-source-maps
(#14924)[jest-schemas]
Upgrade @sinclair/typebox
(#14775)[jest-transform]
Upgrade write-file-atomic
(#14274)[jest-util]
Upgrade picomatch
to v4 (#14653 & #14885)[docs] Append to NODE_OPTIONS, not overwrite ([#14730](https://github.com/jestjs/jest/pull/14730))
[docs]
Updated .toHaveBeenCalled()
documentation to correctly reflect its functionality (#14842)[docs]
Link NestJS documentation on testing with Jest (#14940)[docs]
Revised documentation for .toHaveBeenCalled()
to accurately depict its functionality. (#14853)[docs]
Removed ExpressJS reference link from documentation due to dead link (#15270)[docs]
Correct broken links in docs (#15359)FAQs
Unknown package
The npm package jest-docblock receives a total of 31,397,110 weekly downloads. As such, jest-docblock popularity was classified as popular.
We found that jest-docblock demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover how browser extensions in trusted stores are used to hijack sessions, redirect traffic, and manipulate user behavior.
Research
Security News
An in-depth analysis of credential stealers, crypto drainers, cryptojackers, and clipboard hijackers abusing open source package registries to compromise Web3 development environments.
Security News
pnpm 10.12.1 introduces a global virtual store for faster installs and new options for managing dependencies with version catalogs.