@siyavuyachagi/typesharp 0.1.2 → 0.1.3

package/README.md

@@ -14,34 +14,34 @@ Project structure: [docs/project-structure](docs/project-structure.md)
 
 ## Features
 
-✨ **Automatic Type Generation** – Convert C# models to TypeScript interfaces  
-🎯 **Custom Attribute Targeting** – Use `[TypeSharp]` or any custom attribute  
-🔄 **Nullable Support** – `string?` → `string | null`  
-📦 **Collection Handling** – Supports `List<T>`, `IEnumerable<T>`, arrays **and generic collections**  
-🗺️ **Dictionary Mapping** – `Dictionary<K, V>` → `Record<K, V>`  
-🧬 **Generic Types** – Preserves generic type definitions like `Response<T>` → `Response<T>`  
-🧬 **Inheritance** – Preserves class inheritance using `extends`  
-🏗️ **Computed Properties** – Expression-bodied and block getter properties are included  
-🎨 **Naming Conventions** – Convert property names (camel, pascal, snake, kebab)  
-📁 **Flexible Output** – Single file or multiple files  
-🔢 **Enum Support** – Converts C# enums to TypeScript string enums  
-🗂️ **File Grouping** – Preserves C# file organization (multiple classes per file stay together)  
-🔗 **Auto Imports** – Automatically generates `import type` statements between output files  
-🏢 **Multi-Project** – Scan multiple `.csproj` files in a single run
-🚫 **Obsolete Support** – `[Obsolete]` / `[Obsolete("...")]` → `/** @deprecated ... */` JSDoc
+- **Automatic Type Generation** – Convert C# models to TypeScript interfaces
+- **Custom Attribute Targeting** – Use `[TypeSharp]` or any custom attribute
+- **Nullable Support** – `string?` → `string | null`
+- **Collection Handling** – Supports `List<T>`, `IEnumerable<T>`, arrays **and generic collections**
+- **Dictionary Mapping** – `Dictionary<K, V>` → `Record<K, V>`
+- **Generic Types** – Preserves generic type definitions like `Response<T>` → `Response<T>`
+- **Inheritance** – Preserves class inheritance using `extends`
+- **Computed Properties** – Expression-bodied and block getter properties are included
+- **Naming Conventions** – Convert property names (camel, pascal, snake, kebab)
+- **Flexible Output** – Single file or multiple files
+- **Enum Support** – Converts C# enums to TypeScript string enums
+- **File Grouping** – Preserves C# file organization (multiple classes per file stay together)
+- **Auto Imports** – Automatically generates `import type` statements between output files
+- **Multi-Project** – Scan multiple `.csproj` files in a single run
+- **Obsolete Support** – `[Obsolete]` / `[Obsolete("...")]` → `/** @deprecated ... */` JSDoc
 
 ## How TypeSharp Compares
 
 This is not an OpenApi-based tool !
 | Feature | TypeSharp | NSwag | openapi-typescript | TypeGen |
 | --------------------- | --------- | ----- | ------------------ | ------- |
-| Direct C# parsing | ✅ | ❌ | ❌ | ✅ |
-| Attribute targeting | ✅ | ⚠️ | ❌ | ⚠️ |
-| Non-API models | ✅ | ❌ | ❌ | ✅ |
-| Generics preserved | ✅ | ⚠️ | ⚠️ | ⚠️ |
-| File grouping | ✅ | ❌ | ❌ | ❌ |
-| Naming control | ✅ | ⚠️ | ⚠️ | ❌ |
-| API client generation | ❌ | ✅ | ❌ | ❌ |
+| Direct C# parsing | ✓ | ✕ | ✕ | ✓ |
+| Attribute targeting | ✓ | ! | ✕ | ! |
+| Non-API models | ✓ | ✕ | ✕ | ✓ |
+| Generics preserved | ✓ | ! | ! | ! |
+| File grouping | ✓ | ✕ | ✕ | ✕ |
+| Naming control | ✓ | ! | ! | ✕ |
+| API client generation | ✕ | ✓ | ✕ | ✕ |
 
 Also see [docs/why-typesharp](docs/why-typesharp.md)
 
@@ -53,20 +53,18 @@ npm install -D @siyavuyachagi/typesharp
 
 ## Quick Start
 
-### 1. Create an attribute to target
+### 1. Install the NuGet attributes package
 
-In your target project create the following attribute (`TypeSharp`)
+In your C# project:
 
-```cs
-namespace YourProject.Attribute
-{
-  [AttributeUsage(AttributeTargets.Class | AttributeTargets.Enum)]
-  public class TypeSharpAttribute : Attribute { }
-}
+```bash
+dotnet add package TypeSharp.Attributes
 ```
 
 ### 2. Decorate your C# models or DTOs
 
+Use `[TypeSharp]` to include a class, or `[TypeSharp("name")]` to include it with a custom TypeScript type name:
+
 ```csharp
 [TypeSharp]
 public class User
@@ -263,7 +261,7 @@ TypeSharp supports multiple configuration formats:
 
 ```json
 {
-  "projectFiles": ["C:/Users/User/Desktop/MyApp/Domain/Domain.csproj"],
+  "source": ["C:/Users/User/Desktop/MyApp/Domain/Domain.csproj"],
   "outputPath": "./src/types"
 }
 ```
@@ -274,7 +272,7 @@ TypeSharp supports multiple configuration formats:
 import { TypeSharpConfig } from "typesharp";
 
 const config: TypeSharpConfig = {
-  projectFiles: ["C:/Users/User/Desktop/MyApp/Domain/Domain.csproj"],
+  source: ["C:/Users/User/Desktop/MyApp/Domain/Domain.csproj"],
   outputPath: "./src/types",
 };
 
@@ -285,7 +283,7 @@ export default config;
 
 ```javascript
 module.exports = {
-  projectFiles: ["C:/Users/User/Desktop/MyApp/Domain/Domain.csproj"],
+  source: ["C:/Users/User/Desktop/MyApp/Domain/Domain.csproj"],
   outputPath: "./src/types",
 };
 ```
@@ -403,6 +401,7 @@ export interface PermissionMap {
 ### 4. Obsolete / Deprecated Properties
 
 **C#:**
+
 ```csharp
 [TypeSharp]
 public class Employee
@@ -419,6 +418,7 @@ public class Employee
 ```
 
 **Generated TypeScript:**
+
 ```typescript
 export interface Employee {
   id: number;
@@ -430,7 +430,45 @@ export interface Employee {
 }
 ```
 
-### 5. Multi-Project
+### 5. Custom Type Name Override
+
+Use `[TypeSharp("name")]` to override the generated TypeScript type name. The override takes precedence over `namingConvention`.
+
+**C#:**
+
+```csharp
+[TypeSharp("auth_response")]
+public class AuthResponse
+{
+    public string AccessToken { get; set; }
+    public string RefreshToken { get; set; }
+}
+
+[TypeSharp("user_role")]
+public enum UserRole
+{
+    Admin,
+    User,
+    Guest
+}
+```
+
+**Generated TypeScript:**
+
+```typescript
+export interface auth_response {
+  accessToken: string;
+  refreshToken: string;
+}
+
+export enum user_role {
+  Admin = "Admin",
+  User = "User",
+  Guest = "Guest",
+}
+```
+
+### 6. Multi-Project
 
 Scan multiple C# projects at once:
 
@@ -445,7 +483,7 @@ Scan multiple C# projects at once:
 }
 ```
 
-### 6. Single Output File
+### 7. Single Output File
 
 **Config:**
 
@@ -459,7 +497,7 @@ const config: TypeSharpConfig = {
 
 All types will be generated in `src/types/types.ts`
 
-### 7. Custom Naming Conventions
+### 8. Custom Naming Conventions
 
 **Config:**
 
@@ -517,7 +555,7 @@ generateTypes();
 
 ## Requirements
 
-- Node.js >= 14
+- Node.js >= 20
 - TypeScript >= 4.5 (if using TypeScript config)
 
 ## License

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@siyavuyachagi/typesharp",
   "description": "Generate TypeScript types from C# models with TypeSharp attribute",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "license": "MIT",
   "author": "Siyavuya Chagi <syavuya08@gmail.com>",
   "repository": {