3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-06 10:20:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(v1): add deletedDocs config to escape from versioning fallback (#2955)

Browse source 
* feat: support for deletedDocs in siteConfig

fixes #2429

* docs: document deletedDocs option

* feat: allow array in deletedDocs config

* docs: clarify deletedDocs version formatting
This commit is contained in:
Eric Dobbertin 2020-06-25 10:54:49 -05:00 • committed by GitHub
parent bdffd28b9f
commit d513dec521
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 77 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

37
packages/docusaurus-1.x/lib/server/versionFallback.js
View file

@ -115,15 +115,46 @@ function docVersion(id, reqVersion) {
// iterate through versions until a version less than or equal to the requested
// is found, then check if that version has an available file to use
let requestedFound = false;
let availableVersion = null;
let deletedDocs = null;
if (siteConfig.deletedDocs) {
// Config file may have either Array or Set for each version. Convert
// all to Set to make the check faster in the versions loop below.
deletedDocs = {};
Object.keys(siteConfig.deletedDocs).forEach((deletedDocVersion) => {
deletedDocs[deletedDocVersion] = new Set(
siteConfig.deletedDocs[deletedDocVersion],
);
});
}
for (let i = 0; i < versions.length; i++) {
if (versions[i] === reqVersion) {
requestedFound = true;
}
if (requestedFound && available[id].has(versions[i])) {
return versions[i];
if (requestedFound) {
// If this ID is deleted as of any version equal to or prior to
// the requested, return null.
if (
deletedDocs &&
deletedDocs[versions[i]] &&
deletedDocs[versions[i]].has(id)
) {
return null;
}
if (!availableVersion && available[id].has(versions[i])) {
availableVersion = versions[i];
// Note the fallback version but keep looping in case this ID
// was deleted as of a previous version.
//
// If `deletedDocs` config isn't used, we can return immediately
// and avoid unnecessary looping.
if (!deletedDocs) {
break;
}
}
}
}
return null;
return availableVersion;
}
// returns whether a given file has content that differ from the