feat:docs translation + versioning 💥

This commit is contained in:
endiliey 2018-09-07 20:41:04 +08:00
parent 31d333b82f
commit 0f38ae3979
20 changed files with 1133 additions and 520 deletions

View file

@ -0,0 +1,593 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`loadDocs simple website 1`] = `
Object {
"baseUrl": "/",
"docsData": Object {
"foo/bar": Object {
"id": "foo/bar",
"language": undefined,
"localized_id": "foo/bar",
"permalink": "docs/foo/bar",
"source": "foo/bar.md",
"title": "Bar",
"version": undefined,
},
"foo/baz": Object {
"id": "foo/baz",
"language": undefined,
"localized_id": "foo/baz",
"permalink": "docs/foo/baz",
"source": "foo/baz.md",
"title": "baz",
"version": undefined,
},
"hello": Object {
"id": "hello",
"language": undefined,
"localized_id": "hello",
"permalink": "docs/hello",
"source": "hello.md",
"title": "Hello, World !",
"version": undefined,
},
},
"docsDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/docs",
"env": Object {
"translation": Object {
"defaultLanguage": Object {},
"enabled": false,
"enabledLanguages": Array [],
},
"versioning": Object {
"defaultVersion": null,
"enabled": false,
"latestVersion": null,
"versions": Array [],
},
},
"outDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/simple-site/build",
"pagesData": Array [
Object {
"path": "/",
"source": "index.js",
},
Object {
"path": "/hello/world",
"source": "hello/world.js",
},
],
"pagesDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/simple-site/pages",
"siteConfig": Object {
"baseUrl": "/",
"organizationName": "endiliey",
"projectName": "hello",
"tagline": "Hello World",
"title": "Hello",
},
"siteDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/simple-site",
"themePath": "/mnt/c/Users/endij/Desktop/Linux/munseo/lib/theme",
}
`;
exports[`loadDocs translated website 1`] = `
Object {
"baseUrl": "/",
"docsData": Object {
"en-hello": Object {
"id": "en-hello",
"language": "en",
"localized_id": "en-hello",
"permalink": "docs/en/hello",
"source": "hello.md",
"title": "Hello, World !",
"version": undefined,
},
"foo/bar": Object {
"id": "foo/bar",
"language": undefined,
"localized_id": "foo/bar",
"permalink": "docs/foo/bar",
"source": "foo/bar.md",
"title": "Bar",
"version": undefined,
},
"foo/baz": Object {
"id": "foo/baz",
"language": undefined,
"localized_id": "foo/baz",
"permalink": "docs/foo/baz",
"source": "foo/baz.md",
"title": "baz",
"version": undefined,
},
"ko-docs/foo/bar": Object {
"id": "ko-docs/foo/bar",
"language": "ko",
"localized_id": "ko-docs/foo/bar",
"permalink": "docs/ko/docs/foo/bar",
"source": "ko/docs/foo/bar.md",
"title": "Bar",
"version": undefined,
},
"ko-docs/foo/baz": Object {
"id": "ko-docs/foo/baz",
"language": "ko",
"localized_id": "ko-docs/foo/baz",
"permalink": "docs/ko/docs/foo/baz",
"source": "ko/docs/foo/baz.md",
"title": "baz",
"version": undefined,
},
"ko-docs/hello": Object {
"id": "ko-docs/hello",
"language": "ko",
"localized_id": "ko-docs/hello",
"permalink": "docs/ko/docs/hello",
"source": "ko/docs/hello.md",
"title": "Hello, World !",
"version": undefined,
},
},
"docsDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/docs",
"env": Object {
"translation": Object {
"defaultLanguage": Object {
"enabled": true,
"name": "English",
"tag": "en",
},
"enabled": true,
"enabledLanguages": Array [
Object {
"enabled": true,
"name": "English",
"tag": "en",
},
Object {
"enabled": true,
"name": "한국어",
"tag": "ko",
},
],
},
"versioning": Object {
"defaultVersion": null,
"enabled": false,
"latestVersion": null,
"versions": Array [],
},
},
"outDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/translated-site/build",
"pagesData": Array [
Object {
"path": "/",
"source": "index.js",
},
Object {
"path": "/hello/world",
"source": "hello/world.js",
},
],
"pagesDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/translated-site/pages",
"siteConfig": Object {
"baseUrl": "/",
"defaultLanguage": "en",
"organizationName": "endiliey",
"projectName": "hello",
"tagline": "Hello World",
"title": "Hello",
},
"siteDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/translated-site",
"themePath": "/mnt/c/Users/endij/Desktop/Linux/munseo/lib/theme",
}
`;
exports[`loadDocs versioned & translated website 1`] = `
Object {
"baseUrl": "/",
"docsData": Object {
"en-hello": Object {
"id": "en-hello",
"language": "en",
"localized_id": "en-hello",
"permalink": "docs/en/next/hello",
"source": "hello.md",
"title": "Hello, World !",
"version": "next",
},
"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": "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": "Next",
"permalink": "docs/next/foo/baz",
"previous": "foo/bar",
"previous_id": "foo/bar",
"previous_title": "Bar",
"sidebar": "docs",
"source": "foo/baz.md",
"title": "baz",
"version": "next",
},
"ko-version-1.0.0-version-1.0.0/foo/bar": Object {
"id": "ko-version-1.0.0-version-1.0.0/foo/bar",
"language": "ko",
"localized_id": "ko-version-1.0.0-version-1.0.0/foo/bar",
"permalink": "docs/ko/1.0.0/version-1.0.0/foo/bar",
"source": "ko/version-1.0.0/foo/bar.md",
"title": "Bar",
"version": "1.0.0",
},
"ko-version-1.0.0-version-1.0.0/foo/baz": Object {
"id": "ko-version-1.0.0-version-1.0.0/foo/baz",
"language": "ko",
"localized_id": "ko-version-1.0.0-version-1.0.0/foo/baz",
"permalink": "docs/ko/1.0.0/version-1.0.0/foo/baz",
"source": "ko/version-1.0.0/foo/baz.md",
"title": "baz",
"version": "1.0.0",
},
"ko-version-1.0.0-version-1.0.0/hello": Object {
"id": "ko-version-1.0.0-version-1.0.0/hello",
"language": "ko",
"localized_id": "ko-version-1.0.0-version-1.0.0/hello",
"permalink": "docs/ko/1.0.0/version-1.0.0/hello",
"source": "ko/version-1.0.0/hello.md",
"title": "Hello, World !",
"version": "1.0.0",
},
"ko-version-1.0.1-version-1.0.1/foo/bar": Object {
"id": "ko-version-1.0.1-version-1.0.1/foo/bar",
"language": "ko",
"localized_id": "ko-version-1.0.1-version-1.0.1/foo/bar",
"permalink": "docs/ko/version-1.0.1/foo/bar",
"source": "ko/version-1.0.1/foo/bar.md",
"title": "Bar",
"version": "1.0.1",
},
"ko-version-1.0.1-version-1.0.1/foo/baz": Object {
"id": "ko-version-1.0.1-version-1.0.1/foo/baz",
"language": "ko",
"localized_id": "ko-version-1.0.1-version-1.0.1/foo/baz",
"permalink": "docs/ko/version-1.0.1/foo/baz",
"source": "ko/version-1.0.1/foo/baz.md",
"title": "baz",
"version": "1.0.1",
},
"ko-version-1.0.1-version-1.0.1/hello": Object {
"id": "ko-version-1.0.1-version-1.0.1/hello",
"language": "ko",
"localized_id": "ko-version-1.0.1-version-1.0.1/hello",
"permalink": "docs/ko/version-1.0.1/hello",
"source": "ko/version-1.0.1/hello.md",
"title": "Hello, World !",
"version": "1.0.1",
},
"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": "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": "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": "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": "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": "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": "version-1.0.1/hello.md",
"title": "Hello, World !",
"version": "1.0.1",
},
},
"docsDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/docs",
"env": Object {
"translation": Object {
"defaultLanguage": Object {
"enabled": true,
"name": "English",
"tag": "en",
},
"enabled": true,
"enabledLanguages": Array [
Object {
"enabled": true,
"name": "English",
"tag": "en",
},
Object {
"enabled": true,
"name": "한국어",
"tag": "ko",
},
],
},
"versioning": Object {
"defaultVersion": "1.0.1",
"enabled": true,
"latestVersion": "1.0.1",
"versions": Array [
"1.0.1",
"1.0.0",
],
},
},
"outDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/transversioned-site/build",
"pagesData": Array [
Object {
"path": "/",
"source": "index.js",
},
Object {
"path": "/hello/world",
"source": "hello/world.js",
},
],
"pagesDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/transversioned-site/pages",
"siteConfig": Object {
"baseUrl": "/",
"defaultLanguage": "en",
"organizationName": "endiliey",
"projectName": "hello",
"tagline": "Hello World",
"title": "Hello",
},
"siteDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/transversioned-site",
"themePath": "/mnt/c/Users/endij/Desktop/Linux/munseo/lib/theme",
}
`;
exports[`loadDocs versioned website 1`] = `
Object {
"baseUrl": "/",
"docsData": Object {
"foo/bar": Object {
"id": "foo/bar",
"language": undefined,
"localized_id": "foo/bar",
"permalink": "docs/next/foo/bar",
"source": "foo/bar.md",
"title": "Bar",
"version": "next",
},
"foo/baz": Object {
"id": "foo/baz",
"language": undefined,
"localized_id": "foo/baz",
"permalink": "docs/next/foo/baz",
"source": "foo/baz.md",
"title": "baz",
"version": "next",
},
"hello": Object {
"id": "hello",
"language": undefined,
"localized_id": "hello",
"permalink": "docs/next/hello",
"source": "hello.md",
"title": "Hello, World !",
"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": "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": "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": "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": "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": "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": "version-1.0.1/hello.md",
"title": "Hello, World !",
"version": "1.0.1",
},
},
"docsDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/docs",
"env": Object {
"translation": Object {
"defaultLanguage": Object {},
"enabled": false,
"enabledLanguages": Array [],
},
"versioning": Object {
"defaultVersion": "1.0.1",
"enabled": true,
"latestVersion": "1.0.1",
"versions": Array [
"1.0.1",
"1.0.0",
],
},
},
"outDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/versioned-site/build",
"pagesData": Array [
Object {
"path": "/",
"source": "index.js",
},
Object {
"path": "/hello/world",
"source": "hello/world.js",
},
],
"pagesDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/versioned-site/pages",
"siteConfig": Object {
"baseUrl": "/",
"organizationName": "endiliey",
"projectName": "hello",
"tagline": "Hello World",
"title": "Hello",
},
"siteDir": "/mnt/c/Users/endij/Desktop/Linux/munseo/test/__fixtures__/versioned-site",
"themePath": "/mnt/c/Users/endij/Desktop/Linux/munseo/lib/theme",
}
`;

View file

@ -0,0 +1,23 @@
import loadSetup from '../../loadSetup';
describe('loadDocs', () => {
test('simple website', async () => {
const props = await loadSetup('simple');
expect(props).toMatchSnapshot();
});
test('versioned website', async () => {
const props = await loadSetup('versioned');
expect(props).toMatchSnapshot();
});
test('versioned & translated website', async () => {
const props = await loadSetup('transversioned');
expect(props).toMatchSnapshot();
});
test('translated website', async () => {
const props = await loadSetup('translated');
expect(props).toMatchSnapshot();
});
});

View file

@ -1,35 +1,35 @@
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).toMatchSnapshot();
});
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).toMatchSnapshot();
});
test('edge cases', () => {
expect(createOrder({})).toEqual({});
expect(createOrder(null)).toEqual({});
expect(createOrder(undefined)).toEqual({});
});
});
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).toMatchSnapshot();
});
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).toMatchSnapshot();
});
test('edge cases', () => {
expect(createOrder({})).toEqual({});
expect(createOrder(null)).toEqual({});
expect(createOrder(undefined)).toEqual({});
});
});

View file

@ -1,46 +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."`
);
});
});
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."`
);
});
});