fauxy 0.0.1-alpha.3 → 0.0.1-alpha.4

package/Taskfile.yaml

@@ -10,25 +10,25 @@ tasks:
   build:
     desc: "Build Docker image"
     cmds:
-      - docker build --no-cache -t playground-vapimock182 .
+      - docker build --no-cache -t fauxy .
 
   down:
     desc: "Stop and remove playground container"
     cmds:
-      - docker stop playground-vapimock182-app
-      - docker rm playground-vapimock182-app
+      - docker stop fauxy-app
+      - docker rm fauxy-app
 
   up:
     desc: "Start playground container"
     cmds:
-      - docker start playground-vapimock182-app || docker run -d --name playground-vapimock182-app -p 5173:5173 -v ${PWD}:/app playground-vapimock182
+      - docker start fauxy-app || docker run -d --name fauxy-app -p 5173:5173 -v ${PWD}:/app fauxy
 
   logs:
     desc: "Follow logs from the playground container with tail output"
     cmds:
-      - docker logs -f --tail 100 playground-vapimock182-app
+      - docker logs -f --tail 100 fauxy-app
 
   bash:
     desc: "Open interactive shell session inside the running playground container"
     cmds:
-      - docker exec -it playground-vapimock182-app sh
+      - docker exec -it fauxy-app sh

package/docs/laravel-mix.md

@@ -0,0 +1,54 @@
+# Using Fauxy with Laravel Mix
+
+This section demonstrates how to integrate Fauxy into a project using Laravel Mix, ensuring that all mock-related code
+does not end up in production. This was particularly important for me, as supporting very old browser versions was
+challenging.
+
+> **Note:** This is just an example setup to demonstrate how Fauxy can be integrated with Laravel Mix.
+> It is not meant to be a production-ready configuration, and some parts of the code are simplified for illustrative purposes.
+> Adjust it according to your project's requirements and best practices.
+
+First, create a file, for example, `resources/ts/mock.ts`, and initialize Fauxy there.
+
+Next, add the following code to your `webpack.mix.js`:
+
+```js
+const mockSrc = process.env.MIX_MOCK_API === 'true' ? ['resources/ts/mock.ts'] : [];
+
+mix
+  .ts([
+    ...mockSrc,
+    'resources/ts/vue.ts'
+  ], 'public/js/vue.js')
+```
+
+In this example, I use Vue. Since the `mock.ts` and `vue.ts` files are added to the build independently, it’s important to
+ensure that the code from `mock.ts` runs first. The simplest way to achieve this is:
+
+```ts
+// mock.ts
+import { mockApi } from 'fauxy'
+import someHandlers from '@/mocks/handlers/some-handlers'
+
+window.MOCK_SETUP = {
+  startMock: async () => {
+    return mockApi([...someHandlers])
+  },
+}
+```
+
+```ts
+// vue.ts
+import Vue from 'vue'
+
+const initApp = async () => {
+  if (window?.MOCK_SETUP?.startMock) {
+    await window.MOCK_SETUP?.startMock()
+  }
+
+  return new Vue({
+    el: '#app',
+    pinia,
+  })
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fauxy",
-  "version": "0.0.1-alpha.3",
+  "version": "0.0.1-alpha.4",
   "description": "A package for mocking data and API requests",
   "license": "MIT",
   "homepage": "https://github.com/heavenlybilly/fauxy",

package/readme.md

@@ -1,32 +1,25 @@
 # Fauxy
-description
 
-## Содержание
-- [Начало работы](#начало-работы)
+Fauxy is a lightweight wrapper around **faker.js** and **MSW** (Mock Service Worker), designed to simplify mocking data
+and API requests for both front-end and back-end development. MSW is used as-is (imported directly from the package),
+while Faker is wrapped with a special API that adds some convenience helpers and customizations. I created Fauxy
+primarily for my own convenience, but I hope it can be useful to others as well.
 
-## Начало работы
+## Features
 
-#### Установка пакета
-```bash
-npm i fauxy
-```
-
-#### Настройка окружения
-1. Для добавления Mock API в Laravel Mix, необходимо добавить новый файл, например, `resources/ts/mock.ts` с содержимым:
-```ts
-import { mockApi } from 'fauxy'
+- Simple API for generating mock data using a wrapped version of **faker.js** with additional helpers.
+- Built-in **MSW** integration to mock API requests.
+- Ready-to-use mock service worker file for front-end development.
+- Lightweight and easy to set up.
 
-mockApi.start()
-```
+## Installation
 
-2. Изменить файл `package.json`:
-```json
-"scripts": {
-    "watch:msw": "MIX_MOCK_API=true mix watch",
-},
+```bash
+npm install fauxy
+npx fauxy init
 ```
 
-Добавить в конец файла:
+To ensure MSW knows where to find the service worker, add the following section to your package.json:
 ```json
 "msw": {
   "workerDirectory": [
@@ -35,13 +28,18 @@ mockApi.start()
 }
 ```
 
-3. В файле `webpack.mix.js` добавить в сборку файл `mock.ts` (из п.1):
-```js
-const mockSrc = process.env.MIX_MOCK_API === 'true' ? ['resources/ts/mock.ts'] : [];
+An example of starting the mock service worker:
+```ts
+import { mockApi } from 'fauxy'
+
+mockApi.start()
+```
+
+## How to use ![WIP](https://img.shields.io/badge/status-WIP-yellow)
+
+- [Laravel Mix](docs/laravel-mix.md)
 
-mix
-  .ts([
-    ...mockSrc,
-    'resources/ts/vue.ts'
-  ], 'public/js/vue.js')
-```
+## Notes
+- Fauxy uses MSW directly from its package, so you can access all MSW features as usual.
+- Faker is only available via Fauxy’s wrapper, which adds convenience methods and some custom enhancements.
+- For more advanced usage and configuration, check out the official MSW repository.

package/scripts/init.cjs

@@ -12,9 +12,14 @@ const colors = {
 const sourceSwPath = path.join(__dirname, './mockServiceWorker.js');
 const targetSwPath = path.join(process.cwd(), 'public/mockServiceWorker.js');
 
+console.warn(
+  '\x1b[33m⚠️  This package uses MSW (https://github.com/mswjs/msw). ' +
+  'For more details and advanced usage, please visit the official repository.\x1b[0m'
+);
+
 try {
   if (!fs.existsSync(sourceSwPath)) {
-    console.error(colors.error + '❌ Mock Service Worker not found' + colors.reset);
+    console.error(colors.error + '❌  mockServiceWorker.js not found' + colors.reset);
     process.exit(0);
   }
 
@@ -24,9 +29,9 @@ try {
   }
 
   fs.copyFileSync(sourceSwPath, targetSwPath);
-  console.log(colors.success + '✅ Mock Service Worker copied to public/' + colors.reset);
+  console.log(colors.success + '✅  Mock Service Worker copied to public/' + colors.reset);
 
 } catch (error) {
-  console.error(colors.error + '❌ Failed to copy Mock Service Worker:' + colors.reset);
+  console.error(colors.error + '❌  Failed to copy Mock Service Worker:' + colors.reset);
   console.error(colors.error + error.message + colors.reset);
 }