Refactor package to TypeScript (#93)

Author: Phillip9587

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+quote_type = single

.eslintignore

@@ -1,241 +1,26 @@
-name: ci
-
+name: CI
 on:
-- pull_request
-- push
-
+  - push
+  - pull_request
 permissions:
   contents: read
-
 jobs:
   test:
-    permissions:
-      checks: write  # for coverallsapp/github-action to create new checks
-      contents: read  # for actions/checkout to fetch code
+    name: Node.js ${{ matrix.node-version }}
     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
-        - Node.js 25.x
-
-        include:
-        - name: Node.js 0.8
-          node-version: "0.8"
-          npm-i: mocha@2.5.3
-          npm-rm: nyc
-
-        - name: Node.js 0.10
-          node-version: "0.10"
-          npm-i: mocha@3.5.3 nyc@10.3.2
-
-        - name: Node.js 0.12
-          node-version: "0.12"
-          npm-i: mocha@3.5.3 nyc@10.3.2
-
-        - name: io.js 1.x
-          node-version: "1.8"
-          npm-i: mocha@3.5.3 nyc@10.3.2
-
-        - name: io.js 2.x
-          node-version: "2.5"
-          npm-i: mocha@3.5.3 nyc@10.3.2
-
-        - name: io.js 3.x
-          node-version: "3.3"
-          npm-i: mocha@3.5.3 nyc@10.3.2
-
-        - name: Node.js 4.x
-          node-version: "4.9"
-          npm-i: mocha@5.2.0 nyc@11.9.0
-
-        - name: Node.js 5.x
-          node-version: "5.12"
-          npm-i: mocha@5.2.0 nyc@11.9.0
-
-        - name: Node.js 6.x
-          node-version: "6.17"
-          npm-i: mocha@6.2.2 nyc@14.1.1
-
-        - name: Node.js 7.x
-          node-version: "7.10"
-          npm-i: mocha@6.2.2 nyc@14.1.1
-
-        - name: Node.js 8.x
-          node-version: "8.17"
-          npm-i: mocha@7.1.2 nyc@14.1.1
-
-        - name: Node.js 9.x
-          node-version: "9.11"
-          npm-i: mocha@7.1.2 nyc@14.1.1
-
-        - name: Node.js 10.x
-          node-version: "10.24"
-          npm-i: mocha@8.4.0
-
-        - name: Node.js 11.x
-          node-version: "11.15"
-          npm-i: mocha@8.4.0
-
-        - name: Node.js 12.x
-          node-version: "12.22"
-          npm-i: mocha@9.2.2
-
-        - name: Node.js 13.x
-          node-version: "13.14"
-          npm-i: mocha@9.2.2
-
-        - name: Node.js 14.x
-          node-version: "14.21"
-
-        - name: Node.js 15.x
-          node-version: "15.14"
-
-        - name: Node.js 16.x
-          node-version: "16.20"
-
-        - name: Node.js 17.x
-          node-version: "17.9"
-
-        - name: Node.js 18.x
-          node-version: "18.20"
-
-        - name: Node.js 19.x
-          node-version: "19.9"
-
-        - name: Node.js 20.x
-          node-version: "20.13"
-
-        - name: Node.js 21.x
-          node-version: "21.7"
-
-        - name: Node.js 22.x
-          node-version: "22.1"
-
-        - name: Node.js 23.x
-          node-version: "23"
-
-        - name: Node.js 24.x
-          node-version: "24"
-
-        - name: Node.js 25.x
-          node-version: "25"
-
+        node-version:
+          - 18
+          - '*'
     steps:
-    - uses: actions/checkout@v6
-
-    - 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 }}
-      run: npm rm --silent --save-dev ${{ matrix.npm-rm }}
-      if: matrix.npm-rm != ''
-
-    - name: Install npm module(s) ${{ matrix.npm-i }}
-      run: npm install --save-dev ${{ matrix.npm-i }}
-      if: 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@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@master
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        parallel-finished: true
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test
+      - uses: codecov/codecov-action@v5
+        with:
+          name: Node.js ${{ matrix.node-version }}
+          token: ${{ secrets.CODECOV_TOKEN }}

.eslintrc.yml

@@ -2,3 +2,5 @@ coverage
 node_modules
 npm-debug.log
 package-lock.json
+dist/
+*.tsbuildinfo

.github/workflows/ci.yml

@@ -1,52 +1,43 @@
-2.0.1 / 2018-09-19
-==================
+# 2.0.1 / 2018-09-19
 
-  * deps: safe-buffer@5.1.2
+- deps: safe-buffer@5.1.2
 
-2.0.0 / 2017-09-12
-==================
+# 2.0.0 / 2017-09-12
 
-  * Drop support for Node.js below 0.8
-  * Remove `auth(ctx)` signature -- pass in header or `auth(ctx.req)`
-  * Use `safe-buffer` for improved Buffer API
+- Drop support for Node.js below 0.8
+- Remove `auth(ctx)` signature -- pass in header or `auth(ctx.req)`
+- Use `safe-buffer` for improved Buffer API
 
-1.1.0 / 2016-11-18
-==================
+# 1.1.0 / 2016-11-18
 
-  * Add `auth.parse` for low-level string parsing
+- Add `auth.parse` for low-level string parsing
 
-1.0.4 / 2016-05-10
-==================
+# 1.0.4 / 2016-05-10
 
-  * Improve error message when `req` argument is not an object
-  * Improve error message when `req` missing `headers` property
+- Improve error message when `req` argument is not an object
+- Improve error message when `req` missing `headers` property
 
-1.0.3 / 2015-07-01
-==================
+# 1.0.3 / 2015-07-01
 
-  * Fix regression accepting a Koa context
+- Fix regression accepting a Koa context
 
-1.0.2 / 2015-06-12
-==================
+# 1.0.2 / 2015-06-12
 
-  * Improve error message when `req` argument missing
-  * perf: enable strict mode
-  * perf: hoist regular expression
-  * perf: parse with regular expressions
-  * perf: remove argument reassignment
+- Improve error message when `req` argument missing
+- perf: enable strict mode
+- perf: hoist regular expression
+- perf: parse with regular expressions
+- perf: remove argument reassignment
 
-1.0.1 / 2015-05-04
-==================
+# 1.0.1 / 2015-05-04
 
-  * Update readme
+- Update readme
 
-1.0.0 / 2014-07-01
-==================
+# 1.0.0 / 2014-07-01
 
-  * Support empty password
-  * Support empty username
+- Support empty password
+- Support empty username
 
-0.0.1 / 2013-11-30
-==================
+# 0.0.1 / 2013-11-30
 
-  * Initial release
+- Initial release