@docusaurus/plugin-content-docs 2.0.0-beta.fbdeefcac → 2.0.0-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/categoryGeneratedIndex.d.ts +12 -0
- package/lib/categoryGeneratedIndex.js +37 -0
- package/lib/cli.d.ts +3 -2
- package/lib/cli.js +57 -72
- package/lib/client/docsClientUtils.d.ts +9 -28
- package/lib/client/docsClientUtils.js +34 -43
- package/lib/client/index.d.ts +81 -0
- package/lib/client/index.js +67 -0
- package/lib/constants.d.ts +4 -0
- package/lib/constants.js +4 -1
- package/lib/docs.d.ts +34 -7
- package/lib/docs.js +202 -79
- package/{src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docusaurus.config.js → lib/frontMatter.d.ts} +4 -8
- package/lib/{docFrontMatter.js → frontMatter.js} +22 -3
- package/lib/globalData.d.ts +3 -3
- package/lib/globalData.js +35 -6
- package/lib/index.d.ts +3 -3
- package/lib/index.js +124 -154
- package/lib/lastUpdate.d.ts +4 -6
- package/lib/lastUpdate.js +22 -26
- package/lib/markdown/index.d.ts +3 -6
- package/lib/markdown/index.js +3 -3
- package/lib/markdown/linkify.d.ts +1 -1
- package/lib/markdown/linkify.js +6 -3
- package/lib/numberPrefix.d.ts +1 -1
- package/lib/numberPrefix.js +16 -21
- package/lib/options.d.ts +3 -5
- package/lib/options.js +56 -23
- package/lib/props.d.ts +7 -2
- package/lib/props.js +84 -14
- package/lib/routes.d.ts +29 -0
- package/lib/routes.js +96 -0
- package/lib/server-export.d.ts +9 -0
- package/lib/server-export.js +25 -0
- package/lib/{sidebarItemsGenerator.d.ts → sidebars/generator.d.ts} +1 -6
- package/lib/sidebars/generator.js +209 -0
- package/lib/sidebars/index.d.ts +13 -0
- package/lib/sidebars/index.js +92 -0
- package/lib/sidebars/normalization.d.ts +13 -0
- package/lib/sidebars/normalization.js +59 -0
- package/lib/sidebars/postProcessor.d.ts +11 -0
- package/lib/sidebars/postProcessor.js +81 -0
- package/lib/sidebars/processor.d.ts +10 -0
- package/lib/sidebars/processor.js +79 -0
- package/lib/sidebars/types.d.ts +183 -0
- package/lib/{docFrontMatter.d.ts → sidebars/types.js} +2 -2
- package/lib/sidebars/utils.d.ts +55 -0
- package/lib/sidebars/utils.js +259 -0
- package/lib/sidebars/validation.d.ts +11 -0
- package/lib/sidebars/validation.js +143 -0
- package/lib/slug.d.ts +5 -4
- package/lib/slug.js +28 -18
- package/{src/__tests__/__fixtures__/sidebars/sidebars-first-level-not-category.js → lib/tags.d.ts} +3 -14
- package/lib/tags.js +21 -0
- package/lib/translations.d.ts +3 -3
- package/lib/translations.js +100 -93
- package/lib/types.d.ts +13 -185
- package/lib/versions/files.d.ts +50 -0
- package/lib/versions/files.js +141 -0
- package/lib/versions/index.d.ts +36 -0
- package/lib/versions/index.js +154 -0
- package/lib/versions/validation.d.ts +17 -0
- package/lib/versions/validation.js +71 -0
- package/package.json +44 -30
- package/src/categoryGeneratedIndex.ts +60 -0
- package/src/cli.ts +88 -114
- package/src/client/docsClientUtils.ts +44 -71
- package/src/client/index.ts +158 -0
- package/src/constants.ts +4 -2
- package/src/docs.ts +281 -83
- package/src/frontMatter.ts +63 -0
- package/src/globalData.ts +57 -7
- package/src/index.ts +183 -224
- package/src/lastUpdate.ts +27 -38
- package/src/markdown/index.ts +10 -16
- package/src/markdown/linkify.ts +7 -4
- package/src/numberPrefix.ts +19 -26
- package/src/options.ts +61 -29
- package/src/plugin-content-docs.d.ts +569 -93
- package/src/props.ts +121 -21
- package/src/routes.ts +159 -0
- package/src/server-export.ts +26 -0
- package/src/sidebars/README.md +10 -0
- package/src/sidebars/generator.ts +292 -0
- package/src/sidebars/index.ts +118 -0
- package/src/sidebars/normalization.ts +91 -0
- package/src/sidebars/postProcessor.ts +112 -0
- package/src/sidebars/processor.ts +123 -0
- package/src/sidebars/types.ts +280 -0
- package/src/sidebars/utils.ts +393 -0
- package/src/sidebars/validation.ts +179 -0
- package/src/slug.ts +41 -22
- package/src/tags.ts +20 -0
- package/src/translations.ts +155 -124
- package/src/types.ts +17 -250
- package/src/versions/files.ts +216 -0
- package/src/versions/index.ts +246 -0
- package/src/versions/validation.ts +115 -0
- package/lib/.tsbuildinfo +0 -1
- package/lib/sidebarItemsGenerator.js +0 -211
- package/lib/sidebars.d.ts +0 -43
- package/lib/sidebars.js +0 -320
- package/lib/theme/hooks/useDocs.d.ts +0 -20
- package/lib/theme/hooks/useDocs.js +0 -75
- package/lib/versions.d.ts +0 -16
- package/lib/versions.js +0 -319
- package/src/__tests__/__fixtures__/bad-id-site/docs/invalid-id.md +0 -5
- package/src/__tests__/__fixtures__/bad-slug-on-doc-home-site/docs/docWithSlug.md +0 -5
- package/src/__tests__/__fixtures__/empty-site/docusaurus.config.js +0 -16
- package/src/__tests__/__fixtures__/empty-site/sidebars.json +0 -1
- package/src/__tests__/__fixtures__/sidebars/sidebars-category-shorthand.js +0 -34
- package/src/__tests__/__fixtures__/sidebars/sidebars-category-wrong-items.json +0 -11
- package/src/__tests__/__fixtures__/sidebars/sidebars-category-wrong-label.json +0 -11
- package/src/__tests__/__fixtures__/sidebars/sidebars-category.js +0 -44
- package/src/__tests__/__fixtures__/sidebars/sidebars-collapsed-first-level.json +0 -20
- package/src/__tests__/__fixtures__/sidebars/sidebars-collapsed.json +0 -21
- package/src/__tests__/__fixtures__/sidebars/sidebars-doc-id-not-string.json +0 -10
- package/src/__tests__/__fixtures__/sidebars/sidebars-link-wrong-href.json +0 -11
- package/src/__tests__/__fixtures__/sidebars/sidebars-link-wrong-label.json +0 -11
- package/src/__tests__/__fixtures__/sidebars/sidebars-link.json +0 -11
- package/src/__tests__/__fixtures__/sidebars/sidebars-unknown-type.json +0 -14
- package/src/__tests__/__fixtures__/sidebars/sidebars-wrong-field.json +0 -20
- package/src/__tests__/__fixtures__/sidebars/sidebars.json +0 -20
- package/src/__tests__/__fixtures__/simple-site/docs/foo/bar.md +0 -69
- package/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md +0 -70
- package/src/__tests__/__fixtures__/simple-site/docs/headingAsTitle.md +0 -1
- package/src/__tests__/__fixtures__/simple-site/docs/hello.md +0 -53
- package/src/__tests__/__fixtures__/simple-site/docs/ipsum.md +0 -5
- package/src/__tests__/__fixtures__/simple-site/docs/lorem.md +0 -6
- package/src/__tests__/__fixtures__/simple-site/docs/rootAbsoluteSlug.md +0 -5
- package/src/__tests__/__fixtures__/simple-site/docs/rootRelativeSlug.md +0 -5
- package/src/__tests__/__fixtures__/simple-site/docs/rootResolvedSlug.md +0 -5
- package/src/__tests__/__fixtures__/simple-site/docs/rootTryToEscapeSlug.md +0 -5
- package/src/__tests__/__fixtures__/simple-site/docs/slugs/absoluteSlug.md +0 -5
- package/src/__tests__/__fixtures__/simple-site/docs/slugs/relativeSlug.md +0 -5
- package/src/__tests__/__fixtures__/simple-site/docs/slugs/resolvedSlug.md +0 -5
- package/src/__tests__/__fixtures__/simple-site/docs/slugs/tryToEscapeSlug.md +0 -5
- package/src/__tests__/__fixtures__/simple-site/docusaurus.config.js +0 -14
- package/src/__tests__/__fixtures__/simple-site/sidebars.json +0 -23
- package/src/__tests__/__fixtures__/simple-site/wrong-sidebars.json +0 -7
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/0-getting-started.md +0 -3
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/1-installation.md +0 -3
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/00_api-overview.md +0 -3
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/01_Core APIs/0 --- Client API.md +0 -1
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/01_Core APIs/1 --- Server API.md +0 -1
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/0. Plugin API.md +0 -1
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/1. Theme API.md +0 -1
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/02_Extension APIs/_category_.yml +0 -1
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/03_api-end.md +0 -3
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/3-API/_category_.json +0 -3
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/0-guide2.5.md +0 -8
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/02-guide2.md +0 -7
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/_category_.json +0 -3
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/a-guide4.md +0 -7
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/b-guide5.md +0 -7
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/guide3.md +0 -8
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/docs/Guides/z-guide1.md +0 -8
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/partialAutogeneratedSidebars.js +0 -23
- package/src/__tests__/__fixtures__/site-with-autogenerated-sidebar/partialAutogeneratedSidebars2.js +0 -16
- package/src/__tests__/__fixtures__/site-with-doc-label/docs/hello-1.md +0 -7
- package/src/__tests__/__fixtures__/site-with-doc-label/docs/hello-2.md +0 -8
- package/src/__tests__/__fixtures__/site-with-doc-label/docusaurus.config.js +0 -14
- package/src/__tests__/__fixtures__/site-with-doc-label/sidebars.json +0 -14
- package/src/__tests__/__fixtures__/versioned-site/community/team.md +0 -1
- package/src/__tests__/__fixtures__/versioned-site/community_sidebars.json +0 -3
- package/src/__tests__/__fixtures__/versioned-site/community_versioned_docs/version-1.0.0/team.md +0 -1
- package/src/__tests__/__fixtures__/versioned-site/community_versioned_sidebars/version-1.0.0-sidebars.json +0 -3
- package/src/__tests__/__fixtures__/versioned-site/community_versions.json +0 -1
- package/src/__tests__/__fixtures__/versioned-site/docs/foo/bar.md +0 -4
- package/src/__tests__/__fixtures__/versioned-site/docs/hello.md +0 -1
- package/src/__tests__/__fixtures__/versioned-site/docs/slugs/absoluteSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/docs/slugs/relativeSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/docs/slugs/resolvedSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/docs/slugs/tryToEscapeSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/docusaurus.config.js +0 -18
- package/src/__tests__/__fixtures__/versioned-site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md +0 -1
- package/src/__tests__/__fixtures__/versioned-site/i18n/en/docusaurus-plugin-content-docs-community/current/team.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md +0 -1
- package/src/__tests__/__fixtures__/versioned-site/sidebars.json +0 -10
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/foo/bar.md +0 -4
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/foo/baz.md +0 -1
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/hello.md +0 -1
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/foo/bar.md +0 -1
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.1/hello.md +0 -1
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootAbsoluteSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootRelativeSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootResolvedSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/rootTryToEscapeSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/absoluteSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/relativeSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/resolvedSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-withSlugs/slugs/tryToEscapeSlug.md +0 -5
- package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.0-sidebars.json +0 -11
- package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.1-sidebars.json +0 -10
- package/src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-withSlugs-sidebars.json +0 -5
- package/src/__tests__/__fixtures__/versioned-site/versions.json +0 -5
- package/src/__tests__/__snapshots__/cli.test.ts.snap +0 -90
- package/src/__tests__/__snapshots__/index.test.ts.snap +0 -1916
- package/src/__tests__/__snapshots__/sidebars.test.ts.snap +0 -218
- package/src/__tests__/__snapshots__/translations.test.ts.snap +0 -487
- package/src/__tests__/cli.test.ts +0 -333
- package/src/__tests__/docFrontMatter.test.ts +0 -244
- package/src/__tests__/docs.test.ts +0 -878
- package/src/__tests__/index.test.ts +0 -1871
- package/src/__tests__/lastUpdate.test.ts +0 -69
- package/src/__tests__/numberPrefix.test.ts +0 -199
- package/src/__tests__/options.test.ts +0 -231
- package/src/__tests__/sidebarItemsGenerator.test.ts +0 -336
- package/src/__tests__/sidebars.test.ts +0 -639
- package/src/__tests__/slug.test.ts +0 -109
- package/src/__tests__/translations.test.ts +0 -159
- package/src/__tests__/versions.test.ts +0 -741
- package/src/client/__tests__/docsClientUtils.test.ts +0 -371
- package/src/docFrontMatter.ts +0 -41
- package/src/markdown/__tests__/__fixtures__/docs/doc-localized.md +0 -1
- package/src/markdown/__tests__/__fixtures__/docs/doc1.md +0 -13
- package/src/markdown/__tests__/__fixtures__/docs/doc2.md +0 -12
- package/src/markdown/__tests__/__fixtures__/docs/doc4.md +0 -19
- package/src/markdown/__tests__/__fixtures__/docs/doc5.md +0 -6
- package/src/markdown/__tests__/__fixtures__/docs/subdir/doc3.md +0 -3
- package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/doc2.md +0 -7
- package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/subdir/doc1.md +0 -3
- package/src/markdown/__tests__/__snapshots__/linkify.test.ts.snap +0 -82
- package/src/markdown/__tests__/linkify.test.ts +0 -190
- package/src/sidebarItemsGenerator.ts +0 -307
- package/src/sidebars.ts +0 -522
- package/src/theme/hooks/useDocs.ts +0 -103
- package/src/versions.ts +0 -572
- package/tsconfig.json +0 -9
- package/types.d.ts +0 -13
|
@@ -1,109 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
-
*
|
|
4
|
-
* This source code is licensed under the MIT license found in the
|
|
5
|
-
* LICENSE file in the root directory of this source tree.
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import getSlug from '../slug';
|
|
9
|
-
|
|
10
|
-
describe('getSlug', () => {
|
|
11
|
-
test('should default to dirname/id', () => {
|
|
12
|
-
expect(getSlug({baseID: 'doc', dirName: '/dir'})).toEqual('/dir/doc');
|
|
13
|
-
expect(getSlug({baseID: 'doc', dirName: '/dir/subdir'})).toEqual(
|
|
14
|
-
'/dir/subdir/doc',
|
|
15
|
-
);
|
|
16
|
-
});
|
|
17
|
-
|
|
18
|
-
test('can strip dir number prefixes', () => {
|
|
19
|
-
expect(
|
|
20
|
-
getSlug({
|
|
21
|
-
baseID: 'doc',
|
|
22
|
-
dirName: '/001-dir1/002-dir2',
|
|
23
|
-
stripDirNumberPrefixes: true,
|
|
24
|
-
}),
|
|
25
|
-
).toEqual('/dir1/dir2/doc');
|
|
26
|
-
expect(
|
|
27
|
-
getSlug({
|
|
28
|
-
baseID: 'doc',
|
|
29
|
-
dirName: '/001-dir1/002-dir2',
|
|
30
|
-
stripDirNumberPrefixes: false,
|
|
31
|
-
}),
|
|
32
|
-
).toEqual('/001-dir1/002-dir2/doc');
|
|
33
|
-
});
|
|
34
|
-
|
|
35
|
-
// See https://github.com/facebook/docusaurus/issues/3223
|
|
36
|
-
test('should handle special chars in doc path', () => {
|
|
37
|
-
expect(
|
|
38
|
-
getSlug({baseID: 'my dôc', dirName: '/dir with spâce/hey $hello'}),
|
|
39
|
-
).toEqual('/dir with spâce/hey $hello/my dôc');
|
|
40
|
-
});
|
|
41
|
-
|
|
42
|
-
test('should handle current dir', () => {
|
|
43
|
-
expect(getSlug({baseID: 'doc', dirName: '.'})).toEqual('/doc');
|
|
44
|
-
expect(getSlug({baseID: 'doc', dirName: '/'})).toEqual('/doc');
|
|
45
|
-
});
|
|
46
|
-
|
|
47
|
-
test('should resolve absolute slug frontmatter', () => {
|
|
48
|
-
expect(
|
|
49
|
-
getSlug({baseID: 'any', dirName: '.', frontmatterSlug: '/abc/def'}),
|
|
50
|
-
).toEqual('/abc/def');
|
|
51
|
-
expect(
|
|
52
|
-
getSlug({baseID: 'any', dirName: './any', frontmatterSlug: '/abc/def'}),
|
|
53
|
-
).toEqual('/abc/def');
|
|
54
|
-
expect(
|
|
55
|
-
getSlug({
|
|
56
|
-
baseID: 'any',
|
|
57
|
-
dirName: './any/any',
|
|
58
|
-
frontmatterSlug: '/abc/def',
|
|
59
|
-
}),
|
|
60
|
-
).toEqual('/abc/def');
|
|
61
|
-
});
|
|
62
|
-
|
|
63
|
-
test('should resolve relative slug frontmatter', () => {
|
|
64
|
-
expect(
|
|
65
|
-
getSlug({baseID: 'any', dirName: '.', frontmatterSlug: 'abc/def'}),
|
|
66
|
-
).toEqual('/abc/def');
|
|
67
|
-
expect(
|
|
68
|
-
getSlug({baseID: 'any', dirName: '/dir', frontmatterSlug: 'abc/def'}),
|
|
69
|
-
).toEqual('/dir/abc/def');
|
|
70
|
-
expect(
|
|
71
|
-
getSlug({
|
|
72
|
-
baseID: 'any',
|
|
73
|
-
dirName: 'unslashedDir',
|
|
74
|
-
frontmatterSlug: 'abc/def',
|
|
75
|
-
}),
|
|
76
|
-
).toEqual('/unslashedDir/abc/def');
|
|
77
|
-
expect(
|
|
78
|
-
getSlug({
|
|
79
|
-
baseID: 'any',
|
|
80
|
-
dirName: 'dir/subdir',
|
|
81
|
-
frontmatterSlug: 'abc/def',
|
|
82
|
-
}),
|
|
83
|
-
).toEqual('/dir/subdir/abc/def');
|
|
84
|
-
expect(
|
|
85
|
-
getSlug({baseID: 'any', dirName: '/dir', frontmatterSlug: './abc/def'}),
|
|
86
|
-
).toEqual('/dir/abc/def');
|
|
87
|
-
expect(
|
|
88
|
-
getSlug({
|
|
89
|
-
baseID: 'any',
|
|
90
|
-
dirName: '/dir',
|
|
91
|
-
frontmatterSlug: './abc/../def',
|
|
92
|
-
}),
|
|
93
|
-
).toEqual('/dir/def');
|
|
94
|
-
expect(
|
|
95
|
-
getSlug({
|
|
96
|
-
baseID: 'any',
|
|
97
|
-
dirName: '/dir/subdir',
|
|
98
|
-
frontmatterSlug: '../abc/def',
|
|
99
|
-
}),
|
|
100
|
-
).toEqual('/dir/abc/def');
|
|
101
|
-
expect(
|
|
102
|
-
getSlug({
|
|
103
|
-
baseID: 'any',
|
|
104
|
-
dirName: '/dir/subdir',
|
|
105
|
-
frontmatterSlug: '../../../../../abc/../def',
|
|
106
|
-
}),
|
|
107
|
-
).toEqual('/def');
|
|
108
|
-
});
|
|
109
|
-
});
|
|
@@ -1,159 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
3
|
-
*
|
|
4
|
-
* This source code is licensed under the MIT license found in the
|
|
5
|
-
* LICENSE file in the root directory of this source tree.
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import {LoadedContent, DocMetadata, LoadedVersion} from '../types';
|
|
9
|
-
import {CURRENT_VERSION_NAME} from '../constants';
|
|
10
|
-
import {
|
|
11
|
-
getLoadedContentTranslationFiles,
|
|
12
|
-
translateLoadedContent,
|
|
13
|
-
} from '../translations';
|
|
14
|
-
import {updateTranslationFileMessages} from '@docusaurus/utils';
|
|
15
|
-
|
|
16
|
-
function createSampleDoc(doc: Pick<DocMetadata, 'id'>): DocMetadata {
|
|
17
|
-
return {
|
|
18
|
-
editUrl: 'any',
|
|
19
|
-
isDocsHomePage: false,
|
|
20
|
-
lastUpdatedAt: 0,
|
|
21
|
-
lastUpdatedBy: 'any',
|
|
22
|
-
next: undefined,
|
|
23
|
-
previous: undefined,
|
|
24
|
-
permalink: 'any',
|
|
25
|
-
slug: 'any',
|
|
26
|
-
source: 'any',
|
|
27
|
-
unversionedId: 'any',
|
|
28
|
-
version: 'any',
|
|
29
|
-
title: `${doc.id} title`,
|
|
30
|
-
sidebar_label: `${doc.id} title`,
|
|
31
|
-
description: `${doc.id} description`,
|
|
32
|
-
...doc,
|
|
33
|
-
};
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
function createSampleVersion(
|
|
37
|
-
version: Pick<LoadedVersion, 'versionName'>,
|
|
38
|
-
): LoadedVersion {
|
|
39
|
-
return {
|
|
40
|
-
versionLabel: `${version.versionName} label`,
|
|
41
|
-
versionPath: '/docs/',
|
|
42
|
-
mainDocId: '',
|
|
43
|
-
permalinkToSidebar: {},
|
|
44
|
-
routePriority: undefined,
|
|
45
|
-
sidebarFilePath: 'any',
|
|
46
|
-
isLast: true,
|
|
47
|
-
contentPath: 'any',
|
|
48
|
-
contentPathLocalized: 'any',
|
|
49
|
-
docs: [
|
|
50
|
-
createSampleDoc({
|
|
51
|
-
id: 'doc1',
|
|
52
|
-
}),
|
|
53
|
-
createSampleDoc({
|
|
54
|
-
id: 'doc2',
|
|
55
|
-
}),
|
|
56
|
-
createSampleDoc({
|
|
57
|
-
id: 'doc3',
|
|
58
|
-
}),
|
|
59
|
-
createSampleDoc({
|
|
60
|
-
id: 'doc4',
|
|
61
|
-
}),
|
|
62
|
-
createSampleDoc({
|
|
63
|
-
id: 'doc5',
|
|
64
|
-
}),
|
|
65
|
-
],
|
|
66
|
-
sidebars: {
|
|
67
|
-
docs: [
|
|
68
|
-
{
|
|
69
|
-
type: 'category',
|
|
70
|
-
label: 'Getting started',
|
|
71
|
-
collapsed: false,
|
|
72
|
-
items: [
|
|
73
|
-
{
|
|
74
|
-
type: 'doc',
|
|
75
|
-
id: 'doc1',
|
|
76
|
-
},
|
|
77
|
-
{
|
|
78
|
-
type: 'doc',
|
|
79
|
-
id: 'doc2',
|
|
80
|
-
},
|
|
81
|
-
{
|
|
82
|
-
type: 'link',
|
|
83
|
-
label: 'Link label',
|
|
84
|
-
href: 'https://facebook.com',
|
|
85
|
-
},
|
|
86
|
-
{
|
|
87
|
-
type: 'ref',
|
|
88
|
-
id: 'doc1',
|
|
89
|
-
},
|
|
90
|
-
],
|
|
91
|
-
},
|
|
92
|
-
{
|
|
93
|
-
type: 'doc',
|
|
94
|
-
id: 'doc3',
|
|
95
|
-
},
|
|
96
|
-
],
|
|
97
|
-
otherSidebar: [
|
|
98
|
-
{
|
|
99
|
-
type: 'doc',
|
|
100
|
-
id: 'doc4',
|
|
101
|
-
},
|
|
102
|
-
{
|
|
103
|
-
type: 'doc',
|
|
104
|
-
id: 'doc5',
|
|
105
|
-
},
|
|
106
|
-
],
|
|
107
|
-
},
|
|
108
|
-
...version,
|
|
109
|
-
};
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
const SampleLoadedContent: LoadedContent = {
|
|
113
|
-
loadedVersions: [
|
|
114
|
-
createSampleVersion({
|
|
115
|
-
versionName: CURRENT_VERSION_NAME,
|
|
116
|
-
}),
|
|
117
|
-
createSampleVersion({
|
|
118
|
-
versionName: '2.0.0',
|
|
119
|
-
}),
|
|
120
|
-
createSampleVersion({
|
|
121
|
-
versionName: '1.0.0',
|
|
122
|
-
}),
|
|
123
|
-
],
|
|
124
|
-
};
|
|
125
|
-
|
|
126
|
-
function getSampleTranslationFiles() {
|
|
127
|
-
return getLoadedContentTranslationFiles(SampleLoadedContent);
|
|
128
|
-
}
|
|
129
|
-
function getSampleTranslationFilesTranslated() {
|
|
130
|
-
const translationFiles = getSampleTranslationFiles();
|
|
131
|
-
return translationFiles.map((translationFile) =>
|
|
132
|
-
updateTranslationFileMessages(
|
|
133
|
-
translationFile,
|
|
134
|
-
(message) => `${message} (translated)`,
|
|
135
|
-
),
|
|
136
|
-
);
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
describe('getLoadedContentTranslationFiles', () => {
|
|
140
|
-
test('should return translation files matching snapshot', async () => {
|
|
141
|
-
expect(getSampleTranslationFiles()).toMatchSnapshot();
|
|
142
|
-
});
|
|
143
|
-
});
|
|
144
|
-
|
|
145
|
-
describe('translateLoadedContent', () => {
|
|
146
|
-
test('should not translate anything if translation files are untranslated', () => {
|
|
147
|
-
const translationFiles = getSampleTranslationFiles();
|
|
148
|
-
expect(
|
|
149
|
-
translateLoadedContent(SampleLoadedContent, translationFiles),
|
|
150
|
-
).toEqual(SampleLoadedContent);
|
|
151
|
-
});
|
|
152
|
-
|
|
153
|
-
test('should return translated loaded content matching snapshot', () => {
|
|
154
|
-
const translationFiles = getSampleTranslationFilesTranslated();
|
|
155
|
-
expect(
|
|
156
|
-
translateLoadedContent(SampleLoadedContent, translationFiles),
|
|
157
|
-
).toMatchSnapshot();
|
|
158
|
-
});
|
|
159
|
-
});
|