Merge branch 'main' into OmkarPh-patch-1

Author: janiceilene

.github/workflows/codeql.yml

@@ -2,6 +2,9 @@ name: CodeQL analysis
 
 on:
   push:
+    branches: main
+  pull_request:
+    branches: main
     paths:
       - '**/*.js'
       - '.github/workflows/codeql.yml'

lib/page.js

@@ -29,14 +29,12 @@ class Page {
 
     const relativePath = slash(opts.relativePath)
     const fullPath = slash(path.join(opts.basePath, relativePath))
-    const raw = await fs.readFile(fullPath, 'utf8')
 
-    return new Page({ ...opts, relativePath, fullPath, raw })
-  }
-
-  static async exists (path) {
+    // Per https://nodejs.org/api/fs.html#fs_fs_exists_path_callback
+    // its better to read and handle errors than to check access/stats first
     try {
-      return await fs.stat(path)
+      const raw = await fs.readFile(fullPath, 'utf8')
+      return new Page({ ...opts, relativePath, fullPath, raw })
     } catch (err) {
       if (err.code === 'ENOENT') return false
       console.error(err)

lib/pages.js

@@ -2,7 +2,7 @@ const path = require('path')
 const walk = require('walk-sync').entries
 const Page = require('./page')
 const languages = require('./languages')
-const { mapLimit, filterLimit } = require('async')
+const { mapLimit } = require('async')
 
 const FILE_READ_LIMIT = 100
 
@@ -11,10 +11,10 @@ async function loadPageList () {
 
   // load english pages
   const englishPath = path.join(__dirname, '..', languages.en.dir, 'content')
-  const englishPaths = walk(englishPath)
-    .filter(({ relativePath }) =>
-      relativePath.endsWith('.md') && !relativePath.includes('README')
-    )
+  const englishPaths = walk(englishPath, {
+    globs: ['**/*.md'],
+    ignore: ['**/README.md']
+  })
   const englishPages = await mapLimit(
     englishPaths,
     FILE_READ_LIMIT,
@@ -23,7 +23,7 @@ async function loadPageList () {
   pageList.push(...englishPages)
 
   // load matching pages in other languages
-  let localizedPaths = Object.values(languages)
+  const localizedPaths = Object.values(languages)
     .filter(({ code }) => code !== 'en')
     .map(language => {
       const basePath = path.join(__dirname, '..', language.dir, 'content')
@@ -35,18 +35,13 @@ async function loadPageList () {
       }))
     })
     .flat()
-  localizedPaths = await filterLimit(
-    localizedPaths,
-    FILE_READ_LIMIT,
-    async ({ localizedPath }) => Page.exists(localizedPath)
-  )
   const localizedPages = await mapLimit(
     localizedPaths,
     FILE_READ_LIMIT,
     async ({ basePath, relativePath, languageCode }) =>
       await Page.init({ basePath, relativePath, languageCode })
   )
-  pageList.push(...localizedPages)
+  pageList.push(...localizedPages.filter(Boolean))
 
   return pageList
 }