feat: re-write @koa/send with typescript (#147)

* chore: sync history.md

* feat: re-write with ts

* setup: setup build and linter

* feat: improve code structure

* feat: add github actions over travis ci

* chore: fix linter

* fix: fix typo any in the code

Author: 3imed-jaberi

.eslintrc

@@ -0,0 +1,25 @@
+name: Continuous Integration
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - 16
+          - 18
+          - 20
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+      - name: Install dependencies
+        run: yarn install
+      - name: Check linter
+        run: yarn lint
+      - name: Run tests
+        run: yarn test-ci

.github/workflows/ci.yml

@@ -14,6 +14,7 @@ package-lock.json
 npm-debug.log
 yarn-debug.log
 yarn-error.log
+yarn.lock
 
 
 #       NYC       #

.gitignore

@@ -0,0 +1,24 @@
+{
+  "prettier": true,
+  "space": true,
+  "extends": ["xo-lass"],
+  "rules": {
+    "no-await-in-loop": "off",
+    "node/no-deprecated-api": "off",
+    "no-unused-vars": "off",
+    "no-prototype-builtins": "off",
+    "prefer-rest-params": "off",
+    "n/prefer-global/process": "off",
+    "unicorn/prefer-math-trunc": "off",
+    "no-bitwise": "off",
+    "@typescript-eslint/restrict-template-expressions": "off",
+    "@typescript-eslint/naming-convention": "off",
+    "@typescript-eslint/prefer-nullish-coalescing": "off",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unsafe-call": "off",
+    "@typescript-eslint/no-unsafe-argument": "off",
+    "@typescript-eslint/no-throw-literal": "off",
+    "unicorn/no-array-reduce": "off"
+  },
+  "ignores": ["test/**", "examples/**"]
+}

.npmrc

@@ -1,3 +1,16 @@
+5.0.1 / 2020-07-08
+==================
+
+ * Replace mz with custom promisified wrappers (#140)
+ * fix(jsdoc): send return type (#141)
+ * fix extensions options on windows machines (#79) (#122)
+ * Revert "Using RegExp replace loop in isPathHidden (#109)" (#138)
+ * Using RegExp replace loop in isPathHidden (#109)
+ * Clean up / Pipeline update ... (#135)
+ * Update .travis.yml
+ * Fix Tests & coverage (#132)
+ * Fix license (#134)
+ * travis: add node@11
 
 5.0.0 / 2018-06-19
 ==================

.travis.yml

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2020 Koa contributors
+Copyright (c) 2020 Koa.js contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

.xo-config.json

@@ -1,109 +1,101 @@
-# [**koa-send**](https://github.com/koajs/send)
+# [**@koa/send**](https://github.com/koajs/send)
 
->  Static file serving middleware.
 
 [![NPM version][npm-image]][npm-url]
-[![Build status][travis-image]][travis-url]
+![Build Status][github-action-image]
 [![Test coverage][coveralls-image]][coveralls-url]
-[![Dependency Status][david-image]][david-url]
 [![License][license-image]][license-url]
+[![Node Version][node-image]][node-url]
 [![Downloads][downloads-image]][downloads-url]
 
+[npm-image]: https://img.shields.io/npm/v/@koa/send.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@koa/send
+[github-action-image]: https://github.com/koajs/send/actions/workflows/ci.yml/badge.svg?style=flat-square
+[coveralls-image]: https://img.shields.io/coveralls/koajs/send.svg?style=flat-square
+[coveralls-url]: https://coveralls.io/r/koajs/send?branch=master
+[license-image]: http://img.shields.io/npm/l/koa-send.svg?style=flat-square
+[license-url]: LICENSE
+[downloads-image]: http://img.shields.io/npm/dm/koa-send.svg?style=flat-square
+[downloads-url]: https://npmjs.org/package/koa-send
+
+Koa static file serving middleware.
+
+## Install
 
-## Installation
+[![NPM](https://nodei.co/npm/@koa/send.png?downloads=true)](https://nodei.co/npm/@koa/send)
 
 ```js
-$ npm install koa-send
+$ npm i @koa/send
 ```
 
-
 ## Options
 
- - `maxage` Browser cache max-age in milliseconds. (defaults to `0`).
- - `immutable` Tell the browser the resource is immutable and can be cached indefinitely. (defaults to `false`).
- - `hidden` Allow transfer of hidden files. (defaults to `false`).
- - [`root`](#root-path) Root directory to restrict file access.
- - `index` Name of the index file to serve automatically when visiting the root location. (defaults to none).
- - `gzip` Try to serve the gzipped version of a file automatically when `gzip` is supported by a client and if the requested file with `.gz` extension exists. (defaults to `true`).
- - `brotli` Try to serve the brotli version of a file automatically when `brotli` is supported by a client and if the requested file with `.br` extension exists. (defaults to `true`).
- - `format` If not `false` (defaults to `true`), format the path to serve static file servers and not require a trailing slash for directories, so that you can do both `/directory` and `/directory/`.
- - [`setHeaders`](#setheaders) Function to set custom headers on response.
- - `extensions` Try to match extensions from passed array to search for file when no extension is sufficed in URL. First found is served. (defaults to `false`)
+- `maxage` Browser cache max-age in milliseconds. (defaults to `0`).
+- `immutable` Tell the browser the resource is immutable and can be cached indefinitely. (defaults to `false`).
+- `hidden` Allow transfer of hidden files. (defaults to `false`).
+- [`root`](#root-path) Root directory to restrict file access.
+- `index` Name of the index file to serve automatically when visiting the root location. (defaults to none).
+- `gzip` Try to serve the gzipped version of a file automatically when `gzip` is supported by a client and if the requested file with `.gz` extension exists. (defaults to `true`).
+- `brotli` Try to serve the brotli version of a file automatically when `brotli` is supported by a client and if the requested file with `.br` extension exists. (defaults to `true`).
+- `format` If not `false` (defaults to `true`), format the path to serve static file servers and not require a trailing slash for directories, so that you can do both `/directory` and `/directory/`.
+- [`setHeaders`](#setheaders) Function to set custom headers on response.
+- `extensions` Try to match extensions from passed array to search for file when no extension is sufficed in URL. First found is served. (defaults to `false`)
 
 ### Root path
 
-  Note that `root` is required, defaults to `''` and will be resolved,
-  removing the leading `/` to make the path relative and this
-  path must not contain "..", protecting developers from
-  concatenating user input. If you plan on serving files based on
-  user input supply a `root` directory from which to serve from.
+Note that `root` is required, defaults to `''` and will be resolved,
+removing the leading `/` to make the path relative and this
+path must not contain "..", protecting developers from
+concatenating user input. If you plan on serving files based on
+user input supply a `root` directory from which to serve from.
 
-  For example to serve files from `./public`:
+For example to serve files from `./public`:
 
 ```js
 app.use(async (ctx) => {
-  await send(ctx, ctx.path, { root: __dirname + '/public' });
-})
+  await send(ctx, ctx.path, { root: __dirname + "/public" });
+});
 ```
 
-  To serve developer specified files:
+To serve developer specified files:
 
 ```js
 app.use(async (ctx) => {
-  await send(ctx, 'path/to/my.js');
-})
+  await send(ctx, "path/to/my.js");
+});
 ```
 
 ### setHeaders
 
 The function is called as `fn(res, path, stats)`, where the arguments are:
-* `res`: the response object.
-* `path`: the resolved file path that is being sent.
-* `stats`: the stats object of the file that is being sent.
+
+- `res`: the response object.
+- `path`: the resolved file path that is being sent.
+- `stats`: the stats object of the file that is being sent.
 
 You should only use the `setHeaders` option when you wish to edit the `Cache-Control` or `Last-Modified` headers, because doing it before is useless (it's overwritten by `send`), and doing it after is too late because the headers are already sent.
 
 If you want to edit any other header, simply set them before calling `send`.
 
-
 ## Example
 
 ```js
-const send = require('koa-send');
-const Koa = require('koa');
+const send = require("koa-send");
+const Koa = require("koa");
 const app = new Koa();
 
 // $ GET /package.json
 // $ GET /
 
 app.use(async (ctx) => {
-  if ('/' == ctx.path) return ctx.body = 'Try GET /package.json';
+  if ("/" == ctx.path) return (ctx.body = "Try GET /package.json");
   await send(ctx, ctx.path);
-})
+});
 
 app.listen(3000);
-console.log('listening on port 3000');
+console.log("listening on port 3000");
 ```
 
-
 ## License
 
 [MIT](/LICENSE)
-
-
-[npm-image]: https://img.shields.io/npm/v/koa-send.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/koa-send
-[github-tag]: http://img.shields.io/github/tag/koajs/send.svg?style=flat-square
-[github-url]: https://github.com/koajs/send/tags
-[travis-image]: https://img.shields.io/travis/koajs/send.svg?style=flat-square
-[travis-url]: https://travis-ci.org/koajs/send
-[coveralls-image]: https://img.shields.io/coveralls/koajs/send.svg?style=flat-square
-[coveralls-url]: https://coveralls.io/r/koajs/send?branch=master
-[david-image]: http://img.shields.io/david/koajs/send.svg?style=flat-square
-[david-url]: https://david-dm.org/koajs/send
-[license-image]: http://img.shields.io/npm/l/koa-send.svg?style=flat-square
-[license-url]: LICENSE
-[downloads-image]: http://img.shields.io/npm/dm/koa-send.svg?style=flat-square
-[downloads-url]: https://npmjs.org/package/koa-send
-[gittip-image]: https://img.shields.io/gittip/jonathanong.svg?style=flat-square
-[gittip-url]: https://www.gittip.com/jonathanong/