diff --git a/.eslintrc.js b/.eslintrc.js index 04b0f3ed1a58..b2901d3b1423 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -15,12 +15,15 @@ module.exports = { 'no-console': OFF, // We have console.error, console.warn, etc. radix: ERROR, 'class-methods-use-this': OFF, + 'func-names': OFF, 'no-empty': [ERROR, {allowEmptyCatch: true}], 'no-param-reassign': OFF, 'no-plusplus': OFF, + 'prefer-template': OFF, 'import/no-extraneous-dependencies': OFF, 'react/jsx-closing-bracket-location': OFF, // Formatting is left to Prettier. 'react/jsx-filename-extension': OFF, // Enable in future when migrating. + 'react/jsx-one-expression-per-line': OFF, // Formatting is left to Prettier. 'react/no-danger': OFF, // Need this to inject scripts. 'react/no-multi-comp': OFF, // One component per file creates too many files. 'react/no-unescaped-entities': [ERROR, {forbid: ['>', '}']}], @@ -32,14 +35,10 @@ module.exports = { 'jsx-a11y/anchor-is-valid': OFF, // 9 'import/no-unresolved': OFF, // 15 'react/prefer-stateless-function': OFF, // 22 - 'prefer-arrow-callback': OFF, // 30 - 'func-names': OFF, // 37 'import/no-dynamic-require': OFF, // 46 'prefer-destructuring': OFF, // 69 'global-require': OFF, // 85 - 'react/jsx-one-expression-per-line': OFF, // 129 'react/prop-types': OFF, // 197 - 'prefer-template': OFF, // 292 'react/destructuring-assignment': OFF, // 342 }, }; diff --git a/examples/basics/core/Footer.js b/examples/basics/core/Footer.js index 41fbc0ff6f78..a9595b6f3eb6 100644 --- a/examples/basics/core/Footer.js +++ b/examples/basics/core/Footer.js @@ -10,12 +10,12 @@ const React = require('react'); class Footer extends React.Component { docUrl(doc, language) { const baseUrl = this.props.config.baseUrl; - return baseUrl + 'docs/' + (language ? language + '/' : '') + doc; + return `${baseUrl}docs/${language ? `${language}/` : ''}${doc}`; } pageUrl(doc, language) { const baseUrl = this.props.config.baseUrl; - return baseUrl + (language ? language + '/' : '') + doc; + return baseUrl + (language ? `${language}/` : '') + doc; } render() { @@ -65,7 +65,7 @@ class Footer extends React.Component {
More
- Blog + Blog GitHub Facebook Open Source ( {user.caption} diff --git a/examples/basics/siteConfig.js b/examples/basics/siteConfig.js index cbd6d7cbd911..627fa24ef963 100644 --- a/examples/basics/siteConfig.js +++ b/examples/basics/siteConfig.js @@ -73,10 +73,7 @@ const siteConfig = { */ // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds. - copyright: - 'Copyright © ' + - new Date().getFullYear() + - ' Your Name or Your Company Name', + copyright: `Copyright © ${new Date().getFullYear()} Your Name or Your Company Name`, highlight: { // Highlight.js theme to use for syntax highlighting in code blocks. diff --git a/examples/versions/pages/en/versions.js b/examples/versions/pages/en/versions.js index 6eacf2c53c06..d0895688fa67 100644 --- a/examples/versions/pages/en/versions.js +++ b/examples/versions/pages/en/versions.js @@ -13,8 +13,8 @@ const Container = CompLibrary.Container; const CWD = process.cwd(); -const siteConfig = require(CWD + '/siteConfig.js'); -const versions = require(CWD + '/versions.json'); +const siteConfig = require(`${CWD}/siteConfig.js`); +const versions = require(`${CWD}/versions.json`); function Versions() { const latestVersion = versions[0]; diff --git a/lib/__tests__/build-files.test.js b/lib/__tests__/build-files.test.js index afd1fc7d55ab..129756787975 100644 --- a/lib/__tests__/build-files.test.js +++ b/lib/__tests__/build-files.test.js @@ -16,10 +16,10 @@ const CWD = process.cwd(); const utils = require('../server/utils'); -const siteConfig = require(CWD + '/website/siteConfig.js'); -const buildDir = CWD + '/website/build'; -const docsDir = CWD + '/docs'; -const staticCSSDir = CWD + '/website/static/css'; +const siteConfig = require(`${CWD}/website/siteConfig.js`); +const buildDir = `${CWD}/website/build`; +const docsDir = `${CWD}/docs`; +const staticCSSDir = `${CWD}/website/static/css`; let inputMarkdownFiles = []; let inputAssetsFiles = []; @@ -43,11 +43,11 @@ describe('Build files', () => { beforeAll(() => { generateSite(); return Promise.all([ - glob(docsDir + '/**/*.md'), - glob(buildDir + '/' + siteConfig.projectName + '/docs/**/*.html'), - glob(docsDir + '/assets/*'), - glob(buildDir + '/' + siteConfig.projectName + '/img/*'), - ]).then(function(results) { + glob(`${docsDir}/**/*.md`), + glob(`${buildDir}/${siteConfig.projectName}/docs/**/*.html`), + glob(`${docsDir}/assets/*`), + glob(`${buildDir}/${siteConfig.projectName}/img/*`), + ]).then(results => { [ inputMarkdownFiles, outputHTMLFiles, @@ -61,34 +61,34 @@ describe('Build files', () => { clearBuildFolder(); }); - test('Build folder exists', function() { - return fs.stat(buildDir).then(function(status) { + test('Build folder exists', () => + fs.stat(buildDir).then(status => { expect(status.isDirectory()).toBeTruthy(); - }); - }); + })); - test('Generated HTML for each Markdown resource', function() { + test('Generated HTML for each Markdown resource', () => { const metadata = outputHTMLFiles.map(file => filepath.create(file).basename() ); - inputMarkdownFiles.forEach(function(file) { + inputMarkdownFiles.forEach(file => { const data = fs.readFileSync(file, 'utf8'); const frontmatter = fm(data); - expect(metadata).toContain(frontmatter.attributes.id + '.html'); + expect(metadata).toContain(`${frontmatter.attributes.id}.html`); }); }); - test('Generated table of contents', function() { - outputHTMLFiles.forEach(function(file) { + test('Generated table of contents', () => { + outputHTMLFiles.forEach(file => { const fileContents = fs.readFileSync(file, 'utf8'); expect(fileContents).not.toContain(''); }); }); - test('Concatenated CSS files', async function() { - const inputFiles = await glob(staticCSSDir + '/*.css'); - const combinedCSSFile = - buildDir + '/' + siteConfig.projectName + '/css/main.css'; + test('Concatenated CSS files', async () => { + const inputFiles = await glob(`${staticCSSDir}/*.css`); + const combinedCSSFile = `${buildDir}/${ + siteConfig.projectName + }/css/main.css`; const fileContents = await Promise.all( [combinedCSSFile, ...inputFiles].map(file => fs.readFile(file, 'utf8')) ); @@ -103,11 +103,11 @@ describe('Build files', () => { }); }); - test('Copied assets from /docs/assets', function() { + test('Copied assets from /docs/assets', () => { const metadata = outputAssetsFiles.map(file => filepath.create(file).basename() ); - inputAssetsFiles.forEach(function(file) { + inputAssetsFiles.forEach(file => { const path = filepath.create(file); expect(metadata).toContain(path.basename()); }); diff --git a/lib/build-files.js b/lib/build-files.js index 940669c4ce04..83ed4ceaa9ed 100755 --- a/lib/build-files.js +++ b/lib/build-files.js @@ -10,7 +10,7 @@ require('babel-polyfill'); require('babel-register')({ babelrc: false, - only: [__dirname, process.cwd() + '/core'], + only: [__dirname, `${process.cwd()}/core`], plugins: [ require('./server/translate-plugin.js'), 'transform-class-properties', @@ -25,7 +25,7 @@ const fs = require('fs'); const CWD = process.cwd(); -if (!fs.existsSync(CWD + '/siteConfig.js')) { +if (!fs.existsSync(`${CWD}/siteConfig.js`)) { console.error( chalk.red('Error: No siteConfig.js file found in website folder!') ); diff --git a/lib/copy-examples.js b/lib/copy-examples.js index 72b6c2209dba..1247b2c643f4 100755 --- a/lib/copy-examples.js +++ b/lib/copy-examples.js @@ -25,9 +25,9 @@ commander .parse(process.argv); // add scripts to package.json file -if (fs.existsSync(CWD + '/package.json')) { +if (fs.existsSync(`${CWD}/package.json`)) { const packageContent = JSON.parse( - fs.readFileSync(CWD + '/package.json', 'utf8') + fs.readFileSync(`${CWD}/package.json`, 'utf8') ); if (!packageContent.scripts) { packageContent.scripts = {}; @@ -41,8 +41,8 @@ if (fs.existsSync(CWD + '/package.json')) { packageContent.scripts.version = 'docusaurus-version'; packageContent.scripts['rename-version'] = 'docusaurus-rename-version'; fs.writeFileSync( - CWD + '/package.json', - JSON.stringify(packageContent, null, 2) + '\n' + `${CWD}/package.json`, + `${JSON.stringify(packageContent, null, 2)}\n` ); console.log( `${chalk.green('Wrote docusaurus scripts to package.json file.')}\n` @@ -59,17 +59,17 @@ let exampleSiteCreated = false; if (feature === 'translations') { // copy files for translations const folder = path.join(__dirname, '..', 'examples', 'translations'); - if (fs.existsSync(CWD + '/../crowdin.yaml')) { + if (fs.existsSync(`${CWD}/../crowdin.yaml`)) { console.log( `${chalk.yellow('crowdin.yaml already exists')} in ${chalk.yellow( - outerFolder + '/' + `${outerFolder}/` )}. Rename or remove the file to regenerate an example version.\n` ); } else { - fs.copySync(folder + '/crowdin.yaml', CWD + '/../crowdin.yaml'); + fs.copySync(`${folder}/crowdin.yaml`, `${CWD}/../crowdin.yaml`); exampleSiteCreated = true; } - const files = glob.sync(folder + '/**/*'); + const files = glob.sync(`${folder}/**/*`); files.forEach(file => { if (fs.lstatSync(file).isDirectory()) { return; @@ -87,9 +87,9 @@ if (feature === 'translations') { } catch (e) { console.log( `${chalk.yellow( - path.basename(filePath) + ' already exists' + `${path.basename(filePath)} already exists` )} in ${chalk.yellow( - 'website' + filePath.split(path.basename(filePath))[0] + `website${filePath.split(path.basename(filePath))[0]}` )}. Rename or remove the file to regenerate an example version.\n` ); } @@ -97,7 +97,7 @@ if (feature === 'translations') { } else if (feature === 'versions') { // copy files for versions const folder = path.join(__dirname, '..', 'examples', 'versions'); - const files = glob.sync(folder + '/**/*'); + const files = glob.sync(`${folder}/**/*`); files.forEach(file => { if (fs.lstatSync(file).isDirectory()) { return; @@ -112,9 +112,9 @@ if (feature === 'translations') { } catch (e) { console.log( `${chalk.yellow( - path.basename(filePath) + ' already exists' + `${path.basename(filePath)} already exists` )} in ${chalk.yellow( - 'website' + filePath.split(path.basename(filePath))[0] + `website${filePath.split(path.basename(filePath))[0]}` )}. Rename or remove the file to regenerate an example version.\n` ); } @@ -122,29 +122,29 @@ if (feature === 'translations') { } else { const folder = path.join(__dirname, '..', 'examples', 'basics'); // copy docs examples - if (fs.existsSync(CWD + '/../docs-examples-from-docusaurus')) { + if (fs.existsSync(`${CWD}/../docs-examples-from-docusaurus`)) { console.log( `${chalk.yellow( 'Example docs already exist!' )} Rename or remove ${chalk.yellow( - outerFolder + '/docs-examples-from-docusaurus' + `${outerFolder}/docs-examples-from-docusaurus` )} to regenerate example docs.\n` ); } else { fs.copySync( - folder + '/docs-examples-from-docusaurus', - CWD + '/../docs-examples-from-docusaurus' + `${folder}/docs-examples-from-docusaurus`, + `${CWD}/../docs-examples-from-docusaurus` ); exampleSiteCreated = true; docsCreated = true; } // copy blog examples - if (fs.existsSync(CWD + '/blog-examples-from-docusaurus')) { + if (fs.existsSync(`${CWD}/blog-examples-from-docusaurus`)) { console.log( `${chalk.yellow( 'Example blog posts already exist!' )} Rename or remove ${chalk.yellow( - outerFolder + '/website/blog-examples-from-docusaurus' + `${outerFolder}/website/blog-examples-from-docusaurus` )} to regenerate example blog posts.\n` ); } else { @@ -157,7 +157,7 @@ if (feature === 'translations') { } // copy .gitignore file let gitignoreName = '.gitignore'; - if (fs.existsSync(CWD + '/../.gitignore')) { + if (fs.existsSync(`${CWD}/../.gitignore`)) { gitignoreName = '.gitignore-example-from-docusaurus'; console.log( `${chalk.yellow('.gitignore already exists')} in ${chalk.yellow( @@ -167,11 +167,11 @@ if (feature === 'translations') { } fs.copySync( path.join(folder, 'gitignore'), - path.join(CWD, '/../' + gitignoreName) + path.join(CWD, `/../${gitignoreName}`) ); // copy other files - const files = glob.sync(folder + '/**/*'); + const files = glob.sync(`${folder}/**/*`); files.forEach(file => { if (fs.lstatSync(file).isDirectory()) { return; @@ -194,9 +194,9 @@ if (feature === 'translations') { } catch (e) { console.log( `${chalk.yellow( - path.basename(filePath) + ' already exists' + `${path.basename(filePath)} already exists` )} in ${chalk.yellow( - 'website' + filePath.split(path.basename(filePath))[0] + `website${filePath.split(path.basename(filePath))[0]}` )}. Rename or remove the file to regenerate an example version.\n` ); } @@ -221,9 +221,9 @@ if (feature === 'translations') { if (docsCreated) { console.log( `Rename ${chalk.yellow( - outerFolder + '/docs-examples-from-docusaurus' + `${outerFolder}/docs-examples-from-docusaurus` )} to ${chalk.yellow( - outerFolder + '/docs' + `${outerFolder}/docs` )} to see the example docs on your site.\n` ); } @@ -231,9 +231,9 @@ if (docsCreated) { if (blogCreated) { console.log( `Rename ${chalk.yellow( - outerFolder + '/website/blog-examples-from-docusaurus' + `${outerFolder}/website/blog-examples-from-docusaurus` )} to ${chalk.yellow( - outerFolder + '/website/blog' + `${outerFolder}/website/blog` )} to see the example blog posts on your site.\n` ); } diff --git a/lib/core/BlogPageLayout.js b/lib/core/BlogPageLayout.js index 2ac9248b05d0..25098e6eec73 100644 --- a/lib/core/BlogPageLayout.js +++ b/lib/core/BlogPageLayout.js @@ -16,9 +16,9 @@ const utils = require('./utils.js'); // used to generate entire blog pages, i.e. collection of truncated blog posts class BlogPageLayout extends React.Component { getPageURL(page) { - let url = this.props.config.baseUrl + 'blog/'; + let url = `${this.props.config.baseUrl}blog/`; if (page > 0) { - url += 'page' + (page + 1) + '/'; + url += `page${page + 1}/`; } return url; } diff --git a/lib/core/BlogPost.js b/lib/core/BlogPost.js index a75e4bc5e0a1..da61433d71a5 100644 --- a/lib/core/BlogPost.js +++ b/lib/core/BlogPost.js @@ -23,14 +23,10 @@ class BlogPost extends React.Component {
+ href={`${this.props.config.baseUrl}blog/${utils.getPath( + this.props.post.path, + this.props.config.cleanUrl + )}`}> Read More
@@ -43,9 +39,9 @@ class BlogPost extends React.Component { renderAuthorPhoto() { const post = this.props.post; - const className = - 'authorPhoto' + - (post.author && post.authorTitle ? ' authorPhotoBig' : ''); + const className = `authorPhoto${ + post.author && post.authorTitle ? ' authorPhotoBig' : '' + }`; if (post.authorFBID || post.authorImageURL) { const authorImageURL = post.authorFBID ? `https://graph.facebook.com/${ @@ -68,11 +64,10 @@ class BlogPost extends React.Component { return (

+ href={`${this.props.config.baseUrl}blog/${utils.getPath( + post.path, + this.props.config.cleanUrl + )}`}> {post.title}

diff --git a/lib/core/BlogPostLayout.js b/lib/core/BlogPostLayout.js index d39325aceb7e..bec30776e5ba 100644 --- a/lib/core/BlogPostLayout.js +++ b/lib/core/BlogPostLayout.js @@ -38,12 +38,8 @@ class BlogPostLayout extends React.Component { {/* Facebook SDK require 'fb-comments' class */}
@@ -109,7 +98,7 @@ class BlogPostLayout extends React.Component { className={classNames('sideNavVisible', { separateOnPageNav: hasOnPageNav, })} - url={'blog/' + post.path} + url={`blog/${post.path}`} title={this.props.metadata.title} language="en" description={this.getDescription()} @@ -132,7 +121,7 @@ class BlogPostLayout extends React.Component { {this.renderSocialButtons()}
- + {blogSidebarTitleConfig.default || 'Recent Posts'}
diff --git a/lib/core/BlogSidebar.js b/lib/core/BlogSidebar.js index 80b52116ac81..dfc3aaeb8794 100644 --- a/lib/core/BlogSidebar.js +++ b/lib/core/BlogSidebar.js @@ -41,7 +41,7 @@ class BlogSidebar extends React.Component { {translateThisDoc} diff --git a/lib/core/Head.js b/lib/core/Head.js index b939c3dc9250..8f8c5f5d51b8 100644 --- a/lib/core/Head.js +++ b/lib/core/Head.js @@ -27,9 +27,9 @@ class Head extends React.Component { }/styles/${highlight.theme}.min.css`; // ensure the siteUrl variable ends with a single slash - const siteUrl = - (this.props.config.url + this.props.config.baseUrl).replace(/\/+$/, '') + - '/'; + const siteUrl = `${( + this.props.config.url + this.props.config.baseUrl + ).replace(/\/+$/, '')}/`; return ( @@ -64,7 +64,7 @@ class Head extends React.Component { )} {this.props.config.noIndex && } {this.props.redirect && ( - )} {hasBlog && ( )} {this.props.config.gaTrackingId && @@ -167,13 +167,13 @@ class Head extends React.Component { {this.props.config.usePrism && ( )} {/* Site defined code. Keep these at the end to avoid overriding. */} ); diff --git a/lib/core/Redirect.js b/lib/core/Redirect.js index a719ee532a5b..2b3014bbb9a9 100644 --- a/lib/core/Redirect.js +++ b/lib/core/Redirect.js @@ -16,9 +16,9 @@ class Redirect extends React.Component { ? translation[this.props.language]['localized-strings'].tagline : this.props.config.tagline; const title = this.props.title - ? this.props.title + ' · ' + this.props.config.title + ? `${this.props.title} · ${this.props.config.title}` : (!this.props.config.disableTitleTagline && - this.props.config.title + ' · ' + tagline) || + `${this.props.config.title} · ${tagline}`) || this.props.config.title; const description = this.props.description || tagline; const url = diff --git a/lib/core/Site.js b/lib/core/Site.js index d6037b052200..fa31cd36f6f9 100644 --- a/lib/core/Site.js +++ b/lib/core/Site.js @@ -11,7 +11,7 @@ const fs = require('fs'); const HeaderNav = require('./nav/HeaderNav.js'); const Head = require('./Head.js'); -const Footer = require(process.cwd() + '/core/Footer.js'); +const Footer = require(`${process.cwd()}/core/Footer.js`); const translation = require('../server/translation.js'); const constants = require('./constants'); @@ -24,9 +24,9 @@ class Site extends React.Component { ? translation[this.props.language]['localized-strings'].tagline : this.props.config.tagline; const title = this.props.title - ? this.props.title + ' · ' + this.props.config.title + ? `${this.props.title} · ${this.props.config.title}` : (!this.props.config.disableTitleTagline && - this.props.config.title + ' · ' + tagline) || + `${this.props.config.title} · ${tagline}`) || this.props.config.title; const description = this.props.description || tagline; const url = @@ -35,8 +35,8 @@ class Site extends React.Component { (this.props.url || 'index.html'); let docsVersion = this.props.version; - if (!docsVersion && fs.existsSync(CWD + '/versions.json')) { - const latestVersion = require(CWD + '/versions.json')[0]; + if (!docsVersion && fs.existsSync(`${CWD}/versions.json`)) { + const latestVersion = require(`${CWD}/versions.json`)[0]; docsVersion = latestVersion; } diff --git a/lib/core/anchors.js b/lib/core/anchors.js index ce6ec27bbae7..626a775db947 100644 --- a/lib/core/anchors.js +++ b/lib/core/anchors.js @@ -19,15 +19,9 @@ function anchors(md) { if (textToken.content) { const anchor = toSlug(textToken.content, env); - return ( - '' - ); + return ``; } return originalRender(tokens, idx, options, env); diff --git a/lib/core/nav/HeaderNav.js b/lib/core/nav/HeaderNav.js index 7035074d8eb8..f4be273ccc98 100644 --- a/lib/core/nav/HeaderNav.js +++ b/lib/core/nav/HeaderNav.js @@ -11,7 +11,7 @@ const React = require('react'); const fs = require('fs'); const classNames = require('classnames'); -const siteConfig = require(CWD + '/siteConfig.js'); +const siteConfig = require(`${CWD}/siteConfig.js`); const translation = require('../../server/translation.js'); const env = require('../../server/env.js'); @@ -52,7 +52,7 @@ class LanguageDropDown extends React.Component { `/${lang.tag}/` ); } else if (this.props.current.id && this.props.current.id !== 'index') { - href = siteConfig.baseUrl + lang.tag + '/' + this.props.current.id; + href = `${siteConfig.baseUrl + lang.tag}/${this.props.current.id}`; } return (
  • @@ -91,7 +91,7 @@ class LanguageDropDown extends React.Component { Languages icon {currentLanguage} @@ -162,33 +162,27 @@ class HeaderNav extends React.Component { if (link.doc) { // set link to document with current page's language/version const langPart = env.translation.enabled - ? (this.props.language || 'en') + '-' + ? `${this.props.language || 'en'}-` : ''; const versionPart = env.versioning.enabled && this.props.version !== 'next' - ? 'version-' + - (this.props.version || env.versioning.defaultVersion) + - '-' + ? `version-${this.props.version || env.versioning.defaultVersion}-` : ''; const id = langPart + versionPart + link.doc; if (!Metadata[id]) { - let errorStr = - "Processing the following `doc` field in `headerLinks` within `siteConfig.js`: '" + - link.doc + - "'"; + let errorStr = `Processing the following \`doc\` field in \`headerLinks\` within \`siteConfig.js\`: '${ + link.doc + }'`; if (id === link.doc) { errorStr += ' It looks like there is no document with that id that exists in your docs directory. Please double check the spelling of your `doc` field and the `id` fields of your docs.'; } else { - errorStr += - '. Check the spelling of your `doc` field. If that seems sane, and a document in your docs folder exists with that `id` value, \nthen this is likely a bug in Docusaurus.' + - ' Docusaurus thinks one or both of translations (currently set to: ' + - env.translation.enabled + - ') or versioning (currently set to: ' + - env.versioning.enabled + - ") is enabled when maybe they should not be. \nThus my internal id for this doc is: '" + - id + - "'. Please file an issue for this possible bug on GitHub."; + errorStr += `${'. Check the spelling of your `doc` field. If that seems sane, and a document in your docs folder exists with that `id` value, \nthen this is likely a bug in Docusaurus.' + + ' Docusaurus thinks one or both of translations (currently set to: '}${ + env.translation.enabled + }) or versioning (currently set to: ${ + env.versioning.enabled + }) is enabled when maybe they should not be. \nThus my internal id for this doc is: '${id}'. Please file an issue for this possible bug on GitHub.`; } throw new Error(errorStr); } @@ -202,10 +196,10 @@ class HeaderNav extends React.Component { } else if (link.page) { // set link to page with current page's language if appropriate const language = this.props.language || ''; - if (fs.existsSync(CWD + '/pages/en/' + link.page + '.js')) { + if (fs.existsSync(`${CWD}/pages/en/${link.page}.js`)) { href = siteConfig.baseUrl + - (language ? language + '/' : '') + + (language ? `${language}/` : '') + link.page + extension; } else { @@ -216,7 +210,7 @@ class HeaderNav extends React.Component { href = link.href; } else if (link.blog) { // set link to blog url - href = this.props.baseUrl + 'blog'; + href = `${this.props.baseUrl}blog`; } const itemClasses = classNames({ siteNavGroupActive: @@ -227,7 +221,7 @@ class HeaderNav extends React.Component { (link.page && link.page === this.props.current.id), }); return ( -
  • +
  • {translation[this.props.language] ? translation[this.props.language]['localized-strings'][link.label] @@ -253,24 +247,22 @@ class HeaderNav extends React.Component { headerLinks.forEach(link => { if ( link.doc && - !fs.existsSync(CWD + '/../' + readMetadata.getDocsPath() + '/') + !fs.existsSync(`${CWD}/../${readMetadata.getDocsPath()}/`) ) { throw new Error( - "You have 'doc' in your headerLinks, but no '" + - readMetadata.getDocsPath() + - "' folder exists one level up from " + - "'website' folder. Did you run `docusaurus-init` or `npm run examples`? If so, " + - "make sure you rename 'docs-examples-from-docusaurus' to 'docs'." + `You have 'doc' in your headerLinks, but no '${readMetadata.getDocsPath()}' folder exists one level up from ` + + `'website' folder. Did you run \`docusaurus-init\` or \`npm run examples\`? If so, ` + + `make sure you rename 'docs-examples-from-docusaurus' to 'docs'.` ); } - if (link.blog && !fs.existsSync(CWD + '/blog/')) { + if (link.blog && !fs.existsSync(`${CWD}/blog/`)) { throw new Error( "You have 'blog' in your headerLinks, but no 'blog' folder exists in your " + "'website' folder. Did you run `docusaurus-init` or `npm run examples`? If so, " + "make sure you rename 'blog-examples-from-docusaurus' to 'blog'." ); } - if (link.page && !fs.existsSync(CWD + '/pages/')) { + if (link.page && !fs.existsSync(`${CWD}/pages/`)) { throw new Error( "You have 'page' in your headerLinks, but no 'pages' folder exists in your " + "'website' folder." @@ -302,8 +294,8 @@ class HeaderNav extends React.Component { const versionsLink = this.props.baseUrl + (env.translation.enabled - ? this.props.language + '/versions' + extension - : 'versions' + extension); + ? `${this.props.language}/versions${extension}` + : `versions${extension}`); return (
    diff --git a/lib/core/nav/OnPageNav.js b/lib/core/nav/OnPageNav.js index 2690f9564919..2ca47a260b8e 100644 --- a/lib/core/nav/OnPageNav.js +++ b/lib/core/nav/OnPageNav.js @@ -7,7 +7,7 @@ const React = require('react'); -const siteConfig = require(process.cwd() + '/siteConfig.js'); +const siteConfig = require(`${process.cwd()}/siteConfig.js`); const getTOC = require('../getTOC'); const Link = ({hashLink, content}) => ( diff --git a/lib/core/nav/SideNav.js b/lib/core/nav/SideNav.js index 50562df0f0b3..57682c961897 100644 --- a/lib/core/nav/SideNav.js +++ b/lib/core/nav/SideNav.js @@ -8,7 +8,7 @@ const React = require('react'); const classNames = require('classnames'); -const siteConfig = require(process.cwd() + '/siteConfig.js'); +const siteConfig = require(`${process.cwd()}/siteConfig.js`); const translation = require('../../server/translation.js'); const utils = require('../utils.js'); @@ -51,11 +51,10 @@ class SideNav extends React.Component { return siteConfig.baseUrl + targetLink; } if (metadata.path) { - return ( - siteConfig.baseUrl + - 'blog/' + - utils.getPath(metadata.path, siteConfig.cleanUrl) - ); + return `${siteConfig.baseUrl}blog/${utils.getPath( + metadata.path, + siteConfig.cleanUrl + )}`; } return null; } diff --git a/lib/core/renderMarkdown.js b/lib/core/renderMarkdown.js index a3e70b4ed312..4828ad71a0a8 100644 --- a/lib/core/renderMarkdown.js +++ b/lib/core/renderMarkdown.js @@ -19,7 +19,7 @@ const alias = { class MarkdownRenderer { constructor() { - const siteConfig = require(CWD + '/siteConfig.js'); + const siteConfig = require(`${CWD}/siteConfig.js`); const md = new Markdown({ // Highlight.js expects hljs css classes on the code element. @@ -40,7 +40,7 @@ class MarkdownRenderer { const language = alias[lang] || lang; // Currently people using prismjs on Node have to individually require() // every single language (https://github.com/PrismJS/prism/issues/593) - require('prismjs/components/prism-' + language + '.min'); + require(`prismjs/components/prism-${language}.min`); return prismjs.highlight(str, prismjs.languages[language]); } catch (err) { console.error(err); @@ -71,7 +71,7 @@ class MarkdownRenderer { // Allow client sites to register their own plugins if (siteConfig.markdownPlugins) { - siteConfig.markdownPlugins.forEach(function(plugin) { + siteConfig.markdownPlugins.forEach(plugin => { md.use(plugin); }); } diff --git a/lib/core/toSlug.js b/lib/core/toSlug.js index 2d9102a0e18c..263d776e4ca7 100644 --- a/lib/core/toSlug.js +++ b/lib/core/toSlug.js @@ -13,10 +13,7 @@ const letters = '\u0041-\u005A\u0061-\u007A\u00AA\u00B5\u00BA\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02C1\u02C6-\u02D1\u02E0-\u02E4\u02EC\u02EE\u0370-\u0374\u0376\u0377\u037A-\u037D\u0386\u0388-\u038A\u038C\u038E-\u03A1\u03A3-\u03F5\u03F7-\u0481\u048A-\u0527\u0531-\u0556\u0559\u0561-\u0587\u05D0-\u05EA\u05F0-\u05F2\u0620-\u064A\u066E\u066F\u0671-\u06D3\u06D5\u06E5\u06E6\u06EE\u06EF\u06FA-\u06FC\u06FF\u0710\u0712-\u072F\u074D-\u07A5\u07B1\u07CA-\u07EA\u07F4\u07F5\u07FA\u0800-\u0815\u081A\u0824\u0828\u0840-\u0858\u08A0\u08A2-\u08AC\u0904-\u0939\u093D\u0950\u0958-\u0961\u0971-\u0977\u0979-\u097F\u0985-\u098C\u098F\u0990\u0993-\u09A8\u09AA-\u09B0\u09B2\u09B6-\u09B9\u09BD\u09CE\u09DC\u09DD\u09DF-\u09E1\u09F0\u09F1\u0A05-\u0A0A\u0A0F\u0A10\u0A13-\u0A28\u0A2A-\u0A30\u0A32\u0A33\u0A35\u0A36\u0A38\u0A39\u0A59-\u0A5C\u0A5E\u0A72-\u0A74\u0A85-\u0A8D\u0A8F-\u0A91\u0A93-\u0AA8\u0AAA-\u0AB0\u0AB2\u0AB3\u0AB5-\u0AB9\u0ABD\u0AD0\u0AE0\u0AE1\u0B05-\u0B0C\u0B0F\u0B10\u0B13-\u0B28\u0B2A-\u0B30\u0B32\u0B33\u0B35-\u0B39\u0B3D\u0B5C\u0B5D\u0B5F-\u0B61\u0B71\u0B83\u0B85-\u0B8A\u0B8E-\u0B90\u0B92-\u0B95\u0B99\u0B9A\u0B9C\u0B9E\u0B9F\u0BA3\u0BA4\u0BA8-\u0BAA\u0BAE-\u0BB9\u0BD0\u0C05-\u0C0C\u0C0E-\u0C10\u0C12-\u0C28\u0C2A-\u0C33\u0C35-\u0C39\u0C3D\u0C58\u0C59\u0C60\u0C61\u0C85-\u0C8C\u0C8E-\u0C90\u0C92-\u0CA8\u0CAA-\u0CB3\u0CB5-\u0CB9\u0CBD\u0CDE\u0CE0\u0CE1\u0CF1\u0CF2\u0D05-\u0D0C\u0D0E-\u0D10\u0D12-\u0D3A\u0D3D\u0D4E\u0D60\u0D61\u0D7A-\u0D7F\u0D85-\u0D96\u0D9A-\u0DB1\u0DB3-\u0DBB\u0DBD\u0DC0-\u0DC6\u0E01-\u0E30\u0E32\u0E33\u0E40-\u0E46\u0E81\u0E82\u0E84\u0E87\u0E88\u0E8A\u0E8D\u0E94-\u0E97\u0E99-\u0E9F\u0EA1-\u0EA3\u0EA5\u0EA7\u0EAA\u0EAB\u0EAD-\u0EB0\u0EB2\u0EB3\u0EBD\u0EC0-\u0EC4\u0EC6\u0EDC-\u0EDF\u0F00\u0F40-\u0F47\u0F49-\u0F6C\u0F88-\u0F8C\u1000-\u102A\u103F\u1050-\u1055\u105A-\u105D\u1061\u1065\u1066\u106E-\u1070\u1075-\u1081\u108E\u10A0-\u10C5\u10C7\u10CD\u10D0-\u10FA\u10FC-\u1248\u124A-\u124D\u1250-\u1256\u1258\u125A-\u125D\u1260-\u1288\u128A-\u128D\u1290-\u12B0\u12B2-\u12B5\u12B8-\u12BE\u12C0\u12C2-\u12C5\u12C8-\u12D6\u12D8-\u1310\u1312-\u1315\u1318-\u135A\u1380-\u138F\u13A0-\u13F4\u1401-\u166C\u166F-\u167F\u1681-\u169A\u16A0-\u16EA\u1700-\u170C\u170E-\u1711\u1720-\u1731\u1740-\u1751\u1760-\u176C\u176E-\u1770\u1780-\u17B3\u17D7\u17DC\u1820-\u1877\u1880-\u18A8\u18AA\u18B0-\u18F5\u1900-\u191C\u1950-\u196D\u1970-\u1974\u1980-\u19AB\u19C1-\u19C7\u1A00-\u1A16\u1A20-\u1A54\u1AA7\u1B05-\u1B33\u1B45-\u1B4B\u1B83-\u1BA0\u1BAE\u1BAF\u1BBA-\u1BE5\u1C00-\u1C23\u1C4D-\u1C4F\u1C5A-\u1C7D\u1CE9-\u1CEC\u1CEE-\u1CF1\u1CF5\u1CF6\u1D00-\u1DBF\u1E00-\u1F15\u1F18-\u1F1D\u1F20-\u1F45\u1F48-\u1F4D\u1F50-\u1F57\u1F59\u1F5B\u1F5D\u1F5F-\u1F7D\u1F80-\u1FB4\u1FB6-\u1FBC\u1FBE\u1FC2-\u1FC4\u1FC6-\u1FCC\u1FD0-\u1FD3\u1FD6-\u1FDB\u1FE0-\u1FEC\u1FF2-\u1FF4\u1FF6-\u1FFC\u2071\u207F\u2090-\u209C\u2102\u2107\u210A-\u2113\u2115\u2119-\u211D\u2124\u2126\u2128\u212A-\u212D\u212F-\u2139\u213C-\u213F\u2145-\u2149\u214E\u2183\u2184\u2C00-\u2C2E\u2C30-\u2C5E\u2C60-\u2CE4\u2CEB-\u2CEE\u2CF2\u2CF3\u2D00-\u2D25\u2D27\u2D2D\u2D30-\u2D67\u2D6F\u2D80-\u2D96\u2DA0-\u2DA6\u2DA8-\u2DAE\u2DB0-\u2DB6\u2DB8-\u2DBE\u2DC0-\u2DC6\u2DC8-\u2DCE\u2DD0-\u2DD6\u2DD8-\u2DDE\u2E2F\u3005\u3006\u3031-\u3035\u303B\u303C\u3041-\u3096\u309D-\u309F\u30A1-\u30FA\u30FC-\u30FF\u3105-\u312D\u3131-\u318E\u31A0-\u31BA\u31F0-\u31FF\u3400-\u4DB5\u4E00-\u9FCC\uA000-\uA48C\uA4D0-\uA4FD\uA500-\uA60C\uA610-\uA61F\uA62A\uA62B\uA640-\uA66E\uA67F-\uA697\uA6A0-\uA6E5\uA717-\uA71F\uA722-\uA788\uA78B-\uA78E\uA790-\uA793\uA7A0-\uA7AA\uA7F8-\uA801\uA803-\uA805\uA807-\uA80A\uA80C-\uA822\uA840-\uA873\uA882-\uA8B3\uA8F2-\uA8F7\uA8FB\uA90A-\uA925\uA930-\uA946\uA960-\uA97C\uA984-\uA9B2\uA9CF\uAA00-\uAA28\uAA40-\uAA42\uAA44-\uAA4B\uAA60-\uAA76\uAA7A\uAA80-\uAAAF\uAAB1\uAAB5\uAAB6\uAAB9-\uAABD\uAAC0\uAAC2\uAADB-\uAADD\uAAE0-\uAAEA\uAAF2-\uAAF4\uAB01-\uAB06\uAB09-\uAB0E\uAB11-\uAB16\uAB20-\uAB26\uAB28-\uAB2E\uABC0-\uABE2\uAC00-\uD7A3\uD7B0-\uD7C6\uD7CB-\uD7FB\uF900-\uFA6D\uFA70-\uFAD9\uFB00-\uFB06\uFB13-\uFB17\uFB1D\uFB1F-\uFB28\uFB2A-\uFB36\uFB38-\uFB3C\uFB3E\uFB40\uFB41\uFB43\uFB44\uFB46-\uFBB1\uFBD3-\uFD3D\uFD50-\uFD8F\uFD92-\uFDC7\uFDF0-\uFDFB\uFE70-\uFE74\uFE76-\uFEFC\uFF21-\uFF3A\uFF41-\uFF5A\uFF66-\uFFBE\uFFC2-\uFFC7\uFFCA-\uFFCF\uFFD2-\uFFD7\uFFDA-\uFFDC'; const numbers = '\u0030-\u0039\u00B2\u00B3\u00B9\u00BC-\u00BE\u0660-\u0669\u06F0-\u06F9\u07C0-\u07C9\u0966-\u096F\u09E6-\u09EF\u09F4-\u09F9\u0A66-\u0A6F\u0AE6-\u0AEF\u0B66-\u0B6F\u0B72-\u0B77\u0BE6-\u0BF2\u0C66-\u0C6F\u0C78-\u0C7E\u0CE6-\u0CEF\u0D66-\u0D75\u0E50-\u0E59\u0ED0-\u0ED9\u0F20-\u0F33\u1040-\u1049\u1090-\u1099\u1369-\u137C\u16EE-\u16F0\u17E0-\u17E9\u17F0-\u17F9\u1810-\u1819\u1946-\u194F\u19D0-\u19DA\u1A80-\u1A89\u1A90-\u1A99\u1B50-\u1B59\u1BB0-\u1BB9\u1C40-\u1C49\u1C50-\u1C59\u2070\u2074-\u2079\u2080-\u2089\u2150-\u2182\u2185-\u2189\u2460-\u249B\u24EA-\u24FF\u2776-\u2793\u2CFD\u3007\u3021-\u3029\u3038-\u303A\u3192-\u3195\u3220-\u3229\u3248-\u324F\u3251-\u325F\u3280-\u3289\u32B1-\u32BF\uA620-\uA629\uA6E6-\uA6EF\uA830-\uA835\uA8D0-\uA8D9\uA900-\uA909\uA9D0-\uA9D9\uAA50-\uAA59\uABF0-\uABF9\uFF10-\uFF19'; -const exceptAlphanum = new RegExp( - '[^' + [letters, numbers].join('') + ']', - 'g' -); +const exceptAlphanum = new RegExp(`[^${[letters, numbers].join('')}]`, 'g'); /** * Converts a string to a slug, that can be used in heading anchors @@ -42,7 +39,7 @@ module.exports = (string, context = {}) => { // Handle uppercase characters .toLowerCase() // Handle accentuated characters - .replace(new RegExp('[' + accents + ']', 'g'), c => + .replace(new RegExp(`[${accents}]`, 'g'), c => without.charAt(accents.indexOf(c)) ) // Replace `.`, `(` and `?` with blank string like Github does @@ -66,10 +63,10 @@ module.exports = (string, context = {}) => { if (typeof context.slugStats[slug] === 'number') { // search for an index, that will not clash with an existing headings while ( - typeof context.slugStats[slug + '-' + ++context.slugStats[slug]] === + typeof context.slugStats[`${slug}-${++context.slugStats[slug]}`] === 'number' ); - slug += '-' + context.slugStats[slug]; + slug += `-${context.slugStats[slug]}`; } // we are tracking both original anchors and suffixed to avoid future name diff --git a/lib/core/unindent.js b/lib/core/unindent.js index c1aae4e01de2..df36ea53b365 100644 --- a/lib/core/unindent.js +++ b/lib/core/unindent.js @@ -17,7 +17,7 @@ function unindent(code) { const indent = lines[0].match(/^\s*/)[0]; for (let i = 0; i < lines.length; ++i) { - lines[i] = lines[i].replace(new RegExp('^' + indent), ''); + lines[i] = lines[i].replace(new RegExp(`^${indent}`), ''); } return lines.join('\n'); } diff --git a/lib/generate-feed.js b/lib/generate-feed.js index fafdebb08c6b..6a89accb39f6 100755 --- a/lib/generate-feed.js +++ b/lib/generate-feed.js @@ -9,7 +9,7 @@ require('babel-register')({ babelrc: false, - only: [__dirname, process.cwd() + '/core'], + only: [__dirname, `${process.cwd()}/core`], plugins: [require('./server/translate-plugin.js')], presets: ['react', 'latest'], }); @@ -20,7 +20,7 @@ const fs = require('fs'); const CWD = process.cwd(); -if (!fs.existsSync(CWD + '/siteConfig.js')) { +if (!fs.existsSync(`${CWD}/siteConfig.js`)) { console.error( chalk.red('Error: No siteConfig.js file found in website folder!') ); diff --git a/lib/publish-gh-pages.js b/lib/publish-gh-pages.js index 6460a3fd755c..1a17ab9ee73f 100755 --- a/lib/publish-gh-pages.js +++ b/lib/publish-gh-pages.js @@ -16,7 +16,7 @@ if (!shell.which('git')) { shell.exit(1); } -const siteConfig = require(process.cwd() + '/siteConfig.js'); +const siteConfig = require(`${process.cwd()}/siteConfig.js`); const GIT_USER = process.env.GIT_USER; const CURRENT_BRANCH = process.env.CIRCLE_BRANCH || diff --git a/lib/rename-version.js b/lib/rename-version.js index 7d41958ea52c..fe110c3de752 100755 --- a/lib/rename-version.js +++ b/lib/rename-version.js @@ -22,7 +22,7 @@ const CWD = process.cwd(); function makeHeader(metadata) { let header = '---\n'; Object.keys(metadata).forEach(key => { - header += key + ': ' + metadata[key] + '\n'; + header += `${key}: ${metadata[key]}\n`; }); header += '---\n'; return header; @@ -54,7 +54,7 @@ if ( } // 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!' @@ -63,14 +63,14 @@ if (!fs.existsSync(CWD + '/versions.json')) { 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!' + `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); @@ -78,19 +78,19 @@ if (versionIndex < 0) { // replace old version with new version in versions.json file versions[versionIndex] = newVersion; fs.writeFileSync( - CWD + '/versions.json', - JSON.stringify(versions, null, 2) + '\n' + `${CWD}/versions.json`, + `${JSON.stringify(versions, null, 2)}\n` ); // 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') { @@ -112,10 +112,8 @@ 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 -const currentSidebarFile = - CWD + '/versioned_sidebars/version-' + currentVersion + '-sidebars.json'; -const newSidebarFile = - CWD + '/versioned_sidebars/version-' + newVersion + '-sidebars.json'; +const currentSidebarFile = `${CWD}/versioned_sidebars/version-${currentVersion}-sidebars.json`; +const newSidebarFile = `${CWD}/versioned_sidebars/version-${newVersion}-sidebars.json`; if (fs.existsSync(currentSidebarFile)) { fs.renameSync(currentSidebarFile, newSidebarFile); let sidebarContent = fs.readFileSync(newSidebarFile, 'utf8'); diff --git a/lib/server/env.js b/lib/server/env.js index 96f16ffa9e3a..2812b7b0b703 100644 --- a/lib/server/env.js +++ b/lib/server/env.js @@ -10,7 +10,7 @@ const fs = require('fs-extra'); const path = require('path'); const chalk = require('chalk'); -const siteConfig = require(CWD + '/siteConfig.js'); +const siteConfig = require(`${CWD}/siteConfig.js`); const join = path.join; diff --git a/lib/server/feed.js b/lib/server/feed.js index 433dc8742974..1adb533067af 100644 --- a/lib/server/feed.js +++ b/lib/server/feed.js @@ -8,10 +8,10 @@ const Feed = require('feed'); const CWD = process.cwd(); -const siteConfig = require(CWD + '/siteConfig.js'); +const siteConfig = require(`${CWD}/siteConfig.js`); const readMetadata = require('./readMetadata.js'); -const blogRootURL = siteConfig.url + siteConfig.baseUrl + 'blog'; +const blogRootURL = `${siteConfig.url + siteConfig.baseUrl}blog`; const siteImageURL = siteConfig.url + siteConfig.baseUrl + siteConfig.headerIcon; const utils = require('../core/utils'); @@ -27,11 +27,10 @@ module.exports = function(type) { const MetadataBlog = require('../core/MetadataBlog.js'); const feed = new Feed({ - title: siteConfig.title + ' Blog', - description: - 'The best place to stay up-to-date with the latest ' + - siteConfig.title + - ' news and events.', + title: `${siteConfig.title} Blog`, + description: `The best place to stay up-to-date with the latest ${ + siteConfig.title + } news and events.`, id: blogRootURL, link: blogRootURL, image: siteImageURL, @@ -40,7 +39,7 @@ module.exports = function(type) { }); MetadataBlog.forEach(post => { - const url = blogRootURL + '/' + post.path; + const url = `${blogRootURL}/${post.path}`; const content = utils.blogPostHasTruncateMarker(post.content) ? utils.extractBlogPostBeforeTruncate(post.content) : utils.extractBlogPostSummary(post.content.trim()); diff --git a/lib/server/generate.js b/lib/server/generate.js index c2dd40d00e40..9931bbd71fc9 100644 --- a/lib/server/generate.js +++ b/lib/server/generate.js @@ -23,7 +23,7 @@ async function execute() { const chalk = require('chalk'); const Site = require('../core/Site.js'); const env = require('./env.js'); - const siteConfig = require(CWD + '/siteConfig.js'); + const siteConfig = require(`${CWD}/siteConfig.js`); const translate = require('./translate.js'); const feed = require('./feed.js'); const sitemap = require('./sitemap.js'); @@ -164,29 +164,29 @@ async function execute() { Object.keys(mdToHtml).forEach(key => { let link = mdToHtml[key]; link = utils.getPath(link, siteConfig.cleanUrl); - link = link.replace('/en/', '/' + language + '/'); + link = link.replace('/en/', `/${language}/`); link = link.replace( '/VERSION/', metadata.version && metadata.version !== defaultVersion - ? '/' + metadata.version + '/' + ? `/${metadata.version}/` : '/' ); // replace relative links without "./" rawContent = rawContent.replace( - new RegExp('\\]\\(' + key, 'g'), - '](' + link + new RegExp(`\\]\\(${key}`, 'g'), + `](${link}` ); // replace relative links with "./" rawContent = rawContent.replace( - new RegExp('\\]\\(\\./' + key, 'g'), - '](' + link + new RegExp(`\\]\\(\\./${key}`, 'g'), + `](${link}` ); }); // replace any relative links to static assets to absolute links rawContent = rawContent.replace( /\]\(assets\//g, - '](' + siteConfig.baseUrl + 'docs/assets/' + `](${siteConfig.baseUrl}docs/assets/` ); const docComp = ( @@ -305,7 +305,7 @@ async function execute() { const targetFile = join( buildDir, 'blog', - page > 0 ? 'page' + (page + 1) : '', + page > 0 ? `page${page + 1}` : '', 'index.html' ); writeFileAndCreateFolder(targetFile, str); @@ -341,7 +341,7 @@ async function execute() { let targetFile = path.normalize(file); targetFile = join( buildDir, - targetFile.split(sep + 'static' + sep)[1] || '' + targetFile.split(`${sep}static${sep}`)[1] || '' ); // parse css files to replace colors according to siteConfig if (file.match(/\.css$/)) { @@ -361,16 +361,16 @@ async function execute() { Object.keys(siteConfig.colors).forEach(key => { const color = siteConfig.colors[key]; - cssContent = cssContent.replace(new RegExp('\\$' + key, 'g'), color); + cssContent = cssContent.replace(new RegExp(`\\$${key}`, 'g'), color); }); if (siteConfig.fonts) { Object.keys(siteConfig.fonts).forEach(key => { const fontString = siteConfig.fonts[key] - .map(font => '"' + font + '"') + .map(font => `"${font}"`) .join(', '); cssContent = cssContent.replace( - new RegExp('\\$' + key, 'g'), + new RegExp(`\\$${key}`, 'g'), fontString ); }); @@ -394,20 +394,20 @@ async function execute() { if (normalizedFile.match(/\.css$/) && !isSeparateCss(normalizedFile)) { const mainCss = join(buildDir, 'css', 'main.css'); let cssContent = fs.readFileSync(normalizedFile, 'utf8'); - cssContent = fs.readFileSync(mainCss, 'utf8') + '\n' + cssContent; + cssContent = `${fs.readFileSync(mainCss, 'utf8')}\n${cssContent}`; Object.keys(siteConfig.colors).forEach(key => { const color = siteConfig.colors[key]; - cssContent = cssContent.replace(new RegExp('\\$' + key, 'g'), color); + cssContent = cssContent.replace(new RegExp(`\\$${key}`, 'g'), color); }); if (siteConfig.fonts) { Object.keys(siteConfig.fonts).forEach(key => { const fontString = siteConfig.fonts[key] - .map(font => '"' + font + '"') + .map(font => `"${font}"`) .join(', '); cssContent = cssContent.replace( - new RegExp('\\$' + key, 'g'), + new RegExp(`\\$${key}`, 'g'), fontString ); }); @@ -418,7 +418,7 @@ async function execute() { normalizedFile.match(/\.png$|.jpg$|.svg$|.gif$/) && !commander.skipImageCompression ) { - const parts = normalizedFile.split(sep + 'static' + sep); + const parts = normalizedFile.split(`${sep}static${sep}`); const targetDirectory = join( buildDir, parts[1].substring(0, parts[1].lastIndexOf(sep)) @@ -435,7 +435,7 @@ async function execute() { ], }); } else if (!fs.lstatSync(normalizedFile).isDirectory()) { - const parts = normalizedFile.split(sep + 'static' + sep); + const parts = normalizedFile.split(`${sep}static${sep}`); const targetFile = join(buildDir, parts[1]); mkdirp.sync(path.dirname(targetFile)); fs.copySync(normalizedFile, targetFile); @@ -463,7 +463,7 @@ async function execute() { let tempFile = join(__dirname, '..', 'pages', parts[1]); tempFile = tempFile.replace( path.basename(normalizedFile), - 'temp' + path.basename(normalizedFile) + `temp${path.basename(normalizedFile)}` ); mkdirp.sync(path.dirname(tempFile)); fs.copySync(normalizedFile, tempFile); @@ -474,9 +474,9 @@ async function execute() { targetFile = targetFile.replace(/\.js$/, '.html'); const regexLang = new RegExp( - escapeStringRegexp(sep + 'pages' + sep) + - '(.*)' + - escapeStringRegexp(sep) + `${escapeStringRegexp(`${sep}pages${sep}`)}(.*)${escapeStringRegexp( + sep + )}` ); const match = regexLang.exec(normalizedFile); const langParts = match[1].split(sep); @@ -488,7 +488,7 @@ async function execute() { if ( language === 'en' || !fs.existsSync( - normalizedFile.replace(sep + 'en' + sep, sep + language + sep) + normalizedFile.replace(`${sep}en${sep}`, sep + language + sep) ) ) { translate.setLanguage(language); @@ -504,7 +504,7 @@ async function execute() { ); writeFileAndCreateFolder( // TODO: use path functions - targetFile.replace(sep + 'en' + sep, sep + language + sep), + targetFile.replace(`${sep}en${sep}`, sep + language + sep), str ); } @@ -524,7 +524,7 @@ async function execute() { ); writeFileAndCreateFolder( - targetFile.replace(sep + 'en' + sep, sep), + targetFile.replace(`${sep}en${sep}`, sep), str ); } else { @@ -542,7 +542,7 @@ async function execute() { ); writeFileAndCreateFolder( - targetFile.replace(sep + 'en' + sep, sep), + targetFile.replace(`${sep}en${sep}`, sep), str ); } diff --git a/lib/server/readCategories.js b/lib/server/readCategories.js index ecabed649ca5..21c22427c5bb 100644 --- a/lib/server/readCategories.js +++ b/lib/server/readCategories.js @@ -11,8 +11,8 @@ const Metadata = require('../core/metadata.js'); const CWD = process.cwd(); let languages; -if (fs.existsSync(CWD + '/languages.js')) { - languages = require(CWD + '/languages.js'); +if (fs.existsSync(`${CWD}/languages.js`)) { + languages = require(`${CWD}/languages.js`); } else { languages = [ { diff --git a/lib/server/readMetadata.js b/lib/server/readMetadata.js index 2ce18f2c9046..b039ec522727 100644 --- a/lib/server/readMetadata.js +++ b/lib/server/readMetadata.js @@ -15,7 +15,7 @@ const metadataUtils = require('./metadataUtils'); const env = require('./env.js'); -const siteConfig = require(CWD + '/siteConfig.js'); +const siteConfig = require(`${CWD}/siteConfig.js`); const versionFallback = require('./versionFallback.js'); const utils = require('./utils.js'); @@ -44,8 +44,8 @@ function getDocsPath() { // returns map from id to object containing sidebar ordering info function readSidebar() { let allSidebars; - if (fs.existsSync(CWD + '/sidebars.json')) { - allSidebars = require(CWD + '/sidebars.json'); + if (fs.existsSync(`${CWD}/sidebars.json`)) { + allSidebars = require(`${CWD}/sidebars.json`); } else { allSidebars = {}; } @@ -124,18 +124,18 @@ function processMetadata(file, refDir) { } const langPart = - env.translation.enabled || siteConfig.useEnglishUrl ? language + '/' : ''; + env.translation.enabled || siteConfig.useEnglishUrl ? `${language}/` : ''; let versionPart = ''; if (env.versioning.enabled) { metadata.version = 'next'; versionPart = 'next/'; } - metadata.permalink = 'docs/' + langPart + versionPart + metadata.id + '.html'; + metadata.permalink = `docs/${langPart}${versionPart}${metadata.id}.html`; // change ids previous, next metadata.localized_id = metadata.id; - metadata.id = (env.translation.enabled ? language + '-' : '') + metadata.id; + metadata.id = (env.translation.enabled ? `${language}-` : '') + metadata.id; metadata.language = env.translation.enabled ? language : 'en'; const order = readSidebar(); @@ -148,12 +148,12 @@ function processMetadata(file, refDir) { if (order[id].next) { metadata.next_id = order[id].next; metadata.next = - (env.translation.enabled ? language + '-' : '') + order[id].next; + (env.translation.enabled ? `${language}-` : '') + order[id].next; } if (order[id].previous) { metadata.previous_id = order[id].previous; metadata.previous = - (env.translation.enabled ? language + '-' : '') + order[id].previous; + (env.translation.enabled ? `${language}-` : '') + order[id].previous; } } @@ -179,7 +179,7 @@ function generateMetadataDocs() { // metadata for english files const docsDir = path.join(CWD, '../', getDocsPath()); - let files = glob.sync(CWD + '/../' + getDocsPath() + '/**'); + let files = glob.sync(`${CWD}/../${getDocsPath()}/**`); files.forEach(file => { const extension = path.extname(file); @@ -200,19 +200,19 @@ function generateMetadataDocs() { const baseMetadata = Object.assign({}, metadata); baseMetadata.id = baseMetadata.id .toString() - .replace(/^en-/, currentLanguage + '-'); + .replace(/^en-/, `${currentLanguage}-`); if (baseMetadata.permalink) baseMetadata.permalink = baseMetadata.permalink .toString() - .replace(/^docs\/en\//, 'docs/' + currentLanguage + '/'); + .replace(/^docs\/en\//, `docs/${currentLanguage}/`); if (baseMetadata.next) baseMetadata.next = baseMetadata.next .toString() - .replace(/^en-/, currentLanguage + '-'); + .replace(/^en-/, `${currentLanguage}-`); if (baseMetadata.previous) baseMetadata.previous = baseMetadata.previous .toString() - .replace(/^en-/, currentLanguage + '-'); + .replace(/^en-/, `${currentLanguage}-`); baseMetadata.language = currentLanguage; defaultMetadatas[baseMetadata.id] = baseMetadata; }); @@ -222,7 +222,7 @@ function generateMetadataDocs() { // metadata for non-english docs const translatedDir = path.join(CWD, 'translated_docs'); - files = glob.sync(CWD + '/translated_docs/**'); + files = glob.sync(`${CWD}/translated_docs/**`); files.forEach(file => { if (!utils.getLanguage(file, translatedDir)) { return; @@ -249,20 +249,20 @@ function generateMetadataDocs() { metadata.category = order[id].category; if (order[id].next) { metadata.next_id = order[id].next.replace( - 'version-' + metadata.version + '-', + `version-${metadata.version}-`, '' ); metadata.next = - (env.translation.enabled ? metadata.language + '-' : '') + + (env.translation.enabled ? `${metadata.language}-` : '') + order[id].next; } if (order[id].previous) { metadata.previous_id = order[id].previous.replace( - 'version-' + metadata.version + '-', + `version-${metadata.version}-`, '' ); metadata.previous = - (env.translation.enabled ? metadata.language + '-' : '') + + (env.translation.enabled ? `${metadata.language}-` : '') + order[id].previous; } } @@ -271,7 +271,7 @@ function generateMetadataDocs() { // Get the titles of the previous and next ids so that we can use them in // navigation buttons in DocsLayout.js - Object.keys(metadatas).forEach(function(metadata) { + Object.keys(metadatas).forEach(metadata => { if (metadatas[metadata].previous) { if (metadatas[metadatas[metadata].previous]) { metadatas[metadata].previous_title = @@ -292,13 +292,11 @@ function generateMetadataDocs() { fs.writeFileSync( path.join(__dirname, '/../core/metadata.js'), - '/**\n' + + `${'/**\n' + ' * @' + 'generated\n' + // separate this out for Nuclide treating @generated as readonly ' */\n' + - 'module.exports = ' + - JSON.stringify(metadatas, null, 2) + - ';\n' + 'module.exports = '}${JSON.stringify(metadatas, null, 2)};\n` ); } @@ -306,7 +304,7 @@ function generateMetadataDocs() { function generateMetadataBlog() { const metadatas = []; - const files = glob.sync(CWD + '/blog/**/*.*'); + const files = glob.sync(`${CWD}/blog/**/*.*`); files .sort() .reverse() @@ -342,12 +340,9 @@ function generateMetadataBlog() { .toString() .split('-'); metadata.date = new Date( - filePathDateArr[0] + - '-' + - filePathDateArr[1] + - '-' + - filePathDateArr[2] + - 'T06:00:00.000Z' + `${filePathDateArr[0]}-${filePathDateArr[1]}-${ + filePathDateArr[2] + }T06:00:00.000Z` ); // allow easier sorting of blog by providing seconds since epoch metadata.seconds = Math.round(metadata.date.getTime() / 1000); @@ -361,13 +356,11 @@ function generateMetadataBlog() { fs.writeFileSync( path.join(__dirname, '/../core/MetadataBlog.js'), - '/**\n' + + `${'/**\n' + ' * @' + 'generated\n' + // separate this out for Nuclide treating @generated as readonly ' */\n' + - 'module.exports = ' + - JSON.stringify(sortedMetadatas, null, 2) + - ';\n' + 'module.exports = '}${JSON.stringify(sortedMetadatas, null, 2)};\n` ); } diff --git a/lib/server/renderUtils.js b/lib/server/renderUtils.js index 29dc9873b918..70571e4dbf0e 100644 --- a/lib/server/renderUtils.js +++ b/lib/server/renderUtils.js @@ -13,7 +13,7 @@ const renderToStaticMarkup = require('react-dom/server').renderToStaticMarkup; * rendering within Docusaurus should use this function instead. */ function renderToStaticMarkupWithDoctype(...args) { - return '' + renderToStaticMarkup(...args); + return `${renderToStaticMarkup(...args)}`; } module.exports = { diff --git a/lib/server/server.js b/lib/server/server.js index 57a7c1a3a774..4deb5b729106 100644 --- a/lib/server/server.js +++ b/lib/server/server.js @@ -49,7 +49,7 @@ function execute(port, options) { function removeModulePathFromCache(moduleName) { /* eslint-disable no-underscore-dangle */ - Object.keys(module.constructor._pathCache).forEach(function(cacheKey) { + Object.keys(module.constructor._pathCache).forEach(cacheKey => { if (cacheKey.indexOf(moduleName) > 0) { delete module.constructor._pathCache[cacheKey]; } @@ -149,7 +149,7 @@ function execute(port, options) { // Start LiveReload server. process.env.NODE_ENV = 'development'; const server = tinylr(); - server.listen(constants.LIVE_RELOAD_PORT, function() { + server.listen(constants.LIVE_RELOAD_PORT, () => { console.log( 'LiveReload server started on port %d', constants.LIVE_RELOAD_PORT @@ -159,13 +159,13 @@ function execute(port, options) { // gaze watches some specified dirs and triggers a callback when they change. gaze( [ - '../' + readMetadata.getDocsPath() + '/**/*', // docs + `../${readMetadata.getDocsPath()}/**/*`, // docs '**/*', // website '!node_modules/**/*', // node_modules ], function() { // Listen for all kinds of file changes - modified/added/deleted. - this.on('all', function() { + this.on('all', () => { // Notify LiveReload clients that there's a change. // Typically, LiveReload will only refresh the changed paths, // so we use / here to force a full-page reload. @@ -252,29 +252,29 @@ function execute(port, options) { Object.keys(mdToHtml).forEach(key => { let link = mdToHtml[key]; link = utils.getPath(link, siteConfig.cleanUrl); - link = link.replace('/en/', '/' + language + '/'); + link = link.replace('/en/', `/${language}/`); link = link.replace( '/VERSION/', metadata.version && metadata.version !== defaultVersion - ? '/' + metadata.version + '/' + ? `/${metadata.version}/` : '/' ); // replace relative links without "./" rawContent = rawContent.replace( - new RegExp('\\]\\(' + key, 'g'), - '](' + link + new RegExp(`\\]\\(${key}`, 'g'), + `](${link}` ); // replace relative links with "./" rawContent = rawContent.replace( - new RegExp('\\]\\(\\./' + key, 'g'), - '](' + link + new RegExp(`\\]\\(\\./${key}`, 'g'), + `](${link}` ); }); // replace any relative links to static assets to absolute links rawContent = rawContent.replace( /\]\(assets\//g, - '](' + siteConfig.baseUrl + 'docs/assets/' + `](${siteConfig.baseUrl}docs/assets/` ); removeModuleAndChildrenFromCache('../core/DocsLayout.js'); @@ -357,7 +357,7 @@ function execute(port, options) { ); const str = renderToStaticMarkupWithDoctype(blogPageComp); - const pagePath = (page > 0 ? 'page' + (page + 1) : '') + '/index.html'; + const pagePath = `${page > 0 ? `page${page + 1}` : ''}/index.html`; blogPages[pagePath] = str; } @@ -369,9 +369,9 @@ function execute(port, options) { res.send(blogPages[parts[1]]); } else if (parts[1].match(/page([0-9]+)/)) { if (parts[1].endsWith('/')) { - res.send(blogPages[parts[1] + 'index.html']); + res.send(blogPages[`${parts[1]}index.html`]); } else { - res.send(blogPages[parts[1] + '/index.html']); + res.send(blogPages[`${parts[1]}/index.html`]); } } else { // send corresponding blog post. Ex: request to "blog/test/index.html" or @@ -396,7 +396,7 @@ function execute(port, options) { let rawContent = result.rawContent; rawContent = rawContent.replace( /\]\(assets\//g, - '](' + siteConfig.baseUrl + 'blog/assets/' + `](${siteConfig.baseUrl}blog/assets/` ); const metadata = Object.assign( {path: req.path.toString().split('blog/')[1], content: rawContent}, @@ -478,7 +478,7 @@ function execute(port, options) { } let englishFile = join(CWD, 'pages', file); if (language && language !== 'en') { - englishFile = englishFile.replace(sep + language + sep, sep + 'en' + sep); + englishFile = englishFile.replace(sep + language + sep, `${sep}en${sep}`); } // check for: a file for the page, an english file for page with unspecified language, or an @@ -488,17 +488,17 @@ function execute(port, options) { fs.existsSync( (userFile = userFile.replace( path.basename(userFile), - 'en' + sep + path.basename(userFile) + `en${sep}${path.basename(userFile)}` )) ) || fs.existsSync((userFile = englishFile)) ) { // copy into docusaurus so require paths work - const userFileParts = userFile.split('pages' + sep); + const userFileParts = userFile.split(`pages${sep}`); let tempFile = join(__dirname, '..', 'pages', userFileParts[1]); tempFile = tempFile.replace( path.basename(file), - 'temp' + path.basename(file) + `temp${path.basename(file)}` ); mkdirp.sync(path.dirname(tempFile)); fs.copySync(userFile, tempFile); @@ -544,8 +544,9 @@ function execute(port, options) { if (isSeparateCss(file)) { return; } - cssContent = - cssContent + '\n' + fs.readFileSync(file, {encoding: 'utf8'}); + cssContent = `${cssContent}\n${fs.readFileSync(file, { + encoding: 'utf8', + })}`; }); if ( @@ -562,16 +563,16 @@ function execute(port, options) { Object.keys(siteConfig.colors).forEach(key => { const color = siteConfig.colors[key]; - cssContent = cssContent.replace(new RegExp('\\$' + key, 'g'), color); + cssContent = cssContent.replace(new RegExp(`\\$${key}`, 'g'), color); }); if (siteConfig.fonts) { Object.keys(siteConfig.fonts).forEach(key => { const fontString = siteConfig.fonts[key] - .map(font => '"' + font + '"') + .map(font => `"${font}"`) .join(', '); cssContent = cssContent.replace( - new RegExp('\\$' + key, 'g'), + new RegExp(`\\$${key}`, 'g'), fontString ); }); @@ -597,11 +598,11 @@ function execute(port, options) { // for example, request to "blog" returns "blog/index.html" or "blog.html" app.get(noExtRouting(), (req, res, next) => { const slash = req.path.toString().endsWith('/') ? '' : '/'; - const requestUrl = 'http://localhost:' + port + req.path; - requestFile(requestUrl + slash + 'index.html', res, () => { + const requestUrl = `http://localhost:${port}${req.path}`; + requestFile(`${requestUrl + slash}index.html`, res, () => { requestFile( slash === '/' - ? requestUrl + '.html' + ? `${requestUrl}.html` : requestUrl.replace(/\/$/, '.html'), res, next @@ -616,7 +617,7 @@ function execute(port, options) { next(); return; } - requestFile('http://localhost:' + port + req.path + '.html', res, next); + requestFile(`http://localhost:${port}${req.path}.html`, res, next); }); if (options.watch) startLiveReload(); diff --git a/lib/server/sitemap.js b/lib/server/sitemap.js index 5f0440546ef2..fb0d891ad486 100644 --- a/lib/server/sitemap.js +++ b/lib/server/sitemap.js @@ -14,7 +14,7 @@ const CWD = process.cwd(); const sitemap = require('sitemap'); const utils = require('../core/utils'); -const siteConfig = require(CWD + '/siteConfig.js'); +const siteConfig = require(`${CWD}/siteConfig.js`); const readMetadata = require('./readMetadata.js'); @@ -27,7 +27,7 @@ const MetadataBlog = require('../core/MetadataBlog.js'); module.exports = function(callback) { console.log('sitemap.js triggered...'); - const files = glob.sync(CWD + '/pages/en/**/*.js'); + const files = glob.sync(`${CWD}/pages/en/**/*.js`); // English-only is the default. let enabledLanguages = [ @@ -39,8 +39,8 @@ module.exports = function(callback) { ]; // If we have a languages.js file, get all the enabled languages in there - if (fs.existsSync(CWD + '/languages.js')) { - const languages = require(CWD + '/languages.js'); + if (fs.existsSync(`${CWD}/languages.js`)) { + const languages = require(`${CWD}/languages.js`); enabledLanguages = languages.filter(lang => lang.enabled); } @@ -59,7 +59,7 @@ module.exports = function(callback) { MetadataBlog.forEach(blog => { urls.push({ - url: '/blog/' + utils.getPath(blog.path, siteConfig.cleanUrl), + url: `/blog/${utils.getPath(blog.path, siteConfig.cleanUrl)}`, changefreq: 'weekly', priority: 0.3, }); diff --git a/lib/server/translate-plugin.js b/lib/server/translate-plugin.js index 4cf1fcd157a3..6b642d4418b3 100644 --- a/lib/server/translate-plugin.js +++ b/lib/server/translate-plugin.js @@ -30,14 +30,14 @@ module.exports = function translatePlugin(babel) { path.replaceWith( t.jSXExpressionContainer( t.callExpression(t.identifier('translate'), [ - t.stringLiteral(text + '|' + description), + t.stringLiteral(`${text}|${description}`), ]) ) ); } else { path.replaceWith( t.callExpression(t.identifier('translate'), [ - t.stringLiteral(text + '|' + description), + t.stringLiteral(`${text}|${description}`), ]) ); } diff --git a/lib/server/translate.js b/lib/server/translate.js index c1cb91582342..68d929e8dc23 100644 --- a/lib/server/translate.js +++ b/lib/server/translate.js @@ -47,19 +47,13 @@ function translate(str) { // if a translated string doesn't exist, but english does then fallback if (doesTranslationExist(str, 'en')) { console.error( - "Could not find a string translation in '" + - language + - "' for string '" + - str + - "'. Using English version instead." + `Could not find a string translation in '${language}' for string '${str}'. Using English version instead.` ); return parseEscapeSequences(translation.en['pages-strings'][str]); } throw new Error( - "Text that you've identified for translation ('" + - str + - "') hasn't been added to the global list in 'en.json'. To solve this problem run 'yarn write-translations'." + `Text that you've identified for translation ('${str}') hasn't been added to the global list in 'en.json'. To solve this problem run 'yarn write-translations'.` ); } return parseEscapeSequences(translation[language]['pages-strings'][str]); diff --git a/lib/server/translation.js b/lib/server/translation.js index d43033019e54..885df363ae5f 100644 --- a/lib/server/translation.js +++ b/lib/server/translation.js @@ -13,8 +13,8 @@ const glob = require('glob'); const path = require('path'); let languages; -if (fs.existsSync(CWD + '/languages.js')) { - languages = require(CWD + '/languages.js'); +if (fs.existsSync(`${CWD}/languages.js`)) { + languages = require(`${CWD}/languages.js`); } else { languages = [ { @@ -29,7 +29,7 @@ const enabledLanguages = languages.filter(lang => lang.enabled); const translation = {languages: enabledLanguages}; -const files = glob.sync(CWD + '/i18n/**'); +const files = glob.sync(`${CWD}/i18n/**`); const langRegex = /\/i18n\/(.*)\.json$/; files.forEach(file => { diff --git a/lib/server/utils.js b/lib/server/utils.js index d4598f8ffc57..c10814d784c8 100644 --- a/lib/server/utils.js +++ b/lib/server/utils.js @@ -25,7 +25,7 @@ function getSubDir(file, refDir) { // returns 'ko' function getLanguage(file, refDir) { const regexSubFolder = new RegExp( - '/' + escapeStringRegexp(path.basename(refDir)) + '/(.*)/.*/' + `/${escapeStringRegexp(path.basename(refDir))}/(.*)/.*/` ); const match = regexSubFolder.exec(file); diff --git a/lib/server/versionFallback.js b/lib/server/versionFallback.js index 20a3d46b0f36..bebd034dd196 100644 --- a/lib/server/versionFallback.js +++ b/lib/server/versionFallback.js @@ -15,20 +15,20 @@ const metadataUtils = require('./metadataUtils'); const env = require('./env.js'); const utils = require('./utils.js'); -const siteConfig = require(CWD + '/siteConfig.js'); +const siteConfig = require(`${CWD}/siteConfig.js`); -const ENABLE_TRANSLATION = fs.existsSync(CWD + '/languages.js'); +const ENABLE_TRANSLATION = fs.existsSync(`${CWD}/languages.js`); let versions; -if (fs.existsSync(CWD + '/versions.json')) { - versions = require(CWD + '/versions.json'); +if (fs.existsSync(`${CWD}/versions.json`)) { + versions = require(`${CWD}/versions.json`); } else { versions = []; } let languages; -if (fs.existsSync(CWD + '/languages.js')) { - languages = require(CWD + '/languages.js'); +if (fs.existsSync(`${CWD}/languages.js`)) { + languages = require(`${CWD}/languages.js`); } else { languages = [ { @@ -39,7 +39,7 @@ if (fs.existsSync(CWD + '/languages.js')) { ]; } -const versionFolder = CWD + '/versioned_docs/'; +const versionFolder = `${CWD}/versioned_docs/`; // available stores doc ids of documents that are available for // each version @@ -47,7 +47,7 @@ const available = {}; // versionFiles is used to keep track of what file to use with a // given version/id of a document const versionFiles = {}; -const files = glob.sync(versionFolder + '**'); +const files = glob.sync(`${versionFolder}**`); files.forEach(file => { const ext = path.extname(file); if (ext !== '.md' && ext !== '.markdown') { @@ -85,7 +85,7 @@ files.forEach(file => { // e.g. version-1.0.0-getting-started => 1.0.0 const version = metadata.id.substring( metadata.id.indexOf('version-') + 8, // version- is 8 characters - metadata.id.lastIndexOf('-' + metadata.original_id) + metadata.id.lastIndexOf(`-${metadata.original_id}`) ); available[metadata.original_id].add(version); @@ -178,26 +178,20 @@ function processVersionMetadata(file, version, useVersion, language) { const latestVersion = versions[0]; if (!ENABLE_TRANSLATION && !siteConfig.useEnglishUrl) { - metadata.permalink = - 'docs/' + - (version !== latestVersion ? version + '/' : '') + - metadata.original_id + - '.html'; + metadata.permalink = `docs/${ + version !== latestVersion ? `${version}/` : '' + }${metadata.original_id}.html`; } else { - metadata.permalink = - 'docs/' + - language + - '/' + - (version !== latestVersion ? version + '/' : '') + - metadata.original_id + - '.html'; + metadata.permalink = `docs/${language}/${ + version !== latestVersion ? `${version}/` : '' + }${metadata.original_id}.html`; } metadata.id = metadata.id.replace( - 'version-' + useVersion + '-', - 'version-' + version + '-' + `version-${useVersion}-`, + `version-${version}-` ); metadata.localized_id = metadata.id; - metadata.id = (env.translation.enabled ? language + '-' : '') + metadata.id; + metadata.id = (env.translation.enabled ? `${language}-` : '') + metadata.id; metadata.language = language; metadata.version = version; @@ -252,7 +246,7 @@ function sidebarVersion(reqVersion) { if ( requestedFound && fs.existsSync( - CWD + '/versioned_sidebars/version-' + versions[i] + '-sidebars.json' + `${CWD}/versioned_sidebars/version-${versions[i]}-sidebars.json` ) ) { return versions[i]; @@ -272,12 +266,11 @@ function diffLatestSidebar() { const latest = versions[0]; const version = sidebarVersion(latest); - const latestSidebar = - CWD + '/versioned_sidebars/version-' + version + '-sidebars.json'; + const latestSidebar = `${CWD}/versioned_sidebars/version-${version}-sidebars.json`; if (!fs.existsSync(latestSidebar)) { return true; } - const currentSidebar = CWD + '/sidebars.json'; + const currentSidebar = `${CWD}/sidebars.json`; // if no current sidebar file, return false so no sidebar file gets copied if (!fs.existsSync(currentSidebar)) { return false; @@ -287,7 +280,7 @@ function diffLatestSidebar() { // stripped and current sidebar return ( JSON.stringify(JSON.parse(fs.readFileSync(latestSidebar, 'utf8'))).replace( - new RegExp('version-' + version + '-', 'g'), + new RegExp(`version-${version}-`, 'g'), '' ) !== JSON.stringify(JSON.parse(fs.readFileSync(currentSidebar, 'utf8'))) ); @@ -302,12 +295,12 @@ function sidebarData() { const sidebar = JSON.parse( fs .readFileSync( - CWD + '/versioned_sidebars/version-' + version + '-sidebars.json', + `${CWD}/versioned_sidebars/version-${version}-sidebars.json`, 'utf8' ) .replace( - new RegExp('version-' + version + '-', 'g'), - 'version-' + versions[i] + '-' + new RegExp(`version-${version}-`, 'g'), + `version-${versions[i]}-` ) ); Object.assign(allSidebars, sidebar); diff --git a/lib/start-server.js b/lib/start-server.js index cf940ec15fbd..e5df4351134c 100755 --- a/lib/start-server.js +++ b/lib/start-server.js @@ -9,7 +9,7 @@ require('babel-register')({ babelrc: false, - only: [__dirname, process.cwd() + '/core'], + only: [__dirname, `${process.cwd()}/core`], plugins: [ require('./server/translate-plugin.js'), 'transform-class-properties', @@ -27,7 +27,7 @@ const tcpPortUsed = require('tcp-port-used'); const CWD = process.cwd(); const env = require('./server/env.js'); -if (!fs.existsSync(CWD + '/siteConfig.js')) { +if (!fs.existsSync(`${CWD}/siteConfig.js`)) { console.error( chalk.red('Error: No siteConfig.js file found in website folder!') ); @@ -51,7 +51,7 @@ const MAX_ATTEMPTS = 10; function checkPort() { tcpPortUsed .check(port, 'localhost') - .then(function(inUse) { + .then(inUse => { if (inUse && numAttempts >= MAX_ATTEMPTS) { console.log( 'Reached max attempts, exiting. Please open up some ports or ' + @@ -59,7 +59,7 @@ function checkPort() { ); process.exit(1); } else if (inUse) { - console.error(chalk.red('Port ' + port + ' is in use')); + console.error(chalk.red(`Port ${port} is in use`)); // Try again but with port + 1 port += 1; numAttempts += 1; @@ -68,14 +68,14 @@ function checkPort() { // start local server on specified port const server = require('./server/server.js'); server(port, program.opts()); - const {baseUrl} = require(CWD + '/siteConfig.js'); + const {baseUrl} = require(`${CWD}/siteConfig.js`); const host = `http://localhost:${port}${baseUrl}`; console.log('Docusaurus server started on port %d', port); openBrowser(host); } }) - .catch(function(ex) { - setTimeout(function() { + .catch(ex => { + setTimeout(() => { throw ex; }, 0); }); diff --git a/lib/version.js b/lib/version.js index 18d31219ede0..9c4e23e314c3 100755 --- a/lib/version.js +++ b/lib/version.js @@ -22,8 +22,8 @@ const env = require('./server/env.js'); const CWD = process.cwd(); let versions; -if (fs.existsSync(CWD + '/versions.json')) { - versions = require(CWD + '/versions.json'); +if (fs.existsSync(`${CWD}/versions.json`)) { + versions = require(`${CWD}/versions.json`); } else { versions = []; } @@ -63,7 +63,7 @@ if (versions.includes(version)) { function makeHeader(metadata) { let header = '---\n'; Object.keys(metadata).forEach(key => { - header += key + ': ' + metadata[key] + '\n'; + header += `${key}: ${metadata[key]}\n`; }); header += '---\n'; return header; @@ -75,12 +75,12 @@ function writeFileAndCreateFolder(file, content, encoding) { fs.writeFileSync(file, content, encoding); } -const versionFolder = CWD + '/versioned_docs/version-' + version; +const versionFolder = `${CWD}/versioned_docs/version-${version}`; mkdirp.sync(versionFolder); // copy necessary files to new version, changing some of its metadata to reflect the versioning -const files = glob.sync(CWD + '/../' + readMetadata.getDocsPath() + '/**'); +const files = glob.sync(`${CWD}/../${readMetadata.getDocsPath()}/**`); files.forEach(file => { const ext = path.extname(file); if (ext !== '.md' && ext !== '.markdown') { @@ -109,7 +109,7 @@ files.forEach(file => { } metadata.original_id = metadata.id; - metadata.id = 'version-' + version + '-' + metadata.id; + metadata.id = `version-${version}-${metadata.id}`; const docsDir = path.join(CWD, '../', readMetadata.getDocsPath()); const subDir = utils.getSubDir(file, docsDir); @@ -126,12 +126,12 @@ files.forEach(file => { // copy sidebar if necessary if (versionFallback.diffLatestSidebar()) { - mkdirp(CWD + '/versioned_sidebars'); - const sidebar = JSON.parse(fs.readFileSync(CWD + '/sidebars.json', 'utf8')); + mkdirp(`${CWD}/versioned_sidebars`); + const sidebar = JSON.parse(fs.readFileSync(`${CWD}/sidebars.json`, 'utf8')); const versioned = {}; Object.keys(sidebar).forEach(sb => { - const versionSidebar = 'version-' + version + '-' + sb; + const versionSidebar = `version-${version}-${sb}`; versioned[versionSidebar] = {}; const categories = sidebar[sb]; @@ -140,16 +140,14 @@ if (versionFallback.diffLatestSidebar()) { const ids = categories[category]; ids.forEach(id => { - versioned[versionSidebar][category].push( - 'version-' + version + '-' + id - ); + versioned[versionSidebar][category].push(`version-${version}-${id}`); }); }); }); fs.writeFileSync( - CWD + '/versioned_sidebars/version-' + version + '-sidebars.json', - JSON.stringify(versioned, null, 2) + '\n', + `${CWD}/versioned_sidebars/version-${version}-sidebars.json`, + `${JSON.stringify(versioned, null, 2)}\n`, 'utf8' ); } @@ -157,8 +155,8 @@ if (versionFallback.diffLatestSidebar()) { // update versions.json file versions.unshift(version); fs.writeFileSync( - CWD + '/versions.json', - JSON.stringify(versions, null, 2) + '\n' + `${CWD}/versions.json`, + `${JSON.stringify(versions, null, 2)}\n` ); -console.log(`${chalk.green('Version ' + version + ' created!\n')}`); +console.log(`${chalk.green(`Version ${version} created!\n`)}`); diff --git a/lib/write-translations.js b/lib/write-translations.js index 47bfb1d7cd97..8db7cc21b13d 100755 --- a/lib/write-translations.js +++ b/lib/write-translations.js @@ -29,16 +29,16 @@ const nodePath = require('path'); const readMetadata = require('./server/readMetadata.js'); const CWD = process.cwd(); -const siteConfig = require(CWD + '/siteConfig.js'); -const sidebars = require(CWD + '/sidebars.json'); +const siteConfig = require(`${CWD}/siteConfig.js`); +const sidebars = require(`${CWD}/sidebars.json`); let customTranslations = { 'localized-strings': {}, 'pages-strings': {}, }; -if (fs.existsSync(CWD + '/data/custom-translation-strings.json')) { +if (fs.existsSync(`${CWD}/data/custom-translation-strings.json`)) { customTranslations = JSON.parse( - fs.readFileSync(CWD + '/data/custom-translation-strings.json', 'utf8') + fs.readFileSync(`${CWD}/data/custom-translation-strings.json`, 'utf8') ); } @@ -59,7 +59,7 @@ function execute() { // look through markdown headers of docs for titles and categories to translate const docsDir = nodePath.join(CWD, '../', readMetadata.getDocsPath()); - let files = glob.sync(CWD + '/../' + readMetadata.getDocsPath() + '/**'); + let files = glob.sync(`${CWD}/../${readMetadata.getDocsPath()}/**`); files.forEach(file => { const extension = nodePath.extname(file); if (extension === '.md' || extension === '.markdown') { @@ -98,7 +98,7 @@ function execute() { }); }); - files = glob.sync(CWD + '/versioned_sidebars/*'); + files = glob.sync(`${CWD}/versioned_sidebars/*`); files.forEach(file => { if (!file.endsWith('-sidebars.json')) { if (file.endsWith('-sidebar.json')) { @@ -125,7 +125,7 @@ function execute() { }); // go through pages to look for text inside translate tags - files = glob.sync(CWD + '/pages/en/**'); + files = glob.sync(`${CWD}/pages/en/**`); files.forEach(file => { const extension = nodePath.extname(file); if (extension === '.js') { @@ -148,7 +148,7 @@ function execute() { description = attributes[i].value.value; } } - translations['pages-strings'][text + '|' + description] = text; + translations['pages-strings'][`${text}|${description}`] = text; } }, }); @@ -177,8 +177,8 @@ function execute() { customTranslations['localized-strings'] ); writeFileAndCreateFolder( - CWD + '/i18n/en.json', - JSON.stringify( + `${CWD}/i18n/en.json`, + `${JSON.stringify( Object.assign( { _comment: 'This file is auto-generated by write-translations.js', @@ -187,7 +187,7 @@ function execute() { ), null, 2 - ) + '\n' + )}\n` ); } diff --git a/package.json b/package.json index 92d42329cc51..5ae1f738b91b 100644 --- a/package.json +++ b/package.json @@ -3,12 +3,7 @@ "description": "Easy to Maintain Open Source Documentation Websites", "version": "1.3.2", "license": "MIT", - "keywords": [ - "documentation", - "websites", - "open source", - "docusaurus" - ], + "keywords": ["documentation", "websites", "open source", "docusaurus"], "repository": { "type": "git", "url": "https://github.com/facebook/Docusaurus.git" @@ -16,13 +11,22 @@ "scripts": { "ci-check": "yarn lint && yarn prettier:diff", "format:source": "prettier --config .prettierrc --write \"lib/**/*.js\"", - "format:examples": "prettier --config .prettierrc --write \"examples/**/*.js\"", - "lint": "eslint --cache \"lib/**/*.js\" \"examples/**/*.js\" \"website/**/*.js\"", - "nit:source": "prettier --config .prettierrc --list-different \"lib/**/*.js\"", - "nit:examples": "prettier --config .prettierrc --list-different \"examples/**/*.js\"", + "format:examples": + "prettier --config .prettierrc --write \"examples/**/*.js\"", + "format:website": + "prettier --config .prettierrc --write \"website/**/*.js\"", + "lint": + "eslint --cache \"lib/**/*.js\" \"examples/**/*.js\" \"website/**/*.js\"", + "nit:source": + "prettier --config .prettierrc --list-different \"lib/**/*.js\"", + "nit:examples": + "prettier --config .prettierrc --list-different \"examples/**/*.js\"", + "nit:website": + "prettier --config .prettierrc --list-different \"website/**/*.js\"", "precommit": "lint-staged", - "prettier": "yarn format:source && yarn format:examples", - "prettier:diff": "yarn nit:source && yarn nit:examples", + "prettier": + "yarn format:source && yarn format:examples && yarn format:website", + "prettier:diff": "yarn nit:source && yarn nit:examples && yarn nit:website", "test": "jest", "start": "cd website && yarn start" }, diff --git a/website/data/users.js b/website/data/users.js index 2be89bae7fff..6ea86e28d74e 100644 --- a/website/data/users.js +++ b/website/data/users.js @@ -210,7 +210,7 @@ module.exports = [ fbOpenSource: false, pinned: false, }, - { + { caption: 'single-spa', image: 'https://single-spa.js.org/img/logo-white-bgblue.svg', infoLink: 'https://single-spa.js.org/', diff --git a/website/languages.js b/website/languages.js index 59a17d380b31..2bb754b1a6a9 100644 --- a/website/languages.js +++ b/website/languages.js @@ -8,178 +8,178 @@ const languages = [ { enabled: true, - name: "English", - tag: "en" + name: 'English', + tag: 'en', }, { enabled: false, - name: "日本語", - tag: "ja" + name: '日本語', + tag: 'ja', }, { enabled: false, - name: "العربية", - tag: "ar" + name: 'العربية', + tag: 'ar', }, { enabled: false, - name: "Bosanski", - tag: "bs-BA" + name: 'Bosanski', + tag: 'bs-BA', }, { enabled: false, - name: "Català", - tag: "ca" + name: 'Català', + tag: 'ca', }, { enabled: false, - name: "Čeština", - tag: "cs" + name: 'Čeština', + tag: 'cs', }, { enabled: false, - name: "Dansk", - tag: "da" + name: 'Dansk', + tag: 'da', }, { enabled: false, - name: "Deutsch", - tag: "de" + name: 'Deutsch', + tag: 'de', }, { enabled: false, - name: "Ελληνικά", - tag: "el" + name: 'Ελληνικά', + tag: 'el', }, { enabled: true, - name: "Español", - tag: "es-ES" + name: 'Español', + tag: 'es-ES', }, { enabled: false, - name: "فارسی", - tag: "fa-IR" + name: 'فارسی', + tag: 'fa-IR', }, { enabled: false, - name: "Suomi", - tag: "fi" + name: 'Suomi', + tag: 'fi', }, { enabled: false, - name: "Français", - tag: "fr" + name: 'Français', + tag: 'fr', }, { enabled: false, - name: "עִברִית", - tag: "he" + name: 'עִברִית', + tag: 'he', }, { enabled: false, - name: "Magyar", - tag: "hu" + name: 'Magyar', + tag: 'hu', }, { enabled: false, - name: "Bahasa Indonesia", - tag: "id-ID" + name: 'Bahasa Indonesia', + tag: 'id-ID', }, { enabled: false, - name: "Italiano", - tag: "it" + name: 'Italiano', + tag: 'it', }, { enabled: false, - name: "Afrikaans", - tag: "af" + name: 'Afrikaans', + tag: 'af', }, { enabled: false, - name: "한국어", - tag: "ko" + name: '한국어', + tag: 'ko', }, { enabled: false, - name: "मराठी", - tag: "mr-IN" + name: 'मराठी', + tag: 'mr-IN', }, { enabled: false, - name: "Nederlands", - tag: "nl" + name: 'Nederlands', + tag: 'nl', }, { enabled: false, - name: "Norsk", - tag: "no-NO" + name: 'Norsk', + tag: 'no-NO', }, { enabled: false, - name: "Polskie", - tag: "pl" + name: 'Polskie', + tag: 'pl', }, { enabled: false, - name: "Português", - tag: "pt-PT" + name: 'Português', + tag: 'pt-PT', }, { enabled: false, - name: "Português (Brasil)", - tag: "pt-BR" + name: 'Português (Brasil)', + tag: 'pt-BR', }, { enabled: true, - name: "Română", - tag: "ro" + name: 'Română', + tag: 'ro', }, { enabled: false, - name: "Русский", - tag: "ru" + name: 'Русский', + tag: 'ru', }, { enabled: false, - name: "Slovenský", - tag: "sk-SK" + name: 'Slovenský', + tag: 'sk-SK', }, { enabled: false, - name: "Српски језик (Ћирилица)", - tag: "sr" + name: 'Српски језик (Ћирилица)', + tag: 'sr', }, { enabled: false, - name: "Svenska", - tag: "sv-SE" + name: 'Svenska', + tag: 'sv-SE', }, { enabled: true, - name: "Türkçe", - tag: "tr" + name: 'Türkçe', + tag: 'tr', }, { enabled: false, - name: "Українська", - tag: "uk" + name: 'Українська', + tag: 'uk', }, { enabled: false, - name: "Tiếng Việt", - tag: "vi" + name: 'Tiếng Việt', + tag: 'vi', }, { enabled: true, - name: "简体中文", - tag: "zh-CN" + name: '简体中文', + tag: 'zh-CN', }, { enabled: false, - name: "繁體中文", - tag: "zh-TW" - } + name: '繁體中文', + tag: 'zh-TW', + }, ]; module.exports = languages; diff --git a/website/pages/en/about-slash.js b/website/pages/en/about-slash.js index b6047e6ed386..4ad722134997 100644 --- a/website/pages/en/about-slash.js +++ b/website/pages/en/about-slash.js @@ -11,7 +11,7 @@ const React = require('react'); const CompLibrary = require('../../core/CompLibrary.js'); const Container = CompLibrary.Container; -const siteConfig = require(process.cwd() + '/siteConfig.js'); +const siteConfig = require(`${process.cwd()}/siteConfig.js`); const translate = require('../../server/translate.js').translate; class AboutSlash extends React.Component { diff --git a/website/pages/en/help.js b/website/pages/en/help.js index 9bc40b2289a0..1e80c017e4bd 100755 --- a/website/pages/en/help.js +++ b/website/pages/en/help.js @@ -10,7 +10,7 @@ const CompLibrary = require('../../core/CompLibrary.js'); const Container = CompLibrary.Container; const GridBlock = CompLibrary.GridBlock; -const siteConfig = require(process.cwd() + '/siteConfig.js'); +const siteConfig = require(`${process.cwd()}/siteConfig.js`); const translate = require('../../server/translate.js').translate; class Help extends React.Component { diff --git a/website/pages/en/index.js b/website/pages/en/index.js index 58b2f3c2d3d5..65519b6a9bf8 100755 --- a/website/pages/en/index.js +++ b/website/pages/en/index.js @@ -10,7 +10,7 @@ const CompLibrary = require('../../core/CompLibrary.js'); const Container = CompLibrary.Container; const GridBlock = CompLibrary.GridBlock; -const siteConfig = require(process.cwd() + '/siteConfig.js'); +const siteConfig = require(`${process.cwd()}/siteConfig.js`); const translate = require('../../server/translate.js').translate; class Button extends React.Component { diff --git a/website/pages/en/users.js b/website/pages/en/users.js index 67b598609ddd..c0fdc8cc017f 100644 --- a/website/pages/en/users.js +++ b/website/pages/en/users.js @@ -9,7 +9,7 @@ const React = require('react'); const CompLibrary = require('../../core/CompLibrary.js'); const Container = CompLibrary.Container; -const siteConfig = require(process.cwd() + '/siteConfig.js'); +const siteConfig = require(`${process.cwd()}/siteConfig.js`); const translate = require('../../server/translate.js').translate; class Users extends React.Component { diff --git a/website/pages/en/versions.js b/website/pages/en/versions.js index 6cc4d17ccdc2..b2f7d2512001 100644 --- a/website/pages/en/versions.js +++ b/website/pages/en/versions.js @@ -13,8 +13,8 @@ const Container = CompLibrary.Container; const CWD = process.cwd(); -const siteConfig = require(CWD + '/siteConfig.js'); -const versions = require(CWD + '/versions.json'); +const siteConfig = require(`${CWD}/siteConfig.js`); +const versions = require(`${CWD}/versions.json`); function Versions(props) { const latestVersion = versions[0]; diff --git a/website/siteConfig.js b/website/siteConfig.js index f8d8f20ee72d..cd0e8b769892 100644 --- a/website/siteConfig.js +++ b/website/siteConfig.js @@ -37,15 +37,15 @@ const siteConfig = { apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c', indexName: 'docusaurus', algoliaOptions: { - facetFilters: [ "lang:LANGUAGE" ] - } + facetFilters: ['lang:LANGUAGE'], + }, }, colors: { primaryColor: '#2E8555', secondaryColor: '#205C3B', }, translationRecruitingLink: 'https://crowdin.com/project/docusaurus', - copyright: 'Copyright © ' + new Date().getFullYear() + ' Facebook Inc.', + copyright: `Copyright © ${new Date().getFullYear()} Facebook Inc.`, usePrism: ['jsx'], highlight: { theme: 'atom-one-dark', diff --git a/website/static/js/code-blocks-buttons.js b/website/static/js/code-blocks-buttons.js index a9435d83f3c6..0606b056ac85 100644 --- a/website/static/js/code-blocks-buttons.js +++ b/website/static/js/code-blocks-buttons.js @@ -1,5 +1,5 @@ -/* global ClipboardJS */ - +// Turn off ESLint for this file because it's sent down to users as-is. +/* eslint-disable */ window.addEventListener('load', function() { function button(label, ariaLabel, icon, className) { const btn = document.createElement('button'); @@ -31,8 +31,6 @@ window.addEventListener('load', function() { ); const clipboard = new ClipboardJS('.btnClipboard', { - // Not gonna use the shorthand as this file is sent down to browsers without transpiling. - /* eslint-disable object-shorthand */ target: function(trigger) { return trigger.parentNode.querySelector('code'); },