3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-23 14:06:59 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(v2): docs options.onlyIncludeVersions (#3373)

Browse source 
* docs options.onlyIncludeVersions

* adapt docsVersionDropdown if we render a single version

* fix bad error message

* fix netlify deploy when versioning is disabled
This commit is contained in:
Sébastien Lorber 2020-08-31 17:08:24 +02:00 • committed by GitHub
parent 149d82c730
commit d8cfabb66a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 144 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

58
packages/docusaurus-plugin-content-docs/src/__tests__/versions.test.ts
View file

@ -146,7 +146,7 @@ describe('simple site', () => {
context: defaultContext,
}),
).toThrowErrorMatchingInlineSnapshot(
`"Docs versions option provided configuration for unknown versions: unknownVersionName1,unknownVersionName2. Available version names are: current"`,
`"Bad docs options.versions: unknown versions found: unknownVersionName1,unknownVersionName2. Available version names are: current"`,
);
});
@ -297,6 +297,19 @@ describe('versioned site, pluginId=default', () => {
]);
});
test('readVersionsMetadata versioned site with onlyIncludeVersions option', () => {
const versionsMetadata = readVersionsMetadata({
options: {
...defaultOptions,
// Order reversed on purpose: should not have any impact
onlyIncludeVersions: [vwithSlugs.versionName, v101.versionName],
},
context: defaultContext,
});
expect(versionsMetadata).toEqual([v101, vwithSlugs]);
});
test('readVersionsMetadata versioned site with disableVersioning', () => {
const versionsMetadata = readVersionsMetadata({
options: {...defaultOptions, disableVersioning: true},
@ -323,6 +336,49 @@ describe('versioned site, pluginId=default', () => {
);
});
test('readVersionsMetadata versioned site with empty onlyIncludeVersions', () => {
expect(() =>
readVersionsMetadata({
options: {
...defaultOptions,
onlyIncludeVersions: [],
},
context: defaultContext,
}),
).toThrowErrorMatchingInlineSnapshot(
`"Bad docs options.onlyIncludeVersions: an empty array is not allowed, at least one version is needed"`,
);
});
test('readVersionsMetadata versioned site with unknown versions in onlyIncludeVersions', () => {
expect(() =>
readVersionsMetadata({
options: {
...defaultOptions,
onlyIncludeVersions: ['unknownVersion1', 'unknownVersion2'],
},
context: defaultContext,
}),
).toThrowErrorMatchingInlineSnapshot(
`"Bad docs options.onlyIncludeVersions: unknown versions found: unknownVersion1,unknownVersion2. Available version names are: current, 1.0.1, 1.0.0, withSlugs"`,
);
});
test('readVersionsMetadata versioned site with lastVersion not in onlyIncludeVersions', () => {
expect(() =>
readVersionsMetadata({
options: {
...defaultOptions,
lastVersion: '1.0.1',
onlyIncludeVersions: ['current', '1.0.0'],
},
context: defaultContext,
}),
).toThrowErrorMatchingInlineSnapshot(
`"Bad docs options.lastVersion: if you use both the onlyIncludeVersions and lastVersion options, then lastVersion must be present in the provided onlyIncludeVersions array"`,
);
});
test('readVersionsMetadata versioned site with invalid versions.json file', () => {
const mock = jest.spyOn(JSON, 'parse').mockImplementationOnce(() => {
return {