fix: bump deps, rewrite, added mime-types, rewrote isHidden with findIndex for performance

Author: titanism

.commitlintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional']
+};

.eslintignore

@@ -0,0 +1 @@
+!.*.js

.gitattributes

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

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        node_version:
+          - 18
+    name: Node ${{ matrix.node_version }} on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node_version }}
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm run test

.gitignore

@@ -4,3 +4,12 @@
 node_modules
 coverage
 .nyc_output
+locales/
+package-lock.json
+yarn.lock
+
+Thumbs.db
+tmp/
+temp/
+*.lcov
+.env

.lintstagedrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  "*.md": filenames => filenames.map(filename => `remark ${filename} -qfo`),
+  'package.json': 'fixpack',
+  '*.js': 'xo --fix'
+};

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  singleQuote: true,
+  bracketSpacing: true,
+  trailingComma: 'none'
+};

.remarkignore

@@ -0,0 +1 @@
+test/snapshots/**/*.md

.remarkrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  plugins: ['preset-github']
+};

.travis.yml

@@ -0,0 +1,5 @@
+module.exports = {
+  prettier: true,
+  space: true,
+  extends: ['xo-lass']
+};

.xo-config.js

@@ -1,7 +1,6 @@
 # [**@ladjs/koa-better-static**](https://github.com/ladjs/koa-better-static)
 
-[![build status](https://img.shields.io/travis/ladjs/koa-better-static.svg)](https://travis-ci.com/ladjs/koa-better-static)
-[![code coverage](https://img.shields.io/codecov/c/github/ladjs/koa-better-static.svg)](https://codecov.io/gh/ladjs/koa-better-static)
+[![build status](https://github.com/ladjs/koa-better-static/actions/workflows/ci.yml/badge.svg)](https://github.com/ladjs/koa-better-static/actions/workflows/ci.yml)
 [![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
@@ -30,6 +29,8 @@ Our package `@ladjs/koa-better-static` is a high-performance, drop-in replacemen
 * Removal of `gzip` option (which checks for .gz files)
 * Removal of `defer` (if you want this behavior, put the middleware at the end)
 * No default `index` file
+* Faster performance with `findIndex` hidden file lookup
+* Properly sets `Content-Type` header using `mime-types`
 
 
 ## Install
@@ -40,12 +41,6 @@ Our package `@ladjs/koa-better-static` is a high-performance, drop-in replacemen
 npm install @ladjs/koa-better-static
 ```
 
-[yarn][]:
-
-```sh
-yarn add @ladjs/koa-better-static
-```
-
 
 ## Usage
 
@@ -92,8 +87,6 @@ app.listen(3000, () => {
 [MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)
 
 
-## 
+##
 
 [npm]: https://www.npmjs.com/
-
-[yarn]: https://yarnpkg.com/

README.md

@@ -0,0 +1,3 @@
+module.exports = {
+  files: ['test/*.js', 'test/**/*.js']
+};

ava.config.js

@@ -1,4 +1,4 @@
-const { normalize, resolve, parse, sep } = require('path');
+const { normalize, resolve, parse, sep } = require('node:path');
 const resolvePath = require('resolve-path');
 const debug = require('debug')('@ladjs/koa-better-static');
 const send = require('./send');
@@ -35,17 +35,17 @@ function serve(root, opts = {}) {
   // Options
   debug('static "%s" %j', root, opts);
 
-  return async function(ctx, next) {
+  return async function (ctx, next) {
     if (ctx.method === 'HEAD' || ctx.method === 'GET') {
-      let path = ctx.path.substr(parse(ctx.path).root.length);
+      let path = ctx.path.slice(parse(ctx.path).root.length);
       try {
         path = decodeURIComponent(path);
-      } catch (err) {
+      } catch {
         ctx.throw('Could not decode path', 400);
         return;
       }
 
-      if (options.index && ctx.path[ctx.path.length - 1] === '/') {
+      if (options.index && ctx.path.at(-1) === '/') {
         path += options.index;
       }
 
@@ -59,17 +59,21 @@ function serve(root, opts = {}) {
         return;
       }
     }
+
     return next();
   };
 }
 
-// TODO: this can be sped up, with an findIndexOf loop
 function isHidden(root, path) {
-  path = path.substr(root.length).split(sep);
+  path = path.slice(root.length).split(sep);
+  // optimized with `findIndex`
+  /*
   for (let i = 0; i < path.length; i++) {
     if (path[i][0] === '.') {
       return true;
     }
   }
   return false;
+  */
+  return path.findIndex((segment) => segment[0] === '.') !== -1;
 }

index.js

@@ -3,59 +3,44 @@
   "description": "Static file serving middleware for koa",
   "version": "2.0.1",
   "author": "Nick Baugh <[email protected]> (http://niftylettuce.com/)",
-  "ava": {
-    "failFast": true,
-    "verbose": true
-  },
   "bugs": {
     "url": "https://github.com/ladjs/koa-better-static/issues",
     "email": "[email protected]"
   },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
   "contributors": [
     "Nick Baugh <[email protected]> (http://niftylettuce.com/)"
   ],
   "dependencies": {
     "debug": "*",
+    "mime-types": "^2.1.35",
     "resolve-path": "^1.4.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^7.2.1",
-    "@commitlint/config-conventional": "^7.1.2",
-    "ava": "^1.0.1",
-    "codecov": "^3.1.0",
-    "cross-env": "^5.2.0",
-    "eslint": "^5.12.0",
-    "eslint-config-xo-lass": "^1.0.3",
-    "fixpack": "^2.3.1",
-    "husky": "^1.3.1",
-    "koa": "^2.6.2",
+    "@commitlint/cli": "^19.7.1",
+    "@commitlint/config-conventional": "^19.7.1",
+    "ava": "^5.2.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.55.0",
+    "eslint-config-xo-lass": "^2.0.1",
+    "fixpack": "^4.0.0",
+    "husky": "^9.1.7",
+    "koa": "^2.16.0",
     "koa-mount": "^4.0.0",
-    "lint-staged": "^8.1.0",
-    "nyc": "^13.1.0",
-    "remark-cli": "^6.0.1",
-    "remark-preset-github": "^0.0.13",
-    "supertest": "^3.3.0",
-    "xo": "^0.23.0"
+    "lint-staged": "^15.4.3",
+    "nyc": "^17.1.0",
+    "remark-cli": "11.0.0",
+    "remark-preset-github": "^4.0.4",
+    "supertest": "^7.0.0",
+    "xo": "0.56.0"
   },
   "engines": {
-    "node": ">=8.3"
+    "node": ">=18"
   },
   "files": [
     "index.js",
     "send.js"
   ],
   "homepage": "https://github.com/ladjs/koa-better-static",
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged && npm test",
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-    }
-  },
   "keywords": [
     "assets",
     "file",
@@ -70,50 +55,17 @@
     "static-serve"
   ],
   "license": "MIT",
-  "lint-staged": {
-    "linters": {
-      "*.js": [
-        "xo --fix",
-        "git add"
-      ],
-      "*.md": [
-        "remark . -qfo",
-        "git add"
-      ],
-      "package.json": [
-        "fixpack",
-        "git add"
-      ]
-    }
-  },
   "main": "index.js",
-  "prettier": {
-    "singleQuote": true,
-    "bracketSpacing": true,
-    "trailingComma": "none"
-  },
-  "remarkConfig": {
-    "plugins": [
-      "preset-github"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/ladjs/koa-better-static"
   },
   "scripts": {
     "ava": "cross-env NODE_ENV=test ava",
-    "coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
-    "lint": "xo && remark . -qfo",
+    "lint": "xo --fix && remark . -qfo && fixpack",
     "nyc": "cross-env NODE_ENV=test nyc ava",
-    "test": "npm run lint && npm run ava",
-    "test-coverage": "npm run lint && npm run nyc"
-  },
-  "xo": {
-    "prettier": true,
-    "space": true,
-    "extends": [
-      "xo-lass"
-    ]
+    "prepare": "husky install",
+    "pretest": "npm run lint",
+    "test": "npm run nyc"
   }
 }

package.json

@@ -1,32 +1,10 @@
-const { extname } = require('path');
-const fs = require('fs');
+const fs = require('node:fs');
+const { extname } = require('node:path');
+const mime = require('mime-types');
 const debug = require('debug')('@ladjs/koa-better-static:send');
 
 module.exports = send;
 
-/**
- * Send file at `path` with the
- * given `options` to the koa `ctx`.
- *
- * @param {Context} ctx
- * @param {String} root
- * @param {String} path
- * @param {Object} [opts]
- * @return {Function}
- * @api public
- */
-
-function stat(path) {
-  return new Promise((resolve, reject) => {
-    fs.stat(path, (err, data) => {
-      if (err) {
-        return reject(err);
-      }
-      resolve(data);
-    });
-  });
-}
-
 async function send(ctx, path, opts) {
   if (typeof ctx !== 'object') throw new Error('`ctx` is required');
   if (typeof path !== 'string') throw new Error('`path` is required');
@@ -39,12 +17,13 @@ async function send(ctx, path, opts) {
   // Stat
   let stats;
   try {
-    stats = await stat(path);
+    stats = await fs.promises.stat(path);
   } catch (err) {
     const notfound = ['ENOENT', 'ENAMETOOLONG', 'ENOTDIR'];
-    if (notfound.indexOf(err.code) !== -1) {
+    if (notfound.includes(err.code)) {
       return;
     }
+
     err.status = 500;
     throw err;
   }
@@ -55,12 +34,13 @@ async function send(ctx, path, opts) {
   if (stats.isDirectory()) {
     if (format && index) {
       path += '/' + index;
-      stats = await stat(path);
+      stats = await fs.promises.stat(path);
     } else {
       return;
     }
   }
 
+  // eslint-disable-next-line no-bitwise,unicorn/prefer-math-trunc
   ctx.set('Cache-Control', 'max-age=' + ((maxage / 1000) | 0));
 
   // Check if we can return a cache hit
@@ -81,7 +61,8 @@ async function send(ctx, path, opts) {
   // Stream
   ctx.set('Last-Modified', stats.mtime.toUTCString());
   ctx.set('Content-Length', stats.size);
-  ctx.type = extname(path);
+
+  if (!ctx.type) ctx.type = mime.contentType(extname(path));
   ctx.body = fs.createReadStream(path);
 
   return path;