feat: envFiles in netlify.toml

[iib0011]

Summary

Fixes #4272

We can now set a list in netlify.toml in the dev section like this

env_files = [ ".env", ".env.local" ]

We can also set

env_files = [ ]

to avoid any env file being injected

[erezrokah]

Thanks @iib0011, you're on 🔥

I suggest keeping this feature limited to the [dev] block for now, and also name the property envFiles (to match our naming convention) and communicate this is not only about priority, but also which files to use (if any).

Please let me know what you think

[erezrokah]

Thanks for following up with the changes @iib0011, add another comment.
Also do you mind documenting this under https://github.com/netlify/cli/blob/808a54c9900faf144349df1acd21f3884b7e8098/docs/netlify-dev.md#netlifytoml-dev-block and adding a test similar to

cli/tests/integration/300.command.dev.test.js

Line 162 in 808a54c

test(testName('should pass .env.development vars to function', args), async (t) => {

?

[iib0011]

okay

[iib0011]

@erezrokah should I create a test in each .dev.test file? And can you pls explain to me why there are 8 different test files

[erezrokah]

@erezrokah should I create a test in each .dev.test file? And can you pls explain to me why there are 8 different test files

That's a very good question. You can create a test in the file I linked. See more in #4178 for the reason we have many test files

[iib0011]

thanks. I just commited the test

[iib0011]

@erezrokah It is fixed now

[erezrokah]

🚀

[Soviut]

@erezrokah @iib0011 Tested and it works well.

https://docs.netlify.com/configure-builds/file-based-configuration/ This will need to be documented here.

[awacode21]

i was searching on how to load an .env.local with netlify dev. Have nothing found in official documentation. only your report here. So is it usable, or is it future music?

[Soviut]

@awacode21 it's usable since the 9.7.0 release, however, the documentation is lagging behind. As far as I can tell, the docs are not available as a public repo to make PRs to.

Note that the priority is highest to lowest; highest on the left of the array, lowest on the right. So a variable defined in an env file will override any conflicting variables in the files to the right of it in the array.

[dev]
  envFiles = [".env.netlify.local", ".env.netlify"]

[awacode21]

@Soviut thank you for the detailed explanation and your help :-)