feat: alignment 📐

Author: bricss

.mocharc.yml

@@ -1,3 +1,5 @@
+exit: true
 ignore:
   - test/**/fixtures/**
 require: test/fixtures/index.mjs
+recursive: true

README.md

@@ -130,7 +130,7 @@ console.log(res.body);
   * `h2` **{boolean}** `Default: false` Forces use of the HTTP2 protocol
   * `headers` **{Object}** Headers to add to the request
   * `parse` **{boolean}** `Default: true` Parse response body, or simply return a buffer
-  * `redirect` **{boolean | error | follow}** `Default: 'follow'` Controls redirect flow
+  * `redirect` **{error | follow | manual}** `Default: 'follow'` Controls redirect flow
   * `thenable` **{boolean}** `Default: false` Controls promise resolutions
 * **Returns:** Promise that resolves to
   extended [http.IncomingMessage](https://nodejs.org/api/http.html#http_class_http_incomingmessage)
@@ -168,6 +168,7 @@ Method with limited functionality to use with streams and pipes
 * No automata
 * No redirects
 * Pass `h2: true` in options to use the HTTP2 protocol
+  * Or use `ackn({ url: URL })` method in advance to probe the available protocols
 
 ---
 

package-lock.json

@@ -13,8 +13,8 @@
     "@babel/eslint-parser": "^7.16.5",
     "@babel/preset-env": "^7.16.11",
     "c8": "^7.11.0",
-    "eslint": "^8.7.0",
-    "eslint-config-ultra-refined": "^2.3.0",
+    "eslint": "^8.8.0",
+    "eslint-config-ultra-refined": "^2.4.0",
     "mocha": "^9.2.0"
   },
   "description": "The robust request library that humanity deserves 🌐",
@@ -56,8 +56,9 @@
     "lint": "eslint . --ext .cjs,.js,.mjs",
     "prepack": "npm run build && sh pony.sh",
     "pretest": "rm -rf coverage && npm run cert:gen",
-    "test": "mocha --exit --recursive",
+    "test": "mocha",
+    "test:bail": "mocha --bail",
     "test:cover": "c8 --include=src --reporter=lcov --reporter=text npm test"
   },
-  "version": "2.3.6"
+  "version": "2.4.0"
 }

package.json

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
-# Transforms extensions within source file
+# Transforms extensions within source files
 
 for file in dist/*.js; do
   echo "$file"
-  sed -i -e 's/.mjs/.js/g' "$file"
+  sed -i -e 's/.\bmjs\b/.js/g' "$file"
 done

pony.sh

@@ -167,7 +167,15 @@ export const preflight = (options) => {
 
   options.method ??= method;
   options.parse ??= true;
-  options.redirect ??= 'follow';
+  options.redirect ??= redirects.follow;
+
+  if (!Object.values(redirects).includes(options.redirect)) {
+    options.createConnection?.().destroy();
+    throw new TypeError(`Failed to read the 'redirect' property from 'options': The provided value '${
+      options.redirect
+    }' is not a valid enum value.`);
+  }
+
   options.redirected ??= false;
   options.thenable ??= false;
 
@@ -214,7 +222,7 @@ export const premix = (res, { digest = false, parse = false } = {}) => {
       enumerable: true,
       value: async function () {
         if (this.bodyUsed) {
-          throw new TypeError('Response stream already read');
+          throw new TypeError('Response stream already read.');
         }
 
         let spool = [];
@@ -262,6 +270,12 @@ export const premix = (res, { digest = false, parse = false } = {}) => {
   });
 };
 
+export const redirects = {
+  error: 'error',
+  follow: 'follow',
+  manual: 'manual',
+};
+
 export async function* tap(value) {
   if (Reflect.has(value, Symbol.asyncIterator)) {
     yield* value;

src/helpers.mjs

@@ -9,6 +9,7 @@ import {
   merge,
   preflight,
   premix,
+  redirects,
   transform,
 } from './helpers.mjs';
 import { APPLICATION_OCTET_STREAM } from './mediatypes.mjs';
@@ -44,7 +45,7 @@ export default async function rekwest(url, options = {}) {
     HTTP2_METHOD_GET,
     HTTP2_METHOD_HEAD,
   ].includes(options.method)) {
-    throw new TypeError(`Request with ${ HTTP2_METHOD_GET }/${ HTTP2_METHOD_HEAD } method cannot have body`);
+    throw new TypeError(`Request with ${ HTTP2_METHOD_GET }/${ HTTP2_METHOD_HEAD } method cannot have body.`);
   }
 
   if (!options.follow) {
@@ -122,16 +123,16 @@ export default async function rekwest(url, options = {}) {
       });
 
       if (follow && /^3\d{2}$/.test(res.statusCode) && res.headers[HTTP2_HEADER_LOCATION]) {
-        if (redirect === 'error') {
-          res.emit('error', new RequestError(`Unexpected redirect, redirect mode is set to '${ redirect }'`));
+        if (redirect === redirects.error) {
+          res.emit('error', new RequestError(`Unexpected redirect, redirect mode is set to '${ redirect }'.`));
         }
 
-        if (redirect === 'follow') {
+        if (redirect === redirects.follow) {
           options.url = new URL(res.headers[HTTP2_HEADER_LOCATION], url).href;
 
           if (res.statusCode !== HTTP_STATUS_SEE_OTHER
             && body === Object(body) && body.pipe?.constructor === Function) {
-            res.emit('error', new RequestError(`Unable to ${ redirect } redirect with body as readable stream`));
+            res.emit('error', new RequestError(`Unable to ${ redirect } redirect with body as readable stream.`));
           }
 
           options.follow--;
@@ -211,6 +212,7 @@ Reflect.defineProperty(rekwest, 'stream', {
       ...merge(rekwest.defaults, {
         headers: { [HTTP2_HEADER_CONTENT_TYPE]: APPLICATION_OCTET_STREAM },
       }, options),
+      redirect: redirects.manual,
     });
 
     if (options.h2) {