feat: add option to allow line breaks in values

[andreialecu]

Closes #458

This adds an option { multiline: "line-breaks" } that allows values to contain new lines. See https://github.com/bkeepers/dotenv#multi-line-values for an additional explanation.

The documentation was updated

Also, in the process I discovered that stubbing parse was not working properly in tests, so I changed the exports a bit to fix this and accommodate a new test for this option.

[andreialecu]

See https://stackoverflow.com/questions/46124087/sinon-stub-spy-on-local-functions-in-unit-testing for an explanation of why this was necessary

[ivan-californias]

Any chance of this getting reviewed & merged in the near future?

This also would had solved #196, #391 and #28 which were closed without a real solution

[Asuza]

@motdotla what do you think of this change? It seems like a great addition to a very useful tool.

[andreialecu]

If anyone is interested in a different solution for this:

Even though I made this PR, I ended up just using base64 encoded variables.

If you use VSCode, an extension like https://marketplace.visualstudio.com/items?itemName=adamhartford.vscode-base64 makes it very easy to encode/decode (multiline) strings in your .env file.

You can then use a package like https://www.npmjs.com/package/env-var to manage how you consume the variables in your app:

Your .env file:

SOME_CERTIFICATE=somebase64encodedstring

Code:

import env from 'env-var';

require('dotenv').config();

const certificate = env
      .get("SOME_CERTIFICATE")
      .required()
      .convertFromBase64()
      .asString()

[motdotla]

This is a great addition @andreialecu. Thank you. We might make some small modifications but otherwise, this will be something we release relatively soon.

[Dunky13]

This is awesome! It would really help me out! Do you also need to update the .d.ts file? Or is that done automagically?

[wuntusk]

Would really love to see this in.

[JohnRachid]

Can we please get this resolved and merged?

[motdotla]

I should be getting this merged and released today. Thank you for your incredible patience. 💛

[motdotla]

Thank you for this @andreialecu. It's been merged. I will sit on it for a day or two - testing it incrementally by hand. When comfortable then I will release it. Code is very complete but sometimes edge cases sneak in.