feat: envFiles in netlify.toml

site/scripts/docs.mjs

@@ -1,6 +1,6 @@
 // @ts-check
 import { basename, join } from 'path'
-import { env } from 'process'
+import { env, platform } from 'process'
 import { fileURLToPath } from 'url'
 
 import markdownMagic from 'markdown-magic'
@@ -9,7 +9,11 @@ import stripAnsi from 'strip-ansi'
 import { generateCommandData } from './generate-command-data.mjs'
 
 const rootDir = fileURLToPath(new URL('../..', import.meta.url))
-const markdownFiles = [join(rootDir, 'README.md'), join(rootDir, 'docs/**/**.md')]
+const isWindows = platform === 'win32'
+const markdownFiles = [
+  isWindows ? join(rootDir, 'README.md').replace(/\\/g, '/') : join(rootDir, 'README.md'),
+  isWindows ? join(rootDir, 'docs/**/**.md').replace(/\\/g, '/') : join(rootDir, 'docs/**/**.md'),
+]
 
 env.DOCS_GEN = 'TRUE'
 

src/commands/dev/dev-exec.js

@@ -8,8 +8,8 @@ const { injectEnvVariables } = require('../../utils')
  * @param {import('../base-command').BaseCommand} command
  */
 const devExec = async (cmd, options, command) => {
-  const { cachedConfig, site } = command.netlify
-  await injectEnvVariables({ env: cachedConfig.env, site })
+  const { cachedConfig, config, site } = command.netlify
+  await injectEnvVariables({ devConfig: { ...config.dev }, env: cachedConfig.env, site })
 
   await execa(cmd, command.args.slice(1), {
     stdio: 'inherit',

src/commands/dev/dev.js

@@ -325,8 +325,10 @@ const dev = async (options, command) => {
       '--trafficMesh and -t are deprecated and will be removed in the near future. Please use --edgeHandlers or -e instead.',
     )
   }
-
-  await injectEnvVariables({ env: command.netlify.cachedConfig.env, site })
+  if (options.env) {
+    devConfig.envPriority = options.env.split(' ')
+  }
+  await injectEnvVariables({ devConfig, env: command.netlify.cachedConfig.env, site })
 
   const { addonsUrls, capabilities, siteUrl, timeouts } = await getSiteInformation({
     // inherited from base command --offline
@@ -463,6 +465,7 @@ const createDevCommand = (program) => {
     .option('-o ,--offline', 'disables any features that require network access')
     .option('-l, --live', 'start a public live session', false)
     .option('--functionsPort <port>', 'port of functions server', (value) => Number.parseInt(value))
+    .option('-e, --env <env>', 'set the env files priority', false)
     .addOption(
       new Option('--staticServerPort <port>', 'port of the static app server used when no framework is detected')
         .argParser((value) => Number.parseInt(value))

src/commands/dev/types.d.ts

@@ -17,5 +17,6 @@ export type DevConfig = {
   https?: {
     keyFile: string
     certFile: string
-  }
+  },
+  envPriority?:string[]
 }

src/commands/functions/functions-create.js

@@ -477,8 +477,14 @@ const createFunctionAddon = async function ({ addonName, addons, api, siteData,
  * @param {(command: import('../base-command').BaseCommand) => any} config.onComplete
  */
 const handleOnComplete = async ({ command, onComplete }) => {
+  const { config } = command.netlify
+
   if (onComplete) {
-    await injectEnvVariables({ env: command.netlify.cachedConfig.env, site: command.netlify.site })
+    await injectEnvVariables({
+      devConfig: { ...config.dev },
+      env: command.netlify.cachedConfig.env,
+      site: command.netlify.site,
+    })
     await onComplete.call(command)
   }
 }
@@ -491,6 +497,8 @@ const handleOnComplete = async ({ command, onComplete }) => {
  * @param {string} config.fnPath
  */
 const handleAddonDidInstall = async ({ addonCreated, addonDidInstall, command, fnPath }) => {
+  const { config } = command.netlify
+
   if (!addonCreated || !addonDidInstall) {
     return
   }
@@ -508,7 +516,11 @@ const handleAddonDidInstall = async ({ addonCreated, addonDidInstall, command, f
     return
   }
 
-  await injectEnvVariables({ env: command.netlify.cachedConfig.env, site: command.netlify.site })
+  await injectEnvVariables({
+    devConfig: { ...config.dev },
+    env: command.netlify.cachedConfig.env,
+    site: command.netlify.site,
+  })
   addonDidInstall(fnPath)
 }
 

src/commands/functions/functions-serve.js

@@ -17,7 +17,7 @@ const functionsServe = async (options, command) => {
 
   const functionsDir = getFunctionsDir({ options, config }, join('netlify', 'functions'))
 
-  await injectEnvVariables({ env: command.netlify.cachedConfig.env, site })
+  await injectEnvVariables({ devConfig: { ...config.dev }, env: command.netlify.cachedConfig.env, site })
 
   const { capabilities, siteUrl, timeouts } = await getSiteInformation({
     offline: options.offline,

src/utils/dev.js

@@ -139,9 +139,9 @@ const getEnvSourceName = (source) => {
 
 // Takes a set of environment variables in the format provided by @netlify/config, augments it with variables from both
 // dot-env files and the process itself, and injects into `process.env`.
-const injectEnvVariables = async ({ env, site }) => {
+const injectEnvVariables = async ({ devConfig, env, site }) => {
   const environment = new Map(Object.entries(env))
-  const dotEnvFiles = await loadDotEnvFiles({ projectDir: site.root })
+  const dotEnvFiles = await loadDotEnvFiles({ envPriority: devConfig.envPriority, projectDir: site.root })
 
   dotEnvFiles.forEach(({ env: fileEnv, file }) => {
     Object.keys(fileEnv).forEach((key) => {

src/utils/dot-env.js

@@ -8,8 +8,8 @@ const { isFileAsync } = require('../lib/fs')
 
 const { warn } = require('./command-helpers')
 
-const loadDotEnvFiles = async function ({ projectDir }) {
-  const response = await tryLoadDotEnvFiles({ projectDir })
+const loadDotEnvFiles = async function ({ envPriority, projectDir }) {
+  const response = await tryLoadDotEnvFiles({ projectDir, dotenvFiles: envPriority })
 
   const filesWithWarning = response.filter((el) => el.warning)
   filesWithWarning.forEach((el) => {
@@ -19,8 +19,9 @@ const loadDotEnvFiles = async function ({ projectDir }) {
   return response.filter((el) => el.file && el.env)
 }
 
-const tryLoadDotEnvFiles = async ({ projectDir }) => {
-  const dotenvFiles = ['.env', '.env.development']
+const defaultEnvPriority = ['.env', '.env.development', '.env.local', '.env.development.local']
+
+const tryLoadDotEnvFiles = async ({ projectDir, dotenvFiles = defaultEnvPriority }) => {
   const results = await Promise.all(
     dotenvFiles.map(async (file) => {
       const filepath = path.resolve(projectDir, file)

src/utils/init/utils.js

@@ -198,6 +198,7 @@ const getNetlifyToml = ({
   #  command = "yarn start" # Command to start your dev server
   #  port = 3000 # Port that the dev server will be listening on
   #  publish = "dist" # Folder with the static content for _redirect file
+  #  env_priority = [ ".env", ".env.local", ".env.development", ".env.development.local" ]
 
   ## more info on configuring this file: https://www.netlify.com/docs/netlify-toml-reference/
 `