add eslint, precommit & refactor

facebook · Jun 30, 2018 · 38e5668 · 38e5668
1 parent 0b10b19
commit 38e5668
Show file tree

Hide file tree

Showing 19 changed files with 4,857 additions and 2,192 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -40,7 +40,7 @@ jobs:
       - run: *yarn
       - save-cache: *save-yarn-cache
       - run:
-          name: Check Prettier
+          name: Check Prettier & ESLint
           command: yarn ci-check
       - run:
           name: Run Test Suites

diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,16 @@
+{
+  "extends": ["fbjs", "prettier"],
+  "rules": {
+    "no-console": 0,
+    "radix": 0,
+    "no-unused-vars": 2 
+  },
+  "overrides": [
+    {
+      "files": [ "examples/**/*.js" ],
+      "rules": {
+        "no-unused-vars": 0
+      }
+    }
+  ]
+}
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@
 
 node_modules
 
+.eslintcache
 lib/core/metadata.js
 lib/core/MetadataBlog.js
 lib/pages/

diff --git a/lib/__tests__/build-files.test.js b/lib/__tests__/build-files.test.js
@@ -56,9 +56,9 @@ beforeAll(() => {
   });
 });
 
-function afterAll() {
+afterAll(() => {
   clearBuildFolder();
-}
+});
 
 test('Build folder exists', function() {
   return fs.stat(buildDir).then(function(status) {
@@ -73,7 +73,6 @@ test('Generated HTML for each Markdown resource', function() {
     metadata.push(path.basename());
   });
   inputMarkdownFiles.forEach(function(file) {
-    const path = filepath.create(file);
     const data = fs.readFileSync(file, 'utf8');
     const frontmatter = fm(data);
     expect(metadata).toContain(frontmatter.attributes.id + '.html');

diff --git a/lib/core/DocsSidebar.js b/lib/core/DocsSidebar.js
@@ -5,11 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const Metadata = require('./metadata.js');
 const React = require('react');
 const Container = require('./Container.js');
 const SideNav = require('./nav/SideNav.js');
-const siteConfig = require(process.cwd() + '/siteConfig.js');
 const readCategories = require('../server/readCategories.js');
 
 class DocsSidebar extends React.Component {

diff --git a/lib/core/Redirect.js b/lib/core/Redirect.js
@@ -6,12 +6,9 @@
  */
 
 const React = require('react');
-const fs = require('fs');
 const Head = require('./Head.js');
 const translation = require('../server/translation.js');
 
-const CWD = process.cwd();
-
 // Component used to provide same head, header, footer, other scripts to all pages
 class Redirect extends React.Component {
   render() {
@@ -28,13 +25,9 @@ class Redirect extends React.Component {
       this.props.config.url +
       this.props.config.baseUrl +
       (this.props.url || 'index.html');
-    let latestVersion;
 
     const redirect = this.props.redirect || false;
 
-    if (fs.existsSync(CWD + '/versions.json')) {
-      latestVersion = require(CWD + '/versions.json')[0];
-    }
     return (
       <html>
         <Head

diff --git a/lib/core/Remarkable.js b/lib/core/Remarkable.js
@@ -10,8 +10,6 @@
 const React = require('react');
 const renderMarkdown = require('./renderMarkdown.js');
 
-const CWD = process.cwd();
-
 class Remarkable extends React.Component {
   content() {
     if (this.props.source) {

diff --git a/lib/core/Site.js b/lib/core/Site.js
@@ -7,7 +7,6 @@
 
 const React = require('react');
 const fs = require('fs');
-const classNames = require('classnames');
 
 const HeaderNav = require('./nav/HeaderNav.js');
 const Head = require('./Head.js');

diff --git a/lib/publish-gh-pages.js b/lib/publish-gh-pages.js
@@ -125,11 +125,11 @@ shell.exec('git rm -rf .');
 
 shell.cd('../..');
 
-fromPath = path.join('build', `${PROJECT_NAME}`);
-toPath = path.join('build', `${PROJECT_NAME}-${DEPLOYMENT_BRANCH}`);
+const fromPath = path.join('build', `${PROJECT_NAME}`);
+const toPath = path.join('build', `${PROJECT_NAME}-${DEPLOYMENT_BRANCH}`);
 // In github.io case, project is deployed to root. Need to not recursively
 // copy the deployment-branch to be.
-excludePath = `${PROJECT_NAME}-${DEPLOYMENT_BRANCH}`;
+const excludePath = `${PROJECT_NAME}-${DEPLOYMENT_BRANCH}`;
 
 // cannot use shell.cp because it doesn't support copying dotfiles and we
 // need to copy directories like .circleci, for example

diff --git a/lib/rename-version.js b/lib/rename-version.js
@@ -11,7 +11,6 @@ const chalk = require('chalk');
 const fs = require('fs');
 const glob = require('glob');
 const path = require('path');
-const readMetadata = require('./server/readMetadata.js');
 const metadataUtils = require('./server/metadataUtils.js');
 
 const CWD = process.cwd();

diff --git a/lib/server/feed.js b/lib/server/feed.js
@@ -5,35 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const fs = require('fs-extra');
-const path = require('path');
-const os = require('os');
 const Feed = require('feed');
-
-const chalk = require('chalk');
 const CWD = process.cwd();
-
 const siteConfig = require(CWD + '/siteConfig.js');
-
-const blogFolder = path.resolve('../blog/');
+const readMetadata = require('./readMetadata.js');
 const blogRootURL = siteConfig.url + siteConfig.baseUrl + 'blog';
 const siteImageURL =
   siteConfig.url + siteConfig.baseUrl + siteConfig.headerIcon;
 const utils = require('../core/utils');
 
 const renderMarkdown = require('../core/renderMarkdown.js');
 
-/****************************************************************************/
-
-let readMetadata;
-let Metadata;
-
-readMetadata = require('./readMetadata.js');
-readMetadata.generateMetadataDocs();
-Metadata = require('../core/metadata.js');
-
-/****************************************************************************/
-
 module.exports = function(type) {
   console.log('feed.js triggered...');
 

diff --git a/lib/server/generate.js b/lib/server/generate.js
@@ -6,16 +6,13 @@
  */
 
 async function execute() {
-  const extractTranslations = require('../write-translations.js');
-
   const metadataUtils = require('./metadataUtils');
 
   const CWD = process.cwd();
   const cssnano = require('cssnano');
   const fs = require('fs-extra');
   const readMetadata = require('./readMetadata.js');
   const path = require('path');
-  const color = require('color');
   const getTOC = require('../core/getTOC.js');
   const React = require('react');
   const mkdirp = require('mkdirp');
@@ -321,9 +318,11 @@ async function execute() {
 
   // create sitemap
   if (MetadataBlog.length > 0 || Object.keys(Metadata).length > 0) {
-    let targetFile = join(buildDir, 'sitemap.xml');
-    sitemap(xml => {
-      writeFileAndCreateFolder(targetFile, xml);
+    sitemap((err, xml) => {
+      if (!err) {
+        const targetFile = join(buildDir, 'sitemap.xml');
+        writeFileAndCreateFolder(targetFile, xml);
+      }
     });
   }
 
@@ -454,7 +453,6 @@ async function execute() {
   fs.writeFileSync(mainCss, css);
 
   // compile/copy pages from user
-  let pagesArr = [];
   files = glob.sync(join(CWD, 'pages', '**'));
   files.forEach(file => {
     // Why normalize? In case we are on Windows.

diff --git a/lib/server/readMetadata.js b/lib/server/readMetadata.js
@@ -10,7 +10,6 @@ const CWD = process.cwd();
 const path = require('path');
 const fs = require('fs');
 const glob = require('glob');
-const chalk = require('chalk');
 
 const metadataUtils = require('./metadataUtils');
 
@@ -180,8 +179,6 @@ function generateMetadataDocs() {
   const docsDir = path.join(CWD, '../', getDocsPath());
   let files = glob.sync(CWD + '/../' + getDocsPath() + '/**');
   files.forEach(file => {
-    let language = 'en';
-
     const extension = path.extname(file);
 
     if (extension === '.md' || extension === '.markdown') {

diff --git a/lib/server/server.js b/lib/server/server.js
@@ -11,14 +11,11 @@ function execute(port, options) {
   const metadataUtils = require('./metadataUtils');
 
   const env = require('./env.js');
-  const translation = require('./translation');
   const express = require('express');
   const React = require('react');
   const request = require('request');
   const fs = require('fs-extra');
-  const os = require('os');
   const path = require('path');
-  const color = require('color');
   const getTOC = require('../core/getTOC');
   const {
     blogRouting,
@@ -284,10 +281,13 @@ function execute(port, options) {
   });
 
   app.get(sitemapRouting(siteConfig.baseUrl), (req, res) => {
-    res.set('Content-Type', 'application/xml');
-
-    sitemap(xml => {
-      res.send(xml);
+    sitemap((err, xml) => {
+      if (err) {
+        res.status(500).send('Sitemap error');
+      } else {
+        res.set('Content-Type', 'application/xml');
+        res.send(xml);
+      }
     });
   });
 

diff --git a/lib/server/sitemap.js b/lib/server/sitemap.js
@@ -6,11 +6,7 @@
  */
 
 const fs = require('fs-extra');
-const path = require('path');
-const os = require('os');
-const Feed = require('feed');
 
-const chalk = require('chalk');
 const glob = require('glob');
 const CWD = process.cwd();
 
@@ -104,9 +100,6 @@ module.exports = function(callback) {
   });
 
   sm.toXML((err, xml) => {
-    if (err) {
-      return 'An error has occurred.';
-    }
-    callback(xml);
+    callback(err, xml);
   });
 };
diff --git a/lib/server/versionFallback.js b/lib/server/versionFallback.js
@@ -9,7 +9,6 @@ const CWD = process.cwd();
 const glob = require('glob');
 const fs = require('fs');
 const path = require('path');
-const assert = require('assert');
 
 const metadataUtils = require('./metadataUtils');