Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/betwixt-labs/dot-env-generator
A source generator for C# that turns .env files into runtime constants.
https://github.com/betwixt-labs/dot-env-generator
Last synced: about 1 month ago
JSON representation
A source generator for C# that turns .env files into runtime constants.
- Host: GitHub
- URL: https://github.com/betwixt-labs/dot-env-generator
- Owner: betwixt-labs
- License: mit
- Created: 2021-11-08T05:02:16.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-05T23:33:44.000Z (about 2 years ago)
- Last Synced: 2024-11-02T17:03:47.951Z (about 1 month ago)
- Language: C#
- Size: 38.1 KB
- Stars: 32
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - dot-env-generator - labs/dot-env-generator (Do not want to test 112 ( old ISourceGenerator ) / 1. [ThisAssembly](https://ignatandrei.github.io/RSCG_Examples/v2/docs/ThisAssembly) , in the [EnhancementProject](https://ignatandrei.github.io/RSCG_Examples/v2/docs/rscg-examples#enhancementproject) category)
README
# dot-env-generator
A source generator for C# that turns .env files into runtime constants.
## Basic Usage
| NuGet | | [![DotEnvGenerator][1]][2] |
| :--------------- | ----: | :--------------------------------------------------------------- |
| Package Manager | `PM>` | `Install-Package DotEnvGenerator -Version 0.1.0` |
| .NET CLI | `>` | `dotnet add package DotEnvGenerator --version 0.1.0` |
| PackageReference | | `` |
| Paket CLI | `>` | `paket add DotEnvGenerator --version 0.1.0` |
[1]: https://img.shields.io/nuget/v/DotEnvGenerator.svg?label=DotEnvGenerator
[2]: https://www.nuget.org/packages/DotEnvGenerator
After adding the source generator to your project add an item group to your project that references your .env file like so:
```xml
```
The contents of your .env file would look something like this:
```env
# A string literal
A_STRING="yep, that is a string."
# A string
ALSO_STRING=RANDOM_0026256698
# An array of string
STRING_ARRAY=one,two,three,four,five
# An array of numbers
INT_ARRAY=1, 2, 3, 4, 5, 6, 7
A_NUMBER=1000
A_BIGGER_NUMBER=10_000_000
A_GUID=de095b54-2082-40f8-a928-794da5675e7c
A_DATE_TIME=Tue, 1 Jan 2008 00:00:00Z
# A base64 encoded bytearray
A_BYTE_ARRAY=d2hhdA==
A_DOUBLE=1.0
A_SCIENCE_DOUBLE=3.2e23
A_DOUBLE_LITERAL=1.0D
A_HEX=0xFF0000
A_UINT=2000U
A_LONG=2000L
A_ULONG=2000UL
A_NEGATIVE_LONG=-2000L
```
And the generator will turn it into this:
```csharp
using System;
namespace DotEnv.Generated
{
///
/// An auto-generated class which holds constants derived from 'example.env'
///
public static class ExampleEnvironment
{
/// A string literal
public const System.String AString = "yep, that is a string.";
/// A string
public const System.String AlsoString = "RANDOM_0026256698";
/// An array of string
public static readonly IReadOnlyList StringArray = new string[] { "one", "two", "three", "four", "five" };
/// An array of numbers
public static readonly IReadOnlyList IntArray = new System.Int32[] { 1, 2, 3, 4, 5, 6, 7 };
public const System.Int32 ANumber = 1000;
public const System.Int32 ABiggerNumber = 10_000_000;
public static readonly System.Guid AGuid = Guid.Parse("de095b54-2082-40f8-a928-794da5675e7c");
public static readonly System.DateTime ADateTime = DateTime.Parse("Tue, 1 Jan 2008 00:00:00Z");
/// A base64 encoded bytearray
public static ReadOnlySpan AByteArray => new byte[] { 0x77, 0x68, 0x61, 0x74 };
public const System.Double ADouble = 1.0;
public const System.Double AScienceDouble = 3.2e23;
public const System.Double ADoubleLiteral = 1.0D;
public const System.Int32 AHex = 0xFF0000;
public const System.UInt32 AUint = 2000U;
public const System.Int64 ALong = 2000L;
public const System.UInt64 AUlong = 2000UL;
public const System.Int64 ANegativeLong = -2000L;
}
}
```
The source generator will use your .env file first as a lookup table. Using the left-hand declarations the generator will check for an environment variable with that name in descending order (machine, user, and finally the process.)
If the variable does not exist in any of these stores, the value on the right is used. If no default value is defined, an error is reported.
The value parsing rules are simple:
- Anything wrapped in double quotes is treated as a string.
- If an array has multiple types the entire array is treated as an array of strings.
- Any value that cannot have its CLR type determined is treated as a string.
- Base64 strings are always considered to be byte arrays.
## Known Issues
- Some strings may be detected as being Base64 even if they aren't. If you encounter this issue just wrap you string in double quotes.
- No tokenzation or lexing is performed on the .env file, and as such there is no validation of the .env file or its values. The parsing is very rudimentary.