vuepress-plugin-autodoc/tests/index.test.js

Automatic Code Documentation for VuePress

/**
 * Testing for package.
 */


// imports
// -------
import fs from 'fs';
import { assert } from 'chai';
import MarkdownIt from 'markdown-it';
import plugin from '../src/index';


// api
// ---
/**
* Generic number class
*/
export class Number {
  /**
   * Constructor for object.
   * @param {Number} input - Number to add.
   * @param {String} name - Name for number.
   */
  constructor(input, name) {
    this.number = input || 0;
    this.name = name;
  }

  /**
   * Return number from class.
   * @return {Number} The number value.
   */
  value() {
    return this.number;
  }

  /**
   * Add another number and return result.
   * @param {Number} other - Other number to add.
   * @return {Number} Other number to add.
   */
  increment(other) {
    return this.number + other;
  }
}

/**
 * Function for adding two numbers.
 * @param {Number} x - Left operand.
 * @param {Number} y - Right operand.
 */
export function add(x, y) {
  return x + y;
}

/**
 * Object with functions and data.
 */
const utils = {
  /**
   * Item in utils array.
   */
  item: false,
  /**
   * Echo value.
   *
   * @param {Number} value - Value to echo.
   */
  echo: value => value,
};


// config
// ------
const css = fs.readFileSync(__dirname + '/../src/index.css', 'utf-8');
const extend = plugin({ css }).extendMarkdown;
const md = MarkdownIt();
extend(md);


// tests
// -----
describe("render", () => {
  let result;

  test("render.function", () => {
    result = md.render('/autodoc tests/index.test.js add');
    assert.isTrue(result.includes('<h3 id="add"'));
    assert.isTrue(result.includes('<style>'));
  });

  test("render.const", () => {
    result = md.render('/autodoc tests/index.test.js utils');
    assert.isTrue(result.includes('<h3 id="utils"'));
    assert.isTrue(result.includes('<h4 id="item"'));
    assert.isTrue(result.includes('<h4 id="echo"'));
    assert.isTrue(result.includes('<style>'));
  });

  test("render.class", () => {
    result = md.render('/autodoc tests/index.test.js Number');
    assert.isTrue(result.includes('<h3 id="number"'));
    assert.isTrue(result.includes('<h4 id="value"'));
    assert.isTrue(result.includes('<h4 id="increment"'));
    assert.isTrue(result.includes('<style>'));
  });

  test("render.multiple", () => {
    result = md.render('/autodoc tests/index.test.js add Number');
    assert.isTrue(result.includes('<h3 id="number"'));
    assert.isTrue(result.includes('<h4 id="value"'));
    assert.isTrue(result.includes('<h4 id="increment"'));
    assert.isTrue(result.includes('<h3 id="add"'));
    assert.isTrue(result.includes('<style>'));
  });

  test("render.module", () => {
    result = md.render('/autodoc tests/index.test.js');
    assert.isTrue(result.includes('<h3 id="number"'));
    assert.isTrue(result.includes('<h4 id="value"'));
    assert.isTrue(result.includes('<h4 id="increment"'));
    assert.isTrue(result.includes('<h3 id="add"'));
    assert.isTrue(result.includes('<h3 id="utils"'));
    assert.isTrue(result.includes('<h4 id="item"'));
    assert.isTrue(result.includes('<h4 id="echo"'));
    assert.isTrue(result.includes('<style>'));

    // update readme to show rendered result
    let readme = fs.readFileSync(__dirname + '/../README.md', 'utf-8');
    let idx = readme.indexOf('See a demo of the documentation');
    idx = idx === -1 ? readme.length : idx;
    readme = readme.slice(0, idx);
    readme += 'Here is an example of a class definition:\n\n'
    readme += '### Number\n\n';
    readme += '/autodoc tests/index.test.js Number\n\n';
    readme += 'And here is an example of a function definition:\n\n'
    readme += '### add\n\n';
    readme += '/autodoc tests/index.test.js add\n\n';
    readme += 'And finally, a constatnt definition:\n\n'
    readme += '### utils\n\n';
    readme += '/autodoc tests/index.test.js utils\n\n';
    fs.writeFileSync(__dirname + '/../docs/README.md', readme, 'utf-8');
  });
});