mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-19 20:17:06 +02:00
refactor(v2): use absolute path instead of alias for metadata source (#967)
refactor(v2): use absolute path instead of alias for metadata source
This commit is contained in:
parent
f2927a9fc4
commit
b401a2adc0
8 changed files with 366 additions and 646 deletions
|
@ -106,16 +106,10 @@ module.exports = async function processMetadata(
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
The docs file source
|
The docs absolute file source
|
||||||
e.g: `@docs/hello.md` or `@versioned_docs/version-1.0.0/hello.md`
|
e.g: `/end/docs/hello.md` or `/end/website/versioned_docs/version-1.0.0/hello.md`
|
||||||
*/
|
*/
|
||||||
if (language && language !== defaultLangTag) {
|
metadata.source = path.join(refDir, source);
|
||||||
metadata.source = `@translated_docs/${source}`;
|
|
||||||
} else if (version && version !== 'next') {
|
|
||||||
metadata.source = `@versioned_docs/${source}`;
|
|
||||||
} else {
|
|
||||||
metadata.source = `@docs/${source}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Build the permalink */
|
/* Build the permalink */
|
||||||
const {baseUrl, docsUrl} = siteConfig;
|
const {baseUrl, docsUrl} = siteConfig;
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
const {getOptions} = require('loader-utils');
|
const {getOptions} = require('loader-utils');
|
||||||
|
const path = require('path');
|
||||||
const fm = require('front-matter');
|
const fm = require('front-matter');
|
||||||
|
|
||||||
module.exports = function(fileString) {
|
module.exports = function(fileString) {
|
||||||
|
@ -14,25 +15,23 @@ module.exports = function(fileString) {
|
||||||
/* Extract content of markdown (without frontmatter) */
|
/* Extract content of markdown (without frontmatter) */
|
||||||
const {body} = fm(fileString);
|
const {body} = fm(fileString);
|
||||||
|
|
||||||
/* Determine the source dir. e.g: @docs, @translated_docs/ko and @versioned_docs/version-1.0.0 */
|
/* Determine the source dir. e.g: /docs, /website/versioned_docs/version-1.0.0 */
|
||||||
let sourceDir;
|
let sourceDir;
|
||||||
let thisSource = this.resourcePath;
|
const thisSource = this.resourcePath;
|
||||||
if (thisSource.startsWith(translatedDir)) {
|
if (thisSource.startsWith(translatedDir)) {
|
||||||
thisSource = thisSource.replace(translatedDir, '@translated_docs');
|
|
||||||
const {language, version} = sourceToMetadata[thisSource] || {};
|
const {language, version} = sourceToMetadata[thisSource] || {};
|
||||||
if (language && version && version !== 'next') {
|
if (language && version && version !== 'next') {
|
||||||
sourceDir = `@translated_docs/${language}/version-${version}`;
|
sourceDir = path.join(translatedDir, language, `version-${version}`);
|
||||||
} else if (language && (!version || version === 'next')) {
|
} else if (language && (!version || version === 'next')) {
|
||||||
sourceDir = `@translated_docs/${language}`;
|
sourceDir = path.join(translatedDir, language);
|
||||||
}
|
}
|
||||||
} else if (thisSource.startsWith(versionedDir)) {
|
} else if (thisSource.startsWith(versionedDir)) {
|
||||||
thisSource = thisSource.replace(versionedDir, '@versioned_docs');
|
|
||||||
const {version} = sourceToMetadata[thisSource] || {};
|
const {version} = sourceToMetadata[thisSource] || {};
|
||||||
if (version) {
|
if (version) {
|
||||||
sourceDir = `@versioned_docs/version-${version}`;
|
sourceDir = path.join(versionedDir, `version-${version}`);
|
||||||
}
|
}
|
||||||
} else if (thisSource.startsWith(docsDir)) {
|
} else if (thisSource.startsWith(docsDir)) {
|
||||||
sourceDir = `@docs`;
|
sourceDir = docsDir;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Replace internal markdown linking (except in fenced blocks) */
|
/* Replace internal markdown linking (except in fenced blocks) */
|
||||||
|
|
|
@ -5,6 +5,20 @@ title: Hello, World !
|
||||||
|
|
||||||
안녕하세요, 여기 엔 틸리에 :)
|
안녕하세요, 여기 엔 틸리에 :)
|
||||||
|
|
||||||
|
## 상대 링크
|
||||||
|
|
||||||
|
이것 바꾸기
|
||||||
|
[foo](foo/bar.md)
|
||||||
|
|
||||||
|
이것을 대체 할 수 없습니다.
|
||||||
|
[파일] (file.md)
|
||||||
|
|
||||||
|
아래를 교체하지 마십시오.
|
||||||
|
|
||||||
|
```
|
||||||
|
[hello] (hello.md)
|
||||||
|
```
|
||||||
|
|
||||||
## Blockquotes
|
## Blockquotes
|
||||||
|
|
||||||
> Blockquotes는 또한 중첩 될 수 있습니다 ...
|
> Blockquotes는 또한 중첩 될 수 있습니다 ...
|
||||||
|
|
|
@ -5,6 +5,20 @@ title: Hello, World !
|
||||||
|
|
||||||
Hi, Endilie here :)
|
Hi, Endilie here :)
|
||||||
|
|
||||||
|
## Relative links
|
||||||
|
|
||||||
|
Replace this
|
||||||
|
[foo](foo/bar.md)
|
||||||
|
|
||||||
|
Can't replace this
|
||||||
|
[file](file.md)
|
||||||
|
|
||||||
|
Do not replace below
|
||||||
|
|
||||||
|
```
|
||||||
|
[hello](hello.md)
|
||||||
|
```
|
||||||
|
|
||||||
## Blockquotes
|
## Blockquotes
|
||||||
|
|
||||||
> Blockquotes can also be nested...
|
> Blockquotes can also be nested...
|
||||||
|
|
|
@ -5,6 +5,20 @@ title: Hello, World !
|
||||||
|
|
||||||
Hi, Endilie here :)
|
Hi, Endilie here :)
|
||||||
|
|
||||||
|
## Relative links
|
||||||
|
|
||||||
|
Replace this
|
||||||
|
[foo](foo/bar.md)
|
||||||
|
|
||||||
|
Can't replace this
|
||||||
|
[file](file.md)
|
||||||
|
|
||||||
|
Do not replace below
|
||||||
|
|
||||||
|
```
|
||||||
|
[hello](hello.md)
|
||||||
|
```
|
||||||
|
|
||||||
## Blockquotes
|
## Blockquotes
|
||||||
|
|
||||||
> Blockquotes can also be nested...
|
> Blockquotes can also be nested...
|
||||||
|
|
|
@ -1,597 +0,0 @@
|
||||||
// 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",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
`;
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
import path from 'path';
|
||||||
import loadDocs from '@lib/load/docs';
|
import loadDocs from '@lib/load/docs';
|
||||||
import loadSetup from '../../loadSetup';
|
import loadSetup from '../../loadSetup';
|
||||||
|
|
||||||
|
@ -6,27 +7,162 @@ describe('loadDocs', () => {
|
||||||
const props = await loadSetup('simple');
|
const props = await loadSetup('simple');
|
||||||
const {siteDir, docsDir, env, siteConfig} = props;
|
const {siteDir, docsDir, env, siteConfig} = props;
|
||||||
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
|
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
|
||||||
expect(docsMetadatas).toMatchSnapshot();
|
expect(docsMetadatas.hello).toEqual({
|
||||||
|
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: path.join(docsDir, 'hello.md'),
|
||||||
|
title: 'Hello, World !',
|
||||||
|
version: undefined,
|
||||||
|
});
|
||||||
|
expect(docsMetadatas['foo/bar']).toEqual({
|
||||||
|
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: path.join(docsDir, 'foo', 'bar.md'),
|
||||||
|
title: 'Bar',
|
||||||
|
version: undefined,
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test('versioned website', async () => {
|
test('versioned website', async () => {
|
||||||
const props = await loadSetup('versioned');
|
const props = await loadSetup('versioned');
|
||||||
const {siteDir, docsDir, env, siteConfig} = props;
|
const {siteDir, docsDir, versionedDir, env, siteConfig} = props;
|
||||||
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
|
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
|
||||||
expect(docsMetadatas).toMatchSnapshot();
|
expect(docsMetadatas['version-1.0.0-foo/bar']).toEqual({
|
||||||
|
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: path.join(versionedDir, 'version-1.0.0/foo/bar.md'),
|
||||||
|
title: 'Bar',
|
||||||
|
version: '1.0.0',
|
||||||
|
});
|
||||||
|
expect(docsMetadatas['foo/bar']).toEqual({
|
||||||
|
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: path.join(docsDir, 'foo/bar.md'),
|
||||||
|
title: 'Bar',
|
||||||
|
version: 'next',
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test('versioned & translated website', async () => {
|
test('versioned & translated website', async () => {
|
||||||
const props = await loadSetup('transversioned');
|
const props = await loadSetup('transversioned');
|
||||||
const {siteDir, docsDir, env, siteConfig} = props;
|
const {
|
||||||
|
siteDir,
|
||||||
|
docsDir,
|
||||||
|
env,
|
||||||
|
translatedDir,
|
||||||
|
versionedDir,
|
||||||
|
siteConfig,
|
||||||
|
} = props;
|
||||||
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
|
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
|
||||||
expect(docsMetadatas).toMatchSnapshot();
|
expect(docsMetadatas['ko-version-1.0.0-foo/bar']).toEqual({
|
||||||
|
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: path.join(translatedDir, '/ko/version-1.0.0/foo/bar.md'),
|
||||||
|
title: 'Bar',
|
||||||
|
version: '1.0.0',
|
||||||
|
});
|
||||||
|
expect(docsMetadatas['en-version-1.0.0-foo/baz']).toEqual({
|
||||||
|
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: path.join(versionedDir, 'version-1.0.0/foo/baz.md'),
|
||||||
|
title: 'Baz',
|
||||||
|
version: '1.0.0',
|
||||||
|
});
|
||||||
|
expect(docsMetadatas['en-hello']).toEqual({
|
||||||
|
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: path.join(docsDir, 'hello.md'),
|
||||||
|
title: 'Hello, World !',
|
||||||
|
version: 'next',
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test('translated website', async () => {
|
test('translated website', async () => {
|
||||||
const props = await loadSetup('translated');
|
const props = await loadSetup('translated');
|
||||||
const {siteDir, docsDir, env, siteConfig} = props;
|
const {siteDir, translatedDir, docsDir, env, siteConfig} = props;
|
||||||
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
|
const {docsMetadatas} = await loadDocs({siteDir, docsDir, env, siteConfig});
|
||||||
expect(docsMetadatas).toMatchSnapshot();
|
expect(docsMetadatas['ko-foo/baz']).toEqual({
|
||||||
|
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: path.join(translatedDir, 'ko', 'foo', 'baz.md'),
|
||||||
|
title: 'baz',
|
||||||
|
version: undefined,
|
||||||
|
});
|
||||||
|
expect(docsMetadatas['en-foo/bar']).toEqual({
|
||||||
|
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: path.join(docsDir, 'foo', 'bar.md'),
|
||||||
|
title: 'Bar',
|
||||||
|
version: undefined,
|
||||||
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
|
@ -15,7 +15,7 @@ describe('processMetadata', () => {
|
||||||
language: undefined,
|
language: undefined,
|
||||||
localized_id: 'foo/bar',
|
localized_id: 'foo/bar',
|
||||||
permalink: '/docs/foo/bar',
|
permalink: '/docs/foo/bar',
|
||||||
source: '@docs/foo/bar.md',
|
source: path.join(docsDir, sourceA),
|
||||||
title: 'Bar',
|
title: 'Bar',
|
||||||
version: undefined,
|
version: undefined,
|
||||||
});
|
});
|
||||||
|
@ -24,7 +24,7 @@ describe('processMetadata', () => {
|
||||||
language: undefined,
|
language: undefined,
|
||||||
localized_id: 'hello',
|
localized_id: 'hello',
|
||||||
permalink: '/docs/hello',
|
permalink: '/docs/hello',
|
||||||
source: '@docs/hello.md',
|
source: path.join(docsDir, sourceB),
|
||||||
title: 'Hello, World !',
|
title: 'Hello, World !',
|
||||||
version: undefined,
|
version: undefined,
|
||||||
});
|
});
|
||||||
|
@ -40,7 +40,7 @@ describe('processMetadata', () => {
|
||||||
language: undefined,
|
language: undefined,
|
||||||
localized_id: 'permalink',
|
localized_id: 'permalink',
|
||||||
permalink: '/docs/endiliey/permalink',
|
permalink: '/docs/endiliey/permalink',
|
||||||
source: '@docs/permalink.md',
|
source: path.join(docsDir, source),
|
||||||
title: 'Permalink',
|
title: 'Permalink',
|
||||||
version: undefined,
|
version: undefined,
|
||||||
});
|
});
|
||||||
|
@ -48,18 +48,34 @@ describe('processMetadata', () => {
|
||||||
|
|
||||||
test('versioned docs (without translation)', async () => {
|
test('versioned docs (without translation)', async () => {
|
||||||
const props = await loadSetup('versioned');
|
const props = await loadSetup('versioned');
|
||||||
const {siteDir, env, siteConfig} = props;
|
const {siteDir, docsDir, env, siteConfig} = props;
|
||||||
const refDir = path.join(siteDir, 'versioned_docs');
|
const versionedDir = path.join(siteDir, 'versioned_docs');
|
||||||
const sourceA = path.join('version-1.0.0', 'foo', 'bar.md');
|
const sourceA = path.join('version-1.0.0', 'foo', 'bar.md');
|
||||||
const sourceB = path.join('version-1.0.0', 'hello.md');
|
const sourceB = path.join('version-1.0.0', 'hello.md');
|
||||||
const dataA = await processMetadata(sourceA, refDir, env, {}, siteConfig);
|
const sourceC = path.join('foo', 'bar.md');
|
||||||
const dataB = await processMetadata(sourceB, refDir, env, {}, siteConfig);
|
const sourceD = path.join('hello.md');
|
||||||
|
const dataA = await processMetadata(
|
||||||
|
sourceA,
|
||||||
|
versionedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
|
const dataB = await processMetadata(
|
||||||
|
sourceB,
|
||||||
|
versionedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
|
const dataC = await processMetadata(sourceC, docsDir, env, {}, siteConfig);
|
||||||
|
const dataD = await processMetadata(sourceD, docsDir, env, {}, siteConfig);
|
||||||
expect(dataA).toEqual({
|
expect(dataA).toEqual({
|
||||||
id: 'version-1.0.0-foo/bar',
|
id: 'version-1.0.0-foo/bar',
|
||||||
language: undefined,
|
language: undefined,
|
||||||
localized_id: 'version-1.0.0-foo/bar',
|
localized_id: 'version-1.0.0-foo/bar',
|
||||||
permalink: '/docs/1.0.0/foo/bar',
|
permalink: '/docs/1.0.0/foo/bar',
|
||||||
source: '@versioned_docs/version-1.0.0/foo/bar.md',
|
source: path.join(versionedDir, sourceA),
|
||||||
title: 'Bar',
|
title: 'Bar',
|
||||||
version: '1.0.0',
|
version: '1.0.0',
|
||||||
});
|
});
|
||||||
|
@ -68,30 +84,91 @@ describe('processMetadata', () => {
|
||||||
language: undefined,
|
language: undefined,
|
||||||
localized_id: 'version-1.0.0-hello',
|
localized_id: 'version-1.0.0-hello',
|
||||||
permalink: '/docs/1.0.0/hello',
|
permalink: '/docs/1.0.0/hello',
|
||||||
source: '@versioned_docs/version-1.0.0/hello.md',
|
source: path.join(versionedDir, sourceB),
|
||||||
title: 'Hello, World !',
|
title: 'Hello, World !',
|
||||||
version: '1.0.0',
|
version: '1.0.0',
|
||||||
});
|
});
|
||||||
|
expect(dataC).toEqual({
|
||||||
|
id: 'foo/bar',
|
||||||
|
language: undefined,
|
||||||
|
localized_id: 'foo/bar',
|
||||||
|
permalink: '/docs/next/foo/bar',
|
||||||
|
source: path.join(docsDir, sourceC),
|
||||||
|
title: 'Bar',
|
||||||
|
version: 'next',
|
||||||
|
});
|
||||||
|
expect(dataD).toEqual({
|
||||||
|
id: 'hello',
|
||||||
|
language: undefined,
|
||||||
|
localized_id: 'hello',
|
||||||
|
permalink: '/docs/next/hello',
|
||||||
|
source: path.join(docsDir, sourceD),
|
||||||
|
title: 'Hello, World !',
|
||||||
|
version: 'next',
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test('translated versioned docs', async () => {
|
test('translated versioned docs', async () => {
|
||||||
const props = await loadSetup('transversioned');
|
const props = await loadSetup('transversioned');
|
||||||
const {siteDir, env, siteConfig} = props;
|
const {docsDir, translatedDir, versionedDir, env, siteConfig} = props;
|
||||||
const refDir = path.join(siteDir, 'translated_docs');
|
|
||||||
const sourceA = path.join('ko', 'version-1.0.0', 'foo', 'bar.md');
|
const sourceA = path.join('ko', 'version-1.0.0', 'foo', 'bar.md');
|
||||||
const sourceB = path.join('ko', 'version-1.0.0', 'hello.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 sourceC = path.join('ko', 'version-1.0.1', 'foo', 'bar.md');
|
||||||
const sourceD = path.join('ko', 'version-1.0.1', 'hello.md');
|
const sourceD = path.join('ko', 'version-1.0.1', 'hello.md');
|
||||||
const dataA = await processMetadata(sourceA, refDir, env, {}, siteConfig);
|
const sourceE = path.join('foo', 'bar.md');
|
||||||
const dataB = await processMetadata(sourceB, refDir, env, {}, siteConfig);
|
const sourceF = path.join('hello.md');
|
||||||
const dataC = await processMetadata(sourceC, refDir, env, {}, siteConfig);
|
const sourceG = path.join('version-1.0.0', 'foo', 'bar.md');
|
||||||
const dataD = await processMetadata(sourceD, refDir, env, {}, siteConfig);
|
const sourceH = path.join('version-1.0.0', 'hello.md');
|
||||||
|
const dataA = await processMetadata(
|
||||||
|
sourceA,
|
||||||
|
translatedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
|
const dataB = await processMetadata(
|
||||||
|
sourceB,
|
||||||
|
translatedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
|
const dataC = await processMetadata(
|
||||||
|
sourceC,
|
||||||
|
translatedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
|
const dataD = await processMetadata(
|
||||||
|
sourceD,
|
||||||
|
translatedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
|
const dataE = await processMetadata(sourceE, docsDir, env, {}, siteConfig);
|
||||||
|
const dataF = await processMetadata(sourceF, docsDir, env, {}, siteConfig);
|
||||||
|
const dataG = await processMetadata(
|
||||||
|
sourceG,
|
||||||
|
versionedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
|
const dataH = await processMetadata(
|
||||||
|
sourceH,
|
||||||
|
versionedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
expect(dataA).toEqual({
|
expect(dataA).toEqual({
|
||||||
id: 'ko-version-1.0.0-foo/bar',
|
id: 'ko-version-1.0.0-foo/bar',
|
||||||
language: 'ko',
|
language: 'ko',
|
||||||
localized_id: 'version-1.0.0-foo/bar',
|
localized_id: 'version-1.0.0-foo/bar',
|
||||||
permalink: '/docs/ko/1.0.0/foo/bar',
|
permalink: '/docs/ko/1.0.0/foo/bar',
|
||||||
source: '@translated_docs/ko/version-1.0.0/foo/bar.md',
|
source: path.join(translatedDir, sourceA),
|
||||||
title: 'Bar',
|
title: 'Bar',
|
||||||
version: '1.0.0',
|
version: '1.0.0',
|
||||||
});
|
});
|
||||||
|
@ -100,7 +177,7 @@ describe('processMetadata', () => {
|
||||||
language: 'ko',
|
language: 'ko',
|
||||||
localized_id: 'version-1.0.0-hello',
|
localized_id: 'version-1.0.0-hello',
|
||||||
permalink: '/docs/ko/1.0.0/hello',
|
permalink: '/docs/ko/1.0.0/hello',
|
||||||
source: '@translated_docs/ko/version-1.0.0/hello.md',
|
source: path.join(translatedDir, sourceB),
|
||||||
title: 'Hello, World !',
|
title: 'Hello, World !',
|
||||||
version: '1.0.0',
|
version: '1.0.0',
|
||||||
});
|
});
|
||||||
|
@ -109,7 +186,7 @@ describe('processMetadata', () => {
|
||||||
language: 'ko',
|
language: 'ko',
|
||||||
localized_id: 'version-1.0.1-foo/bar',
|
localized_id: 'version-1.0.1-foo/bar',
|
||||||
permalink: '/docs/ko/foo/bar',
|
permalink: '/docs/ko/foo/bar',
|
||||||
source: '@translated_docs/ko/version-1.0.1/foo/bar.md',
|
source: path.join(translatedDir, sourceC),
|
||||||
title: 'Bar',
|
title: 'Bar',
|
||||||
version: '1.0.1',
|
version: '1.0.1',
|
||||||
});
|
});
|
||||||
|
@ -118,26 +195,77 @@ describe('processMetadata', () => {
|
||||||
language: 'ko',
|
language: 'ko',
|
||||||
localized_id: 'version-1.0.1-hello',
|
localized_id: 'version-1.0.1-hello',
|
||||||
permalink: '/docs/ko/hello',
|
permalink: '/docs/ko/hello',
|
||||||
source: '@translated_docs/ko/version-1.0.1/hello.md',
|
source: path.join(translatedDir, sourceD),
|
||||||
title: 'Hello, World !',
|
title: 'Hello, World !',
|
||||||
version: '1.0.1',
|
version: '1.0.1',
|
||||||
});
|
});
|
||||||
|
expect(dataE).toEqual({
|
||||||
|
id: 'en-foo/bar',
|
||||||
|
language: 'en',
|
||||||
|
localized_id: 'foo/bar',
|
||||||
|
permalink: '/docs/en/next/foo/bar',
|
||||||
|
source: path.join(docsDir, sourceE),
|
||||||
|
title: 'Bar',
|
||||||
|
version: 'next',
|
||||||
|
});
|
||||||
|
expect(dataF).toEqual({
|
||||||
|
id: 'en-hello',
|
||||||
|
language: 'en',
|
||||||
|
localized_id: 'hello',
|
||||||
|
permalink: '/docs/en/next/hello',
|
||||||
|
source: path.join(docsDir, sourceF),
|
||||||
|
title: 'Hello, World !',
|
||||||
|
version: 'next',
|
||||||
|
});
|
||||||
|
expect(dataG).toEqual({
|
||||||
|
id: 'en-version-1.0.0-foo/bar',
|
||||||
|
language: 'en',
|
||||||
|
localized_id: 'version-1.0.0-foo/bar',
|
||||||
|
permalink: '/docs/en/1.0.0/foo/bar',
|
||||||
|
source: path.join(versionedDir, sourceG),
|
||||||
|
title: 'Bar',
|
||||||
|
version: '1.0.0',
|
||||||
|
});
|
||||||
|
expect(dataH).toEqual({
|
||||||
|
id: 'en-version-1.0.0-hello',
|
||||||
|
language: 'en',
|
||||||
|
localized_id: 'version-1.0.0-hello',
|
||||||
|
permalink: '/docs/en/1.0.0/hello',
|
||||||
|
source: path.join(versionedDir, sourceH),
|
||||||
|
title: 'Hello, World !',
|
||||||
|
version: '1.0.0',
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test('translated docs only', async () => {
|
test('translated docs only', async () => {
|
||||||
const props = await loadSetup('translated');
|
const props = await loadSetup('translated');
|
||||||
const {siteDir, env, siteConfig} = props;
|
const {docsDir, translatedDir, env, siteConfig} = props;
|
||||||
const refDir = path.join(siteDir, 'translated_docs');
|
|
||||||
const sourceA = path.join('ko', 'foo', 'bar.md');
|
const sourceA = path.join('ko', 'foo', 'bar.md');
|
||||||
const sourceB = path.join('ko', 'hello.md');
|
const sourceB = path.join('ko', 'hello.md');
|
||||||
const dataA = await processMetadata(sourceA, refDir, env, {}, siteConfig);
|
const sourceC = path.join('foo', 'bar.md');
|
||||||
const dataB = await processMetadata(sourceB, refDir, env, {}, siteConfig);
|
const sourceD = path.join('hello.md');
|
||||||
|
const dataA = await processMetadata(
|
||||||
|
sourceA,
|
||||||
|
translatedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
|
const dataB = await processMetadata(
|
||||||
|
sourceB,
|
||||||
|
translatedDir,
|
||||||
|
env,
|
||||||
|
{},
|
||||||
|
siteConfig,
|
||||||
|
);
|
||||||
|
const dataC = await processMetadata(sourceC, docsDir, env, {}, siteConfig);
|
||||||
|
const dataD = await processMetadata(sourceD, docsDir, env, {}, siteConfig);
|
||||||
expect(dataA).toEqual({
|
expect(dataA).toEqual({
|
||||||
id: 'ko-foo/bar',
|
id: 'ko-foo/bar',
|
||||||
language: 'ko',
|
language: 'ko',
|
||||||
localized_id: 'foo/bar',
|
localized_id: 'foo/bar',
|
||||||
permalink: '/docs/ko/foo/bar',
|
permalink: '/docs/ko/foo/bar',
|
||||||
source: '@translated_docs/ko/foo/bar.md',
|
source: path.join(translatedDir, sourceA),
|
||||||
title: 'Bar',
|
title: 'Bar',
|
||||||
version: undefined,
|
version: undefined,
|
||||||
});
|
});
|
||||||
|
@ -146,7 +274,25 @@ describe('processMetadata', () => {
|
||||||
language: 'ko',
|
language: 'ko',
|
||||||
localized_id: 'hello',
|
localized_id: 'hello',
|
||||||
permalink: '/docs/ko/hello',
|
permalink: '/docs/ko/hello',
|
||||||
source: '@translated_docs/ko/hello.md',
|
source: path.join(translatedDir, sourceB),
|
||||||
|
title: 'Hello, World !',
|
||||||
|
version: undefined,
|
||||||
|
});
|
||||||
|
expect(dataC).toEqual({
|
||||||
|
id: 'en-foo/bar',
|
||||||
|
language: 'en',
|
||||||
|
localized_id: 'foo/bar',
|
||||||
|
permalink: '/docs/en/foo/bar',
|
||||||
|
source: path.join(docsDir, sourceC),
|
||||||
|
title: 'Bar',
|
||||||
|
version: undefined,
|
||||||
|
});
|
||||||
|
expect(dataD).toEqual({
|
||||||
|
id: 'en-hello',
|
||||||
|
language: 'en',
|
||||||
|
localized_id: 'hello',
|
||||||
|
permalink: '/docs/en/hello',
|
||||||
|
source: path.join(docsDir, sourceD),
|
||||||
title: 'Hello, World !',
|
title: 'Hello, World !',
|
||||||
version: undefined,
|
version: undefined,
|
||||||
});
|
});
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue