acquit-markdown

Quick tool for converting acquit output to markdown

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
acquit-markdown
0.1.04 years ago7 years agoMinified + gzip package size for acquit-markdown in KB

Readme

acquit-markdown

It converts acquit output to a simple markdown format

The acquit-markdown plugin adds an output processor to acquit that transforms acquit's syntax tree output into a markdown string. It converts mocha descriptions into headers, comments into paragraphs, and wraps code in backticks.
var acquit = require('acquit');
require('acquit-markdown')();

var code = [
  'describe("My feature", function() {',
  '  /** This is a very important feature */',
  '  describe("My subfeature", function() {',
  '    it("works", function() {',
  '      // code here',
  '    })',
  '  })',
  '})'
].join('\n');

assert.equal(acquit.parse(code), [
  '# My feature',
  '',
  '## My subfeature',
  '',
  'This is a very important feature',
  '',
  '### It works',
  '',
  '```javascript',
  '',
  '      // code here',
  '    ',
  '```'
].join('\n'));
  

It can use acquit constructor

var acquit = require('acquit')();
require('acquit-markdown')(acquit);

var code = [
  'describe("My feature", function() {',
  '  /** This is a very important feature */',
  '  describe("My subfeature", function() {',
  '    it("works", function() {',
  '      // code here',
  '    })',
  '  })',
  '})'
].join('\n');

assert.equal(acquit.parse(code), [
  '# My feature',
  '',
  '## My subfeature',
  '',
  'This is a very important feature',
  '',
  '### It works',
  '',
  '```javascript',
  '',
  '      // code here',
  '    ',
  '```'
].join('\n'));