Skip to content

theolivenbaum/h5

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
H5
 
 
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 

h5 πŸš€ - C# to JavaScript compiler

H5 is a modern fork of the original Bridge C# to Javascript compiler, updated to support multi-platform development using .NET 7.0 for the compiler and .NET Standard 2.1 for H5 projects, while dropping support for legacy features and dependencies.

H5 is under active development, and targets a more integrated and faster development experience for C# web-developers.

Package NuGet
Compiler Nuget
Base Library Nuget
Core Library Nuget
SDK Target Nuget
Json Library Nuget
Template Nuget
UI Toolkit Nuget

Getting Started ⚑

Gitter

H5 projects are based on netstandard2.1, and the compiler on net7.0, and removes legacy dependencies coming from the original Bridge source-code.

To get started with it, you can use the following project template (replace h5.Target/* with the latest version from h5.target).

<Project Sdk="h5.Target/*">
  <PropertyGroup>
    <TargetFramework>netstandard2.1</TargetFramework>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="h5" Version="*" />
    <PackageReference Include="h5.Core" Version="*" />
  </ItemGroup>
</Project>

The Sdk target above (<Project Sdk="h5.Target/*">) will automatically install (and update) the compiler as a dotnet global tool.

You can also manually install it with:

dotnet tool update --global h5-compiler

You can also install a dotnet new template (latest version: Nuget):

dotnet new --install h5.Template

And create a new project with:

dotnet new h5

Samples

The easiest way to get started is to check out some of the examples of using h5 in this repository.

Breaking Changes πŸ’₯

This fork introduces a series of breaking changes as part of the modernization effort:

  • Projects must explicitly target netstandard2.1.
  • Drop support to the legacy .csproj format (only SDK-style projects are supported)
  • Drop support for legacy (and unused) command line arguments (check h5 -h for supported arguments)
  • Compiler is distributed as a dotnet global tool and have it's own versioning and auto-update on build (this can be disable by setting <UpdateH5>false<UpdateH5/> on your project file.
  • Retyped packages are not supported (as those are maintained by the Bridge authors, and cannot be built separately or consumed without the Bridge NuGet package).
  • Logging and Report options have been removed from the h5.json config file.
  • Hosted Compiler process (to speed up compilation and avoiding reloading assemblies that don't change often (like NuGet packages).

Update Notes πŸ“‘

To avoid any conflicts with the original Bridge ecosystem, all packages have been renamed. For upgrading, you can use the following mapping:

Other packages might be added in the future as we experiment with this fork, but we do not aim on providing any kind of Retyped replacement here. If you're missing any specific Retyped package, open an issue and I can take a look into publishing it derived from the Retyped ones.