Merge branch 'esm'

Author: aral

CHANGELOG.md

@@ -4,23 +4,35 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.0] - 2021-03-09
+
+__Breaking change:__ ESM version. Includes Auto Encrypt 3.0.0 and Auto Encrypt Localhost 7.0.2.
+
+## Changed
+
+  - Uses ECMAScript Modules (ESM; es6 modules).
+  - Upgraded Auto Encrypt to version 3.0.0 (ESM + includes the latest Let’s Encrypt staging certificate authority root certificate for testing).
+  - Upgraded Auto Encrypt Localhost to version 7.0.2 (the mkcert binaries are no longer bundled).
+  - Testing and coverage: migrate from using nyc, tap-spec, and tap-nyc to c8 and tap-monkey.
+  - Reduce npm package size by specifying files whitelist.
+
 ## [2.1.1] - 2021-02-16
 
 ## Changed
 
-   - Upgrade auto-encrypt to version 2.0.6. Fixes assignment to constant that would result in a crash when a Retry-After header was received from Let’s Encrypt.
+   - Upgrade Auto Encrypt to version 2.0.6. Fixes assignment to constant that would result in a crash when a Retry-After header was received from Let’s Encrypt.
 
 ## [2.1.0] - 2020-11-04
 
 ### Changed
 
-  - Upgrade auto-encrypt-localhost to version 6.1.0. (This upgrades mkcert to 1.4.2 and includes the new separate mkcert arm64 binary.)
+  - Upgrade Auto Encrypt Localhost to version 6.1.0. (This upgrades mkcert to 1.4.2 and includes the new separate mkcert arm64 binary.)
 
 ## [2.0.0] - 2020-11-03
 
 ### Changed
 
-  - __Breaking change:__ Update to auto-encrypt-localhost version 6.0.0.
+  - __Breaking change:__ Update to Auto Encrypt Localhost version 6.0.0.
 
     Running multiple local servers at different HTTPS ports no longer results in an error due to port 80 being unavailable for the HTTP Server. However, know that only the first server will get the HTTP Server at port 80 that redirects HTTP calls to HTTPS and also serves your local root certificate authority public key.
 
@@ -34,55 +46,55 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Added
 
-  - Update auto-encrypt-localhost to 5.4.0 to add arm64 support on Linux.
+  - Update Auto Encrypt Localhost to 5.4.0 to add arm64 support on Linux.
 
 ## [1.5.1] - 2020-07-10
 
 ### Fixed
 
-  - Update auto-encrypt to 2.0.4 to fix HTTP → HTTPS redirects on global servers. They now work (the HTTP server was not being started previously due to a typo in the monkey-patched method name).
+  - Update Auto Encrypt to 2.0.4 to fix HTTP → HTTPS redirects on global servers. They now work (the HTTP server was not being started previously due to a typo in the monkey-patched method name).
 
 ## [1.5.0] - 2020-07-07
 
 ### Changed
 
-  - Update auto-encrypt-localhost to version 5.3.0 (now serves the local root certificate authority’s public key at route /.ca).
+  - Update Auto Encrypt Localhost to version 5.3.0 (now serves the local root certificate authority’s public key at route /.ca).
 
 ## [1.4.0] - 2020-07-06
 
 ### Changed
 
-  - Update auto-encrypt-localhost to version 5.2.2 (you can now access local servers from any device on your local network via its IPv4 address).
+  - Update Auto Encrypt Localhost to version 5.2.2 (you can now access local servers from any device on your local network via its IPv4 address).
 
 ## [1.3.1] - 2020-07-03
 
 ### Changed
 
-  - Update to auto-encrypt version 2.0.1 (HTTP to HTTPS forwarding is now logged).
+  - Update to Auto Encrypt version 2.0.1 (HTTP to HTTPS forwarding is now logged).
 
 ## [1.3.0] - 2020-07-03
 
 ### Changed
 
-  - Update to auto-encrypt version 2.0.0 with automatic HTTP to HTTPS forwarding for servers at hostname.
+  - Update to Auto Encrypt version 2.0.0 with automatic HTTP to HTTPS forwarding for servers at hostname.
 
 ## [1.2.5] - 2020-06-20
 
 ### Changed
 
-  - Update to auto-encrypt version 1.0.3 with fix for carriage returns in CSRs causing some certificate provisioning attempts to fail.
+  - Update to Auto Encrypt version 1.0.3 with fix for carriage returns in CSRs causing some certificate provisioning attempts to fail.
 
 ## [1.2.4] - 2020-06-16
 
 ### Changed
 
-  - Updated auto-encrypt to version 1.0.2 and auto-encrypt localhost to version 5.1.2 (fixes and cosmetic improvements).
+  - Updated Auto Encrypt to version 1.0.2 and Auto Encrypt localhost to version 5.1.2 (fixes and cosmetic improvements).
 
 ## [1.2.3] - 2020-06-16
 
 ### Changed
 
-  - Updated auto-encrypt to version 1.0.1 and auto-encrypt localhost to version 5.1.1.
+  - Updated Auto Encrypt to version 1.0.1 and Auto Encrypt localhost to version 5.1.1.
   - Log output now conforms to format used by Site.js.
 
 ## [1.2.2] - 2020-04-16
@@ -101,7 +113,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Changed
 
-  - Let’s Encrypt certificates are now managed by [Auto Encrypt](https://source.ind.ie/site.js/lib/auto-encrypt).
+  - Let’s Encrypt certificates are now managed by [Auto Encrypt](https://source.ind.ie/site.js/lib/Auto Encrypt).
   - Entire library is now licensed under AGPL version 3.0 or later.
 
 ## [1.1.0] - 2020-02-15
@@ -132,13 +144,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Fixed
 
-  - Update to latest nodecert (version 3.1.4) which fixes regression so Node.js once again recognises local certificates as valid.
+  - Update to latest Nodecert (version 3.1.4) which fixes regression so Node.js once again recognises local certificates as valid.
 
 ## [1.0.5] - 2019-11-26
 
 ### Fixed
 
-  - Update to latest nodecert (version 3.1.3) which fixes crash when multiple directories are missing in the requested nodecert configuration directory.
+  - Update to latest Nodecert (version 3.1.3) which fixes crash when multiple directories are missing in the requested Nodecert configuration directory.
 
 ## [1.0.4] - 2019-11-26
 

README.md

@@ -12,6 +12,8 @@ That’s it.
 
 This is basically a batteries-included version of the standard Node.js `https` module.
 
+___Note:__ This is a standard ECMAScript Modules (ESM; es6 modules) project. If you need to use legacy CommonJS, [please see the 2.x branch](https://github.com/small-tech/https/tree/2.x) which is currently still being maintained._
+
 ## Like this? Fund us!
 
 [Small Technology Foundation](https://small-tech.org) is a tiny, independent not-for-profit.

example/index.js

@@ -1,4 +1,4 @@
-const https = require('..')
+import https from '../index.js'
 
 // Helpers
 function html(message) {

index.js

@@ -1,10 +1,10 @@
-const fs                   = require('fs-extra')
-const os                   = require('os')
-const path                 = require('path')
-const https                = require('https')
-const log                  = require('./lib/util/log')
-const AutoEncrypt          = require('@small-tech/auto-encrypt')
-const AutoEncryptLocalhost = require('@small-tech/auto-encrypt-localhost')
+import os from 'os'
+import fs from 'fs-extra'
+import path from 'path'
+import https from 'https'
+import AutoEncrypt from '@small-tech/auto-encrypt'
+import AutoEncryptLocalhost from '@small-tech/auto-encrypt-localhost'
+import log from './lib/util/log.js'
 
 const AUTO_ENCRYPT_STAGING_SERVER_TYPE = 1
 
@@ -61,4 +61,4 @@ smallTechHttps.createServer = function (options, listener) {
     return server
 }
 
-module.exports = smallTechHttps
+export default smallTechHttps

lib/util/log.js

@@ -1,8 +1,6 @@
-function log(...args) {
+export default function log(...args) {
   if (process.env.QUIET) {
     return
   }
   console.log(...args)
 }
-
-module.exports = log