@fastify/static 6.1.0 → 6.2.0

package/README.md

@@ -190,7 +190,9 @@ If set, it provide the directory list calling the directory path.
 
 Default response is json.
 
-Note: Multi-root is not supported within the `list` option.
+Note:
+- Multi-root is not supported within the `list` option.
+- If `dotfiles` option value is `deny` or `ignore`, dotfiles will be excluded.
 
 **Example:**
 

package/index.js

@@ -161,7 +161,8 @@ async function fastifyStatic (fastify, opts) {
           dir: path,
           options: opts.list,
           route: pathname,
-          prefix
+          prefix,
+          dotfiles: opts.dotfiles
         }).catch((err) => reply.send(err))
         return
       }
@@ -217,7 +218,8 @@ async function fastifyStatic (fastify, opts) {
             dir: dirList.path(opts.root, pathname),
             options: opts.list,
             route: pathname,
-            prefix
+            prefix,
+            dotfiles: opts.dotfiles
           }).catch((err) => reply.send(err))
           return
         }

package/lib/dirList.js

@@ -8,12 +8,16 @@ const dirList = {
   /**
    * get files and dirs from dir, or error
    * @param {string} dir full path fs dir
-   * @param {function(error, entries)} callback
+   * @param {ListOptions} options
+   * @param {string} dotfiles
    * note: can't use glob because don't get error on non existing dir
    */
-  list: async function (dir, options) {
+  list: async function (dir, options, dotfiles) {
     const entries = { dirs: [], files: [] }
-    const files = await fs.readdir(dir)
+    let files = await fs.readdir(dir)
+    if (dotfiles === 'deny' || dotfiles === 'ignore') {
+      files = files.filter(f => f.charAt(0) !== '.')
+    }
     if (files.length < 1) {
       return entries
     }
@@ -97,11 +101,12 @@ const dirList = {
    * @param {string} dir full path fs dir
    * @param {ListOptions} options
    * @param {string} route request route
+   * @param {string} dotfiles
    */
-  send: async function ({ reply, dir, options, route, prefix }) {
+  send: async function ({ reply, dir, options, route, prefix, dotfiles }) {
     let entries
     try {
-      entries = await dirList.list(dir, options)
+      entries = await dirList.list(dir, options, dotfiles)
     } catch (error) {
       return reply.callNotFound()
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/static",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Plugin for serving static files as fast as possible.",
   "main": "index.js",
   "types": "index.d.ts",

package/test/dir-list.test.js

@@ -636,6 +636,90 @@ t.test('serve a non existent dir and get error', t => {
   })
 })
 
+t.test('dir list with dotfiles allow option', t => {
+  t.plan(2)
+
+  const options = {
+    root: path.join(__dirname, '/static-dotfiles'),
+    prefix: '/public',
+    dotfiles: 'allow',
+    index: false,
+    list: true
+  }
+  const route = '/public/'
+  const content = { dirs: ['dir'], files: ['.aaa', 'test.txt'] }
+
+  helper.arrange(t, options, (url) => {
+    t.test(route, t => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: url + route
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), JSON.stringify(content))
+      })
+    })
+  })
+})
+
+t.test('dir list with dotfiles deny option', t => {
+  t.plan(2)
+
+  const options = {
+    root: path.join(__dirname, '/static-dotfiles'),
+    prefix: '/public',
+    dotfiles: 'deny',
+    index: false,
+    list: true
+  }
+  const route = '/public/'
+  const content = { dirs: ['dir'], files: ['test.txt'] }
+
+  helper.arrange(t, options, (url) => {
+    t.test(route, t => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: url + route
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), JSON.stringify(content))
+      })
+    })
+  })
+})
+
+t.test('dir list with dotfiles ignore option', t => {
+  t.plan(2)
+
+  const options = {
+    root: path.join(__dirname, '/static-dotfiles'),
+    prefix: '/public',
+    dotfiles: 'ignore',
+    index: false,
+    list: true
+  }
+  const route = '/public/'
+  const content = { dirs: ['dir'], files: ['test.txt'] }
+
+  helper.arrange(t, options, (url) => {
+    t.test(route, t => {
+      t.plan(3)
+      simple.concat({
+        method: 'GET',
+        url: url + route
+      }, (err, response, body) => {
+        t.error(err)
+        t.equal(response.statusCode, 200)
+        t.equal(body.toString(), JSON.stringify(content))
+      })
+    })
+  })
+})
+
 t.test('dir list error', t => {
   t.plan(7)