delegateas/fsharp.typeproviders.starterpack

What you need to get started in type provider creation

F# Type Provider Starter Pack

The F# Type Provider Starter Pack is two things: a code only NuGet package with the code files you'll need to get you started in type provider creation, and a repository of tutorials that will (hopefully, over time) answer all your questions about how to build type providers, best practices and general hints and tips.

This package is still currently pre-release, and actively seeking contributions towards documentation (the plan is a GitHub page setup similar to FSharp.Data) with examples of all the most common features of Type Providers that people will want to use (basic erased type generation, parameterized providers, full generated types, seperating design and runtime how's and why's, etc). It will also become the main place for improvements and additions to the ProvidedTypes code.

Once it has reached an acceptable standard of documentation/helpfulness ownership will be transferred to the F# Foundation.

Build status

Windows (.net)

MacOS (mono)

Documentation

Building a type provider nearly always starts with adding the ProvidedTypes.fs and ProvidedTypes.fsi. The Starter Pack NuGet package contains both these files as well as a set of debugging helpers, and when you install it, it should add them all to your F# project. It's probably best not to modify the files after adding them as upgrades to the package will ask to replace the previous versions - either submit changes back to this project or shadow the relevant functions in a seperate file.

For advice on how to get started building a type provider, check out:

• Type Providers from the ground up
• (and the follow up posts)
• The MSDN Tutorial. The code in this package replaces the code from the sample pack it mentions.

Support and community

• If you have a question about FSharp, ask at StackOverflow and mark your question with the f# tag.
• If you want to submit a bug, a feature request or help with fixing bugs then look at issues.
• To discuss more general issues about F# Type Providers Starter Pack, its goals and other open-source F# projects, join the fsharp-opensource mailing list

Building

• This repository contains no compiled code.

Library license

The library is available under Apache 2.0. For more information see the License file in the GitHub repository.

Maintainer(s)

• @mavnn
• @ovatsus

The default maintainer account for projects under "fsprojects" is @fsprojectsgit - F# Community Project Incubation Space (repo management)