Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ava-to-json

devtin17MIT1.0.0

Converts AVA tests syntax into JSON

ava, test, parse, json, annotate, documentation

readme

ava2json

tests

ava2json~AvaTest

Properties

Name Type Description
title String The AVA test title wrapped inside of the test function
description String The feature description (if any) added above the test as a JSDoc comment
code String The code found wrapped in the test function.
flag String Either 'skip', 'only', 'todo' or null for none;

ava2json~parseAva(avaString, [options])

Param Type Default Description
avaString String | The source of the AVA test file
[options] Object |
[options.unIndent] Number 2 Positive integer in which the code will be un-indented
[options.testName] String test The name of the test function to look-up into the code

Returns: Array.<AvaTest> - The tests found in the source code

Parses given AVA test source code

ava2json~parseFile(file, [options])

Param Type Description
file String Path to the AVA file
[options] Object Same options as in parseAva

Parses given AVA file

ava2json~parseFileSync(file, [options])

Param Type Description
file String Path to the AVA file
[options] Object Same options as in parseAva

Parses given AVA file synchronously

A module for converting AVA tests syntax into JSON


License

MIT

© 2020-present Martin Rafael Gonzalez tin@devtin.io

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.0.0 (2020-05-25)

Features

  • parses AVA tests syntax (45b345e)