mockaton 2.3.1 → 3.0.0

package/README.md

@@ -44,17 +44,17 @@ node my-mockaton.js
 ## Config Options
 ```ts
 interface Config {
-  mocksDir: string
-  staticDir?: string 
-  host?: string, // defaults to 'localhost'
-  port?: number // defaults to 0, which means auto-assigned
-  delay?: number // defaults to 1200 (ms)
-  cookies?: object 
-  skipOpen?: boolean // Prevents opening the dashboard in a browser
-  proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
-  allowedExt?: RegExp // /\.(json|txt|md|js)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
-  generate500?: boolean // autogenerates an Internal Server Error empty mock for routes that have no 500
-  extraHeaders?: []
+	mocksDir: string
+	staticDir?: string
+	host?: string, // defaults to 'localhost'
+	port?: number // defaults to 0, which means auto-assigned
+	delay?: number // defaults to 1200 (ms)
+  open?: (dashboardUrl: string) => void // pass a noop to prevent opening the dashboard
+	cookies?: object
+	proxyFallback?: string // e.g. http://localhost:9999 Target for relaying routes without mocks
+	allowedExt?: RegExp // /\.(json|txt|md|js)$/ Just for excluding temporary editor files (e.g. JetBrains appends a ~)
+	generate500?: boolean // autogenerates an Internal Server Error empty mock for routes that have no 500
+	extraHeaders?: []
 }
 ```
 

package/Tests.js

@@ -106,7 +106,7 @@ writeStatic('another-entry/index.html', '<h1>Another</h1>')
 const server = Mockaton({
 	mocksDir: tmpDir,
 	staticDir: staticTmpDir,
-	skipOpen: true,
+	open: () => {},
 	cookies: {
 		userA: 'CookieA',
 		userB: 'CookieB'

package/index.d.ts

@@ -6,8 +6,8 @@ interface Config {
 	host?: string,
 	port?: number
 	delay?: number
+	open?: (address: string) => void
 	cookies?: object
-	skipOpen?: boolean
 	proxyFallback?: string
 	allowedExt?: RegExp
 	generate500?: boolean,

package/package.json

@@ -2,7 +2,7 @@
 	"name": "mockaton",
 	"description": "A deterministic server-side for developing and testing frontend clients",
 	"type": "module",
-	"version": "2.3.1",
+	"version": "3.0.0",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",

package/src/Config.js

@@ -1,5 +1,5 @@
-import { existsSync as exists, lstatSync } from 'node:fs'
-import { validate, is, optional } from './utils/validate.js'
+import { openInBrowser } from './utils/openInBrowser.js'
+import { validate, is, optional, isDirectory } from './utils/validate.js'
 
 
 export const Config = {
@@ -8,8 +8,8 @@ export const Config = {
 	host: '127.0.0.1',
 	port: 0, // auto-assigned
 	delay: 1200, // milliseconds
+	open: openInBrowser,
 	cookies: {}, // defaults to the first kv
-	skipOpen: false,
 	proxyFallback: '', // e.g. http://localhost:9999
 	allowedExt: /\.(json|txt|md|js)$/, // Just for excluding temporary editor files (e.g. JetBrains appends a ~)
 	generate500: false,
@@ -24,8 +24,8 @@ export function setup(options) {
 		host: is(String),
 		port: port => Number.isInteger(port) && port >= 0 && port < 2 ** 16,
 		delay: ms => Number.isInteger(ms) && ms > 0,
+		open: is(Function),
 		cookies: is(Object),
-		skipOpen: is(Boolean),
 		proxyFallback: optional(URL.canParse),
 		allowedExt: is(RegExp),
 		generate500: is(Boolean),
@@ -33,8 +33,4 @@ export function setup(options) {
 	})
 }
 
-function isDirectory(dir) {
-	return exists(dir) && lstatSync(dir).isDirectory()
-}
-
 

package/src/Mockaton.js

@@ -36,7 +36,7 @@ export function Mockaton(options) {
 			console.log('Dashboard', url + API.dashboard)
 			if (error)
 				console.error(error)
-			else if (!Config.skipOpen)
-				exec(`open ${url + API.dashboard}`)
+			else
+				Config.open(url + API.dashboard)
 		})
 }

package/src/utils/openInBrowser.js

@@ -0,0 +1,8 @@
+import { exec } from 'node:child_process'
+
+
+export function openInBrowser(address) {
+	if (process.platform === 'darwin')
+		exec(`open ${address}`)
+}
+

package/src/utils/validate.js

@@ -1,3 +1,6 @@
+import { existsSync as exists, lstatSync } from 'node:fs'
+
+
 export function validate(obj, shape) {
 	for (const [field, value] of Object.entries(obj))
 		if (!shape[field](value))
@@ -6,3 +9,4 @@ export function validate(obj, shape) {
 
 export const is = ctor => val => val.constructor === ctor
 export const optional = tester => val => !val || tester(val)
+export const isDirectory = dir => exists(dir) && lstatSync(dir).isDirectory()