Node 18+ 💥; convert to ESM 💥📝

.eslintrc.json

@@ -4,6 +4,9 @@
 		"es2021": true,
 		"node": true
 	},
+	"parserOptions": {
+		"sourceType": "module"
+	},
 	"ignorePatterns": [
 		"node_modules"
 	],

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: ['10', '12', '14', '16', '18']
+        node-version: ['18']
 
     steps:
     - name: checkout

example.js

@@ -1,15 +1,14 @@
-'use strict'
-
-const createHafas = require('.')
-// const createThrottledHafas = require('./throttle')
-// const createHafasWithRetry = require('./retry')
+import {inspect} from 'node:util'
+import {createBvgHafas as createHafas} from './index.js'
+// import {createThrottledHafas} from './throttle.js'
+// import {createRetryingClient} from './retry.js'
 
 const hafas = createHafas('bvg-hafas-example')
 // const hafas = createThrottledHafas('bvg-hafas-example', {
 // 	throttlingLimit: 5,
 // 	throttlingInterval: 10000 // 10s
 // })
-// const hafas = createHafasWithRetry('bvg-hafas-example', {
+// const hafas = createRetryingClient('bvg-hafas-example', {
 // 	retryOpts: {retries: 2}
 // })
 
@@ -42,7 +41,7 @@ hafas.journeys(spichernstr, bismarckstr, {
 // }, {results: 10})
 
 .then((data) => {
-	console.log(require('util').inspect(data, {depth: null, colors: true}))
+	console.log(inspect(data, {depth: null, colors: true}))
 })
 .catch((err) => {
 	console.error(err)

index.js

@@ -1,19 +1,19 @@
-'use strict'
-
-const createHafasClient = require('hafas-client')
-const bvgProfile = require('hafas-client/p/bvg')
+import createHafasClient from 'hafas-client'
+import bvgProfile from 'hafas-client/p/bvg/index.js'
 
 const defaults = {
 	profile: bvgProfile
 }
 
-const createClient = (userAgent, opt = {}) => {
+const createBvgHafas = (userAgent, opt = {}) => {
 	const {
 		profile,
 	} = {...defaults, ...opt}
 
 	return createHafasClient(profile, userAgent)
 }
 
-createClient.defaults = defaults
-module.exports = createClient
+export {
+	defaults,
+	createBvgHafas,
+}

package.json

@@ -2,6 +2,7 @@
 	"name": "bvg-hafas",
 	"description": "JavaScript client for the BVG HAFAS API.",
 	"version": "3.1.0",
+	"type": "module",
 	"main": "index.js",
 	"files": [
 		"index.js",
@@ -25,7 +26,7 @@
 	"bugs": "https://github.com/public-transport/bvg-hafas/issues",
 	"license": "ISC",
 	"engines": {
-		"node": ">=10"
+		"node": ">=18"
 	},
 	"dependencies": {
 		"hafas-client": "^5.0.1"

readme.md

@@ -27,9 +27,9 @@ Check [the docs for `hafas-client@5`](https://github.com/public-transport/hafas-
 ## Usage
 
 ```javascript
-const createClient = require('bvg-hafas')
+import {createBvgHafas} from 'bvg-hafas'
 
-const client = createClient('my-awesome-program')
+const client = createBvgHafas('my-awesome-program')
 ```
 
 As an example, we will search for a route from *Berlin Jungfernheide* to *Tempelhof*. To get the station IDs, use [`locations(query, [opt])`](https://github.com/public-transport/hafas-client/blob/5/docs/locations.md).

retry.js

@@ -1,8 +1,6 @@
-'use strict'
-
-const createClient = require('hafas-client')
-const withRetrying = require('hafas-client/retry')
-const bvgProfile = require('hafas-client/p/bvg')
+import createClient from 'hafas-client'
+import withRetrying from 'hafas-client/retry.js'
+import bvgProfile from 'hafas-client/p/bvg/index.js'
 
 const createRetryingClient = (userAgent, opt = {}) => {
 	const {retryOpts} = {retryOpts: {}, ...opt}
@@ -11,4 +9,6 @@ const createRetryingClient = (userAgent, opt = {}) => {
 	return createClient(retryingProfile, userAgent, opt)
 }
 
-module.exports = createRetryingClient
+export {
+	createRetryingClient,
+}

throttle.js

@@ -1,8 +1,6 @@
-'use strict'
-
-const createClient = require('hafas-client')
-const withThrottling = require('hafas-client/throttle')
-const bvgProfile = require('hafas-client/p/bvg')
+import createClient from 'hafas-client'
+import withThrottling from 'hafas-client/throttle.js'
+import bvgProfile from 'hafas-client/p/bvg/index.js'
 
 const createThrottledClient = (userAgent, opt = {}) => {
 	const {
@@ -18,4 +16,6 @@ const createThrottledClient = (userAgent, opt = {}) => {
 	return createClient(throttledProfile, userAgent, opt)
 }
 
-module.exports = createThrottledClient
+export {
+	createThrottledClient,
+}