@tsonic/tsbindgen 0.7.7 → 0.7.9

package/README.md

@@ -8,7 +8,7 @@ tsbindgen generates TypeScript declaration files (`.d.ts`) from .NET assemblies
 
 - **Complete BCL coverage** - Generates declarations for all 130 BCL namespaces, 4,296 types, and 50,675+ members
 - **Zero TypeScript errors** - Output validates cleanly with `tsc --strict`
-- **Branded primitives** - Type-safe numeric types (`int`, `long`, `decimal`, etc.) via `@tsonic/types`
+- **CLR primitives** - Numeric type aliases (`int`, `long`, `decimal`, etc.) via `@tsonic/types`
 - **Dual naming modes** - CLR PascalCase (`GetEnumerator`) or JavaScript camelCase (`getEnumerator`)
 - **Generic type preservation** - Full generic type parameter support with constraints
 - **Metadata sidecars** - CLR-specific information (static, virtual, override) in companion JSON files
@@ -16,8 +16,19 @@ tsbindgen generates TypeScript declaration files (`.d.ts`) from .NET assemblies
 
 ## Installation
 
+### Via npm (recommended)
+
+```bash
+npm install tsbindgen
+# or
+npm install @tsonic/tsbindgen
+```
+
+Requires .NET 10 runtime installed.
+
+### From source
+
 ```bash
-# Clone and build
 git clone https://github.com/tsoniclang/tsbindgen
 cd tsbindgen
 dotnet build src/tsbindgen/tsbindgen.csproj
@@ -28,30 +39,33 @@ dotnet build src/tsbindgen/tsbindgen.csproj
 ### Generate BCL declarations
 
 ```bash
-# Generate TypeScript declarations for .NET BCL
+# Via npm
+npx tsbindgen generate -d ~/.dotnet/shared/Microsoft.NETCore.App/10.0.0 -o ./output
+
+# Via dotnet (from source)
 dotnet run --project src/tsbindgen/tsbindgen.csproj -- \
-  generate -d ~/.dotnet/shared/Microsoft.NETCore.App/10.0.0 \
-  -o ./output
+  generate -d ~/.dotnet/shared/Microsoft.NETCore.App/10.0.0 -o ./output
 ```
 
 ### Generate for a custom assembly
 
 ```bash
-# Generate for your own assembly
+# Via npm
+npx tsbindgen generate -a ./MyLibrary.dll -d $DOTNET_RUNTIME -o ./output
+
+# Via dotnet (from source)
 dotnet run --project src/tsbindgen/tsbindgen.csproj -- \
-  generate -a ./MyLibrary.dll \
-  -d ~/.dotnet/shared/Microsoft.NETCore.App/10.0.0 \
-  -o ./output
+  generate -a ./MyLibrary.dll -d $DOTNET_RUNTIME -o ./output
 ```
 
 ### Library mode (exclude BCL types)
 
 ```bash
 # First, generate BCL types
-dotnet run -- generate -d $DOTNET_RUNTIME -o ./bcl-types
+npx tsbindgen generate -d $DOTNET_RUNTIME -o ./bcl-types
 
 # Then generate your library, importing BCL from the pre-existing package
-dotnet run -- generate -a ./MyLibrary.dll -d $DOTNET_RUNTIME -o ./my-lib --lib ./bcl-types
+npx tsbindgen generate -a ./MyLibrary.dll -d $DOTNET_RUNTIME -o ./my-lib --lib ./bcl-types
 ```
 
 ## CLI Reference
@@ -80,16 +94,16 @@ dotnet run -- generate -a ./MyLibrary.dll -d $DOTNET_RUNTIME -o ./my-lib --lib .
 
 ```bash
 # Generate BCL with JavaScript naming
-dotnet run -- generate -d $DOTNET_RUNTIME -o ./out --naming js
+npx tsbindgen generate -d $DOTNET_RUNTIME -o ./out --naming js
 
 # Generate specific namespaces only
-dotnet run -- generate -d $DOTNET_RUNTIME -o ./out -n System,System.Collections.Generic
+npx tsbindgen generate -d $DOTNET_RUNTIME -o ./out -n System,System.Collections.Generic
 
 # Verbose output with specific log categories
-dotnet run -- generate -d $DOTNET_RUNTIME -o ./out -v --logs ImportPlanner,FacadeEmitter
+npx tsbindgen generate -d $DOTNET_RUNTIME -o ./out -v --logs ImportPlanner,FacadeEmitter
 
 # Strict mode (additional validation)
-dotnet run -- generate -d $DOTNET_RUNTIME -o ./out --strict
+npx tsbindgen generate -d $DOTNET_RUNTIME -o ./out --strict
 ```
 
 ## Output Structure
@@ -120,19 +134,19 @@ output/
 
 ### Primitive Types
 
-CLR primitive types map to branded TypeScript types from `@tsonic/types`:
+CLR primitive types map to type aliases from `@tsonic/types`:
 
 | CLR Type | TypeScript Type |
 |----------|----------------|
-| `System.Int32` | `int` |
-| `System.Int64` | `long` |
-| `System.Single` | `float` |
-| `System.Double` | `double` |
-| `System.Decimal` | `decimal` |
-| `System.Byte` | `byte` |
-| `System.Boolean` | `boolean` |
+| `System.Int32` | `int` (alias for `number`) |
+| `System.Int64` | `long` (alias for `number`) |
+| `System.Single` | `float` (alias for `number`) |
+| `System.Double` | `double` (alias for `number`) |
+| `System.Decimal` | `decimal` (alias for `number`) |
+| `System.Byte` | `byte` (alias for `number`) |
+| `System.Boolean` | `bool` (branded) |
 | `System.String` | `string` |
-| `System.Char` | `char` |
+| `System.Char` | `char` (branded) |
 
 ### Generic Types
 
@@ -240,7 +254,7 @@ dotnet run --project src/tsbindgen/tsbindgen.csproj -- <args>
 
 - **[@tsonic/dotnet](https://www.npmjs.com/package/@tsonic/dotnet)** - Pre-generated BCL types with JavaScript naming
 - **[@tsonic/dotnet-pure](https://www.npmjs.com/package/@tsonic/dotnet-pure)** - Pre-generated BCL types with CLR naming
-- **[@tsonic/types](https://www.npmjs.com/package/@tsonic/types)** - Branded primitive types
+- **[@tsonic/types](https://www.npmjs.com/package/@tsonic/types)** - CLR primitive type aliases
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsonic/tsbindgen",
-  "version": "0.7.7",
+  "version": "0.7.9",
   "description": "Generate TypeScript declarations from .NET assemblies",
   "type": "module",
   "bin": {