laravel-typescript - GitLite

KO | EN

gitlite — search

#javascript #react #go #golang #android #machine-learning #linux #nodejs #macos #java #awesome #awesome-list #pytorch #open-source

laravel-typescript

(★ 400)

No description available.

File Explorer

Download Latest Version (.zip)

- - config.yml
- - run-tests.yml
- CONTRIBUTING.md
- FUNDING.yml
- SECURITY.md
- typescript.php
- - TypeScriptGenerateCommand.php
- - Generator.php
- - TypeScriptProperty.php
  - TypeScriptType.php
- - AbstractGenerator.php
  - ModelGenerator.php
  - RequestGenerator.php
- TypeScriptGenerator.php
- TypeScriptServiceProvider.php
- - Category.php
  - Feature.php
  - helpers.php
  - Product.php
- GeneratorTest.php
- TestCase.php
.editorconfig
.gitattributes
.gitignore
.php_cs.dist.php
composer.json
LICENSE.md
phpstan.neon.dist
phpunit.xml.dist
README.md

# Installation Guide

1. Get the code

git clone https://github.com/lepikhinb/laravel-typescript

Downloads the entire project code from GitHub to your computer.

cd laravel-typescript

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require based/laravel-typescript

Type this command into your terminal and run it.

// load namespaces from composer's `dev-autoload`

Type this command into your terminal and run it.

composer test

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Laravel TypeScript

[![Latest Version on Packagist](https://img.shields.io/packagist/v/based/laravel-typescript.svg?style=flat-square)](https://packagist.org/packages/based/laravel-typescript)
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/lepikhinb/laravel-typescript/run-tests?label=tests)](https://github.com/lepikhinb/laravel-typescript/actions?query=workflow%3Arun-tests+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/based/laravel-typescript.svg?style=flat-square)](https://packagist.org/packages/based/laravel-typescript)

The package lets you generate TypeScript interfaces from your Laravel models.

## Introduction
Say you have a model which has several properties (database columns) and multiple relations.
```php
class Product extends Model
{
    public function category(): BelongsTo
    {
        return $this->belongsTo(Category::class);
    }

public function features(): HasMany
    {
        return $this->hasMany(Feature::class);
    }
}
```

Laravel TypeScript will generate the following TypeScript interface:

```typescript
declare namespace App.Models {
    export interface Product {
        id: number;
        category_id: number;
        name: string;
        price: number;
        created_at: string | null;
        updated_at: string | null;
        category?: App.Models.Category | null;
        features?: Array<App.Models.Feature> | null;
    }
    ...
}
```

**Laravel TypeScript** supports:
- [x] Database columns
- [x] Model relations
- [x] Model accessors
- [ ] Casted attributes

## Installation

**Laravel 8 and PHP 8 are required.**
You can install the package via composer:

```bash
composer require based/laravel-typescript
```

You can publish the config file with:
```bash
php artisan vendor:publish --provider="Based\TypeScript\TypeScriptServiceProvider" --tag="typescript-config"
```

This is the contents of the published config file:

```php
return [
    'generators' => [
        Model::class => ModelGenerator::class,
    ],

'output' => resource_path('js/models.d.ts'),

// load namespaces from composer's `dev-autoload`
    'autoloadDev' => false,
];

```

## Usage

Generate TypeScript interfaces.
```bash
php artisan typescript:generate
```

Example usage with Vue 3:
```typescript
import { defineComponent, PropType } from "vue";

export default defineComponent({
    props: {
        product: {
            type: Object as PropType<App.Models.Product>,
            required: true,
        },
    },
}
```

## Testing

```bash
composer test
```

## Credits

- [Boris Lepikhin](https://github.com/lepikhinb)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.