feat: add eslint

Author: lindsaylevine

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+max_line_length = 120
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintignore

@@ -0,0 +1,16 @@
+### Node ###
+
+.next
+/next.config.js
+node_modules
+src/cypress
+src/lib/helpers/logger.js
+src/lib/helpers/asyncForEach.js
+src/lib/templates
+src/tests
+test/sample/node_modules
+test/sample/out_functions
+test/sample/netlify/functions
+test/sample/my-publish-dir
+test/sample/.next
+test/sample/.netlify

.eslintrc.js

@@ -0,0 +1,35 @@
+const { overrides } = require('@netlify/eslint-config-node')
+
+const customOverrides = [
+  {
+    files: ['*.js'],
+    rules: {
+      complexity: 0,
+      'fp/no-let': 0,
+      'fp/no-loops': 0,
+      'fp/no-mutation': 0,
+      'fp/no-mutating-methods': 0,
+      'id-length': 0,
+      'max-statements': 0,
+      'no-await-in-loop': 0,
+      'node/exports-style': 0,
+      'node/global-require': 0,
+      'node/no-unpublished-require': 0,
+      'node/prefer-global/process': 0,
+      'no-magic-numbers': 0,
+      'no-promise-executor-return': 0,
+      'no-prototype-builtins': 0,
+      'no-shadow': 0,
+      'prefer-regex-literals': 0,
+      'promise/prefer-await-to-callbacks': 0,
+      'unicorn/filename-case': 0,
+      'unicorn/no-array-push-push': 0,
+    },
+  },
+]
+
+module.exports = {
+  extends: '@netlify/eslint-config-node',
+  rules: {},
+  overrides: [...overrides, ...customOverrides],
+}

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/test.yml

@@ -26,5 +26,8 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm install
+      - run: npm ci
+      - name: Linting
+        run: npm run format:ci
+        if: "${{ matrix.node-version == '15.x' }}"
       - run: npm test

index.js

@@ -1,15 +1,15 @@
 const fs = require('fs')
-const path = require('path')
 const util = require('util')
-const makeDir = require('make-dir')
+
 const findUp = require('find-up')
-const nextOnNetlify = require('./src/index.js')
+const makeDir = require('make-dir')
 
-const validateNextUsage = require('./helpers/validateNextUsage')
+const { restoreCache, saveCache } = require('./helpers/cacheBuild')
+const copyUnstableIncludedDirs = require('./helpers/copyUnstableIncludedDirs')
 const doesNotNeedPlugin = require('./helpers/doesNotNeedPlugin')
 const getNextConfig = require('./helpers/getNextConfig')
-const copyUnstableIncludedDirs = require('./helpers/copyUnstableIncludedDirs')
-const { restoreCache, saveCache } = require('./helpers/cacheBuild')
+const validateNextUsage = require('./helpers/validateNextUsage')
+const nextOnNetlify = require('./src/index.js')
 
 const pWriteFile = util.promisify(fs.writeFile)
 

package.json

@@ -11,8 +11,15 @@
     "!src/tests"
   ],
   "scripts": {
-    "format": "prettier --write .",
     "build": "next build test/sample",
+    "format": "run-s format:check-fix:*",
+    "format:ci": "run-s format:check:*",
+    "format:check-fix:lint": "run-e format:check:lint format:fix:lint",
+    "format:check:lint": "cross-env-shell eslint $npm_package_config_eslint",
+    "format:fix:lint": "cross-env-shell eslint --fix $npm_package_config_eslint",
+    "format:check-fix:prettier": "run-e format:check:prettier format:fix:prettier",
+    "format:check:prettier": "cross-env-shell prettier --check $npm_package_config_prettier",
+    "format:fix:prettier": "cross-env-shell prettier --write $npm_package_config_prettier",
     "test:plugin": "npm run build && jest",
     "test:src": "jest --config src/tests/jest.config.js",
     "test": "npm run test:plugin && npm run test:src",
@@ -26,6 +33,10 @@
     "prepublishOnly:install": "npm ci",
     "prepublishOnly:test": "npm test"
   },
+  "config": {
+    "eslint": "--cache --format=codeframe --max-warnings=0 \"{src,scripts,tests,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
+    "prettier": "--loglevel=warn \"{src,scripts,tests,.github}/**/*.{js,md,yml,json,html}\" \"*.{js,yml,json,html}\" \".*.{js,yml,json,html}\" \"!package-lock.json\""
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/netlify/netlify-plugin-nextjs.git"
@@ -77,7 +88,7 @@
   "husky": {
     "hooks": {
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "prettier --check ."
+      "pre-push": "npm run format"
     }
   },
   "engines": {

src/cypress/plugins/buildProject.js

@@ -1,4 +1,5 @@
 const { join } = require('path')
+
 const execa = require('execa')
 
 // Build the given NextJS project

src/cypress/plugins/clearProject.js

@@ -1,4 +1,5 @@
 const { join } = require('path')
+
 const { emptyDirSync } = require('fs-extra')
 
 // Clear the project

src/cypress/plugins/copyFixture.js

@@ -1,4 +1,5 @@
 const { join } = require('path')
+
 const { copySync } = require('fs-extra')
 
 // Copy the fixture files from fixtures/ to the project folder

src/cypress/plugins/deployProject.js

@@ -1,7 +1,9 @@
+const { join } = require('path')
+
+const execa = require('execa')
 const { removeSync } = require('fs-extra')
 const waitOn = require('wait-on')
-const execa = require('execa')
-const { join } = require('path')
+
 const getBaseUrl = require('./getBaseUrl')
 
 // Deploy the project locally, using netlify dev
@@ -62,7 +64,7 @@ const deployProject = ({ project }, config) => {
     return deployLocally({ project }, config)
   }
   // Deployment on Netlify
-  else if (config.env.DEPLOY == 'netlify') {
+  if (config.env.DEPLOY == 'netlify') {
     return deployOnNetlify({ project }, config)
   }
 }

src/cypress/plugins/getBaseUrl.js

@@ -1,4 +1,5 @@
 const { join } = require('path')
+
 const { readJsonSync } = require('fs-extra')
 
 // Set baseurl, either localhost:8888 or based on deployed Netlify URL
@@ -8,7 +9,7 @@ const getBaseUrl = ({ project }, config) => {
     return 'http://localhost:8888/'
   }
   // Deployment on Netlify
-  else if (config.env.DEPLOY == 'netlify') {
+  if (config.env.DEPLOY == 'netlify') {
     const { deploy_url } = readJsonSync(join(config.buildsFolder, project, 'deployment.json'))
     return deploy_url
   }

src/cypress/plugins/index.js

@@ -5,12 +5,12 @@
 
 const { join } = require('path')
 
+const buildProject = require('./buildProject')
+const clearDeployment = require('./clearDeployment')
 const clearProject = require('./clearProject')
 const copyFixture = require('./copyFixture')
-const buildProject = require('./buildProject')
 const deployProject = require('./deployProject')
 const getBaseUrl = require('./getBaseUrl')
-const clearDeployment = require('./clearDeployment')
 
 const tasks = [clearProject, copyFixture, buildProject, deployProject, getBaseUrl, clearDeployment]
 

src/index.js

@@ -1,18 +1,18 @@
 const { normalize } = require('path')
-const debounceFn = require('debounce-fn')
+
 const chokidar = require('chokidar')
+const debounceFn = require('debounce-fn')
 const execa = require('execa')
 
+const { NETLIFY_PUBLISH_PATH, NETLIFY_FUNCTIONS_PATH, SRC_FILES } = require('./lib/config')
 const { logTitle } = require('./lib/helpers/logger')
-
-const prepareFolders = require('./lib/steps/prepareFolders')
-const copyPublicFiles = require('./lib/steps/copyPublicFiles')
 const copyNextAssets = require('./lib/steps/copyNextAssets')
-const setupPages = require('./lib/steps/setupPages')
+const copyPublicFiles = require('./lib/steps/copyPublicFiles')
+const prepareFolders = require('./lib/steps/prepareFolders')
+const setupHeaders = require('./lib/steps/setupHeaders')
 const setupImageFunction = require('./lib/steps/setupImageFunction')
+const setupPages = require('./lib/steps/setupPages')
 const setupRedirects = require('./lib/steps/setupRedirects')
-const setupHeaders = require('./lib/steps/setupHeaders')
-const { NETLIFY_PUBLISH_PATH, NETLIFY_FUNCTIONS_PATH, SRC_FILES } = require('./lib/config')
 
 const build = async (functionsPath, publishPath) => {
   const trackNextOnNetlifyFiles = prepareFolders({
@@ -45,8 +45,8 @@ const watch = (functionsPath, publishPath) => {
       try {
         execa.sync('next', ['build'], { stdio: 'inherit' })
         await build(functionsPath, publishPath)
-      } catch (e) {
-        console.log(e)
+      } catch (error) {
+        console.log(error)
       }
     },
     {
@@ -57,13 +57,13 @@ const watch = (functionsPath, publishPath) => {
   chokidar.watch(SRC_FILES).on('all', runBuild)
 }
 
-/** options param:
- * {
- *   functionsDir: string to path
- *   publishDir: string to path
- *   watch: { directory: string to path }
- * }
- */
+// options param:
+// {
+//   functionsDir: string to path
+//   publishDir: string to path
+//   watch: { directory: string to path }
+// }
+//
 
 const nextOnNetlify = async (options = {}) => {
   const functionsPath = normalize(options.functionsDir || NETLIFY_FUNCTIONS_PATH)

src/lib/config.js

@@ -1,5 +1,5 @@
 const { join } = require('path')
-const getNextDistDir = require('./helpers/getNextDistDir')
+
 const getNextSrcDirs = require('./helpers/getNextSrcDir')
 
 // This is where next-on-netlify will place all static files.

src/lib/constants/regex.js

@@ -1,6 +1,6 @@
-const CATCH_ALL_REGEX = /\/\[\.{3}(.*)\](.json)?$/
-const OPTIONAL_CATCH_ALL_REGEX = /\/\[{2}\.{3}(.*)\]{2}(.json)?$/
-const DYNAMIC_PARAMETER_REGEX = /\/\[(.*?)\]/g
+const CATCH_ALL_REGEX = /\/\[\.{3}(.*)](.json)?$/
+const OPTIONAL_CATCH_ALL_REGEX = /\/\[{2}\.{3}(.*)]{2}(.json)?$/
+const DYNAMIC_PARAMETER_REGEX = /\/\[(.*?)]/g
 
 module.exports = {
   CATCH_ALL_REGEX,

src/lib/helpers/addDefaultLocaleRedirect.js

@@ -11,7 +11,7 @@ const addDefaultLocaleRedirect = async (redirects, route, target, additionalPara
   if (!defaultLocale) return
 
   const routePieces = route.split('/')
-  const routeLocale = routePieces[1]
+  const [, routeLocale] = routePieces
   if (routeLocale === defaultLocale) {
     const nakedRoute = route === `/${routeLocale}` ? '/' : route.replace(`/${routeLocale}`, '')
     redirects.push({

src/lib/helpers/addLocaleRedirects.js

@@ -1,6 +1,6 @@
-const getI18n = require('./getI18n')
-const getDataRouteForRoute = require('./getDataRouteForRoute')
 const asyncForEach = require('./asyncForEach')
+const getDataRouteForRoute = require('./getDataRouteForRoute')
+const getI18n = require('./getI18n')
 
 const addLocaleRedirects = async (redirects, route, target) => {
   const i18n = await getI18n()

src/lib/helpers/copyDynamicImportChunks.js

@@ -1,17 +1,19 @@
 const { join } = require('path')
+
 const { copySync, readdirSync } = require('fs-extra')
-const { logTitle } = require('../helpers/logger')
+
 const getNextDistDir = require('./getNextDistDir')
+const { logTitle } = require('./logger')
 
 // Check if there are dynamic import chunks and copy to the necessary function dir
 const copyDynamicImportChunks = async (functionPath) => {
   const nextDistDir = await getNextDistDir()
   const chunksPath = join(nextDistDir, 'serverless')
   const files = readdirSync(chunksPath)
-  const chunkRegex = new RegExp(/^(\.?[-_$~A-Z0-9a-z]+){1,}\.js$/g)
-  const excludeFiles = ['init-server.js.js', 'on-error-server.js.js']
+  const chunkRegex = new RegExp(/^(\.?[-$~\w]+)+\.js$/g)
+  const excludeFiles = new Set(['init-server.js.js', 'on-error-server.js.js'])
   files.forEach((file) => {
-    if (!excludeFiles.includes(file) && chunkRegex.test(file)) {
+    if (!excludeFiles.has(file) && chunkRegex.test(file)) {
       logTitle('💼 Copying dynamic import chunks to', functionPath)
       copySync(join(chunksPath, file), join(functionPath, file), {
         overwrite: false,

src/lib/helpers/getDataRouteForRoute.js

@@ -1,5 +1,7 @@
 const { join } = require('path')
+
 const { readFileSync } = require('fs-extra')
+
 const getFilePathForRoute = require('./getFilePathForRoute')
 const getNextDistDir = require('./getNextDistDir')
 

src/lib/helpers/getNetlifyRoutes.js

@@ -13,7 +13,7 @@ const getNetlifyRoutes = (nextRoute) => {
   // If the route is an optional catch-all route, we need to add a second
   // Netlify route for the base path (when no parameters are present).
   // The file ending must be present!
-  if (nextRoute.match(OPTIONAL_CATCH_ALL_REGEX)) {
+  if (OPTIONAL_CATCH_ALL_REGEX.test(nextRoute)) {
     let netlifyRoute = nextRoute.replace(OPTIONAL_CATCH_ALL_REGEX, '$2')
 
     // When optional catch-all route is at top-level, the regex on line 19 will

src/lib/helpers/getNextDistDir.js

@@ -1,5 +1,6 @@
 // Get the NextJS distDir specified in next.config.js
 const { join } = require('path')
+
 const getNextConfig = require('../../../helpers/getNextConfig')
 
 const getNextDistDir = async () => {

src/lib/helpers/getNextSrcDir.js

@@ -1,7 +1,5 @@
 const { join } = require('path')
 
-const getNextSrcDirs = () => {
-  return ['pages', 'src', 'public', 'styles'].map((dir) => join('.', dir))
-}
+const getNextSrcDirs = () => ['pages', 'src', 'public', 'styles'].map((dir) => join('.', dir))
 
 module.exports = getNextSrcDirs

src/lib/helpers/getPagesManifest.js

@@ -1,5 +1,7 @@
 const { join } = require('path')
+
 const { existsSync, readJSONSync } = require('fs-extra')
+
 const getNextDistDir = require('./getNextDistDir')
 
 const getPagesManifest = async () => {

src/lib/helpers/getPrerenderManifest.js

@@ -1,19 +1,22 @@
 const { join } = require('path')
+
 const { readJSONSync } = require('fs-extra')
+
 const getNextConfig = require('../../../helpers/getNextConfig')
-const getNextDistDir = require('./getNextDistDir')
-const getDataRouteForRoute = require('./getDataRouteForRoute')
+
 const asyncForEach = require('./asyncForEach')
+const getDataRouteForRoute = require('./getDataRouteForRoute')
+const getNextDistDir = require('./getNextDistDir')
 
 const transformManifestForI18n = async (manifest) => {
   const { routes } = manifest
   const newRoutes = {}
-  await asyncForEach(Object.entries(routes), async ([route, { dataRoute, srcRoute, ...params }]) => {
-    const isDynamicRoute = !!srcRoute
+  await asyncForEach(Object.entries(routes), async ([route, { srcRoute, ...params }]) => {
+    const isDynamicRoute = Boolean(srcRoute)
     if (isDynamicRoute) {
       newRoutes[route] = routes[route]
     } else {
-      const locale = route.split('/')[1]
+      const [, locale] = route.split('/')
       const routeWithoutLocale = `/${route.split('/').slice(2, route.split('/').length).join('/')}`
       newRoutes[route] = {
         dataRoute: await getDataRouteForRoute(routeWithoutLocale, locale),

src/lib/helpers/getRoutesManifest.js

@@ -1,5 +1,7 @@
 const { join } = require('path')
+
 const { readJSONSync } = require('fs-extra')
+
 const getNextDistDir = require('./getNextDistDir')
 
 const getRoutesManifest = async () => {