|
1 | 1 | # Changelog |
2 | 2 |
|
3 | | -All notable changes to VueSanity are documented here. |
| 3 | +All notable changes to this project will be documented in this file. |
4 | 4 |
|
5 | | -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
6 | | -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/). |
7 | 7 |
|
8 | | -## [1.0.0] - 2025-12-12 |
| 8 | +## Important note |
| 9 | +TypeSharp is NOT an OpenAPI-based tool. It parses C# projects directly, targeting classes and enums decorated with a `[TypeSharp]` (or other configured) attribute. It preserves generics, inheritance, file grouping, and supports multiple collection types and naming conventions — see the README for details. |
9 | 10 |
|
10 | | -### 🎉 Features |
| 11 | +<!-- ## [Unreleased] |
11 | 12 |
|
12 | | -- |
| 13 | +### Added |
| 14 | +- Placeholder for upcoming features and fixes. |
13 | 15 |
|
14 | | -### 🧪 Tests |
| 16 | +### Changed |
| 17 | +- — |
15 | 18 |
|
16 | | -- |
| 19 | +### Fixed |
| 20 | +- — |
17 | 21 |
|
18 | | -### 📚 Documentation |
| 22 | +### Removed |
| 23 | +- — |
19 | 24 |
|
20 | | -- |
| 25 | +--- --> |
21 | 26 |
|
22 | | -### ⌛ Maintanance |
| 27 | +## [0.1.0] - 2025-12-19 |
23 | 28 |
|
24 | | -- |
| 29 | +### Summary |
| 30 | +Initial public release of TypeSharp — a direct C# → TypeScript generator that is NOT OpenAPI-based. |
25 | 31 |
|
26 | | -### 📝 Notes |
| 32 | +### Key characteristics (callouts) |
| 33 | +- Direct C# parsing (not derived from OpenAPI/Swagger). |
| 34 | +- Attribute targeting: only classes/enums decorated with the configured attribute are converted. |
| 35 | +- Generic types preserved (e.g., `Response<T>` → `Response<T>`). |
| 36 | +- File grouping preserved — classes declared together in C# files can be emitted together. |
| 37 | +- Naming conversion options (camelCase, PascalCase, snake_case, kebab-case). |
| 38 | +- Collection handling (arrays, List<T>, IEnumerable<T>, generic collections). |
| 39 | +- Enum conversion to TypeScript enums. |
| 40 | +- Does not generate API clients; it focuses on types. |
27 | 41 |
|
28 | | -- |
| 42 | +### Added |
| 43 | +- Initial public release of `typesharp`. |
| 44 | +- Core library functionality (public API, core utilities). |
| 45 | +- TypeScript type definitions and runtime validation helpers. |
| 46 | +- Command-line interface (CLI) scaffolding for common developer workflows. |
| 47 | +- Getting started guide and examples in README. |
| 48 | +- Basic automated tests and CI configuration (unit test runner and linting). |
| 49 | + |
| 50 | +<!-- ### Changed |
| 51 | +- Not applicable for initial release. |
| 52 | +
|
| 53 | +### Fixed |
| 54 | +- Not applicable for initial release. |
| 55 | +
|
| 56 | +### Removed |
| 57 | +- Not applicable for initial release. --> |
| 58 | + |
| 59 | +## Contributors |
| 60 | +- @siyavuyachagi — initial author and maintainer. |
| 61 | + |
| 62 | +--- |
| 63 | + |
| 64 | +For more details and context, see the README: https://github.com/siyavuyachagi/typesharp#readme |
0 commit comments