jest-docblock
Advanced tools
Package description
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.
Changelog
24.3.0
We skipped 24.2.0 because a draft was accidentally published. Please use 24.3.0 or a newer version instead.
[expect]: Improve report when matcher fails, part 10 (#7960)[expect]: Improve report when matcher fails, part 11 (#8008)[expect]: Improve report when matcher fails, part 12 (#8033)[expect]: Improve report when matcher fails, part 7 (#7866)[expect]: Improve report when matcher fails, part 8 (#7876)[expect]: Improve report when matcher fails, part 9 (#7940)[jest-circus/jest-jasmine2] Warn if describe returns a value (#7852)[jest-config] Print error information on preset normalization error (#7935)[jest-get-type] Add isPrimitive function (#7708)[jest-haste-map] Add skipPackageJson option (#7778)[jest-util] Add isPromise (#7852)[pretty-format] Support React.memo (#7891)[expect] Fix toStrictEqual not considering arrays with objects having undefined values correctly (#7938)[expect] Fix custom async matcher stack trace (#7652)[expect] Fix non-object received value in toHaveProperty (#7986, #8067)[expect] Fix non-symmetric equal for Number (#7948)[expect] Remove duck typing and obsolete browser support code when comparing DOM nodes and use DOM-Level-3 API instead (#7995)[jest-changed-files] Fix getChangedFilesFromRoots to not return parts of the commit messages as if they were files, when the commit messages contained multiple paragraphs (#7961)[jest-changed-files] Fix pattern for HG changed files (#8066)[jest-changed-files] Improve default file selection for Mercurial repos (#7880)[jest-circus] Fix bug with test.only (#7888)[jest-circus]: Throw explicit error when errors happen after test is considered complete (#8005)[jest-cli] Fix prototype pollution vulnerability in dependency (#7904)[jest-cli] Refactor -o and --coverage combined (#7611)[jest-environment-node] Add missing globals: TextEncoder and TextDecoder (#8022)[jest-haste-map] Enforce uniqueness in names (mocks and haste ids) (#8002)[jest-jasmine2]: Throw explicit error when errors happen after test is considered complete (#8005)[jest-mock] Adds a type check to prototype to allow mocks of objects with a primitive prototype property. (#8040)[jest-transform] Normalize config and remove unnecessary checks, convert TestUtils.js to TypeScript (#7801)[jest-util]Make sure to not fail if unable to assign toStringTag to the process object, which is read only in Node 12 (#8050)[jest-validate] Fix validating async functions (#7894)[jest-worker] Fix jest-worker when using pre-allocated jobs (#7934)[static] Remove console log '-' on the front page (#7977)[*]: Setup building, linting and testing of TypeScript (#7808, #7855, #7951)[@jest/console]: Extract custom console implementations from jest-util into a new separate package (#8030)[@jest/core] Create new package, which is jest-cli minus yargs and prompts (#7696)[@jest/core]: Migrate to TypeScript (#7998)[@jest/fake-timers]: Extract FakeTimers class from jest-util into a new separate package (#7987)[@jest/reporter]: New package extracted from jest-cli (#7902)[@jest/reporters]: Migrate to TypeScript (#7994, #8045)[@jest/source-map]: Extract getCallsite function from jest-util into a new separate package (#8029)[@jest/test-result]: Extract TestResult types and helpers into a new separate package (#8034)[@jest/transform]: Migrate to TypeScript (#7918, #7945)[@jest/transform]: New package extracted from jest-runtime (#7915)[@jest/types]: New package to handle shared types (#7834)[babel-jest]: Migrate to TypeScript (#7862)[babel-plugin-jest-hoist]: Migrate to TypeScript (#7898)[diff-sequences]: Migrate to Typescript (#7820)[docs] Add missing import to docs (#7928)[docs] Update automock configuration, add note related to manual mocks (#8051)[docs] Update/Organize TestSequencer and testSchedulerHelper code comments(#7984)[docs]: Fix image paths in SnapshotTesting.md for current and version 24 (#7872)[docs]: Improve runAllTimers doc (it exhausts the micro-task queue) (#8031)[docs]: Update CONTRIBUTING.md to add information about running jest with jest-circus locally (#8013).[expect]: Migrate to TypeScript (#7919, #8028)[jest-changed-files]: Migrate to TypeScript (#7827)[jest-circus]: Migrate to TypeScript (#7916)[jest-cli]: Migrate to TypeScript (#8024)[jest-diff]: Migrate to TypeScript (#7824, #8027)[jest-docblock]: Migrate to TypeScript (#7836)[jest-each]: Migrate to Typescript (#8007)[jest-each]: Refactor into multiple files with better types (#8018)[jest-environment-jsdom]: Migrate to TypeScript (#8003)[jest-environment-node]: Migrate to TypeScript (#7985)[jest-get-type]: Migrate to TypeScript (#7818)[jest-haste-map]: Migrate to TypeScript (#7854, #7951)[jest-jasmine2]: TS migration (#7970)[jest-leak-detector]: Migrate to TypeScript (#7825)[jest-matcher-utils]: Migrate to TypeScript (#7835)[jest-message-util]: Migrate to TypeScript (#7834)[jest-mock]: Migrate to TypeScript (#7847, #7850, #7971)[jest-phabricator]: Migrate to TypeScript (#7965)[jest-regex-util]: Migrate to TypeScript (#7822)[jest-repl]: Migrate to TypeScript (#8000)[jest-resolve-dependencies]: Migrate to TypeScript (#7922)[jest-resolve]: Migrate to TypeScript (#7871)[jest-runner]: Migrate to TypeScript (#7968)[jest-runtime]: Migrate to TypeScript (#7964, #7988)[jest-serializer]: Migrate to TypeScript (#7841)[jest-snapshot]: Migrate to TypeScript (#7899)[jest-util]: Migrate to TypeScript (#7844, #8021)[jest-validate]: Migrate to TypeScript (#7991)[jest-watcher]: Migrate to TypeScript (#7843)[jest-worker]: Migrate to TypeScript (#7853)[jest]: Migrate to TypeScript (#8024)[pretty-format]: Migrate to TypeScript (#7809, #7972)[jest-haste-map] Optimize haste map tracking of deleted files with Watchman. (#8056)Readme
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): stringExtracts 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): stringStrips 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[]} }): stringPrints 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
`jest-docblock` is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.
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.
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.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.