chore: enforce formatting and linting (#38)

Author: erezrokah

.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

.eslintrc.js

@@ -0,0 +1,6 @@
+const { overrides } = require('@netlify/eslint-config-node')
+
+module.exports = {
+  extends: '@netlify/eslint-config-node',
+  overrides: [...overrides],
+}

.gitattributes

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

.github/workflows/test.yml

@@ -22,5 +22,9 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm ci
-      - run: npm test
+      - name: Install dependencies
+        run: npm ci
+      - name: Linting
+        run: npm run format:ci
+      - name: Tests
+        run: npm test

.gitignore

@@ -109,3 +109,5 @@ Icon
 Network Trash Folder
 Temporary Items
 .apdisk
+
+.vscode

.prettierrc.json

@@ -0,0 +1 @@
+"@netlify/eslint-config-node/.prettierrc.json"

index.js

@@ -1,19 +1,26 @@
 /* Generates a sitemap */
+const { env } = require('process')
+
 const makeSitemap = require('./make_sitemap')
 
+const getBuildDir = ({ inputs, constants }) => {
+  // Backwards compat... Correct opt is buildDir
+  const buildDir = inputs.dir || inputs.distPath || inputs.buildDir || constants.PUBLISH_DIR
+  // remove leading / to treat the dir a a relative one
+  const trimmedBuildDir = buildDir.startsWith('/') ? buildDir.slice(1) : buildDir
+  return trimmedBuildDir
+}
+
 module.exports = {
   onPostBuild: async ({ constants, inputs, utils }) => {
-    const baseUrl = inputs.baseUrl || process.env.URL
-    // Backwards compat... Correct opt is buildDir
-    const buildDir = inputs.dir || inputs.distPath || inputs.buildDir || constants.PUBLISH_DIR
-    // remove leading / to treat the dir a a relative one
-    const trimmedBuildDir = buildDir.startsWith('/') ? buildDir.slice(1) : buildDir
+    const baseUrl = inputs.baseUrl || env.URL
+    const buildDir = getBuildDir({ inputs, constants })
 
     console.log('Creating sitemap from files...')
 
     const data = await makeSitemap({
       homepage: baseUrl,
-      distPath: trimmedBuildDir,
+      distPath: buildDir,
       exclude: inputs.exclude,
       prettyURLs: inputs.prettyURLs,
       changeFreq: inputs.changeFreq,

make_sitemap.js

@@ -1,40 +1,57 @@
 const fs = require('fs')
-const util = require('util')
 const path = require('path')
+const util = require('util')
+
+const globby = require('globby')
 const mkdirp = require('mkdirp')
 const sm = require('sitemap')
-const globby = require('globby')
 
-module.exports = async function makeSitemap(opts = {}) {
-  const { distPath, fileName, homepage, exclude, prettyURLs, trailingSlash, failBuild } = opts
+const getPaths = async ({ distPath, exclude }) => {
   const htmlFiles = `${distPath}/**/**.html`
-  const excludeFiles = (exclude || []).map((filePath) => {
-    return `!${filePath.replace(/^!/, '')}`
-  })
+  const excludeFiles = (exclude || []).map((filePath) => `!${filePath.replace(/^!/, '')}`)
 
-  const lookup = [ htmlFiles ].concat(excludeFiles)
+  const lookup = [htmlFiles].concat(excludeFiles)
   const paths = await globby(lookup)
-  const urls = paths.map(file => {
-    let urlPath = file.startsWith(distPath) ? file.replace(distPath, '') : distPath
-    if (prettyURLs) {
-      urlPath = urlPath.replace(/\/index\.html$/, '').replace(/\.html$/, '')
-
-      if (trailingSlash) {
-        urlPath += urlPath.endsWith("/") ? "" : "/";
-      }
-    }
+  return paths
+}
+
+const getUrlFromFile = ({ file, distPath, prettyURLs, trailingSlash }) => {
+  const url = file.startsWith(distPath) ? file.replace(distPath, '') : distPath
 
+  if (!prettyURLs) {
+    return url
+  }
+
+  const prettyUrl = url.replace(/\/index\.html$/, '').replace(/\.html$/, '')
+
+  if (!trailingSlash) {
+    return prettyUrl
+  }
+
+  return prettyUrl.endsWith('/') ? prettyUrl : `${prettyUrl}/`
+}
+
+const DEFAULT_CHANGE_FREQ = 'weekly'
+const DEFAULT_PRIORITY = 0.8
+// 600 sec cache period
+const DEFAULT_CACHE_TIME = 600000
+
+module.exports = async function makeSitemap(opts = {}) {
+  const { distPath, fileName, homepage, exclude, prettyURLs, trailingSlash, failBuild } = opts
+  const paths = await getPaths({ distPath, exclude })
+  const urls = paths.map((file) => {
+    const url = getUrlFromFile({ file, distPath, prettyURLs, trailingSlash })
     return {
-      url: urlPath,
-      changefreq: opts.changeFreq || 'weekly',
-      priority: opts.priority || 0.8,
+      url,
+      changefreq: opts.changeFreq || DEFAULT_CHANGE_FREQ,
+      priority: opts.priority || DEFAULT_PRIORITY,
       lastmodrealtime: true,
       lastmodfile: file,
     }
   })
   const options = {
     hostname: `${homepage.replace(/\/$/, '')}/`,
-    cacheTime: 600000, // 600 sec cache period
+    cacheTime: DEFAULT_CACHE_TIME,
     urls,
   }
   // Creates a sitemap object given the input configuration with URLs
@@ -57,6 +74,6 @@ module.exports = async function makeSitemap(opts = {}) {
   // Return info
   return {
     sitemapPath: sitemapFileName,
-    sitemap: sitemap
+    sitemap,
   }
 }