Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.
/ mirepoix Public archive

A small collection of utility APIs including command line argument splitting and quoting, file system globbing, cross platform process execution, and console output redirection handling.

License

Notifications You must be signed in to change notification settings

xamarin/mirepoix

Repository files navigation

Mirepoix

Build Status

A mirepoix (/mɪərˈpwɑː/ meer-PWAH) is a flavor base made from diced vegetables that are cooked, usually with butter or oil or other fat, for a long time on a low heat without color or browning.

This project contains a handful of useful utility libraries for constructing applications. All libraries target .NET Standard 2.0, but may have platform-specific components.

Most of the functionality in this project has been derived from various utility APIs within other projects within Xamarin, particularly Xamarin Workbooks.

Please browse the full documentation for more information on consuming Mirepoix libraries.

Use

Mirepoix is currently distributed on MyGet while it is still establishing itself. It will move to nuget.org eventually.

Add the feed to your project's NuGet.config to reference packages.

NuGet.config

<configuration>
  <packageSources>
    <add
      key="mirepoix"
      value="https://www.myget.org/F/mirepoix/api/v3/index.json"/>
  </packageSources>
</configuration>

Hack

.NET Core 2.1 is used to build, test, and package Mirepoix.

Build all Projects

dotnet build

Package all NuGets

dotnet pack

Write

  • Open the root of the repository as a workspace in VS Code (code .) and ensure OmniSharp is using mirepoix.sln

  • Or open mirepoix.sln in Visual Studio or Visual Studio for Mac.

Test

It's best to simply run dotnet xunit at the root of the src/*.Tests/ directory to run scoped tests for the library of interest.

Unfortunately running dotnet test at the root of the repository fails on both Windows and macOS locally, even though VSTS is happy to do it.

CI

VSTS is used to produce official builds. See .vsts-ci.yml.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

About

A small collection of utility APIs including command line argument splitting and quoting, file system globbing, cross platform process execution, and console output redirection handling.

Resources

License

Stars

Watchers

Forks

Packages

No packages published