Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Publish Ferry

on:
push:
tags: ["v*"]
permissions:
id-token: write
contents: read

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 24
registry-url: https://registry.npmjs.org
- run: npm ci
- run: npm test
- run: npm run build
- run: npm publish --provenance --access public
38 changes: 38 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Test Ferry

on:
pull_request:
branches: [master]
paths-ignore:
- "**/*.md"
push:
branches: [master]
paths-ignore:
- "**/*.md"

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
test:
runs-on: ubuntu-latest
permissions:
packages: write
contents: read

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm

- name: Install dependencies
run: npm ci

- name: Run tests
run: npm test
78 changes: 76 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ in sync with your backend.
- **Enums** — Generates types and runtime constants from `app/Enums/`
- **Resources** — Generates response types from `app/Http/Resources/`

## Requirements

- **TypeScript ^5.0** — Required as a peer dependency for code generation

## Installation

```bash
npm install vite-plugin-ferry --save-dev
npm install vite-plugin-ferry typescript@^5 --save-dev
```

Add it to your `vite.config.ts`:
Expand All @@ -33,7 +37,77 @@ Import your backend types directly in your frontend code:

```ts
import { OrderStatus } from '@ferry/enums';
import { UserResource } from '@ferry/resources';
import type { UserResource } from '@ferry/resources';
```

## Examples

### Enums

A PHP enum with labels:

```php
// app/Enums/OrderStatus.php
enum OrderStatus: string
{
case Pending = 'pending';
case Shipped = 'shipped';
case Delivered = 'delivered';

public function label(): string
{
return match ($this) {
self::Pending => 'Pending Order',
self::Shipped => 'Shipped',
self::Delivered => 'Delivered',
};
}
}
```

Generates:

```ts
// @ferry/enums
export declare const OrderStatus: {
Pending: { value: 'pending'; label: 'Pending Order' };
Shipped: { value: 'shipped'; label: 'Shipped' };
Delivered: { value: 'delivered'; label: 'Delivered' };
};
```

### Resources

A Laravel JsonResource:

```php
// app/Http/Resources/UserResource.php
class UserResource extends JsonResource
{
public function toArray(Request $request): array
{
return [
'id' => $this->resource->id,
'name' => $this->resource->name,
'email' => $this->resource->email,
'created_at' => $this->resource->created_at,
'posts' => PostResource::collection($this->whenLoaded('posts')),
];
}
}
```

Generates:

```ts
// @ferry/resources
export type UserResource = {
id: string;
name: string;
email: string;
created_at: string;
posts?: PostResource[];
};
```

## License
Expand Down
Loading