mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-11 08:07:26 +02:00
Add Prettier Formatting (#258)
* Add Prettier formatting to source files and example files, and check that Prettier formatting is maintained on PRs * Remove trailing-comma as we are using Node 6 on Circle * Use latest Node 6 LTS version in Circle * Remove unused test
This commit is contained in:
parent
0cead4b6f9
commit
65421db62e
50 changed files with 1376 additions and 1350 deletions
|
@ -7,35 +7,35 @@
|
|||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
const chalk = require("chalk");
|
||||
const fs = require("fs");
|
||||
const glob = require("glob");
|
||||
const path = require("path");
|
||||
const readMetadata = require("./server/readMetadata.js");
|
||||
const chalk = require('chalk');
|
||||
const fs = require('fs');
|
||||
const glob = require('glob');
|
||||
const path = require('path');
|
||||
const readMetadata = require('./server/readMetadata.js');
|
||||
|
||||
const CWD = process.cwd();
|
||||
|
||||
// escape appropriate characters in a string to be used in a regex
|
||||
RegExp.escape = function(s) {
|
||||
return s.replace(/[-\/\\^$*+?.()|[\]{}]/g, "\\$&");
|
||||
return s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
|
||||
};
|
||||
|
||||
// generate a doc header from metadata
|
||||
function makeHeader(metadata) {
|
||||
let header = "---\n";
|
||||
let header = '---\n';
|
||||
Object.keys(metadata).forEach(key => {
|
||||
header += key + ": " + metadata[key] + "\n";
|
||||
header += key + ': ' + metadata[key] + '\n';
|
||||
});
|
||||
header += "---\n";
|
||||
header += '---\n';
|
||||
return header;
|
||||
}
|
||||
|
||||
let currentVersion, newVersion;
|
||||
|
||||
const program = require("commander");
|
||||
const program = require('commander');
|
||||
|
||||
program
|
||||
.arguments("<version_name> <new_version_name>")
|
||||
.arguments('<version_name> <new_version_name>')
|
||||
.action((ver1, ver2) => {
|
||||
currentVersion = ver1;
|
||||
newVersion = ver2;
|
||||
|
@ -45,58 +45,60 @@ program
|
|||
// require user to input two command line arguments, current version to be
|
||||
// renamed, and new version name
|
||||
if (
|
||||
typeof currentVersion === "undefined" ||
|
||||
typeof newVersion === "undefined"
|
||||
typeof currentVersion === 'undefined' ||
|
||||
typeof newVersion === 'undefined'
|
||||
) {
|
||||
console.error(
|
||||
`${chalk.yellow(
|
||||
"Version numbers are not properly specified!"
|
||||
'Version numbers are not properly specified!'
|
||||
)}\nSpecify as command line arguments: the current version you wish to rename, then the version number you want to rename it to. `
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
// error if no versions currently exist
|
||||
if (!fs.existsSync(CWD + "/versions.json")) {
|
||||
if (!fs.existsSync(CWD + '/versions.json')) {
|
||||
console.error(
|
||||
`${chalk.yellow(
|
||||
"No versions found!"
|
||||
'No versions found!'
|
||||
)}\nNo versions.json file currently exists. Use the \`versions\` script if you wish to create new versions.`
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const versions = JSON.parse(fs.readFileSync(CWD + "/versions.json", "utf8"));
|
||||
const versions = JSON.parse(fs.readFileSync(CWD + '/versions.json', 'utf8'));
|
||||
|
||||
const versionIndex = versions.indexOf(currentVersion);
|
||||
// error if current specified version does not exist
|
||||
if (versionIndex < 0) {
|
||||
console.error(
|
||||
`${chalk.yellow(
|
||||
"Version " + currentVersion + " does not currently exist!"
|
||||
)}\n Version ${currentVersion} is not in the versions.json file. You can only rename existing versions.`
|
||||
'Version ' + currentVersion + ' does not currently exist!'
|
||||
)}\n Version ${
|
||||
currentVersion
|
||||
} is not in the versions.json file. You can only rename existing versions.`
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
// replace old version with new version in versions.json file
|
||||
versions[versionIndex] = newVersion;
|
||||
fs.writeFileSync(CWD + "/versions.json", JSON.stringify(versions));
|
||||
fs.writeFileSync(CWD + '/versions.json', JSON.stringify(versions));
|
||||
|
||||
// if folder of docs for this version exists, rename folder and rewrite doc
|
||||
// headers to use new version
|
||||
if (fs.existsSync(CWD + "/versioned_docs/version-" + currentVersion)) {
|
||||
if (fs.existsSync(CWD + '/versioned_docs/version-' + currentVersion)) {
|
||||
fs.renameSync(
|
||||
CWD + "/versioned_docs/version-" + currentVersion,
|
||||
CWD + "/versioned_docs/version-" + newVersion
|
||||
CWD + '/versioned_docs/version-' + currentVersion,
|
||||
CWD + '/versioned_docs/version-' + newVersion
|
||||
);
|
||||
|
||||
const files = glob.sync(CWD + "/versioned_docs/version-" + newVersion + "/*");
|
||||
const files = glob.sync(CWD + '/versioned_docs/version-' + newVersion + '/*');
|
||||
files.forEach(file => {
|
||||
const extension = path.extname(file);
|
||||
if (extension !== ".md" && extension !== ".markdown") {
|
||||
if (extension !== '.md' && extension !== '.markdown') {
|
||||
return;
|
||||
}
|
||||
const res = readMetadata.extractMetadata(fs.readFileSync(file, "utf8"));
|
||||
const res = readMetadata.extractMetadata(fs.readFileSync(file, 'utf8'));
|
||||
const metadata = res.metadata;
|
||||
const rawContent = res.rawContent;
|
||||
if (!metadata.id) {
|
||||
|
@ -113,21 +115,21 @@ if (fs.existsSync(CWD + "/versioned_docs/version-" + currentVersion)) {
|
|||
// if sidebar file exists for this version, rename sidebar file and rewrite
|
||||
// doc ids in the file
|
||||
let currentSidebarFile =
|
||||
CWD + "/versioned_sidebars/version-" + currentVersion + "-sidebar.json";
|
||||
CWD + '/versioned_sidebars/version-' + currentVersion + '-sidebar.json';
|
||||
let newSidebarFile =
|
||||
CWD + "/versioned_sidebars/version-" + newVersion + "-sidebar.json";
|
||||
CWD + '/versioned_sidebars/version-' + newVersion + '-sidebar.json';
|
||||
if (fs.existsSync(currentSidebarFile)) {
|
||||
fs.renameSync(currentSidebarFile, newSidebarFile);
|
||||
let sidebarContent = fs.readFileSync(newSidebarFile, "utf8");
|
||||
let sidebarContent = fs.readFileSync(newSidebarFile, 'utf8');
|
||||
sidebarContent = sidebarContent.replace(
|
||||
new RegExp(`version-${RegExp.escape(currentVersion)}-`, "g"),
|
||||
new RegExp(`version-${RegExp.escape(currentVersion)}-`, 'g'),
|
||||
`version-${newVersion}-`
|
||||
);
|
||||
fs.writeFileSync(newSidebarFile, sidebarContent);
|
||||
}
|
||||
|
||||
console.log(
|
||||
`${chalk.green("Successfully enamed version ")}${chalk.yellow(
|
||||
`${chalk.green('Successfully enamed version ')}${chalk.yellow(
|
||||
currentVersion
|
||||
)}${chalk.green(" to version ")}${chalk.yellow(newVersion)}\n`
|
||||
)}${chalk.green(' to version ')}${chalk.yellow(newVersion)}\n`
|
||||
);
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue