Merge pull request #217 from netlify/chore/comments-rules

Enable some comment-related ESLint rules

Author: ehmicky

.eslintrc.js

@@ -6,11 +6,9 @@ module.exports = {
     // TODO: enable those rules
     complexity: 0,
     'id-length': 0,
-    'line-comment-position': 0,
     'max-nested-callbacks': 0,
     'max-statements': 0,
     'no-await-in-loop': 0,
-    'no-inline-comments': 0,
     'no-magic-numbers': 0,
     'no-param-reassign': 0,
     'no-shadow': 0,

src/deploy/hash-files.js

@@ -20,8 +20,10 @@ const hashFiles = async (dir, configPath, opts) => {
   const fileNormalizer = fileNormalizerCtor(opts)
 
   // Written to by manifestCollector
-  const files = {} // normalizedPath: hash (wanted by deploy API)
-  const filesShaMap = {} // hash: [fileObj, fileObj, fileObj]
+  // normalizedPath: hash (wanted by deploy API)
+  const files = {}
+  // hash: [fileObj, fileObj, fileObj]
+  const filesShaMap = {}
   const manifestCollector = manifestCollectorCtor(files, filesShaMap, opts)
 
   await pump(fileStream, filter, hasher, fileNormalizer, manifestCollector)

src/deploy/hash-fns.js

@@ -39,8 +39,10 @@ const hashFns = async (dir, opts) => {
   const hasher = hasherCtor(opts)
 
   // Written to by manifestCollector
-  const functions = {} // normalizedPath: hash (wanted by deploy API)
-  const fnShaMap = {} // hash: [fileObj, fileObj, fileObj]
+  // normalizedPath: hash (wanted by deploy API)
+  const functions = {}
+  // hash: [fileObj, fileObj, fileObj]
+  const fnShaMap = {}
   const manifestCollector = manifestCollectorCtor(functions, fnShaMap, opts)
 
   await pump(functionStream, hasher, manifestCollector)

src/deploy/index.js

@@ -15,14 +15,20 @@ const deploySite = async (api, siteId, dir, opts) => {
     fnDir: null,
     configPath: null,
     draft: false,
-    message: undefined, // API calls this the 'title'
+    // API calls this the 'title'
+    message: undefined,
     tmpDir: tempy.directory(),
-    deployTimeout: 1.2e6, // local deploy timeout: 20 mins
-    concurrentHash: 100, // concurrent file hash calls
-    concurrentUpload: 5, // Number of concurrent uploads
+    // local deploy timeout: 20 mins
+    deployTimeout: 1.2e6,
+    // concurrent file hash calls
+    concurrentHash: 100,
+    // Number of concurrent uploads
+    concurrentUpload: 5,
     filter: defaultFilter,
-    syncFileLimit: 100, // number of files
-    maxRetry: 5, // number of times to retry an upload
+    // number of files
+    syncFileLimit: 100,
+    // number of times to retry an upload
+    maxRetry: 5,
     statusCb: () => {
       /* default to noop */
       // statusObj: {

src/deploy/upload-files.js

@@ -81,7 +81,8 @@ const retryUpload = (uploadFn, maxRetry) =>
         .catch((error) => {
           lastError = error
           switch (true) {
-            case error.status >= 400: // observed errors: 408, 401 (4** swallowed), 502
+            // observed errors: 408, 401 (4** swallowed), 502
+            case error.status >= 400:
             case error.name === 'FetchError': {
               return fibonacciBackoff.backoff()
             }

src/deploy/util.js

@@ -31,7 +31,8 @@ const normalizePath = (relname) => {
 
 // poll an async deployId until its done diffing
 const waitForDiff = async (api, deployId, siteId, timeout) => {
-  let deploy // capture ready deploy during poll
+  // capture ready deploy during poll
+  let deploy
 
   const loadDeploy = async () => {
     const d = await api.getSiteDeploy({ siteId, deployId })
@@ -68,7 +69,8 @@ const waitForDiff = async (api, deployId, siteId, timeout) => {
 
 // Poll a deployId until its ready
 const waitForDeploy = async (api, deployId, siteId, timeout) => {
-  let deploy // capture ready deploy during poll
+  // capture ready deploy during poll
+  let deploy
 
   const loadDeploy = async () => {
     const d = await api.getSiteDeploy({ siteId, deployId })

src/index.js

@@ -61,7 +61,8 @@ class NetlifyAPI {
 
     const { id } = ticket
 
-    let authorizedTicket // ticket capture
+    // ticket capture
+    let authorizedTicket
     const checkTicket = async () => {
       const t = await this.showTicket({ ticketId: id })
       if (t.authorized) {

src/methods/index.js

@@ -1,4 +1,5 @@
-const fetch = require('node-fetch').default || require('node-fetch') // Webpack will sometimes export default exports in different places
+// Webpack will sometimes export default exports in different places
+const fetch = require('node-fetch').default || require('node-fetch')
 
 const { getOperations } = require('../operations')