Socket
Socket
Sign inDemoInstall

jest-docblock

Package Overview
Dependencies
1
Maintainers
6
Versions
111
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

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.


Version published
Maintainers
6
Weekly downloads
23,055,717
decreased by-6.78%

Weekly downloads

Package description

What is jest-docblock?

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.

What are jest-docblock's main functionalities?

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);

Other packages similar to jest-docblock

Readme

Source

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

Last updated on 14 Oct 2022

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc