mockaton 8.12.7 → 8.12.9

package/README.md

@@ -8,10 +8,12 @@ An HTTP mock server for simulating APIs with minimal setup
 
 
 ## Overview
-With Mockaton, you don’t need to write code for wiring up your mocks. Instead, a
-given directory is scanned for filenames following a convention similar to the URLs.
+With Mockaton, you don’t need to write code for wiring up your
+mocks. Instead, a given directory is scanned for filenames
+following a convention similar to the URLs. 
+
+For example, for [/api/user/123](#), the mock filename could be:
 
-For example, for <code>/<b>api/user</b>/1234</code> the filename would be:
 <pre>
 <code>my-mocks-dir/<b>api/user</b>/[user-id].GET.200.json</code>
 </pre>
@@ -20,8 +22,7 @@ For example, for <code>/<b>api/user</b>/1234</code> the filename would be:
 ## Dashboard
 
 On the dashboard you can select a mock variant for a particular route, delaying responses,
-or triggering an autogenerated `500` (Internal Server Error), among other features.
-
+or triggering an autogenerated `500` error, among other features.
 Nonetheless, there’s a programmatic API, which is handy
 for setting up tests (see **Commander&nbsp;API** section).
 
@@ -60,12 +61,12 @@ api/videos.GET.<b>500</b>.txt               # Internal Server Error
 <br/>
 
 ## Fallback to Your Backend
-No need to mock everything. Mockaton can forward requests to your backend for routes
+No need to mock everything. You can forward requests to your backend for routes
 you don’t have mocks for, or routes that have the ☁️ **Cloud Checkbox** checked.
 
 
 ### Scraping mocks from your backend
-If you check **Save Mocks**, Mockaton will collect the responses that hit your backend.
+By checking ✅ **Save Mocks**, you can collect the responses that hit your backend.
 They will be saved in your `config.mocksDir` following the filename convention.
 
 
@@ -111,9 +112,10 @@ cd mockaton/demo-app-vite
 npm install 
 
 npm run mockaton
-npm run start
-# BTW, that directory has scripts for running Mockaton and Vite 
-# with one command in two terminals.
+npm run start # in another terminal
+
+# BTW, that directory has scripts for running both 
+# servers with one command in two terminals.
 ```
 
 
@@ -167,7 +169,7 @@ For example, `api/foo.GET.200.js`
 **Option A:** An Object, Array, or String is sent as JSON.
 
 ```js
-export default [{ foo: 'bar' }]
+export default { foo: 'bar' }
 ```
 
 **Option B:** Function
@@ -205,7 +207,7 @@ export default async function insertColor(request, response) {
 }
 ```
 
-`api/colors(assorted)(default).GET.200.ts`
+`api/colors.GET.200.js`
 ```js
 import colorsFixture from './colors.json' with { type: 'json' }
 
@@ -386,7 +388,7 @@ header was not sent by your backend.
 
 <p>
 An <code>.unknown</code> extension means the <code>Content-Type</code> is not in
-Mockaton’s predefined list. For that, you can add it to <code>config.extraMimes</code>
+the predefined list. For that, you can add it to <code>config.extraMimes</code>
 </p>
 </details>
 
@@ -520,7 +522,7 @@ config.corsExposedHeaders = [] // headers you need to access in client-side JS
 ### `onReady?: (dashboardUrl: string) => void`
 By default, it will open the dashboard in your default browser on macOS and
 Windows. But for a more cross-platform utility you could `npm install open` and
-Mockaton will use that implementation instead.
+that implementation will be automatically used instead.
 
 If you don’t want to open a browser, pass a noop:
 ```js

package/package.json

@@ -2,11 +2,19 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "8.12.7",
+	"version": "8.12.9",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "MIT",
 	"repository": "https://github.com/ericfortis/mockaton",
+	"keywords": [
+		"mock-server",
+		"mock",
+		"api",
+		"testing",
+		"front-end",
+		"back-end"
+	],
 	"scripts": {
 		"test": "node --test \"src/**/*.test.js\"",
 		"coverage": "node --test --test-reporter=lcov --test-reporter-destination=.coverage/lcov.info --experimental-test-coverage \"src/**/*.test.js\"",

package/src/Commander.js

@@ -1,7 +1,7 @@
 import { API, DF, LONG_POLL_SERVER_TIMEOUT } from './ApiConstants.js'
 
 
-// Client for controlling Mockaton via its HTTP API
+/** Client for controlling Mockaton via its HTTP API */
 export class Commander {
 	#addr = ''
 	constructor(addr) {