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:
Docblocks can contain pragmas, which are words prefixed by @
:
Pragmas can also take arguments:
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
$ yarn add jest-docblock
$ 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);
const stripped = strip(code);
console.log(stripped);
const pragmas = parse(docblock);
console.log(pragmas);
const parsed = parseWithComments(docblock);
console.log(parsed);
console.log(print({pragmas, comments: 'hi!'}));
API Documentation
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.
Similar to parse
except this method also returns the comments from the docblock. Useful when used with print()
.
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.