3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-03 12:17:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add comments for new versioning files

Browse source
This commit is contained in:
Frank Li 2017-08-03 11:14:56 -07:00
parent 3598dffc58
commit d3e3d209a4
2 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
lib/server/versionFallback.js
View file

@ -68,7 +68,7 @@ function extractMetadata(content) {
/*****************************************************************/ /*****************************************************************/
/* preprocessing */ // versions is an array of all versions currently in use
const versions = []; const versions = [];
const versionFolder = ENABLE_TRANSLATION const versionFolder = ENABLE_TRANSLATION
? CWD + "/versioned_docs/en/" ? CWD + "/versioned_docs/en/"
@ -83,7 +83,11 @@ files.forEach(file => {
}); });
versions.sort(semver.rcompare); versions.sort(semver.rcompare);
// available stores doc ids of documents that are available for
// each version
const available = {}; const available = {};
// versionFiles is used to keep track of what file to use with a
// given version/id of a document
const versionFiles = {}; const versionFiles = {};
files = glob.sync(versionFolder + "**"); files = glob.sync(versionFolder + "**");
files.forEach(file => { files.forEach(file => {
@ -106,6 +110,8 @@ files.forEach(file => {
versionFiles[version][metadata.original_id] = file; versionFiles[version][metadata.original_id] = file;
}); });
// returns the version to use for a document based on its id and
// what the requested version is
function docVersion(id, req_version) { function docVersion(id, req_version) {
for (let i = 0; i < versions.length; i++) { for (let i = 0; i < versions.length; i++) {
if (semver.gt(versions[i], req_version)) { if (semver.gt(versions[i], req_version)) {
@ -121,6 +127,8 @@ function docVersion(id, req_version) {
return null; return null;
} }
// returns whether a given file has content that differ from the
// document with the given id
function diffLatestDoc(file, id) { function diffLatestDoc(file, id) {
if (versions.length === 0) { if (versions.length === 0) {
return true; return true;
@ -150,6 +158,8 @@ function diffLatestDoc(file, id) {
return false; return false;
} }
// return metadata for a versioned file given the file, its version (requested),
// the version of the file to be used, and its language
function processVersionMetadata(file, version, useVersion, language) { function processVersionMetadata(file, version, useVersion, language) {
const metadata = extractMetadata(fs.readFileSync(file, "utf8")).metadata; const metadata = extractMetadata(fs.readFileSync(file, "utf8")).metadata;
metadata.source = "version-" + useVersion + "/" + path.basename(file); metadata.source = "version-" + useVersion + "/" + path.basename(file);
@ -172,6 +182,7 @@ function processVersionMetadata(file, version, useVersion, language) {
return metadata; return metadata;
} }
// return all metadata of versioned documents
function docData() { function docData() {
const files = glob.sync(CWD + "/versioned_docs/**"); const files = glob.sync(CWD + "/versioned_docs/**");
@ -203,6 +214,7 @@ function docData() {
return metadatas; return metadatas;
} }
// return the version of the sidebar to use given a requested version
function sidebarVersion(req_version) { function sidebarVersion(req_version) {
for (let i = 0; i < versions.length; i++) { for (let i = 0; i < versions.length; i++) {
if (semver.gt(versions[i], req_version)) { if (semver.gt(versions[i], req_version)) {
@ -219,6 +231,8 @@ function sidebarVersion(req_version) {
return null; return null;
} }
// return whether or not the current sidebar.json file differs from the
// latest versioned one
function diffLatestSidebar() { function diffLatestSidebar() {
if (versions.length === 0) { if (versions.length === 0) {
return true; return true;
@ -246,6 +260,7 @@ function diffLatestSidebar() {
); );
} }
// return all versioned sidebar data
function sidebarData() { function sidebarData() {
const allSidebars = {}; const allSidebars = {};

5
lib/version.js
View file

@ -59,6 +59,7 @@ if (ENABLE_TRANSLATION) {
} }
mkdirp.sync(versionFolder); mkdirp.sync(versionFolder);
// copy necessary files to new version, changing some of its metadata to reflect the versioning
let files = glob.sync(CWD + "/../docs/*"); let files = glob.sync(CWD + "/../docs/*");
files.forEach(file => { files.forEach(file => {
const ext = path.extname(file); const ext = path.extname(file);
@ -83,11 +84,13 @@ files.forEach(file => {
let targetFile = let targetFile =
CWD + "/versioned_docs/version-" + version + "/" + path.basename(file); CWD + "/versioned_docs/version-" + version + "/" + path.basename(file);
if (ENABLE_TRANSLATION) { if (ENABLE_TRANSLATION) {
targetFile = CWD + "/versioned_docs/en/version-" + version + "/" + path.basename(file); targetFile =
CWD + "/versioned_docs/en/version-" + version + "/" + path.basename(file);
} }
fs.writeFileSync(targetFile, makeHeader(metadata) + rawContent, "utf8"); fs.writeFileSync(targetFile, makeHeader(metadata) + rawContent, "utf8");
}); });
// copy sidebar if necessary
if (versionFallback.diffLatestSidebar()) { if (versionFallback.diffLatestSidebar()) {
mkdirp(CWD + "/versioned_sidebars"); mkdirp(CWD + "/versioned_sidebars");
const sidebar = JSON.parse(fs.readFileSync(CWD + "/sidebar.json", "utf8")); const sidebar = JSON.parse(fs.readFileSync(CWD + "/sidebar.json", "utf8"));