From 1a80834129855c86ec51a93eeaeb74eddea57853 Mon Sep 17 00:00:00 2001 From: Zohar Peled Date: Tue, 1 Jul 2025 12:23:20 +0300 Subject: [PATCH 1/4] Update README.md --- README.md | 49 +++++++++++++++++++++++++++++++++++++------------ 1 file changed, 37 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fb0902f..0142d6b 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,18 @@ This extension helps developers quickly create and maintain supporting classes, enhancing productivity and reducing manual coding errors. **AutoEntityGenerator** logs to event log, meaning you can view the logs using windows Event Viewer, under "Windows logs" -> "Application" with the source "AutoEntityGenerator". +# Quick links + +- [Features](#features) +- [User feedback](#we-love-users-feedback) +- [Licence](#license) +- [Installation](#installation) +- [Target platforms](#target-platforms) +- [Usage](#usage) +- [Configuration](#configuration) +- [Want to Contribute?](#want-to-contribute) +- [Thanks!](#thank-you) + ## Features - Automatically generates DTOs from domain entity classes or records. @@ -27,17 +39,25 @@ This extension helps developers quickly create and maintain supporting classes, - All generated classes are partial, allowing users to add custom code while still maintaining the ability to re-generate if needed. - Supports generic types and generic constraints. + +## We love users Feedback! + +If you have any feedback of any kind, we would love to know about it! +Please [open a new discussion or join an existing one in the feedback category](https://github.com/Peled-Zohar/AutoEntityGenerator/discussions/categories/user-feedback). + +If encounter any bugs or have feature requests, +please join the [Suggested Features discussion]([https://github.com/Peled-Zohar/AutoEntityGenerator/discussions](https://github.com/Peled-Zohar/AutoEntityGenerator/discussions/16)) on the GitHub repository. + ## Note Currently, only types with parameterless constructors are supported for mapping generation. -If the model doesn't have a parameterless constructor, the generated mapping extension will not compile. -In future versions, I plan to support entities without parameterless constructors by allowing users to include the properties that correspond to the constructor parameters. +If the model doesn't have a parameterless constructor, the generated mapping extension can still be generated but it will not compile without manual changes. +In future versions, I'm considering to support entities without parameterless constructors by allowing users to include the properties that correspond to the constructor parameters. ## License This project is licensed under the MIT License - see the [LICENSE](/AutoEntityGenerator.Manifest/LICENSE.txt) file for details. - ## Installation ####    From Visual Studio Marketplace @@ -117,17 +137,22 @@ public static partial class CreateProductRequestDtoMappingExtensions } ``` -## Contributing -We welcome contributions to improve AutoEntityGenerator! If you encounter any bugs or have feature requests, please open an issue on the GitHub repository. +## Want to Contribute? + +We'd love your help! + +Whether it's: +- Trying the extension and giving feedback +- Suggesting a feature +- Fixing a bug +- Improving tests or docs + +Start here 👉 [How to Contribute](https://github.com/Peled-Zohar/AutoEntityGenerator/blob/main/.github/CONTRIBUTING.md) +or check out [open issues](https://github.com/Peled-Zohar/AutoEntityGenerator/issues) and [good first issues](https://github.com/Peled-Zohar/AutoEntityGenerator/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) -### Steps to Contribute -1. Fork the repository. -1. Create a new branch for your feature or bugfix. -1. Commit your changes. -1. Push the branch to your forked repository. -1. Open a pull request to the main repository. +We appreciate every bit of help 💙 -## +## Thank you! Thank you for using AutoEntityGenerator! We hope it enhances your development experience by automating the creation of DTOs and mapping methods. From efbf86c505df101de7e8936a46c81f00394bc566 Mon Sep 17 00:00:00 2001 From: Zohar Peled Date: Tue, 1 Jul 2025 12:24:50 +0300 Subject: [PATCH 2/4] Update README.md --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0142d6b..26473bc 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,11 @@ **AutoEntityGenerator** is a Visual Studio extension that simplifies the process of generating Data Transfer Objects (DTOs) and mapping extensions based on existing domain entity classes. This extension helps developers quickly create and maintain supporting classes, enhancing productivity and reducing manual coding errors. -**AutoEntityGenerator** logs to event log, meaning you can view the logs using windows Event Viewer, under "Windows logs" -> "Application" with the source "AutoEntityGenerator". -# Quick links +### Quick links - [Features](#features) +- [Technical Notes](#technical-notes) - [User feedback](#we-love-users-feedback) - [Licence](#license) - [Installation](#installation) @@ -48,7 +48,9 @@ Please [open a new discussion or join an existing one in the feedback category]( If encounter any bugs or have feature requests, please join the [Suggested Features discussion]([https://github.com/Peled-Zohar/AutoEntityGenerator/discussions](https://github.com/Peled-Zohar/AutoEntityGenerator/discussions/16)) on the GitHub repository. -## Note +## Technical Notes + +**AutoEntityGenerator** logs to event log, meaning you can view the logs using windows Event Viewer, under "Windows logs" -> "Application" with the source "AutoEntityGenerator". Currently, only types with parameterless constructors are supported for mapping generation. If the model doesn't have a parameterless constructor, the generated mapping extension can still be generated but it will not compile without manual changes. From c5dea60d9e6b6365208e99e289dc34430fd0b8e2 Mon Sep 17 00:00:00 2001 From: Zohar Peled Date: Tue, 1 Jul 2025 12:28:30 +0300 Subject: [PATCH 3/4] Update README.md --- README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26473bc..5e31b80 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ This extension helps developers quickly create and maintain supporting classes, - [Target platforms](#target-platforms) - [Usage](#usage) - [Configuration](#configuration) +- [Example](#example) - [Want to Contribute?](#want-to-contribute) - [Thanks!](#thank-you) @@ -39,6 +40,11 @@ This extension helps developers quickly create and maintain supporting classes, - All generated classes are partial, allowing users to add custom code while still maintaining the ability to re-generate if needed. - Supports generic types and generic constraints. +
+ + [back to the top](#autoentitygenerator) + +
## We love users Feedback! @@ -48,6 +54,12 @@ Please [open a new discussion or join an existing one in the feedback category]( If encounter any bugs or have feature requests, please join the [Suggested Features discussion]([https://github.com/Peled-Zohar/AutoEntityGenerator/discussions](https://github.com/Peled-Zohar/AutoEntityGenerator/discussions/16)) on the GitHub repository. +
+ + [back to the top](#autoentitygenerator) + +
+ ## Technical Notes **AutoEntityGenerator** logs to event log, meaning you can view the logs using windows Event Viewer, under "Windows logs" -> "Application" with the source "AutoEntityGenerator". @@ -56,10 +68,22 @@ Currently, only types with parameterless constructors are supported for mapping If the model doesn't have a parameterless constructor, the generated mapping extension can still be generated but it will not compile without manual changes. In future versions, I'm considering to support entities without parameterless constructors by allowing users to include the properties that correspond to the constructor parameters. +
+ + [back to the top](#autoentitygenerator) + +
+ ## License This project is licensed under the MIT License - see the [LICENSE](/AutoEntityGenerator.Manifest/LICENSE.txt) file for details. +
+ + [back to the top](#autoentitygenerator) + +
+ ## Installation ####    From Visual Studio Marketplace @@ -72,10 +96,22 @@ This project is licensed under the MIT License - see the [LICENSE](/AutoEntityGe    Alternatively, you can install the extension by downloading the `.vsix` file from the latest [release](https://github.com/Peled-Zohar/AutoEntityGenerator/releases).    Once downloaded, double-click the `.vsix` file and follow the instructions in the VSIX installer to complete the installation. +
+ + [back to the top](#autoentitygenerator) + +
+ ## Target platforms Supported targets are visual studio 2022 - Community, Professinal and Enterprise editions. +
+ + [back to the top](#autoentitygenerator) + +
+ ## Usage 1. Open your project in Visual Studio. @@ -85,6 +121,12 @@ Supported targets are visual studio 2022 - Community, Professinal and Enterprise 6. Configure the generation options in the UI dialog that appears. 7. Click OK to generate the DTOs and mapping extensions. +
+ + [back to the top](#autoentitygenerator) + +
+ ## Configuration **AutoEntityGenerator** allows you to configure various aspects of the code generation process, including: @@ -103,6 +145,12 @@ Supported targets are visual studio 2022 - Community, Professinal and Enterprise - The default destination folder - The default suffix for request and response DTOs +
+ + [back to the top](#autoentitygenerator) + +
+ ## Example Suppose you have a domain entity class `Product`: @@ -138,7 +186,11 @@ public static partial class CreateProductRequestDtoMappingExtensions } } ``` - +
+ + [back to the top](#autoentitygenerator) + +
## Want to Contribute? @@ -155,6 +207,18 @@ or check out [open issues](https://github.com/Peled-Zohar/AutoEntityGenerator/is We appreciate every bit of help 💙 +
+ + [back to the top](#autoentitygenerator) + +
+ ## Thank you! Thank you for using AutoEntityGenerator! We hope it enhances your development experience by automating the creation of DTOs and mapping methods. + +
+ + [back to the top](#autoentitygenerator) + +
From b90573ab1a655e5224ccb467059766a18f942d8f Mon Sep 17 00:00:00 2001 From: Zohar Peled Date: Tue, 1 Jul 2025 12:33:58 +0300 Subject: [PATCH 4/4] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5e31b80..c15268f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ This extension helps developers quickly create and maintain supporting classes, - [Features](#features) - [Technical Notes](#technical-notes) -- [User feedback](#we-love-users-feedback) +- [User feedback](#we-love-feedback) - [Licence](#license) - [Installation](#installation) - [Target platforms](#target-platforms) @@ -46,13 +46,13 @@ This extension helps developers quickly create and maintain supporting classes, -## We love users Feedback! +## We love Feedback! If you have any feedback of any kind, we would love to know about it! Please [open a new discussion or join an existing one in the feedback category](https://github.com/Peled-Zohar/AutoEntityGenerator/discussions/categories/user-feedback). -If encounter any bugs or have feature requests, -please join the [Suggested Features discussion]([https://github.com/Peled-Zohar/AutoEntityGenerator/discussions](https://github.com/Peled-Zohar/AutoEntityGenerator/discussions/16)) on the GitHub repository. +If you encounter any bugs or have feature requests, +please join the [Suggested Features discussion](https://github.com/Peled-Zohar/AutoEntityGenerator/discussions/16) on the GitHub repository.
@@ -104,7 +104,7 @@ This project is licensed under the MIT License - see the [LICENSE](/AutoEntityGe ## Target platforms -Supported targets are visual studio 2022 - Community, Professinal and Enterprise editions. +Supported targets are visual studio 2022 - Community, Professional and Enterprise editions.
@@ -137,7 +137,7 @@ Supported targets are visual studio 2022 - Community, Professinal and Enterprise - The generated file name - The generated mapping direction (from DTO to Model or from Model to DTO) -## Default condiguration +## Default configuration **AutoEntityGenerator** allows you to configure some default values for the extension: