jest-docblock
Advanced tools
`jest-docblock` is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.
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): 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.
24.9.0
[expect] Highlight substring differences when matcher fails, part 1 (#8448)[expect] Highlight substring differences when matcher fails, part 2 (#8528)[expect] Improve report when mock-spy matcher fails, part 1 (#8640)[expect] Improve report when mock-spy matcher fails, part 2 (#8649)[expect] Improve report when mock-spy matcher fails, part 3 (#8697)[expect] Improve report when mock-spy matcher fails, part 4 (#8710)[expect] Throw matcher error when received cannot be jasmine spy (#8747)[expect] Improve report when negative CalledWith assertion fails (#8755)[expect] Improve report when positive CalledWith assertion fails (#8771)[expect] Display equal values for ReturnedWith similar to CalledWith (#8791)[expect, jest-snapshot] Change color from green for some args in matcher hints (#8812)[jest-snapshot] Highlight substring differences when matcher fails, part 3 (#8569)[jest-core] Improve report when snapshots are obsolete (#8665)[jest-cli] Improve chai support (with detailed output, to match jest exceptions) (#8454)[*] Manage the global timeout with --testTimeout command line argument. (#8456)[pretty-format] Render custom displayName of memoized components (#8546)[jest-validate] Allow maxWorkers as part of the jest.config.js (#8565)[jest-runtime] Allow passing configuration objects to transformers (#7288)[@jest/core, @jest/test-sequencer] Support async sort in custom testSequencer (#8642)[jest-runtime, @jest/fake-timers] Add jest.advanceTimersToNextTimer (#8713)[@jest-transform] Extract transforming require logic within jest-core into @jest-transform (#8756)[jest-matcher-utils] Add color options to matcherHint (#8795)[jest-circus/jest-jasmine2] Give clearer output for Node assert errors (#8792)[jest-runner] Export all types in the type signature of jest-runner (#8825)[jest-cli] Detect side-effect only imports when running --onlyChanged or --changedSince (#8670)[jest-cli] Allow --maxWorkers to work with % input again (#8565)[babel-plugin-jest-hoist] Expand list of whitelisted globals in global mocks (#8429)[jest-core] Make watch plugin initialization errors look nice (#8422)[jest-snapshot] Prevent inline snapshots from drifting when inline snapshots are updated (#8492)[jest-haste-map] Don't throw on missing mapper in Node crawler (#8558)[jest-core] Fix incorrect passWithNoTests warning (#8595)[jest-snapshots] Fix test retries that contain snapshots (#8629)[jest-mock] Fix incorrect assignments when restoring mocks in instances where they originally didn't exist (#8631)[expect] Fix stack overflow when matching objects with circular references (#8687)[jest-haste-map] Workaround a node >=12.5.0 bug that causes the process not to exit after tests have completed and cancerous memory growth (#8787)[docs] Replace FlowType with TypeScript in CONTRIBUTING.MD code conventions[jest-leak-detector] remove code repeat (#8438)[docs] Add example to jest.requireActual (#8482)[docs] Add example to jest.mock for mocking ES6 modules with the factory parameter (#8550)[docs] Add information about using jest.doMock with ES6 imports (#8573)[docs] Fix variable name in custom-matcher-api code example (#8582)[docs] Fix example used in custom environment docs (#8617)[docs] Updated react tutorial to refer to new package of react-testing-library (@testing-library/react) (#8753)[docs] Updated imports of react-testing-library to @testing-library/react in website (#8757)[jest-core] Add getVersion (moved from jest-cli) (#8706)[docs] Fix MockFunctions example that was using toContain instead of toContainEqual (#8765)[*] Make sure copyright header comment includes license (#8783)[*] Check copyright and license as one joined substring (#8815)[docs] Fix WatchPlugins jestHooks.shouldRunTestSuite example that receives an object (#8784)[*] Enforce LF line endings (#8809)[pretty-format] Delete obsolete link and simplify structure in README (#8824)[docs] Fix broken transform link on webpack page (#9155)FAQs
`jest-docblock` is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.
The npm package jest-docblock receives a total of 11,294,070 weekly downloads. As such, jest-docblock popularity was classified as popular.
We found that jest-docblock demonstrated a not healthy version release cadence and project activity because the last version was released 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
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.