@adobe/jsonschema2md/spec/lib/header.spec.js

Validate and document complex JSON Schemas the easy way.

const { Header, headers } = require('../../lib/header');
const i18n = require('i18n');
var path = require('path');

beforeEach(function() {
  jasmine.addMatchers(require('jasmine-diff')(jasmine, {
    colors: true,
    inline: true
  }));
  let i18nPath=path.resolve('./lib/locales');
  i18n.configure({
    // setup some locales - other locales default to en silently
    locales:[ 'en' ],
    // where to store json files - defaults to './locales' relative to modules directory
    directory: i18nPath,
    defaultLocale: 'en'
  });
});

describe('Header Integration Test', () => {
  it('Renders a header without link if link is unknown', () => {
    const h = new Header('Foo');
    expect(h.renderHeader()).toEqual('Foo');
  });

  it('Renders a header with link if link is known', () => {
    const h = new Header('Foo', '../bar.md');
    expect(h.renderHeader()).toEqual('[Foo](../bar.md)');
  });

  it('Renders a header body without link if link is unknown', () => {
    const h = new Header('Foo', null, 'Bar');
    expect(h.renderValue()).toEqual('Bar');
  });

  it('Renders a header body with link if link is known', () => {
    const h = new Header('Foo', '../bar.md', 'Bar', '#bar-md');
    expect(h.renderValue()).toEqual('[Bar](#bar-md)');
  });
});

describe('Headers Integration Test', () => {
  it('Abstract', () => {
    const schema = {
      additionalProperties: true,
      'meta:extensible': false,
      properties: { 'foo':'bar', 'bar': 'baz' }
    };

    const h = headers(schema, '/home/lars', '/home/lars/complex.schema.json');

    const result = `| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In |
|----------|------------|--------|--------------|-------------------|-----------------------|------------|
| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [complex.schema.json](complex.schema.json) |`;
    expect(h.render()).toEqual(result);
  });

  it('Markdown links should be correct when schema is in a subdir.', () => {
    const schema = {
      additionalProperties: true,
      'meta:extensible': false,
      properties: { 'foo':'bar', 'bar': 'baz' }
    };

    const h = headers(schema, '/home/lars', '/home/lars/some/deep/path/complex.schema.json');

    const result = `| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In |
|----------|------------|--------|--------------|-------------------|-----------------------|------------|
| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [some/deep/path/complex.schema.json](complex.schema.json) |`;
    expect(h.render()).toEqual(result);
  });

});