refactor: update package details and README for migration to pillarjs/send

- I also run the npm run lint:fix command, and I remove all the t.plan calls since that functionality is only available in newer versions of Node.js, and we need to keep Node 18 as the minimum.

Author: bjohansebas

.github/workflows/ci.yml

@@ -62,7 +62,7 @@ jobs:
         run: npm install
 
       - name: Run tests
-        run: npm run test-ci
+        run: npm run test:ci
 
       - name: Upload code coverage
         uses: actions/upload-artifact@v5

README.md

@@ -1,8 +1,9 @@
-# @fastify/send
+# send
 
-[![CI](https://github.com/fastify/send/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/send/actions/workflows/ci.yml)
-[![NPM version](https://img.shields.io/npm/v/@fastify/send.svg?style=flat)](https://www.npmjs.com/package/@fastify/send)
-[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
+[![NPM Version][npm-version-image]][npm-url]
+[![NPM Downloads][npm-downloads-image]][npm-url]
+[![CI][github-actions-ci-image]][github-actions-ci-url]
+[![Test Coverage][coveralls-image]][coveralls-url]
 
 Send is a library for streaming files from the file system as an HTTP response
 supporting partial responses (Ranges), conditional-GET negotiation (If-Match,
@@ -17,7 +18,7 @@ This is a [Node.js](https://nodejs.org/en/) module available through the
 [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
 
 ```bash
-$ npm install @fastify/send
+$ npm install send
 ```
 
 ### TypeScript
@@ -32,7 +33,7 @@ $ npm install -D @types/mime@3
 ## API
 
 ```js
-const send = require('@fastify/send')
+const send = require('send')
 ```
 
 ### send(req, path, [options])
@@ -208,7 +209,7 @@ given directory as the top-level. For example, a request
 ```js
 const http = require('node:http')
 const parseUrl = require('parseurl')
-const send = require('@fastify/send')
+const send = require('send')
 
 const server = http.createServer(async function onRequest (req, res) {
   const { statusCode, headers, stream } = await send(req, parseUrl(req).pathname, { root: '/www/public' })
@@ -224,7 +225,7 @@ server.listen(3000)
 ```js
 const http = require('node:http')
 const parseUrl = require('parseurl')
-const send = require('@fastify/send')
+const send = require('send')
 
 // Default unknown types to text/plain
 send.mime.default_type = 'text/plain'
@@ -252,7 +253,7 @@ custom function to render a listing of a directory.
 const http = require('node:http')
 const fs = require('node:fs')
 const parseUrl = require('parseurl')
-const send = require('@fastify/send')
+const send = require('send')
 
 // Transfer arbitrary files from within /www/example.com/public/*
 // with a custom handler for directory listing
@@ -278,7 +279,7 @@ server.listen(3000)
 ```js
 const http = require('node:http')
 const parseUrl = require('parseurl')
-const send = require('@fastify/send')
+const send = require('send')
 
 const server = http.createServer(async function onRequest (req, res) {
   // transfer arbitrary files from within
@@ -314,4 +315,14 @@ server.listen(3000)
 
 ## License
 
-Licensed under [MIT](./LICENSE).
+[MIT](LICENSE)
+
+[coveralls-image]: https://badgen.net/coveralls/c/github/pillarjs/send/master
+[coveralls-url]: https://coveralls.io/r/pillarjs/send?branch=master
+[github-actions-ci-image]: https://badgen.net/github/checks/pillarjs/send/master?label=linux
+[github-actions-ci-url]: https://github.com/pillarjs/send/actions/workflows/ci.yml
+[node-image]: https://badgen.net/npm/node/send
+[node-url]: https://nodejs.org/en/download/
+[npm-downloads-image]: https://badgen.net/npm/dm/send
+[npm-url]: https://npmjs.org/package/send
+[npm-version-image]: https://badgen.net/npm/v/send

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@fastify/send",
+  "name": "send",
   "description": "Better streaming static file server with Range and conditional-GET support",
-  "version": "4.1.0",
+  "version": "1.2.1",
   "author": "TJ Holowaychuk <tj@vision-media.ca>",
   "contributors": [
     "Douglas Christopher Wilson <doug@somethingdoug.com>",
@@ -24,25 +24,25 @@
   "main": "index.js",
   "type": "commonjs",
   "types": "types/index.d.ts",
+  "files": [
+    "LICENSE",
+    "index.js",
+    "lib/",
+    "types"
+  ],
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/fastify/send.git"
+    "url": "git+https://github.com/pillarjs/send.git"
   },
   "bugs": {
-    "url": "https://github.com/fastify/send/issues"
+    "url": "https://github.com/pillarjs/send/issues"
+  },
+  "homepage": "https://github.com/pillarjs/send#readme",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/express"
   },
-  "homepage": "https://github.com/fastify/send#readme",
-  "funding": [
-    {
-      "type": "github",
-      "url": "https://github.com/sponsors/fastify"
-    },
-    {
-      "type": "opencollective",
-      "url": "https://opencollective.com/fastify"
-    }
-  ],
   "keywords": [
     "static",
     "file",
@@ -69,8 +69,12 @@
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "test": "npm run test:unit && npm run test:typescript",
+    "test:ci": "c8 --reporter=lcovonly --reporter=text npm test",
     "test:coverage": "c8 --reporter html node --test",
     "test:typescript": "tsd",
     "test:unit": "c8 --100 node --test"
+  },
+  "engines": {
+    "node": ">= 18"
   }
 }

scripts/version-history.js

@@ -1,14 +1,14 @@
 'use strict'
 
-var fs = require('fs')
-var path = require('path')
+const fs = require('fs')
+const path = require('path')
 
-var HISTORY_FILE_PATH = path.join(__dirname, '..', 'HISTORY.md')
-var MD_HEADER_REGEXP = /^====*$/
-var VERSION = process.env.npm_package_version
-var VERSION_PLACEHOLDER_REGEXP = /^(?:unreleased|(\d+\.)+x)$/
+const HISTORY_FILE_PATH = path.join(__dirname, '..', 'HISTORY.md')
+const MD_HEADER_REGEXP = /^====*$/
+const VERSION = process.env.npm_package_version
+const VERSION_PLACEHOLDER_REGEXP = /^(?:unreleased|(\d+\.)+x)$/
 
-var historyFileLines = fs.readFileSync(HISTORY_FILE_PATH, 'utf-8').split('\n')
+const historyFileLines = fs.readFileSync(HISTORY_FILE_PATH, 'utf-8').split('\n')
 
 if (!MD_HEADER_REGEXP.test(historyFileLines[1])) {
   console.error('Missing header in HISTORY.md')
@@ -21,7 +21,7 @@ if (!VERSION_PLACEHOLDER_REGEXP.test(historyFileLines[0])) {
 }
 
 if (historyFileLines[0].indexOf('x') !== -1) {
-  var versionCheckRegExp = new RegExp('^' + historyFileLines[0].replace('x', '.+') + '$')
+  const versionCheckRegExp = new RegExp('^' + historyFileLines[0].replace('x', '.+') + '$')
 
   if (!versionCheckRegExp.test(VERSION)) {
     console.error('Version %s does not match placeholder %s', VERSION, historyFileLines[0])
@@ -35,25 +35,25 @@ historyFileLines[1] = repeat('=', historyFileLines[0].length)
 fs.writeFileSync(HISTORY_FILE_PATH, historyFileLines.join('\n'))
 
 function getLocaleDate () {
-  var now = new Date()
+  const now = new Date()
 
   return zeroPad(now.getFullYear(), 4) + '-' +
     zeroPad(now.getMonth() + 1, 2) + '-' +
     zeroPad(now.getDate(), 2)
 }
 
 function repeat (str, length) {
-  var out = ''
+  let out = ''
 
-  for (var i = 0; i < length; i++) {
+  for (let i = 0; i < length; i++) {
     out += str
   }
 
   return out
 }
 
 function zeroPad (number, length) {
-  var num = number.toString()
+  let num = number.toString()
 
   while (num.length < length) {
     num = '0' + num

test/collapseLeadingSlashes.test.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { test } = require('node:test')
+const assert = require('node:assert')
 const { collapseLeadingSlashes } = require('../lib/collapseLeadingSlashes')
 
 test('collapseLeadingSlashes', function (t) {
@@ -14,9 +15,8 @@ test('collapseLeadingSlashes', function (t) {
     ['//./text/json', '/./text/json'],
     ['///./text/json', '/./text/json']
   ]
-  t.plan(testCases.length)
 
   for (const testCase of testCases) {
-    t.assert.deepStrictEqual(collapseLeadingSlashes(testCase[0]), testCase[1])
+    assert.deepStrictEqual(collapseLeadingSlashes(testCase[0]), testCase[1])
   }
 })

test/containsDotFile.test.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { test } = require('node:test')
+const assert = require('node:assert')
 const { containsDotFile } = require('../lib/containsDotFile')
 
 test('containsDotFile', function (t) {
@@ -10,9 +11,8 @@ test('containsDotFile', function (t) {
     ['index.html', false],
     ['./index.html', false]
   ]
-  t.plan(testCases.length)
 
   for (const testCase of testCases) {
-    t.assert.deepStrictEqual(containsDotFile(testCase[0].split('/')), testCase[1], testCase[0])
+    assert.deepStrictEqual(containsDotFile(testCase[0].split('/')), testCase[1], testCase[0])
   }
 })

test/isUtf8MimeType.test.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { test } = require('node:test')
+const assert = require('node:assert')
 const { isUtf8MimeType } = require('../lib/isUtf8MimeType')
 
 test('isUtf8MimeType', function (t) {
@@ -14,9 +15,8 @@ test('isUtf8MimeType', function (t) {
     ['text/html', true],
     ['image/png', false]
   ]
-  t.plan(testCases.length)
 
   for (const testCase of testCases) {
-    t.assert.deepStrictEqual(isUtf8MimeType(testCase[0], 'test'), testCase[1])
+    assert.deepStrictEqual(isUtf8MimeType(testCase[0], 'test'), testCase[1])
   }
 })

test/mime.test.js

@@ -1,25 +1,21 @@
 'use strict'
 
-const { test } = require('node:test')
+const { test, before } = require('node:test')
 const path = require('node:path')
 const request = require('supertest')
+const assert = require('node:assert')
 const send = require('..')
 const { shouldNotHaveHeader, createServer } = require('./utils')
 
 const fixtures = path.join(__dirname, 'fixtures')
 
 test('send.mime', async function (t) {
-  t.plan(2)
-
   await t.test('should be exposed', function (t) {
-    t.plan(1)
-    t.assert.ok(send.mime)
+    assert.ok(send.mime)
   })
 
   await t.test('.default_type', async function (t) {
-    t.plan(3)
-
-    t.before(() => {
+    before(() => {
       this.default_type = send.mime.default_type
     })
 
@@ -37,7 +33,6 @@ test('send.mime', async function (t) {
     })
 
     await t.test('should not add Content-Type for undefined default', async function (t) {
-      t.plan(1)
       send.mime.default_type = undefined
 
       await request(createServer({ root: fixtures }))

test/normalizeList.test.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { test } = require('node:test')
+const assert = require('node:assert')
 const { normalizeList } = require('../lib/normalizeList')
 
 test('normalizeList', function (t) {
@@ -16,13 +17,12 @@ test('normalizeList', function (t) {
     [1, new TypeError('test must be array of strings or false')],
     [[1], new TypeError('test must be array of strings or false')]
   ]
-  t.plan(testCases.length)
 
   for (const testCase of testCases) {
     if (testCase[1] instanceof Error) {
-      t.assert.throws(() => normalizeList(testCase[0], 'test'), testCase[1])
+      assert.throws(() => normalizeList(testCase[0], 'test'), testCase[1])
     } else {
-      t.assert.deepStrictEqual(normalizeList(testCase[0], 'test'), testCase[1])
+      assert.deepStrictEqual(normalizeList(testCase[0], 'test'), testCase[1])
     }
   }
 })