build(deps): bump github/codeql-action from 3.29.7 to 4.31.2

Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3.29.7 to 4.31.2.
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](https://github.com/github/codeql-action/compare/51f77329afa6477de8c49fc9c7046c15b9a4e79d...0499de31b99561a6d14a36a5f662c2a54f91beee)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-version: 4.31.2
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

.editorconfig

@@ -0,0 +1,11 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[{*.js,*.json,*.yml}]
+indent_size = 2
+indent_style = space

.eslintignore

@@ -0,0 +1,3 @@
+.nyc_output
+coverage
+node_modules

.eslintrc.yml

@@ -0,0 +1,13 @@
+root: true
+extends:
+  - plugin:markdown/recommended
+plugins:
+  - markdown
+overrides:
+  - files: '**/*.md'
+    processor: 'markdown/markdown'
+rules:
+  eol-last: error
+  eqeqeq: [error, allow-null]
+  indent: [error, 2, { SwitchCase: 1 }]
+  no-trailing-spaces: error

.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: monthly
+    open-pull-requests-limit: 10
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]

.github/workflows/ci.yml

@@ -0,0 +1,241 @@
+name: ci
+
+on:
+- pull_request
+- push
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    permissions:
+      checks: write  # for coverallsapp/github-action to create new checks
+      contents: read  # for actions/checkout to fetch code
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        name:
+        - Node.js 0.8
+        - Node.js 0.10
+        - Node.js 0.12
+        - io.js 1.x
+        - io.js 2.x
+        - io.js 3.x
+        - Node.js 4.x
+        - Node.js 5.x
+        - Node.js 6.x
+        - Node.js 7.x
+        - Node.js 8.x
+        - Node.js 9.x
+        - Node.js 10.x
+        - Node.js 11.x
+        - Node.js 12.x
+        - Node.js 13.x
+        - Node.js 14.x
+        - Node.js 15.x
+        - Node.js 16.x
+        - Node.js 17.x
+        - Node.js 18.x
+        - Node.js 19.x
+        - Node.js 20.x
+        - Node.js 21.x
+        - Node.js 22.x
+        - Node.js 23.x
+        - Node.js 24.x
+
+        include:
+        - name: Node.js 0.8
+          node-version: "0.8"
+          npm-i: mocha@2.5.3 supertest@1.1.0
+          npm-rm: nyc
+
+        - name: Node.js 0.10
+          node-version: "0.10"
+          npm-i: mocha@3.5.3 nyc@10.3.2 supertest@2.0.1
+
+        - name: Node.js 0.12
+          node-version: "0.12"
+          npm-i: mocha@3.5.3 nyc@10.3.2 supertest@2.0.1
+
+        - name: io.js 1.x
+          node-version: "1"
+          npm-i: mocha@3.5.3 nyc@10.3.2 supertest@2.0.1
+
+        - name: io.js 2.x
+          node-version: "2"
+          npm-i: mocha@3.5.3 nyc@10.3.2 supertest@2.0.1
+
+        - name: io.js 3.x
+          node-version: "3"
+          npm-i: mocha@3.5.3 nyc@10.3.2 supertest@2.0.1
+
+        - name: Node.js 4.x
+          node-version: "4"
+          npm-i: mocha@5.2.0 nyc@11.9.0 supertest@3.4.2
+
+        - name: Node.js 5.x
+          node-version: "5"
+          npm-i: mocha@5.2.0 nyc@11.9.0 supertest@3.4.2
+
+        - name: Node.js 6.x
+          node-version: "6"
+          npm-i: mocha@6.2.2 nyc@14.1.1 supertest@6.1.3
+
+        - name: Node.js 7.x
+          node-version: "7"
+          npm-i: mocha@6.2.2 nyc@14.1.1 supertest@6.1.3
+
+        - name: Node.js 8.x
+          node-version: "8"
+          npm-i: mocha@7.1.2 nyc@14.1.1 supertest@6.1.3
+
+        - name: Node.js 9.x
+          node-version: "9"
+          npm-i: mocha@7.1.2 nyc@14.1.1 supertest@6.1.3
+
+        - name: Node.js 10.x
+          node-version: "10"
+          npm-i: mocha@8.4.0 supertest@6.1.3
+
+        - name: Node.js 11.x
+          node-version: "11"
+          npm-i: mocha@8.4.0 supertest@6.1.3
+
+        - name: Node.js 12.x
+          node-version: "12"
+          npm-i: mocha@9.2.2 supertest@6.1.3
+
+        - name: Node.js 13.x
+          node-version: "13"
+          npm-i: mocha@9.2.2 supertest@6.1.3
+
+        - name: Node.js 14.x
+          node-version: "14"
+          npm-i: supertest@6.1.3
+
+        - name: Node.js 15.x
+          node-version: "15"
+          npm-i: supertest@6.1.3
+
+        - name: Node.js 16.x
+          node-version: "16"
+          npm-i: supertest@6.1.3
+
+        - name: Node.js 17.x
+          node-version: "17"
+          npm-i: supertest@6.1.3
+
+        - name: Node.js 18.x
+          node-version: "18"
+
+        - name: Node.js 19.x
+          node-version: "19"
+
+        - name: Node.js 20.x
+          node-version: "20"
+
+        - name: Node.js 21.x
+          node-version: "21"
+
+        - name: Node.js 22.x
+          node-version: "22"
+
+        - name: Node.js 23.x
+          node-version: "23"
+
+        - name: Node.js 24.x
+          node-version: "24"
+
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+    - name: Install Node.js ${{ matrix.node-version }}
+      shell: bash -eo pipefail -l {0}
+      run: |
+        nvm install --default ${{ matrix.node-version }}
+        if [[ "${{ matrix.node-version }}" == 0.* && "$(cut -d. -f2 <<< "${{ matrix.node-version }}")" -lt 10 ]]; then
+          nvm install --alias=npm 0.10
+          nvm use ${{ matrix.node-version }}
+          if [[ "$(npm -v)" == 1.1.* ]]; then
+            nvm exec npm npm install -g npm@1.1
+            ln -fs "$(which npm)" "$(dirname "$(nvm which npm)")/npm"
+          else
+            sed -i '1s;^.*$;'"$(printf '#!%q' "$(nvm which npm)")"';' "$(readlink -f "$(which npm)")"
+          fi
+          npm config set strict-ssl false
+        fi
+        dirname "$(nvm which ${{ matrix.node-version }})" >> "$GITHUB_PATH"
+
+    - name: Configure npm
+      run: |
+        if [[ "$(npm config get package-lock)" == "true" ]]; then
+          npm config set package-lock false
+        else
+          npm config set shrinkwrap false
+        fi
+
+    - name: Remove npm module(s) ${{ matrix.npm-rm }}
+      if: matrix.npm-rm != ''
+      run: npm rm --silent --save-dev ${{ matrix.npm-rm }}
+
+    - name: Install npm module(s) ${{ matrix.npm-i }}
+      if: matrix.npm-i != ''
+      run: npm install --save-dev ${{ matrix.npm-i }}
+
+    - name: Setup Node.js version-specific dependencies
+      shell: bash
+      run: |
+        # eslint for linting
+        # - remove on Node.js < 12
+        if [[ "$(cut -d. -f1 <<< "${{ matrix.node-version }}")" -lt 12 ]]; then
+          node -pe 'Object.keys(require("./package").devDependencies).join("\n")' | \
+            grep -E '^eslint(-|$)' | \
+            sort -r | \
+            xargs -n1 npm rm --silent --save-dev
+        fi
+
+    - name: Install Node.js dependencies
+      run: npm install
+
+    - name: List environment
+      id: list_env
+      shell: bash
+      run: |
+        echo "node@$(node -v)"
+        echo "npm@$(npm -v)"
+        npm -s ls ||:
+        (npm -s ls --depth=0 ||:) | awk -F'[ @]' 'NR>1 && $2 { print $2 "=" $3 }' >> "$GITHUB_OUTPUT"
+
+    - name: Run tests
+      shell: bash
+      run: |
+        if npm -ps ls nyc | grep -q nyc; then
+          npm run test-ci
+        else
+          npm test
+        fi
+
+    - name: Lint code
+      if: steps.list_env.outputs.eslint != ''
+      run: npm run lint
+
+    - name: Collect code coverage
+      uses: coverallsapp/github-action@648a8eb78e6d50909eff900e4ec85cab4524a45b # master
+      if: steps.list_env.outputs.nyc != ''
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        flag-name: run-${{ matrix.test_number }}
+        parallel: true
+
+  coverage:
+    permissions:
+      checks: write  # for coverallsapp/github-action to create new checks
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Upload code coverage
+      uses: coverallsapp/github-action@648a8eb78e6d50909eff900e4ec85cab4524a45b # master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        parallel-finished: true

.github/workflows/codeql.yml

@@ -0,0 +1,78 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: ["master"]
+  schedule:
+    - cron: "0 0 * * 1"
+
+permissions:
+  contents: read
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["javascript"]
+        # CodeQL supports [ $supported-codeql-languages ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0
+        with:
+          egress-policy: audit
+
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@0499de31b99561a6d14a36a5f662c2a54f91beee # v3.29.5
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@0499de31b99561a6d14a36a5f662c2a54f91beee # v3.29.5
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+      # - run: |
+      #   echo "Run, Build Application using script"
+      #   ./location_of_script_within_repo/buildscript.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@0499de31b99561a6d14a36a5f662c2a54f91beee # v3.29.5
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/scorecard.yml

@@ -0,0 +1,73 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '16 21 * * 1'
+  push:
+    branches: [ "master" ]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      # Uncomment the permissions below if installing in a private repository.
+      # contents: read
+      # actions: read
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@05b42c624433fc40578a4040d5cf5e36ddca8cde # v2.4.2
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecard on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard.
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@0499de31b99561a6d14a36a5f662c2a54f91beee # v3.29.5
+        with:
+          sarif_file: results.sarif

.gitignore

@@ -1,3 +1,5 @@
+.nyc_output/
 coverage
 node_modules
 npm-debug.log
+package-lock.json

.travis.yml

@@ -1,11 +0,0 @@
-language: node_js
-node_js:
-  - "0.8"
-  - "0.10"
-  - "0.11"
-matrix:
-  allow_failures:
-    - node_js: "0.11"
-  fast_finish: true
-script: "npm run-script test-ci"
-after_script: "npm install coveralls@2.10.0 && cat ./coverage/lcov.info | coveralls"

HISTORY.md

@@ -1,3 +1,168 @@
+unreleased
+==========
+
+  * Fix icons for MIME types with `+`
+  * Fix text and json responses to match html sorting
+  * Show font icon for more font types
+  * Use 400 error on URI decode failure instead of 500
+  * deps: accepts@~1.3.7
+    - deps: mime-types@~2.1.24
+    - deps: negotiator@0.6.2
+  * deps: http-errors@~1.8.0
+    - Set constructor name when possible
+    - deps: depd@~1.1.2
+    - deps: inherits@2.0.4
+    - deps: setprototypeof@1.2.0
+    - deps: statuses@'>= 1.5.0 < 2'
+  * deps: mime-types@~2.1.30
+    - Add new mime types
+    - deps: mime-db@~1.47.0
+  * deps: parseurl@~1.3.3
+
+1.9.1 / 2017-09-28
+==================
+
+  * deps: accepts@~1.3.4
+    - deps: mime-types@~2.1.16
+  * deps: debug@2.6.9
+  * deps: http-errors@~1.6.2
+    - deps: depd@1.1.1
+  * deps: mime-types@~2.1.17
+    - Add new mime types
+    - deps: mime-db@~1.30.0
+  * deps: parseurl@~1.3.2
+    - perf: reduce overhead for full URLs
+    - perf: unroll the "fast-path" `RegExp`
+
+1.9.0 / 2017-05-25
+==================
+
+  * Set `X-Content-Type-Options: nosniff` header
+  * deps: batch@0.6.1
+  * deps: debug@2.6.8
+    - Allow colors in workers
+    - Deprecated `DEBUG_FD` environment variable set to `3` or higher
+    - Fix `DEBUG_MAX_ARRAY_LENGTH`
+    - Fix error when running under React Native
+    - Use same color for same namespace
+    - deps: ms@2.0.0
+  * deps: http-errors@~1.6.1
+    - Make `message` property enumerable for `HttpError`s
+    - deps: inherits@2.0.3
+    - deps: setprototypeof@1.0.3
+    - deps: statuses@'>= 1.3.1 < 2'
+  * deps: mime-types@~2.1.15
+    - Add new mime types
+    - Add `audio/mp3`
+
+1.8.0 / 2016-06-17
+==================
+
+  * Make inline file search case-insensitive
+  * deps: accepts@~1.3.3
+    - deps: mime-types@~2.1.11
+    - deps: negotiator@0.6.1
+    - perf: improve header parsing speed
+  * deps: http-errors@~1.5.0
+    - Use `setprototypeof` module to replace `__proto__` setting
+    - deps: inherits@2.0.1
+    - deps: statuses@'>= 1.3.0 < 2'
+    - perf: enable strict mode
+  * deps: mime-types@~2.1.11
+    - Add new mime types
+    - Update primary extension for `audio/mp4`
+    - deps: mime-db@~1.23.0
+
+1.7.3 / 2016-01-24
+==================
+
+  * deps: accepts@~1.2.13
+    - deps: mime-types@~2.1.6
+  * deps: batch@0.5.3
+    - Fix invalid dependency for browserify
+  * deps: escape-html@~1.0.3
+    - perf: enable strict mode
+    - perf: optimize string replacement
+    - perf: use faster string coercion
+  * deps: mime-types@~2.1.9
+    - Add new mime types
+  * deps: parseurl@~1.3.1
+    - perf: enable strict mode
+
+1.7.2 / 2015-07-30
+==================
+
+  * deps: accepts@~1.2.12
+    - deps: mime-types@~2.1.4
+  * deps: mime-types@~2.1.4
+    - Add new mime types
+
+1.7.1 / 2015-07-05
+==================
+
+  * deps: accepts@~1.2.10
+    - deps: mime-types@~2.1.2
+  * deps: mime-types@~2.1.2
+    - Add new mime types
+
+1.7.0 / 2015-06-15
+==================
+
+  * Accept `function` value for `template` option
+  * Send non-chunked response for `OPTIONS`
+  * Stat parent directory when necessary
+  * Use `Date.prototype.toLocaleDateString` to format date
+  * deps: accepts@~1.2.9
+    - deps: mime-types@~2.1.1
+    - deps: negotiator@0.5.3
+    - perf: avoid argument reassignment & argument slice
+    - perf: avoid negotiator recursive construction
+    - perf: enable strict mode
+    - perf: remove unnecessary bitwise operator
+  * deps: escape-html@1.0.2
+  * deps: mime-types@~2.1.1
+    - Add new mime types
+  * perf: enable strict mode
+  * perf: remove argument reassignment
+
+1.6.4 / 2015-05-12
+==================
+
+  * deps: accepts@~1.2.7
+    - deps: mime-types@~2.0.11
+    - deps: negotiator@0.5.3
+  * deps: debug@~2.2.0
+    - deps: ms@0.7.1
+  * deps: mime-types@~2.0.11
+    - Add new mime types
+
+1.6.3 / 2015-03-13
+==================
+
+  * Properly escape file names in HTML
+  * deps: accepts@~1.2.5
+    - deps: mime-types@~2.0.10
+  * deps: debug@~2.1.3
+    - Fix high intensity foreground color for bold
+    - deps: ms@0.7.0
+  * deps: escape-html@1.0.1
+  * deps: mime-types@~2.0.10
+    - Add new mime types
+
+1.6.2 / 2015-02-16
+==================
+
+  * deps: accepts@~1.2.4
+    - deps: mime-types@~2.0.9
+    - deps: negotiator@0.5.1
+  * deps: http-errors@~1.3.1
+    - Construct errors using defined constructors from `createError`
+    - Fix error names that are not identifiers
+    - Set a meaningful `name` property on constructed errors
+  * deps: mime-types@~2.0.9
+    - Add new mime types
+    - deps: mime-db@~1.7.0
+
 1.6.1 / 2015-01-31
 ==================
 

LICENSE

@@ -3,7 +3,7 @@
 Copyright (c) 2010 Sencha Inc.
 Copyright (c) 2011 LearnBoost
 Copyright (c) 2011 TJ Holowaychuk
-Copyright (c) 2014 Douglas Christopher Wilson
+Copyright (c) 2014-2015 Douglas Christopher Wilson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -2,15 +2,18 @@
 
 [![NPM Version][npm-image]][npm-url]
 [![NPM Downloads][downloads-image]][downloads-url]
-[![Linux Build][travis-image]][travis-url]
+[![Linux Build Status][ci-image]][ci-url]
 [![Windows Build][appveyor-image]][appveyor-url]
-[![Test Coverage][coveralls-image]][coveralls-url]
+[![Coverage Status][coveralls-image]][coveralls-url]
-[![Gratipay][gratipay-image]][gratipay-url]
 
   Serves pages that contain directory listings for a given path.
 
 ## Install
 
+This is a [Node.js](https://nodejs.org/en/) module available through the
+[npm registry](https://www.npmjs.com/). Installation is done using the
+[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
+
 ```sh
 $ npm install serve-index
 ```
@@ -56,15 +59,31 @@ Optional path to a CSS stylesheet. Defaults to a built-in stylesheet.
 
 ##### template
 
-Optional path to an HTML template. Defaults to a built-in template.
+Optional path to an HTML template or a function that will render a HTML
+string. Defaults to a built-in template.
 
-The following tokens are replaced in templates:
+When given a string, the string is used as a file path to load and then the
+following tokens are replaced in templates:
 
   * `{directory}` with the name of the directory.
   * `{files}` with the HTML of an unordered list of file links.
   * `{linked-path}` with the HTML of a link to the directory.
   * `{style}` with the specified stylesheet and embedded images.
 
+When given as a function, the function is called as `template(locals, callback)`
+and it needs to invoke `callback(error, htmlString)`. The following are the
+provided locals:
+
+  * `directory` is the directory being displayed (where `/` is the root).
+  * `displayIcons` is a Boolean for if icons should be rendered or not.
+  * `fileList` is a sorted array of files in the directory. The array contains
+    objects with the following properties:
+    - `name` is the relative name for the file.
+    - `stat` is a `fs.Stats` object for the file.
+  * `path` is the full filesystem path to `directory`.
+  * `style` is the default stylesheet or the contents of the `stylesheet` option.
+  * `viewName` is the view name provided by the `view` option.
+
 ##### view
 
 Display mode. `tiles` and `details` are available. Defaults to `tiles`.
@@ -107,8 +126,12 @@ var serveIndex = require('serve-index')
 var app = express()
 
 // Serve URLs like /ftp/thing as public/ftp/thing
-app.use('/ftp', serveIndex('public/ftp', {'icons': true}))
+// The express.static serves the file contents
-app.listen()
+// The serveIndex is this module serving the directory
+app.use('/ftp', express.static('public/ftp'), serveIndex('public/ftp', {'icons': true}))
+
+// Listen
+app.listen(3000)
 ```
 
 ## License
@@ -116,15 +139,13 @@ app.listen()
 [MIT](LICENSE). The [Silk](http://www.famfamfam.com/lab/icons/silk/) icons
 are created by/copyright of [FAMFAMFAM](http://www.famfamfam.com/).
 
-[npm-image]: https://img.shields.io/npm/v/serve-index.svg?style=flat
+[appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/serve-index/master.svg?label=windows
-[npm-url]: https://npmjs.org/package/serve-index
-[travis-image]: https://img.shields.io/travis/expressjs/serve-index/master.svg?label=linux&style=flat
-[travis-url]: https://travis-ci.org/expressjs/serve-index
-[appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/serve-index/master.svg?label=windows&style=flat
 [appveyor-url]: https://ci.appveyor.com/project/dougwilson/serve-index
-[coveralls-image]: https://img.shields.io/coveralls/expressjs/serve-index/master.svg?style=flat
+[ci-image]: https://badgen.net/github/checks/expressjs/serve-index/master?label=ci
+[ci-url]: https://github.com/expressjs/serve-index/actions/workflows/ci.yml
+[coveralls-image]: https://img.shields.io/coveralls/expressjs/serve-index/master.svg
 [coveralls-url]: https://coveralls.io/r/expressjs/serve-index?branch=master
-[downloads-image]: https://img.shields.io/npm/dm/serve-index.svg?style=flat
+[downloads-image]: https://img.shields.io/npm/dm/serve-index.svg
 [downloads-url]: https://npmjs.org/package/serve-index
-[gratipay-image]: https://img.shields.io/gratipay/dougwilson.svg?style=flat
+[npm-image]: https://img.shields.io/npm/v/serve-index.svg
-[gratipay-url]: https://www.gratipay.com/dougwilson/
+[npm-url]: https://npmjs.org/package/serve-index

appveyor.yml

@@ -2,17 +2,91 @@ environment:
   matrix:
     - nodejs_version: "0.8"
     - nodejs_version: "0.10"
-    - nodejs_version: "0.11"
+    - nodejs_version: "0.12"
-matrix:
+    - nodejs_version: "1.8"
-  allow_failures:
+    - nodejs_version: "2.5"
-    - nodejs_version: "0.11"
+    - nodejs_version: "3.3"
-  fast_finish: true
+    - nodejs_version: "4.9"
+    - nodejs_version: "5.12"
+    - nodejs_version: "6.17"
+    - nodejs_version: "7.10"
+    - nodejs_version: "8.17"
+    - nodejs_version: "9.11"
+    - nodejs_version: "10.24"
+    - nodejs_version: "11.15"
+    - nodejs_version: "12.22"
+    - nodejs_version: "13.14"
+    - nodejs_version: "14.16"
+    - nodejs_version: "15.13"
+cache:
+  - node_modules
 install:
-  - ps: Update-NodeJsInstallation (Get-NodeJsLatestBuild $env:nodejs_version)
+  # Install Node.js
+  - ps: >-
+      try { Install-Product node $env:nodejs_version -ErrorAction Stop }
+      catch { Update-NodeJsInstallation (Get-NodeJsLatestBuild $env:nodejs_version) }
+  # Configure npm
+  - ps: |
+      # Skip updating shrinkwrap / lock
+      npm config set shrinkwrap false
+      # Skip SSL validation on Node.js < 0.10
+      if ([int]$env:nodejs_version.split(".")[0] -eq 0 -and [int]$env:nodejs_version.split(".")[1] -lt 10) {
+        npm config set strict-ssl false
+      }
+  # Remove all non-test dependencies
+  - ps: |
+      # Remove coverage dependency
+      npm rm --silent --save-dev nyc
+      # Remove lint dependencies
+      cmd.exe /c "node -pe `"Object.keys(require('./package').devDependencies).join('\n')`"" | `
+        sls "^eslint(-|$)" | `
+        %{ npm rm --silent --save-dev $_ }
+  # Setup Node.js version-specific dependencies
+  - ps: |
+      # mocha for testing
+      # - use 2.x for Node.js < 0.10
+      # - use 3.x for Node.js < 4
+      # - use 5.x for Node.js < 6
+      # - use 6.x for Node.js < 8
+      # - use 7.x for Node.js < 10
+      if ([int]$env:nodejs_version.split(".")[0] -eq 0 -and [int]$env:nodejs_version.split(".")[1] -lt 10) {
+        npm install --silent --save-dev mocha@2.5.3
+      } elseif ([int]$env:nodejs_version.split(".")[0] -lt 4) {
+        npm install --silent --save-dev mocha@3.5.3
+      } elseif ([int]$env:nodejs_version.split(".")[0] -lt 6) {
+        npm install --silent --save-dev mocha@5.2.0
+      } elseif ([int]$env:nodejs_version.split(".")[0] -lt 8) {
+        npm install --silent --save-dev mocha@6.2.2
+      } elseif ([int]$env:nodejs_version.split(".")[0] -lt 10) {
+        npm install --silent --save-dev mocha@7.2.0
+      }
+  - ps: |
+      # mocha for testing
+      # - use 1.1.0 for Node.js < 0.10
+      # - use 2.0.0 for Node.js < 4
+      # - use 3.4.2 for Node.js < 6
+      if ([int]$env:nodejs_version.split(".")[0] -eq 0 -and [int]$env:nodejs_version.split(".")[1] -lt 10) {
+        npm install --silent --save-dev supertest@1.1.0
+      } elseif ([int]$env:nodejs_version.split(".")[0] -lt 4) {
+        npm install --silent --save-dev supertest@2.0.0
+      } elseif ([int]$env:nodejs_version.split(".")[0] -lt 6) {
+        npm install --silent --save-dev supertest@3.4.2
+      }
+  # Update Node.js modules
+  - ps: |
+      # Prune & rebuild node_modules
+      if (Test-Path -Path node_modules) {
+        npm prune
+        npm rebuild
+      }
+  # Install Node.js modules
   - npm install
 build: off
 test_script:
-  - node --version
+  # Output version data
-  - npm --version
+  - ps: |
-  - npm run test-ci
+      node --version
+      npm --version
+  # Run test script
+  - npm test
 version: "{build}"

index.js

@@ -2,20 +2,21 @@
  * serve-index
  * Copyright(c) 2011 Sencha Inc.
  * Copyright(c) 2011 TJ Holowaychuk
- * Copyright(c) 2014 Douglas Christopher Wilson
+ * Copyright(c) 2014-2015 Douglas Christopher Wilson
  * MIT Licensed
  */
 
-// TODO: arrow key navigation
+'use strict';
-// TODO: make icons extensible
 
 /**
  * Module dependencies.
+ * @private
  */
 
 var accepts = require('accepts');
 var createError = require('http-errors');
 var debug = require('debug')('serve-index');
+var escapeHtml = require('escape-html');
 var fs = require('fs')
   , path = require('path')
   , normalize = path.normalize
@@ -27,6 +28,13 @@ var mime = require('mime-types');
 var parseUrl = require('parseurl');
 var resolve = require('path').resolve;
 
+/**
+ * Module exports.
+ * @public
+ */
+
+module.exports = serveIndex;
+
 /*!
  * Icon cache.
  */
@@ -66,59 +74,63 @@ var mediaType = {
  *
  * See Readme.md for documentation of options.
  *
- * @param {String} path
+ * @param {String} root
  * @param {Object} options
  * @return {Function} middleware
- * @api public
+ * @public
  */
 
-exports = module.exports = function serveIndex(root, options){
+function serveIndex(root, options) {
-  options = options || {};
+  var opts = options || {};
 
   // root required
-  if (!root) throw new TypeError('serveIndex() root path required');
+  if (!root) {
+    throw new TypeError('serveIndex() root path required');
+  }
 
   // resolve root to absolute and normalize
-  root = resolve(root);
+  var rootPath = normalize(resolve(root) + sep);
-  root = normalize(root + sep);
 
-  var hidden = options.hidden
+  var filter = opts.filter;
-    , icons = options.icons
+  var hidden = opts.hidden;
-    , view = options.view || 'tiles'
+  var icons = opts.icons;
-    , filter = options.filter
+  var stylesheet = opts.stylesheet || defaultStylesheet;
-    , template = options.template || defaultTemplate
+  var template = opts.template || defaultTemplate;
-    , stylesheet = options.stylesheet || defaultStylesheet;
+  var view = opts.view || 'tiles';
 
-  return function serveIndex(req, res, next) {
+  return function (req, res, next) {
     if (req.method !== 'GET' && req.method !== 'HEAD') {
-      res.statusCode = 'OPTIONS' === req.method
+      res.statusCode = 'OPTIONS' === req.method ? 200 : 405;
-        ? 200
-        : 405;
       res.setHeader('Allow', 'GET, HEAD, OPTIONS');
+      res.setHeader('Content-Length', '0');
       res.end();
       return;
     }
 
+    // get dir
+    var dir = getRequestedDir(req)
+
+    // bad request
+    if (dir === null) return next(createError(400))
+
     // parse URLs
-    var url = parseUrl(req);
     var originalUrl = parseUrl.original(req);
-    var dir = decodeURIComponent(url.pathname);
     var originalDir = decodeURIComponent(originalUrl.pathname);
 
     // join / normalize from root dir
-    var path = normalize(join(root, dir));
+    var path = normalize(join(rootPath, dir));
 
     // null byte(s), bad request
     if (~path.indexOf('\0')) return next(createError(400));
 
     // malicious path
-    if ((path + sep).substr(0, root.length) !== root) {
+    if ((path + sep).substr(0, rootPath.length) !== rootPath) {
       debug('malicious path "%s"', path);
       return next(createError(403));
     }
 
     // determine ".." display
-    var showUp = normalize(resolve(path) + sep) !== root;
+    var showUp = normalize(resolve(path) + sep) !== rootPath;
 
     // check if we have a directory
     debug('stat "%s"', path);
@@ -152,7 +164,7 @@ exports = module.exports = function serveIndex(root, options){
 
         // not acceptable
         if (!type) return next(createError(406));
-        exports[mediaType[type]](req, res, files, next, originalDir, showUp, icons, path, view, template, stylesheet);
+        serveIndex[mediaType[type]](req, res, files, next, originalDir, showUp, icons, path, view, template, stylesheet);
       });
     });
   };
@@ -162,26 +174,40 @@ exports = module.exports = function serveIndex(root, options){
  * Respond with text/html.
  */
 
-exports.html = function(req, res, files, next, dir, showUp, icons, path, view, template, stylesheet){
+serveIndex.html = function _html(req, res, files, next, dir, showUp, icons, path, view, template, stylesheet) {
-  fs.readFile(template, 'utf8', function(err, str){
+  var render = typeof template !== 'function'
-    if (err) return next(err);
+    ? createHtmlRender(template)
-    fs.readFile(stylesheet, 'utf8', function(err, style){
+    : template
-      if (err) return next(err);
-      stat(path, files, function(err, stats){
-        if (err) return next(err);
-        files = files.map(function(file, i){ return { name: file, stat: stats[i] }; });
-        files.sort(fileSort);
-        if (showUp) files.unshift({ name: '..' });
-        str = str
-          .replace(/\{style\}/g, style.concat(iconStyle(files, icons)))
-          .replace(/\{files\}/g, html(files, dir, icons, view))
-          .replace(/\{directory\}/g, dir)
-          .replace(/\{linked-path\}/g, htmlPath(dir));
 
-        var buf = new Buffer(str, 'utf8');
+  if (showUp) {
-        res.setHeader('Content-Type', 'text/html; charset=utf-8');
+    files.unshift('..');
-        res.setHeader('Content-Length', buf.length);
+  }
-        res.end(buf);
+
+  // stat all files
+  stat(path, files, function (err, fileList) {
+    if (err) return next(err);
+
+    // sort file list
+    fileList.sort(fileSort);
+
+    // read stylesheet
+    fs.readFile(stylesheet, 'utf8', function (err, style) {
+      if (err) return next(err);
+
+      // create locals for rendering
+      var locals = {
+        directory: dir,
+        displayIcons: Boolean(icons),
+        fileList: fileList,
+        path: path,
+        style: style,
+        viewName: view
+      };
+
+      // render html
+      render(locals, function (err, body) {
+        if (err) return next(err);
+        send(res, 'text/html', body)
       });
     });
   });
@@ -191,47 +217,175 @@ exports.html = function(req, res, files, next, dir, showUp, icons, path, view, t
  * Respond with application/json.
  */
 
-exports.json = function(req, res, files){
+serveIndex.json = function _json (req, res, files, next, dir, showUp, icons, path) {
-  var body = JSON.stringify(files);
+  // stat all files
-  var buf = new Buffer(body, 'utf8');
+  stat(path, files, function (err, fileList) {
+    if (err) return next(err)
 
-  res.setHeader('Content-Type', 'application/json; charset=utf-8');
+    // sort file list
-  res.setHeader('Content-Length', buf.length);
+    fileList.sort(fileSort)
-  res.end(buf);
+
+    // serialize
+    var body = JSON.stringify(fileList.map(function (file) {
+      return file.name
+    }))
+
+    send(res, 'application/json', body)
+  })
 };
 
 /**
  * Respond with text/plain.
  */
 
-exports.plain = function(req, res, files){
+serveIndex.plain = function _plain (req, res, files, next, dir, showUp, icons, path) {
-  var body = files.join('\n') + '\n';
+  // stat all files
-  var buf = new Buffer(body, 'utf8');
+  stat(path, files, function (err, fileList) {
+    if (err) return next(err)
 
-  res.setHeader('Content-Type', 'text/plain; charset=utf-8');
+    // sort file list
-  res.setHeader('Content-Length', buf.length);
+    fileList.sort(fileSort)
-  res.end(buf);
+
+    // serialize
+    var body = fileList.map(function (file) {
+      return file.name
+    }).join('\n') + '\n'
+
+    send(res, 'text/plain', body)
+  })
 };
 
+/**
+ * Map html `files`, returning an html unordered list.
+ * @private
+ */
+
+function createHtmlFileList(files, dir, useIcons, view) {
+  var html = '<ul id="files" class="view-' + escapeHtml(view) + '">'
+    + (view === 'details' ? (
+      '<li class="header">'
+      + '<span class="name">Name</span>'
+      + '<span class="size">Size</span>'
+      + '<span class="date">Modified</span>'
+      + '</li>') : '');
+
+  html += files.map(function (file) {
+    var classes = [];
+    var isDir = file.stat && file.stat.isDirectory();
+    var path = dir.split('/').map(function (c) { return encodeURIComponent(c); });
+
+    if (useIcons) {
+      classes.push('icon');
+
+      if (isDir) {
+        classes.push('icon-directory');
+      } else {
+        var ext = extname(file.name);
+        var icon = iconLookup(file.name);
+
+        classes.push('icon');
+        classes.push('icon-' + ext.substring(1));
+
+        if (classes.indexOf(icon.className) === -1) {
+          classes.push(icon.className);
+        }
+      }
+    }
+
+    path.push(encodeURIComponent(file.name));
+
+    var date = file.stat && file.name !== '..'
+      ? file.stat.mtime.toLocaleDateString() + ' ' + file.stat.mtime.toLocaleTimeString()
+      : '';
+    var size = file.stat && !isDir
+      ? file.stat.size
+      : '';
+
+    return '<li><a href="'
+      + escapeHtml(normalizeSlashes(normalize(path.join('/'))))
+      + '" class="' + escapeHtml(classes.join(' ')) + '"'
+      + ' title="' + escapeHtml(file.name) + '">'
+      + '<span class="name">' + escapeHtml(file.name) + '</span>'
+      + '<span class="size">' + escapeHtml(size) + '</span>'
+      + '<span class="date">' + escapeHtml(date) + '</span>'
+      + '</a></li>';
+  }).join('\n');
+
+  html += '</ul>';
+
+  return html;
+}
+
+/**
+ * Create function to render html.
+ */
+
+function createHtmlRender(template) {
+  return function render(locals, callback) {
+    // read template
+    fs.readFile(template, 'utf8', function (err, str) {
+      if (err) return callback(err);
+
+      var body = str
+        .replace(/\{style\}/g, locals.style.concat(iconStyle(locals.fileList, locals.displayIcons)))
+        .replace(/\{files\}/g, createHtmlFileList(locals.fileList, locals.directory, locals.displayIcons, locals.viewName))
+        .replace(/\{directory\}/g, escapeHtml(locals.directory))
+        .replace(/\{linked-path\}/g, htmlPath(locals.directory));
+
+      callback(null, body);
+    });
+  };
+}
+
 /**
  * Sort function for with directories first.
  */
 
 function fileSort(a, b) {
+  // sort ".." to the top
+  if (a.name === '..' || b.name === '..') {
+    return a.name === b.name ? 0
+      : a.name === '..' ? -1 : 1;
+  }
+
   return Number(b.stat && b.stat.isDirectory()) - Number(a.stat && a.stat.isDirectory()) ||
     String(a.name).toLocaleLowerCase().localeCompare(String(b.name).toLocaleLowerCase());
 }
 
+/**
+ * Get the requested directory from request.
+ *
+ * @param req
+ * @return {string}
+ * @api private
+ */
+
+function getRequestedDir (req) {
+  try {
+    return decodeURIComponent(parseUrl(req).pathname)
+  } catch (e) {
+    return null
+  }
+}
+
 /**
  * Map html `dir`, returning a linked path.
  */
 
 function htmlPath(dir) {
-  var curr = [];
+  var parts = dir.split('/');
-  return dir.split('/').map(function(part){
+  var crumb = new Array(parts.length);
-    curr.push(encodeURIComponent(part));
+
-    return part ? '<a href="' + curr.join('/') + '">' + part + '</a>' : '';
+  for (var i = 0; i < parts.length; i++) {
-  }).join(' / ');
+    var part = parts[i];
+
+    if (part) {
+      parts[i] = encodeURIComponent(part);
+      crumb[i] = '<a href="' + escapeHtml(parts.slice(0, i + 1).join('/')) + '">' + escapeHtml(part) + '</a>';
+    }
+  }
+
+  return crumb.join(' / ');
 }
 
 /**
@@ -262,7 +416,7 @@ function iconLookup(filename) {
   // try by mime type
   if (icons[mimetype]) {
     return {
-      className: 'icon-' + mimetype.replace('/', '-'),
+      className: 'icon-' + mimetype.replace('/', '-').replace('+', '_'),
       fileName: icons[mimetype]
     };
   }
@@ -296,11 +450,9 @@ function iconLookup(filename) {
  * Load icon images, return css string.
  */
 
-function iconStyle (files, useIcons) {
+function iconStyle(files, useIcons) {
   if (!useIcons) return '';
-  var className;
   var i;
-  var iconName;
   var list = [];
   var rules = {};
   var selector;
@@ -310,7 +462,7 @@ function iconStyle (files, useIcons) {
   for (i = 0; i < files.length; i++) {
     var file = files[i];
 
-    var isDir = '..' == file.name || (file.stat && file.stat.isDirectory());
+    var isDir = file.stat && file.stat.isDirectory();
     var icon = isDir
       ? { className: 'icon-directory', fileName: icons.folder }
       : iconLookup(file.name);
@@ -337,63 +489,6 @@ function iconStyle (files, useIcons) {
   return style;
 }
 
-/**
- * Map html `files`, returning an html unordered list.
- */
-
-function html(files, dir, useIcons, view) {
-  return '<ul id="files" class="view-' + view + '">'
-    + (view == 'details' ? (
-      '<li class="header">'
-      + '<span class="name">Name</span>'
-      + '<span class="size">Size</span>'
-      + '<span class="date">Modified</span>'
-      + '</li>') : '')
-    + files.map(function(file){
-    var isDir = '..' == file.name || (file.stat && file.stat.isDirectory())
-      , classes = []
-      , path = dir.split('/').map(function (c) { return encodeURIComponent(c); });
-
-    if (useIcons) {
-      classes.push('icon');
-
-      if (isDir) {
-        classes.push('icon-directory');
-      } else {
-        var ext = extname(file.name);
-        var icon = iconLookup(file.name);
-
-        classes.push('icon');
-        classes.push('icon-' + ext.substring(1));
-
-        if (classes.indexOf(icon.className) === -1) {
-          classes.push(icon.className);
-        }
-      }
-    }
-
-    path.push(encodeURIComponent(file.name));
-
-    var date = file.stat && file.name !== '..'
-      ? file.stat.mtime.toDateString() + ' ' + file.stat.mtime.toLocaleTimeString()
-      : '';
-    var size = file.stat && !isDir
-      ? file.stat.size
-      : '';
-
-    return '<li><a href="'
-      + normalizeSlashes(normalize(path.join('/')))
-      + '" class="'
-      + classes.join(' ') + '"'
-      + ' title="' + file.name + '">'
-      + '<span class="name">'+file.name+'</span>'
-      + '<span class="size">'+size+'</span>'
-      + '<span class="date">'+date+'</span>'
-      + '</a></li>';
-
-  }).join('\n') + '</ul>';
-}
-
 /**
  * Load and cache the given `icon`.
  *
@@ -431,13 +526,34 @@ function normalizeSlashes(path) {
 
 function removeHidden(files) {
   return files.filter(function(file){
-    return '.' != file[0];
+    return file[0] !== '.'
   });
 }
 
 /**
- * Stat all files and return array of stat
+ * Send a response.
- * in same order.
+ * @private
+ */
+
+function send (res, type, body) {
+  // security header for content sniffing
+  res.setHeader('X-Content-Type-Options', 'nosniff')
+
+  // standard headers
+  res.setHeader('Content-Type', type + '; charset=utf-8')
+  res.setHeader('Content-Length', Buffer.byteLength(body, 'utf8'))
+
+  // body
+  res.end(body, 'utf8')
+}
+
+/**
+ * Stat all files and return array of objects in the form
+ * `{ name, stat }`.
+ *
+ * @param {Array} files
+ * @return {Array}
+ * @api private
  */
 
 function stat(dir, files, cb) {
@@ -451,7 +567,10 @@ function stat(dir, files, cb) {
         if (err && err.code !== 'ENOENT') return done(err);
 
         // pass ENOENT as null stat, not error
-        done(null, stat || null);
+        done(null, {
+          name: file,
+          stat: stat || null
+        })
       });
     });
   });
@@ -469,6 +588,7 @@ var icons = {
   'folder': 'folder.png',
 
   // generic mime type icons
+  'font': 'font.png',
   'image': 'image.png',
   'text': 'page_white_text.png',
   'video': 'film.png',
@@ -479,7 +599,6 @@ var icons = {
   '+zip': 'box.png',
 
   // specific mime type icons
-  'application/font-woff': 'font.png',
   'application/javascript': 'page_white_code_red.png',
   'application/json': 'page_white_code.png',
   'application/msword': 'page_white_word.png',
@@ -493,7 +612,6 @@ var icons = {
   'application/vnd.oasis.opendocument.text': 'page_white_word.png',
   'application/x-7z-compressed': 'box.png',
   'application/x-sh': 'application_xp_terminal.png',
-  'application/x-font-ttf': 'font.png',
   'application/x-msaccess': 'page_white_database.png',
   'application/x-shockwave-flash': 'page_white_flash.png',
   'application/x-sql': 'page_white_database.png',
@@ -547,7 +665,6 @@ var icons = {
   '.map': 'map.png',
   '.msi': 'box.png',
   '.mv4': 'film.png',
-  '.otf': 'font.png',
   '.pdb': 'page_white_database.png',
   '.php': 'page_white_php.png',
   '.pl': 'page_white_code.png',

package.json

@@ -1,23 +1,30 @@
 {
   "name": "serve-index",
   "description": "Serve directory listings",
-  "version": "1.6.1",
+  "version": "1.9.1",
   "author": "Douglas Christopher Wilson <doug@somethingdoug.com>",
   "license": "MIT",
   "repository": "expressjs/serve-index",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/express"
+  },
   "dependencies": {
-    "accepts": "~1.2.3",
+    "accepts": "~1.3.7",
-    "batch": "0.5.2",
+    "batch": "0.6.1",
-    "debug": "~2.1.1",
+    "debug": "2.6.9",
-    "http-errors": "~1.2.8",
+    "escape-html": "~1.0.3",
-    "mime-types": "~2.0.8",
+    "http-errors": "~1.8.0",
-    "parseurl": "~1.3.0"
+    "mime-types": "~2.1.29",
+    "parseurl": "~1.3.3"
   },
   "devDependencies": {
-    "after": "0.8.1",
+    "after": "0.8.2",
-    "istanbul": "0.3.5",
+    "eslint": "7.23.0",
-    "mocha": "~2.1.0",
+    "eslint-plugin-markdown": "2.0.0",
-    "supertest": "~0.15.0"
+    "mocha": "10.4.0",
+    "nyc": "15.1.0",
+    "supertest": "7.0.0"
   },
   "files": [
     "public/",
@@ -29,8 +36,9 @@
     "node": ">= 0.8.0"
   },
   "scripts": {
+    "lint": "eslint .",
     "test": "mocha --reporter spec --bail --check-leaks test/",
-    "test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/",
+    "test-ci": "nyc --reporter=lcov --reporter=text npm test",
-    "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/"
+    "test-cov": "nyc --reporter=html --reporter=text npm test"
   }
 }

public/directory.html

@@ -52,11 +52,11 @@
       }
 
       function search() {
-        var str = $('search').value
+        var str = $('search').value.toLowerCase();
-          , links = $('files').all('a');
+        var links = $('files').all('a');
 
         links.each(function(link){
-          var text = link.textContent;
+          var text = link.textContent.toLowerCase();
 
           if ('..' == text) return;
           if (str.length && ~text.indexOf(str)) {

test/fixtures/users/#dir/tobi.txt

@@ -0,0 +1 @@
+ferret

test/shared/index.js

@@ -1,26 +0,0 @@
-
-var bytes = require('bytes');
-
-exports['default request body'] = function(app){
-  it('should default to {}', function(done){
-    app.request()
-    .post('/')
-    .end(function(res){
-      res.body.should.equal('{}');
-      done();
-    })
-  })
-};
-
-exports['limit body to'] = function(size, type, app){
-  it('should accept a limit option', function(done){
-    app.request()
-    .post('/')
-    .set('Content-Length', bytes(size) + 1)
-    .set('Content-Type', type)
-    .end(function(res){
-      res.should.have.status(413);
-      done();
-    })
-  })
-}

test/test.js

@@ -26,6 +26,15 @@ describe('serveIndex(root)', function () {
       .expect(200, done)
   })
 
+  it('should include security header', function (done) {
+    var server = createServer()
+
+    request(server)
+      .get('/')
+      .expect('X-Content-Type-Options', 'nosniff')
+      .expect(200, done)
+  })
+
   it('should serve a directory index', function (done) {
     var server = createServer()
 
@@ -39,7 +48,9 @@ describe('serveIndex(root)', function () {
 
     request(server)
       .head('/')
-    .expect(200, '', done)
+      .expect(200)
+      .expect(shouldNotHaveBody())
+      .end(done)
   })
 
   it('should work with OPTIONS requests', function (done) {
@@ -67,6 +78,14 @@ describe('serveIndex(root)', function () {
       .expect(400, done)
   })
 
+  it('should deny path that does not decode', function (done) {
+    var server = createServer()
+
+    request(server)
+      .head('/%FF')
+      .expect(400, done)
+  })
+
   it('should deny path outside root', function (done) {
     var server = createServer()
 
@@ -84,11 +103,11 @@ describe('serveIndex(root)', function () {
   })
 
   it('should treat an ENAMETOOLONG as a 414', function (done) {
-    var path = Array(11000).join('foobar')
+    var dir = path.join(fixtures, Array(10000).join('/foobar'))
-    var server = createServer()
+    var server = createServer(dir)
 
     request(server)
-    .get('/' + path)
+      .get('/')
       .expect(414, done)
   })
 
@@ -109,7 +128,7 @@ describe('serveIndex(root)', function () {
           .get('/')
           .set('Accept', 'application/json')
           .expect('Content-Type', /json/)
-        .expect(/g# %3 o %2525 %37 dir/)
+          .expect(/g# %3 o & %2525 %37 dir/)
           .expect(/users/)
           .expect(/file #1\.txt/)
           .expect(/nums/)
@@ -117,6 +136,36 @@ describe('serveIndex(root)', function () {
           .expect(/さくら\.txt/)
           .expect(200, done)
       });
+
+      it('should include security header', function (done) {
+        var server = createServer()
+
+        request(server)
+          .get('/')
+          .set('Accept', 'application/json')
+          .expect('X-Content-Type-Options', 'nosniff')
+          .expect(200, done)
+      })
+
+      it('should sort folders first', function (done) {
+        request(createServer())
+          .get('/')
+          .set('Accept', 'application/json')
+          .expect(200)
+          .expect('Content-Type', 'application/json; charset=utf-8')
+          .expect([
+            '#directory',
+            'collect',
+            'g# %3 o & %2525 %37 dir',
+            'users',
+            'file #1.txt',
+            'foo & bar',
+            'nums',
+            'todo.txt',
+            'さくら.txt'
+          ])
+          .end(done)
+      })
     });
 
     describe('when Accept: text/html is given', function () {
@@ -128,12 +177,36 @@ describe('serveIndex(root)', function () {
           .set('Accept', 'text/html')
           .expect(200)
           .expect('Content-Type', 'text/html; charset=utf-8')
-        .expect(/<a href="\/g%23%20%253%20o%20%252525%20%2537%20dir"/)
+          .expect(/<a href="\/g%23%20%253%20o%20%26%20%252525%20%2537%20dir"/)
           .expect(/<a href="\/users"/)
           .expect(/<a href="\/file%20%231.txt"/)
           .expect(/<a href="\/todo.txt"/)
           .expect(/<a href="\/%E3%81%95%E3%81%8F%E3%82%89\.txt"/)
-        .end(done);
+          .end(done)
+      });
+
+      it('should include security header', function (done) {
+        var server = createServer()
+
+        request(server)
+          .get('/')
+          .set('Accept', 'text/html')
+          .expect('X-Content-Type-Options', 'nosniff')
+          .expect(200, done)
+      })
+
+      it('should property escape file names', function (done) {
+        var server = createServer()
+
+        request(server)
+          .get('/')
+          .set('Accept', 'text/html')
+          .expect(200)
+          .expect('Content-Type', 'text/html; charset=utf-8')
+          .expect(/<a href="\/foo%20%26%20bar"/)
+          .expect(/foo &amp; bar/)
+          .expect(bodyDoesNotContain('foo & bar'))
+          .end(done)
       });
 
       it('should sort folders first', function (done) {
@@ -144,23 +217,23 @@ describe('serveIndex(root)', function () {
           .set('Accept', 'text/html')
           .expect(200)
           .expect('Content-Type', 'text/html; charset=utf-8')
-        .end(function (err, res) {
+          .expect(function (res) {
-          if (err) done(err);
+            var urls = res.text
-          var body = res.text.split('</h1>')[1];
+              .split('</h1>')[1]
-          var urls = body.split(/<a href="([^"]*)"/).filter(function(s, i){ return i%2; });
+              .split(/<a href="([^"]*)"/).filter(function (s, i) { return i % 2 })
             assert.deepEqual(urls, [
               '/%23directory',
               '/collect',
-            '/g%23%20%253%20o%20%252525%20%2537%20dir',
+              '/g%23%20%253%20o%20%26%20%252525%20%2537%20dir',
               '/users',
               '/file%20%231.txt',
-            '/foo%20bar',
+              '/foo%20%26%20bar',
               '/nums',
               '/todo.txt',
               '/%E3%81%95%E3%81%8F%E3%82%89.txt'
-          ]);
+            ])
-          done();
+          })
-        });
+          .end(done)
       });
     });
 
@@ -174,12 +247,43 @@ describe('serveIndex(root)', function () {
           .expect(200)
           .expect('Content-Type', 'text/plain; charset=utf-8')
           .expect(/users/)
-        .expect(/g# %3 o %2525 %37 dir/)
+          .expect(/g# %3 o & %2525 %37 dir/)
           .expect(/file #1.txt/)
           .expect(/todo.txt/)
           .expect(/さくら\.txt/)
-        .end(done);
+          .end(done)
       });
+
+      it('should include security header', function (done) {
+        var server = createServer()
+
+        request(server)
+          .get('/')
+          .set('Accept', 'text/plain')
+          .expect('X-Content-Type-Options', 'nosniff')
+          .expect(200, done)
+      })
+
+      it('should sort folders first', function (done) {
+        request(createServer())
+          .get('/')
+          .set('Accept', 'text/plain')
+          .expect(200)
+          .expect('Content-Type', 'text/plain; charset=utf-8')
+          .expect([
+            '#directory',
+            'collect',
+            'g# %3 o & %2525 %37 dir',
+            'users',
+            'file #1.txt',
+            'foo & bar',
+            'nums',
+            'todo.txt',
+            'さくら.txt',
+            ''
+          ].join('\n'))
+          .end(done)
+      })
     });
 
     describe('when Accept: application/x-bogus is given', function () {
@@ -256,7 +360,7 @@ describe('serveIndex(root)', function () {
     });
 
     it('should filter directory paths', function (done) {
-      var cb = after(3, done)
+      var cb = after(4, done)
       var server = createServer(fixtures, {'filter': filter})
 
       function filter(name, index, list, dir) {
@@ -282,6 +386,7 @@ describe('serveIndex(root)', function () {
         .expect(/icon-default/)
         .expect(/icon-directory/)
         .expect(/icon-image/)
+        .expect(/icon-image-svg_xml/)
         .expect(/icon-txt/)
         .expect(/icon-application-pdf/)
         .expect(/icon-video/)
@@ -290,6 +395,146 @@ describe('serveIndex(root)', function () {
     });
   });
 
+  describe('with "template" option', function () {
+    describe('when setting a custom template file', function () {
+      var server;
+      before(function () {
+        server = createServer(fixtures, {'template': __dirname + '/shared/template.html'});
+      });
+
+      it('should respond with file list', function (done) {
+        request(server)
+          .get('/')
+          .set('Accept', 'text/html')
+          .expect(/<a href="\/g%23%20%253%20o%20%26%20%252525%20%2537%20dir"/)
+          .expect(/<a href="\/users"/)
+          .expect(/<a href="\/file%20%231.txt"/)
+          .expect(/<a href="\/todo.txt"/)
+          .expect(200, done)
+      });
+
+      it('should respond with testing template sentence', function (done) {
+        request(server)
+          .get('/')
+          .set('Accept', 'text/html')
+          .expect(200, /This is the test template/, done)
+      });
+
+      it('should have default styles', function (done) {
+        request(server)
+          .get('/')
+          .set('Accept', 'text/html')
+          .expect(200, /ul#files/, done)
+      });
+
+      it('should list directory twice', function (done) {
+        request(server)
+          .get('/users/')
+          .set('Accept', 'text/html')
+          .expect(function (res) {
+            var occurances = res.text.match(/directory \/users\//g)
+            if (occurances && occurances.length === 2) return
+            throw new Error('directory not listed twice')
+          })
+          .expect(200, done)
+      });
+    });
+
+    describe('when setting a custom template function', function () {
+      it('should invoke function to render', function (done) {
+        var server = createServer(fixtures, {'template': function (locals, callback) {
+          callback(null, 'This is a template.');
+        }});
+
+        request(server)
+          .get('/')
+          .set('Accept', 'text/html')
+          .expect(200, 'This is a template.', done)
+      });
+
+      it('should handle render errors', function (done) {
+        var server = createServer(fixtures, {'template': function (locals, callback) {
+          callback(new Error('boom!'));
+        }});
+
+        request(server)
+          .get('/')
+          .set('Accept', 'text/html')
+          .expect(500, 'boom!', done)
+      });
+
+      it('should provide "directory" local', function (done) {
+        var server = createServer(fixtures, {'template': function (locals, callback) {
+          callback(null, JSON.stringify(locals.directory));
+        }});
+
+        request(server)
+          .get('/users/')
+          .set('Accept', 'text/html')
+          .expect(200, '"/users/"', done)
+      });
+
+      it('should provide "displayIcons" local', function (done) {
+        var server = createServer(fixtures, {'template': function (locals, callback) {
+          callback(null, JSON.stringify(locals.displayIcons));
+        }});
+
+        request(server)
+          .get('/users/')
+          .set('Accept', 'text/html')
+          .expect(200, 'false', done)
+      });
+
+      it('should provide "fileList" local', function (done) {
+        var server = createServer(fixtures, {'template': function (locals, callback) {
+          callback(null, JSON.stringify(locals.fileList.map(function (file) {
+            file.stat = file.stat instanceof fs.Stats;
+            return file;
+          })));
+        }});
+
+        request(server)
+          .get('/users/')
+          .set('Accept', 'text/html')
+          .expect('[{"name":"..","stat":true},{"name":"#dir","stat":true},{"name":"index.html","stat":true},{"name":"tobi.txt","stat":true}]')
+          .expect(200, done)
+      });
+
+      it('should provide "path" local', function (done) {
+        var server = createServer(fixtures, {'template': function (locals, callback) {
+          callback(null, JSON.stringify(locals.path));
+        }});
+
+        request(server)
+          .get('/users/')
+          .set('Accept', 'text/html')
+          .expect(200, JSON.stringify(path.join(fixtures, 'users/')), done)
+      });
+
+      it('should provide "style" local', function (done) {
+        var server = createServer(fixtures, {'template': function (locals, callback) {
+          callback(null, JSON.stringify(locals.style));
+        }});
+
+        request(server)
+          .get('/users/')
+          .set('Accept', 'text/html')
+          .expect(200, /#files \.icon \.name/, done)
+      });
+
+      it('should provide "viewName" local', function (done) {
+        var server = createServer(fixtures, {'template': function (locals, callback) {
+          callback(null, JSON.stringify(locals.viewName));
+        }});
+
+        request(server)
+          .get('/users/')
+          .set('Accept', 'text/html')
+          .expect(200, '"tiles"', done)
+      });
+    });
+  });
+
   describe('when using custom handler', function () {
     describe('exports.html', function () {
       alterProperty(serveIndex, 'html', serveIndex.html)
@@ -434,7 +679,27 @@ describe('serveIndex(root)', function () {
         .expect('Content-Type', 'text/html; charset=utf-8')
         .expect(/<a href="\/users\/index.html"/)
         .expect(/<a href="\/users\/tobi.txt"/)
-      .end(done);
+        .end(done)
+    });
+
+    it('should include link to parent directory', function (done) {
+      var server = createServer()
+
+      request(server)
+        .get('/users')
+        .expect(200)
+        .expect(function (res) {
+          var urls = res.text
+            .split('</h1>')[1]
+            .split(/<a href="([^"]*)"/).filter(function (s, i) { return i % 2 })
+          assert.deepEqual(urls, [
+            '/',
+            '/users/%23dir',
+            '/users/index.html',
+            '/users/tobi.txt'
+          ])
+        })
+        .end(done)
     });
 
     it('should work for directory with #', function (done) {
@@ -447,20 +712,34 @@ describe('serveIndex(root)', function () {
         .expect('Content-Type', 'text/html; charset=utf-8')
         .expect(/<a href="\/%23directory"/)
         .expect(/<a href="\/%23directory\/index.html"/)
-      .end(done);
+        .end(done)
     });
 
     it('should work for directory with special chars', function (done) {
       var server = createServer()
 
       request(server)
-      .get('/g%23%20%253%20o%20%252525%20%2537%20dir/')
+        .get('/g%23%20%253%20o%20%26%20%252525%20%2537%20dir/')
         .set('Accept', 'text/html')
         .expect(200)
         .expect('Content-Type', 'text/html; charset=utf-8')
-      .expect(/<a href="\/g%23%20%253%20o%20%252525%20%2537%20dir"/)
+        .expect(/<a href="\/g%23%20%253%20o%20%26%20%252525%20%2537%20dir"/)
-      .expect(/<a href="\/g%23%20%253%20o%20%252525%20%2537%20dir\/empty.txt"/)
+        .expect(/<a href="\/g%23%20%253%20o%20%26%20%252525%20%2537%20dir\/empty.txt"/)
-      .end(done);
+        .end(done)
+    });
+
+    it('should property escape directory names', function (done) {
+      var server = createServer()
+
+      request(server)
+        .get('/g%23%20%253%20o%20%26%20%252525%20%2537%20dir/')
+        .set('Accept', 'text/html')
+        .expect(200)
+        .expect('Content-Type', 'text/html; charset=utf-8')
+        .expect(/<a href="\/g%23%20%253%20o%20%26%20%252525%20%2537%20dir"/)
+        .expect(/g# %3 o &amp; %2525 %37 dir/)
+        .expect(bodyDoesNotContain('g# %3 o & %2525 %37 dir'))
+        .end(done)
     });
 
     it('should not work for outside root', function (done) {
@@ -469,51 +748,7 @@ describe('serveIndex(root)', function () {
       request(server)
         .get('/../support/')
         .set('Accept', 'text/html')
-      .expect(403, done);
+        .expect(403, done)
-    });
-  });
-
-  describe('when setting a custom template', function () {
-    var server;
-    before(function () {
-      server = createServer(fixtures, {'template': __dirname + '/shared/template.html'});
-    });
-
-    it('should respond with file list', function (done) {
-      request(server)
-      .get('/')
-      .set('Accept', 'text/html')
-      .expect(/<a href="\/g%23%20%253%20o%20%252525%20%2537%20dir"/)
-      .expect(/<a href="\/users"/)
-      .expect(/<a href="\/file%20%231.txt"/)
-      .expect(/<a href="\/todo.txt"/)
-      .expect(200, done)
-    });
-
-    it('should respond with testing template sentence', function (done) {
-      request(server)
-      .get('/')
-      .set('Accept', 'text/html')
-      .expect(200, /This is the test template/, done)
-    });
-
-    it('should have default styles', function (done) {
-      request(server)
-      .get('/')
-      .set('Accept', 'text/html')
-      .expect(200, /ul#files/, done)
-    });
-
-    it('should list directory twice', function (done) {
-      request(server)
-      .get('/users/')
-      .set('Accept', 'text/html')
-      .expect(function (res) {
-        var occurances = res.text.match(/directory \/users\//g)
-        if (occurances && occurances.length === 2) return
-        throw new Error('directory not listed twice')
-      })
-      .expect(200, done)
     });
   });
 
@@ -530,7 +765,7 @@ describe('serveIndex(root)', function () {
         .expect(200)
         .expect('Content-Type', 'text/html; charset=utf-8')
         .expect(/color: #00ff00;/)
-      .end(done);
+        .end(done)
     });
   });
 
@@ -576,7 +811,7 @@ describe('serveIndex(root)', function () {
       request(server)
         .get('/../')
         .set('Accept', 'text/html')
-      .expect(403, done);
+        .expect(403, done)
     });
   });
 });
@@ -611,3 +846,9 @@ function bodyDoesNotContain(text) {
     assert.equal(res.text.indexOf(text), -1)
   }
 }
+
+function shouldNotHaveBody () {
+  return function (res) {
+    assert.ok(res.text === '' || res.text === undefined)
+  }
+}