gear-mesh 0.1.0

Next-generation Rust to TypeScript type definition sharing library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

# gear-mesh ⚙️

Next-generation Rust to TypeScript type definition sharing library.

[![Crates.io](https://img.shields.io/crates/v/gear-mesh.svg)](https://crates.io/crates/gear-mesh)
[![Documentation](https://docs.rs/gear-mesh/badge.svg)](https://docs.rs/gear-mesh)
![Rust](https://img.shields.io/badge/Rust-1.90%2B-orange)
![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue)

## Features

- **🏷️ Branded Types**: Convert Rust newtype patterns to TypeScript Branded Types
- **📝 Doc Comments**: Automatically convert Rust doc comments to JSDoc
- **✅ Validation**: Generate Zod schemas with validation rules
- **🔢 BigInt Support**: Automatically use `bigint` for `u64`/`i64`
- **🎯 Type Safety**: Full type safety from Rust to TypeScript

## Quick Start

### Installation

```toml
[dependencies]
gear-mesh = "0.1"
```

### Basic Usage

```rust
use gear_mesh::GearMesh;

#[derive(GearMesh)]
#[gear_mesh(branded)]
struct UserId(i32);

/// User information
#[derive(GearMesh)]
struct User {
    /// User's unique identifier
    id: UserId,
    /// User's display name
    #[validate(length(min = 1, max = 20))]
    name: String,
    /// User's email address
    #[validate(email)]
    email: String,
}

fn main() {
    // Generate TypeScript types
    gear_mesh::generate_types_to_dir("generated")
        .expect("Failed to generate TypeScript types");
}
```

### Generated TypeScript

```typescript
// Branded Type
type Brand<T, B> = T & { readonly __brand: B };
export type UserId = Brand<number, "UserId">;

// Interface with JSDoc
/**
 * User information
 */
export interface User {
    /** User's unique identifier */
    id: UserId;
    /** User's display name */
    name: string;
    /** User's email address */
    email: string;
}

// Zod Schema with Validation
export const UserSchema = z.object({
    id: z.number(),
    name: z.string().min(1).max(20),
    email: z.string().email(),
});
```

## Validation Rules

| Rule | Attribute | Generated Zod |
|------|-----------|---------------|
| Range | `#[validate(range(min = 0, max = 100))]` | `.min(0).max(100)` |
| Length | `#[validate(length(min = 1, max = 20))]` | `.min(1).max(20)` |
| Email | `#[validate(email)]` | `.email()` |
| URL | `#[validate(url)]` | `.url()` |
| Pattern | `#[validate(pattern = "^[A-Z]")]` | `.regex(/^[A-Z]/)` |

## Configuration

```rust
use gear_mesh::{GeneratorConfig, generate_with_config};

let config = GeneratorConfig::new()
    .with_bigint(true)        // Use bigint for u64/i64
    .with_zod(true)           // Generate Zod schemas
    .with_validation(true)    // Include validation rules
    .with_branded(true)       // Generate Branded Types
    .with_jsdoc(true);        // Include JSDoc comments

gear_mesh::generate_with_config("generated", config)
    .expect("Failed to generate");
```

## Examples

See the [examples](https://github.com/UtakataKyosui/GearMesh/tree/main/examples) directory for complete examples:

- **simple-bigint**: Basic BigInt usage
- **axum-react**: Full-stack application with Axum backend and React frontend

## Comparison with Existing Crates

| Feature | ts-rs | typeshare | specta | **gear-mesh** |
|---------|-------|-----------|--------|---------------|
| Basic type conversion | ✅ | ✅ | ✅ | ✅ |
| Branded Types | ❌ | ❌ | ❌ | ✅ |
| Doc comment conversion | ❌ | ❌ | ❌ | ✅ |
| Zod Schema | ❌ | ❌ | ❌ | ✅ |
| Validation embedding | ❌ | ❌ | ❌ | ✅ |
| Auto BigInt | Manual | Manual | Manual | ✅ Auto |

## Documentation

- [API Documentation](https://docs.rs/gear-mesh)
- [GitHub Repository](https://github.com/UtakataKyosui/GearMesh)
- [Examples](https://github.com/UtakataKyosui/GearMesh/tree/main/examples)

## License

Licensed under either of:
- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/UtakataKyosui/GearMesh/blob/main/LICENSE-APACHE))
- MIT license ([LICENSE-MIT](https://github.com/UtakataKyosui/GearMesh/blob/main/LICENSE-MIT))

at your option.

## Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](https://github.com/UtakataKyosui/GearMesh/blob/main/CONTRIBUTING.md) for details.