v2: prepare to move

This commit is contained in:
endiliey 2018-09-17 11:16:07 +08:00
parent dc7ef96849
commit 45736200b0
172 changed files with 0 additions and 0 deletions

View file

@ -0,0 +1,597 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`loadDocs simple website 1`] = `
Object {
"foo/bar": Object {
"category": "Test",
"id": "foo/bar",
"language": undefined,
"localized_id": "foo/bar",
"next": "foo/baz",
"next_id": "foo/baz",
"next_title": "baz",
"permalink": "/docs/foo/bar",
"sidebar": "docs",
"source": "@docs/foo/bar.md",
"title": "Bar",
"version": undefined,
},
"foo/baz": Object {
"category": "Test",
"id": "foo/baz",
"language": undefined,
"localized_id": "foo/baz",
"next": "hello",
"next_id": "hello",
"next_title": "Hello, World !",
"permalink": "/docs/foo/baz",
"previous": "foo/bar",
"previous_id": "foo/bar",
"previous_title": "Bar",
"sidebar": "docs",
"source": "@docs/foo/baz.md",
"title": "baz",
"version": undefined,
},
"hello": Object {
"category": "Guides",
"id": "hello",
"language": undefined,
"localized_id": "hello",
"permalink": "/docs/hello",
"previous": "foo/baz",
"previous_id": "foo/baz",
"previous_title": "baz",
"sidebar": "docs",
"source": "@docs/hello.md",
"title": "Hello, World !",
"version": undefined,
},
"permalink": Object {
"id": "permalink",
"language": undefined,
"localized_id": "permalink",
"permalink": "/docs/endiliey/permalink",
"source": "@docs/permalink.md",
"title": "Permalink",
"version": undefined,
},
}
`;
exports[`loadDocs translated website 1`] = `
Object {
"en-foo/bar": Object {
"category": "Test",
"id": "en-foo/bar",
"language": "en",
"localized_id": "foo/bar",
"next": "en-foo/baz",
"next_id": "foo/baz",
"next_title": "baz",
"permalink": "/docs/en/foo/bar",
"sidebar": "docs",
"source": "@docs/foo/bar.md",
"title": "Bar",
"version": undefined,
},
"en-foo/baz": Object {
"category": "Test",
"id": "en-foo/baz",
"language": "en",
"localized_id": "foo/baz",
"next": "en-hello",
"next_id": "hello",
"next_title": "Hello, World !",
"permalink": "/docs/en/foo/baz",
"previous": "en-foo/bar",
"previous_id": "foo/bar",
"previous_title": "Bar",
"sidebar": "docs",
"source": "@docs/foo/baz.md",
"title": "baz",
"version": undefined,
},
"en-hello": Object {
"category": "Guides",
"id": "en-hello",
"language": "en",
"localized_id": "hello",
"permalink": "/docs/en/hello",
"previous": "en-foo/baz",
"previous_id": "foo/baz",
"previous_title": "baz",
"sidebar": "docs",
"source": "@docs/hello.md",
"title": "Hello, World !",
"version": undefined,
},
"en-permalink": Object {
"id": "en-permalink",
"language": "en",
"localized_id": "permalink",
"permalink": "/docs/en/endiliey/permalink",
"source": "@docs/permalink.md",
"title": "Permalink",
"version": undefined,
},
"ko-foo/bar": Object {
"category": "Test",
"id": "ko-foo/bar",
"language": "ko",
"localized_id": "foo/bar",
"next": "ko-foo/baz",
"next_id": "foo/baz",
"next_title": "baz",
"permalink": "/docs/ko/foo/bar",
"sidebar": "docs",
"source": "@translated_docs/ko/foo/bar.md",
"title": "Bar",
"version": undefined,
},
"ko-foo/baz": Object {
"category": "Test",
"id": "ko-foo/baz",
"language": "ko",
"localized_id": "foo/baz",
"next": "ko-hello",
"next_id": "hello",
"next_title": "Hello, World !",
"permalink": "/docs/ko/foo/baz",
"previous": "ko-foo/bar",
"previous_id": "foo/bar",
"previous_title": "Bar",
"sidebar": "docs",
"source": "@translated_docs/ko/foo/baz.md",
"title": "baz",
"version": undefined,
},
"ko-hello": Object {
"category": "Guides",
"id": "ko-hello",
"language": "ko",
"localized_id": "hello",
"permalink": "/docs/ko/hello",
"previous": "ko-foo/baz",
"previous_id": "foo/baz",
"previous_title": "baz",
"sidebar": "docs",
"source": "@translated_docs/ko/hello.md",
"title": "Hello, World !",
"version": undefined,
},
}
`;
exports[`loadDocs versioned & translated website 1`] = `
Object {
"en-foo/bar": Object {
"category": "Test",
"id": "en-foo/bar",
"language": "en",
"localized_id": "foo/bar",
"next": "en-foo/baz",
"next_id": "foo/baz",
"next_title": "baz",
"permalink": "/docs/en/next/foo/bar",
"sidebar": "docs",
"source": "@docs/foo/bar.md",
"title": "Bar",
"version": "next",
},
"en-foo/baz": Object {
"category": "Test",
"id": "en-foo/baz",
"language": "en",
"localized_id": "foo/baz",
"next": "en-hello",
"next_id": "hello",
"next_title": "Hello, World !",
"permalink": "/docs/en/next/foo/baz",
"previous": "en-foo/bar",
"previous_id": "foo/bar",
"previous_title": "Bar",
"sidebar": "docs",
"source": "@docs/foo/baz.md",
"title": "baz",
"version": "next",
},
"en-hello": Object {
"category": "Guides",
"id": "en-hello",
"language": "en",
"localized_id": "hello",
"permalink": "/docs/en/next/hello",
"previous": "en-foo/baz",
"previous_id": "foo/baz",
"previous_title": "baz",
"sidebar": "docs",
"source": "@docs/hello.md",
"title": "Hello, World !",
"version": "next",
},
"en-permalink": Object {
"id": "en-permalink",
"language": "en",
"localized_id": "permalink",
"permalink": "/docs/en/next/endiliey/permalink",
"source": "@docs/permalink.md",
"title": "Permalink",
"version": "next",
},
"en-version-1.0.0-foo/bar": Object {
"category": "Test",
"id": "en-version-1.0.0-foo/bar",
"language": "en",
"localized_id": "version-1.0.0-foo/bar",
"next": "en-version-1.0.0-foo/baz",
"next_id": "version-1.0.0-foo/baz",
"next_title": "Baz",
"permalink": "/docs/en/1.0.0/foo/bar",
"sidebar": "version-1.0.0-docs",
"source": "@versioned_docs/version-1.0.0/foo/bar.md",
"title": "Bar",
"version": "1.0.0",
},
"en-version-1.0.0-foo/baz": Object {
"category": "Test",
"id": "en-version-1.0.0-foo/baz",
"language": "en",
"localized_id": "version-1.0.0-foo/baz",
"next": "en-version-1.0.0-hello",
"next_id": "version-1.0.0-hello",
"next_title": "Hello, World !",
"permalink": "/docs/en/1.0.0/foo/baz",
"previous": "en-version-1.0.0-foo/bar",
"previous_id": "version-1.0.0-foo/bar",
"previous_title": "Bar",
"sidebar": "version-1.0.0-docs",
"source": "@versioned_docs/version-1.0.0/foo/baz.md",
"title": "Baz",
"version": "1.0.0",
},
"en-version-1.0.0-hello": Object {
"category": "Guides",
"id": "en-version-1.0.0-hello",
"language": "en",
"localized_id": "version-1.0.0-hello",
"permalink": "/docs/en/1.0.0/hello",
"previous": "en-version-1.0.0-foo/baz",
"previous_id": "version-1.0.0-foo/baz",
"previous_title": "Baz",
"sidebar": "version-1.0.0-docs",
"source": "@versioned_docs/version-1.0.0/hello.md",
"title": "Hello, World !",
"version": "1.0.0",
},
"en-version-1.0.1-foo/bar": Object {
"category": "Test",
"id": "en-version-1.0.1-foo/bar",
"language": "en",
"localized_id": "version-1.0.1-foo/bar",
"next": "en-version-1.0.1-foo/baz",
"next_id": "version-1.0.1-foo/baz",
"next_title": "Baz",
"permalink": "/docs/en/foo/bar",
"sidebar": "version-1.0.1-docs",
"source": "@versioned_docs/version-1.0.1/foo/bar.md",
"title": "Bar",
"version": "1.0.1",
},
"en-version-1.0.1-foo/baz": Object {
"category": "Test",
"id": "en-version-1.0.1-foo/baz",
"language": "en",
"localized_id": "version-1.0.1-foo/baz",
"next": "en-version-1.0.1-hello",
"next_id": "version-1.0.1-hello",
"next_title": "Hello, World !",
"permalink": "/docs/en/foo/baz",
"previous": "en-version-1.0.1-foo/bar",
"previous_id": "version-1.0.1-foo/bar",
"previous_title": "Bar",
"sidebar": "version-1.0.1-docs",
"source": "@versioned_docs/version-1.0.1/foo/baz.md",
"title": "Baz",
"version": "1.0.1",
},
"en-version-1.0.1-hello": Object {
"category": "Guides",
"id": "en-version-1.0.1-hello",
"language": "en",
"localized_id": "version-1.0.1-hello",
"permalink": "/docs/en/hello",
"previous": "en-version-1.0.1-foo/baz",
"previous_id": "version-1.0.1-foo/baz",
"previous_title": "Baz",
"sidebar": "version-1.0.1-docs",
"source": "@versioned_docs/version-1.0.1/hello.md",
"title": "Hello, World !",
"version": "1.0.1",
},
"ko-foo/bar": Object {
"category": "Test",
"id": "ko-foo/bar",
"language": "ko",
"localized_id": "foo/bar",
"next": "ko-foo/baz",
"next_id": "foo/baz",
"next_title": "baz",
"permalink": "/docs/ko/next/foo/bar",
"sidebar": "docs",
"source": "@translated_docs/ko/foo/bar.md",
"title": "Bar",
"version": "next",
},
"ko-foo/baz": Object {
"category": "Test",
"id": "ko-foo/baz",
"language": "ko",
"localized_id": "foo/baz",
"next": "ko-hello",
"next_id": "hello",
"next_title": "Hello, World !",
"permalink": "/docs/ko/next/foo/baz",
"previous": "ko-foo/bar",
"previous_id": "foo/bar",
"previous_title": "Bar",
"sidebar": "docs",
"source": "@translated_docs/ko/foo/baz.md",
"title": "baz",
"version": "next",
},
"ko-hello": Object {
"category": "Guides",
"id": "ko-hello",
"language": "ko",
"localized_id": "hello",
"permalink": "/docs/ko/next/hello",
"previous": "ko-foo/baz",
"previous_id": "foo/baz",
"previous_title": "baz",
"sidebar": "docs",
"source": "@translated_docs/ko/hello.md",
"title": "Hello, World !",
"version": "next",
},
"ko-version-1.0.0-foo/bar": Object {
"category": "Test",
"id": "ko-version-1.0.0-foo/bar",
"language": "ko",
"localized_id": "version-1.0.0-foo/bar",
"next": "ko-version-1.0.0-foo/baz",
"next_id": "version-1.0.0-foo/baz",
"next_title": "baz",
"permalink": "/docs/ko/1.0.0/foo/bar",
"sidebar": "version-1.0.0-docs",
"source": "@translated_docs/ko/version-1.0.0/foo/bar.md",
"title": "Bar",
"version": "1.0.0",
},
"ko-version-1.0.0-foo/baz": Object {
"category": "Test",
"id": "ko-version-1.0.0-foo/baz",
"language": "ko",
"localized_id": "version-1.0.0-foo/baz",
"next": "ko-version-1.0.0-hello",
"next_id": "version-1.0.0-hello",
"next_title": "Hello, World !",
"permalink": "/docs/ko/1.0.0/foo/baz",
"previous": "ko-version-1.0.0-foo/bar",
"previous_id": "version-1.0.0-foo/bar",
"previous_title": "Bar",
"sidebar": "version-1.0.0-docs",
"source": "@translated_docs/ko/version-1.0.0/foo/baz.md",
"title": "baz",
"version": "1.0.0",
},
"ko-version-1.0.0-hello": Object {
"category": "Guides",
"id": "ko-version-1.0.0-hello",
"language": "ko",
"localized_id": "version-1.0.0-hello",
"permalink": "/docs/ko/1.0.0/hello",
"previous": "ko-version-1.0.0-foo/baz",
"previous_id": "version-1.0.0-foo/baz",
"previous_title": "baz",
"sidebar": "version-1.0.0-docs",
"source": "@translated_docs/ko/version-1.0.0/hello.md",
"title": "Hello, World !",
"version": "1.0.0",
},
"ko-version-1.0.1-foo/bar": Object {
"category": "Test",
"id": "ko-version-1.0.1-foo/bar",
"language": "ko",
"localized_id": "version-1.0.1-foo/bar",
"next": "ko-version-1.0.1-foo/baz",
"next_id": "version-1.0.1-foo/baz",
"next_title": "baz",
"permalink": "/docs/ko/foo/bar",
"sidebar": "version-1.0.1-docs",
"source": "@translated_docs/ko/version-1.0.1/foo/bar.md",
"title": "Bar",
"version": "1.0.1",
},
"ko-version-1.0.1-foo/baz": Object {
"category": "Test",
"id": "ko-version-1.0.1-foo/baz",
"language": "ko",
"localized_id": "version-1.0.1-foo/baz",
"next": "ko-version-1.0.1-hello",
"next_id": "version-1.0.1-hello",
"next_title": "Hello, World !",
"permalink": "/docs/ko/foo/baz",
"previous": "ko-version-1.0.1-foo/bar",
"previous_id": "version-1.0.1-foo/bar",
"previous_title": "Bar",
"sidebar": "version-1.0.1-docs",
"source": "@translated_docs/ko/version-1.0.1/foo/baz.md",
"title": "baz",
"version": "1.0.1",
},
"ko-version-1.0.1-hello": Object {
"category": "Guides",
"id": "ko-version-1.0.1-hello",
"language": "ko",
"localized_id": "version-1.0.1-hello",
"permalink": "/docs/ko/hello",
"previous": "ko-version-1.0.1-foo/baz",
"previous_id": "version-1.0.1-foo/baz",
"previous_title": "baz",
"sidebar": "version-1.0.1-docs",
"source": "@translated_docs/ko/version-1.0.1/hello.md",
"title": "Hello, World !",
"version": "1.0.1",
},
}
`;
exports[`loadDocs versioned website 1`] = `
Object {
"foo/bar": Object {
"category": "Test",
"id": "foo/bar",
"language": undefined,
"localized_id": "foo/bar",
"next": "foo/baz",
"next_id": "foo/baz",
"next_title": "baz",
"permalink": "/docs/next/foo/bar",
"sidebar": "docs",
"source": "@docs/foo/bar.md",
"title": "Bar",
"version": "next",
},
"foo/baz": Object {
"category": "Test",
"id": "foo/baz",
"language": undefined,
"localized_id": "foo/baz",
"next": "hello",
"next_id": "hello",
"next_title": "Hello, World !",
"permalink": "/docs/next/foo/baz",
"previous": "foo/bar",
"previous_id": "foo/bar",
"previous_title": "Bar",
"sidebar": "docs",
"source": "@docs/foo/baz.md",
"title": "baz",
"version": "next",
},
"hello": Object {
"category": "Guides",
"id": "hello",
"language": undefined,
"localized_id": "hello",
"permalink": "/docs/next/hello",
"previous": "foo/baz",
"previous_id": "foo/baz",
"previous_title": "baz",
"sidebar": "docs",
"source": "@docs/hello.md",
"title": "Hello, World !",
"version": "next",
},
"permalink": Object {
"id": "permalink",
"language": undefined,
"localized_id": "permalink",
"permalink": "/docs/next/endiliey/permalink",
"source": "@docs/permalink.md",
"title": "Permalink",
"version": "next",
},
"version-1.0.0-foo/bar": Object {
"category": "Test",
"id": "version-1.0.0-foo/bar",
"language": undefined,
"localized_id": "version-1.0.0-foo/bar",
"next": "version-1.0.0-foo/baz",
"next_id": "version-1.0.0-foo/baz",
"next_title": "Baz",
"permalink": "/docs/1.0.0/foo/bar",
"sidebar": "version-1.0.0-docs",
"source": "@versioned_docs/version-1.0.0/foo/bar.md",
"title": "Bar",
"version": "1.0.0",
},
"version-1.0.0-foo/baz": Object {
"category": "Test",
"id": "version-1.0.0-foo/baz",
"language": undefined,
"localized_id": "version-1.0.0-foo/baz",
"next": "version-1.0.0-hello",
"next_id": "version-1.0.0-hello",
"next_title": "Hello, World !",
"permalink": "/docs/1.0.0/foo/baz",
"previous": "version-1.0.0-foo/bar",
"previous_id": "version-1.0.0-foo/bar",
"previous_title": "Bar",
"sidebar": "version-1.0.0-docs",
"source": "@versioned_docs/version-1.0.0/foo/baz.md",
"title": "Baz",
"version": "1.0.0",
},
"version-1.0.0-hello": Object {
"category": "Guides",
"id": "version-1.0.0-hello",
"language": undefined,
"localized_id": "version-1.0.0-hello",
"permalink": "/docs/1.0.0/hello",
"previous": "version-1.0.0-foo/baz",
"previous_id": "version-1.0.0-foo/baz",
"previous_title": "Baz",
"sidebar": "version-1.0.0-docs",
"source": "@versioned_docs/version-1.0.0/hello.md",
"title": "Hello, World !",
"version": "1.0.0",
},
"version-1.0.1-foo/bar": Object {
"category": "Test",
"id": "version-1.0.1-foo/bar",
"language": undefined,
"localized_id": "version-1.0.1-foo/bar",
"next": "version-1.0.1-foo/baz",
"next_id": "version-1.0.1-foo/baz",
"next_title": "Baz",
"permalink": "/docs/foo/bar",
"sidebar": "version-1.0.1-docs",
"source": "@versioned_docs/version-1.0.1/foo/bar.md",
"title": "Bar",
"version": "1.0.1",
},
"version-1.0.1-foo/baz": Object {
"category": "Test",
"id": "version-1.0.1-foo/baz",
"language": undefined,
"localized_id": "version-1.0.1-foo/baz",
"next": "version-1.0.1-hello",
"next_id": "version-1.0.1-hello",
"next_title": "Hello, World !",
"permalink": "/docs/foo/baz",
"previous": "version-1.0.1-foo/bar",
"previous_id": "version-1.0.1-foo/bar",
"previous_title": "Bar",
"sidebar": "version-1.0.1-docs",
"source": "@versioned_docs/version-1.0.1/foo/baz.md",
"title": "Baz",
"version": "1.0.1",
},
"version-1.0.1-hello": Object {
"category": "Guides",
"id": "version-1.0.1-hello",
"language": undefined,
"localized_id": "version-1.0.1-hello",
"permalink": "/docs/hello",
"previous": "version-1.0.1-foo/baz",
"previous_id": "version-1.0.1-foo/baz",
"previous_title": "Baz",
"sidebar": "version-1.0.1-docs",
"source": "@versioned_docs/version-1.0.1/hello.md",
"title": "Hello, World !",
"version": "1.0.1",
},
}
`;

View file

@ -0,0 +1,45 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`loadSidebars normal site with sidebars 1`] = `
Object {
"docs": Object {
"Getting Started": Array [
"installation",
],
"Guides": Array [
"blog",
],
},
}
`;
exports[`loadSidebars site with sidebars & versioned sidebars 1`] = `
Object {
"docs": Object {
"Getting Started": Array [
"installation",
],
"Guides": Array [
"blog",
],
},
"version-1.0.0-docs": Object {
"Getting Started": Array [
"version-1.0.0-installation",
],
"Guides": Array [
"version-1.0.0-blog",
],
},
"version-1.0.1-docs": Object {
"Getting Started": Array [
"version-1.0.1-installation",
],
"Guides": Array [
"version-1.0.1-blog",
],
},
}
`;
exports[`loadSidebars site without sidebars 1`] = `Object {}`;

View file

@ -0,0 +1,32 @@
import loadDocs from '@lib/load/docs';
import loadSetup from '../../loadSetup';
describe('loadDocs', () => {
test('simple website', async () => {
const props = await loadSetup('simple');
const {siteDir, docsDir, env, siteConfig} = props;
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
expect(docsMetadatas).toMatchSnapshot();
});
test('versioned website', async () => {
const props = await loadSetup('versioned');
const {siteDir, docsDir, env, siteConfig} = props;
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
expect(docsMetadatas).toMatchSnapshot();
});
test('versioned & translated website', async () => {
const props = await loadSetup('transversioned');
const {siteDir, docsDir, env, siteConfig} = props;
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
expect(docsMetadatas).toMatchSnapshot();
});
test('translated website', async () => {
const props = await loadSetup('translated');
const {siteDir, docsDir, env, siteConfig} = props;
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
expect(docsMetadatas).toMatchSnapshot();
});
});

View file

@ -0,0 +1,154 @@
import path from 'path';
import processMetadata from '@lib/load/docs/metadata';
import loadSetup from '../../loadSetup';
describe('processMetadata', () => {
test('normal docs', async () => {
const props = await loadSetup('simple');
const {docsDir, env, siteConfig} = props;
const sourceA = path.join('foo', 'bar.md');
const sourceB = path.join('hello.md');
const dataA = await processMetadata(sourceA, docsDir, env, {}, siteConfig);
const dataB = await processMetadata(sourceB, docsDir, env, {}, siteConfig);
expect(dataA).toEqual({
id: 'foo/bar',
language: undefined,
localized_id: 'foo/bar',
permalink: '/docs/foo/bar',
source: '@docs/foo/bar.md',
title: 'Bar',
version: undefined
});
expect(dataB).toEqual({
id: 'hello',
language: undefined,
localized_id: 'hello',
permalink: '/docs/hello',
source: '@docs/hello.md',
title: 'Hello, World !',
version: undefined
});
});
test('docs with custom permalink', async () => {
const props = await loadSetup('simple');
const {docsDir, env, siteConfig} = props;
const source = path.join('permalink.md');
const data = await processMetadata(source, docsDir, env, {}, siteConfig);
expect(data).toEqual({
id: 'permalink',
language: undefined,
localized_id: 'permalink',
permalink: '/docs/endiliey/permalink',
source: '@docs/permalink.md',
title: 'Permalink',
version: undefined
});
});
test('versioned docs (without translation)', async () => {
const props = await loadSetup('versioned');
const {siteDir, env, siteConfig} = props;
const refDir = path.join(siteDir, 'versioned_docs');
const sourceA = path.join('version-1.0.0', 'foo', 'bar.md');
const sourceB = path.join('version-1.0.0', 'hello.md');
const dataA = await processMetadata(sourceA, refDir, env, {}, siteConfig);
const dataB = await processMetadata(sourceB, refDir, env, {}, siteConfig);
expect(dataA).toEqual({
id: 'version-1.0.0-foo/bar',
language: undefined,
localized_id: 'version-1.0.0-foo/bar',
permalink: '/docs/1.0.0/foo/bar',
source: '@versioned_docs/version-1.0.0/foo/bar.md',
title: 'Bar',
version: '1.0.0'
});
expect(dataB).toEqual({
id: 'version-1.0.0-hello',
language: undefined,
localized_id: 'version-1.0.0-hello',
permalink: '/docs/1.0.0/hello',
source: '@versioned_docs/version-1.0.0/hello.md',
title: 'Hello, World !',
version: '1.0.0'
});
});
test('translated versioned docs', async () => {
const props = await loadSetup('transversioned');
const {siteDir, env, siteConfig} = props;
const refDir = path.join(siteDir, 'translated_docs');
const sourceA = path.join('ko', 'version-1.0.0', 'foo', 'bar.md');
const sourceB = path.join('ko', 'version-1.0.0', 'hello.md');
const sourceC = path.join('ko', 'version-1.0.1', 'foo', 'bar.md');
const sourceD = path.join('ko', 'version-1.0.1', 'hello.md');
const dataA = await processMetadata(sourceA, refDir, env, {}, siteConfig);
const dataB = await processMetadata(sourceB, refDir, env, {}, siteConfig);
const dataC = await processMetadata(sourceC, refDir, env, {}, siteConfig);
const dataD = await processMetadata(sourceD, refDir, env, {}, siteConfig);
expect(dataA).toEqual({
id: 'ko-version-1.0.0-foo/bar',
language: 'ko',
localized_id: 'version-1.0.0-foo/bar',
permalink: '/docs/ko/1.0.0/foo/bar',
source: '@translated_docs/ko/version-1.0.0/foo/bar.md',
title: 'Bar',
version: '1.0.0'
});
expect(dataB).toEqual({
id: 'ko-version-1.0.0-hello',
language: 'ko',
localized_id: 'version-1.0.0-hello',
permalink: '/docs/ko/1.0.0/hello',
source: '@translated_docs/ko/version-1.0.0/hello.md',
title: 'Hello, World !',
version: '1.0.0'
});
expect(dataC).toEqual({
id: 'ko-version-1.0.1-foo/bar',
language: 'ko',
localized_id: 'version-1.0.1-foo/bar',
permalink: '/docs/ko/foo/bar',
source: '@translated_docs/ko/version-1.0.1/foo/bar.md',
title: 'Bar',
version: '1.0.1'
});
expect(dataD).toEqual({
id: 'ko-version-1.0.1-hello',
language: 'ko',
localized_id: 'version-1.0.1-hello',
permalink: '/docs/ko/hello',
source: '@translated_docs/ko/version-1.0.1/hello.md',
title: 'Hello, World !',
version: '1.0.1'
});
});
test('translated docs only', async () => {
const props = await loadSetup('translated');
const {siteDir, env, siteConfig} = props;
const refDir = path.join(siteDir, 'translated_docs');
const sourceA = path.join('ko', 'foo', 'bar.md');
const sourceB = path.join('ko', 'hello.md');
const dataA = await processMetadata(sourceA, refDir, env, {}, siteConfig);
const dataB = await processMetadata(sourceB, refDir, env, {}, siteConfig);
expect(dataA).toEqual({
id: 'ko-foo/bar',
language: 'ko',
localized_id: 'foo/bar',
permalink: '/docs/ko/foo/bar',
source: '@translated_docs/ko/foo/bar.md',
title: 'Bar',
version: undefined
});
expect(dataB).toEqual({
id: 'ko-hello',
language: 'ko',
localized_id: 'hello',
permalink: '/docs/ko/hello',
source: '@translated_docs/ko/hello.md',
title: 'Hello, World !',
version: undefined
});
});
});

View file

@ -0,0 +1,85 @@
import createOrder from '@lib/load/docs/order';
describe('createOrder', () => {
test('should populate docs index from multiple sidebars', () => {
const result = createOrder({
docs: {
Category1: ['doc1', 'doc2'],
Category2: ['doc3', 'doc4']
},
otherDocs: {
Category1: ['doc5']
}
});
expect(result).toEqual({
doc1: {
category: 'Category1',
next: 'doc2',
previous: undefined,
sidebar: 'docs'
},
doc2: {
category: 'Category1',
next: 'doc3',
previous: 'doc1',
sidebar: 'docs'
},
doc3: {
category: 'Category2',
next: 'doc4',
previous: 'doc2',
sidebar: 'docs'
},
doc4: {
category: 'Category2',
next: undefined,
previous: 'doc3',
sidebar: 'docs'
},
doc5: {
category: 'Category1',
next: undefined,
previous: undefined,
sidebar: 'otherDocs'
}
});
});
test('should resolve docs from older versions', () => {
const result = createOrder({
docs: {
Category1: ['doc1']
},
'version-1.2.3-docs': {
Category1: ['version-1.2.3-doc2'],
Category2: ['version-1.2.3-doc1']
}
});
expect(result).toEqual({
doc1: {
category: 'Category1',
next: undefined,
previous: undefined,
sidebar: 'docs'
},
'version-1.2.3-doc1': {
category: 'Category2',
next: undefined,
previous: 'version-1.2.3-doc2',
sidebar: 'version-1.2.3-docs'
},
'version-1.2.3-doc2': {
category: 'Category1',
next: 'version-1.2.3-doc1',
previous: undefined,
sidebar: 'version-1.2.3-docs'
}
});
});
test('edge cases', () => {
expect(createOrder({})).toEqual({});
expect(createOrder(null)).toEqual({});
expect(createOrder(undefined)).toEqual({});
});
});

View file

@ -0,0 +1,46 @@
import path from 'path';
import loadSidebars from '@lib/load/docs/sidebars';
describe('loadSidebars', () => {
const fixtures = path.join(__dirname, '..', '__fixtures__');
test('normal site with sidebars', () => {
const env = {};
const siteDir = path.join(fixtures, 'simple-site');
const result = loadSidebars({siteDir, env});
expect(result).toMatchSnapshot();
});
test('site without sidebars', () => {
const env = {};
const siteDir = path.join(fixtures, 'bad-site');
const result = loadSidebars({siteDir, env});
expect(result).toMatchSnapshot();
});
test('site with sidebars & versioned sidebars', () => {
const env = {
versioning: {
enabled: true,
versions: ['1.0.1', '1.0.0']
}
};
const siteDir = path.join(fixtures, 'versioned-site');
const result = loadSidebars({siteDir, env});
expect(result).toMatchSnapshot();
});
test('site with missing versioned sidebars', () => {
const env = {
versioning: {
enabled: true,
versions: ['2.0.0']
}
};
const siteDir = path.join(fixtures, 'versioned-site');
expect(() => {
loadSidebars({siteDir, env});
}).toThrowErrorMatchingInlineSnapshot(
`"Failed to load versioned_sidebars/version-2.0.0-sidebars.json. It does not exist."`
);
});
});