- Big update!Introducing GitHub Bot Commands. Learn more →
jest-docblock
Advanced tools
jest-docblock
`jest-docblock` is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.
- 29.0.0latest
- Version published
- Maintainers
- 6
- Weekly downloads
- 14,906,261
- decreased by-19.84%
Weekly downloads
Changelog
29.0.0
Features
[expect][BREAKING] Differentiate betweenMatcherContextMatcherUtilsandMatcherStatetypes (#13141)[jest-circus]Add support fortest.failing.each(#13142)[jest-config][BREAKING] MakesnapshotFormatdefault toescapeString: falseandprintBasicPrototype: false(#13036)[jest-config][BREAKING] Remove undocumentedcollectCoverageOnlyFromoption (#13156)[jest-environment-jsdom][BREAKING] Upgrade to[email protected](#13037, #13058)[@jest/globals]Addjest.Mocked,jest.MockedClass,jest.MockedFunctionandjest.MockedObjectutility types (#12727)[jest-mock][BREAKING] RefactorMocked*utility types.MaybeMockedDeepandMaybeMockedbecameMockedandMockedShallowrespectively; only deep mocked variants ofMockedClass,MockedFunctionandMockedObjectare exported (#13123, #13124)[jest-mock][BREAKING] Change the defaultjest.mockedhelper’s behavior to deep mocked (#13125)[jest-snapshot][BREAKING] Letbabelfind config when updating inline snapshots (#13150)[@jest/test-result, @jest/types][BREAKING] ReplaceBytesandMillisecondstypes withnumber(#13155)[jest-worker]AddsworkerIdleMemoryLimitoption which is used as a check for worker memory leaks >= Node 16.11.0 and recycles child workers as required (#13056, #13105, #13106, #13107)[pretty-format][BREAKING] RemoveConvertAnsiplugin in favour ofjest-serializer-ansi-escapes(#13040)[pretty-format]Allow to opt out from sorting object keys withcompareKeys: null(#12443)
Fixes
[jest-config]Fix testing multiple projects with TypeScript config files (#13099)[@jest/expect-utils]Fix deep equality of ImmutableJS Record (#13055)[jest-haste-map]Increase the maximum possible file size that jest-haste-map can handle (#13094)[jest-runtime]Properly support CJS re-exports from dual packages (#13170)[jest-snapshot]MakeprettierPathoptional inSnapshotState(#13149)[jest-snapshot]Fix parsing error from inline snapshot files withJSX(#12760)[jest-worker]When a process runs out of memory worker exits correctly and doesn't spin indefinitely (#13054)
Chore & Maintenance
[*][BREAKING] Drop support for Node v12 and v17 (#13033)[docs]Fix webpack name (#13049)[docs]Explicit how to setnfor--bail(#13128)[docs]Update Enzyme URL (#13166)[jest-leak-detector]Remove support forweak-napi(#13035)[jest-snapshot][BREAKING] RequirerootDiras argument toSnapshotState(#13150)
Readme
jest-docblock
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:
- extract the docblock from some code as a string
- parse a docblock string's pragmas into an object
- print an object and some comments back to a string
Installation
# with yarn
$ yarn add jest-docblock
# with npm
$ npm install jest-docblock
Usage
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 */;
API Documentation
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.
FAQs
What is jest-docblock?
`jest-docblock` is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.
Is jest-docblock popular?
The npm package jest-docblock receives a total of 11,341,884 weekly downloads. As such, jest-docblock popularity was classified as popular.
Is jest-docblock well maintained?
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 6 open source maintainers collaborating on the project.