sharp2Js is a small library that can create javascript objects that mirror your C# POCO classes and can be easily used to generate js files using T4 templates.
- Optionally generates merge map function to make applying model changes easy
- Optionally generates a deep comparison
$equalsfunction to compare equality easily - Handle custom types, primitives, arrays, recursive types, structs, enums, and collections (
IList,ICollection,IDictionary) - Allows for an override constructor if you need to wrap the created objects (e.g. for Angular)
- Outputs to string for easy addition to
T4template output or otherwise - Supports optional camel casing
- Supports optional automatic removal of phrases like Dto, etc
- Supports the
[DefaultValue]attribute for primitive types - Supports
[IgnoreDataMember]and[DataMember]attributes - Supports custom function injection into generated Js objects
sharp2Js can be installed via the nuget UI (as sharp2Js), or via the nuget package manager console:
PM> Install-Package sharp2Js
<#@ templatedebug="false"hostspecific="false"language="C#" #><#@ assembly name="System.Core" #><#@ import namespace="System.Linq" #><#@ import namespace="System.Text" #><#@ import namespace="System.Collections.Generic" #><#@ output extension=".js" #><#@ assembly name="$(ProjectDir)bin\$(ConfigurationName)\Castle.Sharp2Js.dll" #><#@ output extension=".js" #><# var str = Castle.Sharp2Js.JsGenerator.Generate(new[]{typeof(Castle.Sharp2Js.SampleData.AddressInformation)}); #>models={};<#=str#>publicclassAddressInformation{publicstringName{get;set;}publicstringAddress{get;set;}publicintZipCode{get;set;}publicOwnerInformationOwner{get;set;}publicList<Feature>Features{get;set;}publicList<string>Tags{get;set;}}publicclassOwnerInformation{publicstringFirstName{get;set;}publicstringLastName{get;set;}publicintAge{get;set;}}publicclassFeature{publicstringName{get;set;}publicdoubleValue{get;set;}}models = {};
models.AddressInformation = function (cons, overrideObj) {
if (!overrideObj) { overrideObj = { }; }
if (!cons) { cons = { }; }
var i, length;
this.Name = cons.Name;
this.Address = cons.Address;
this.ZipCode = cons.ZipCode;
if (!overrideObj.OwnerInformation) {
this.Owner = new models.OwnerInformation(cons.Owner);
} else {
this.Owner = new overrideObj.OwnerInformation(cons.Owner, overrideObj);
}
this.Features = new Array(cons.Features == null ? 0 : cons.Features.length );
if(cons.Features != null) {
for (i = 0, length = cons.Features.length; i < length; i++) {
if (!overrideObj.Feature) {
this.Features[i] = new models.Feature(cons.Features[i]);
} else {
this.Features[i] = new overrideObj.Feature(cons.Features[i], overrideObj);
}
}
}
this.Tags = new Array(cons.Tags == null ? 0 : cons.Tags.length );
if(cons.Tags != null) {
for (i = 0, length = cons.Tags.length; i < length; i++) {
this.Tags[i] = cons.Tags[i];
}
}
}
models.OwnerInformation = function (cons) {
if (!cons) { cons = { }; }
this.FirstName = cons.FirstName;
this.LastName = cons.LastName;
this.Age = cons.Age;
}
models.Feature = function (cons) {
if (!cons) { cons = { }; }
this.Name = cons.Name;
this.Value = cons.Value;
}
- Support for
.Net Standard 2.0
- Addresses
OutOfMemoryExceptioncaused by some object graphs.
- Adds support for an
$equalsmethod that can be used to perform deep comparisons on objects - Fixes an issue that caused
boolDefaultValuevalues to be rendered improperly - Switches to Appveyor CI
- Adds coveralls/OpenCover support
- Adds support for
Enumtypes - Adds support for custom function parsers if you want to add your own custom functions to the output
- Adds support for all
IList,ICollection, andIDictionarytypes - Light internal refactoring for maintainability
- Fixes the camel-casing implementation
- Fixes an issue with improperly initialized object types
- Adds support for the
DefaultValueAttributeon primitive types - Test coverage upped to 100%
- Adds Slack integration to CI
- Switches to NUnit for unit tests
- Adds support for
DataMemberandIgnoreDataMemberattributes
- Adds support for array and recursive types
- Includes NuGet package
- Adds
$mergefunction to perform a deep merge on objects
- Initial Commit/Version
Any improvements are welcome. sharp2Js has served our limited purposes so far, but we would love to see it grow.