Skip to content

feat: Add .env.local support for backend projects #828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kingston merged 1 commit into from
Mar 13, 2026
Merged

feat: Add .env.local support for backend projects #828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/add-env-local-backend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@baseplate-dev/fastify-generators': patch
---

Add .env.local support for backend projects - adds .env.local to gitignore and loads it via --env-file-if-exists flag in dev scripts
1 change: 1 addition & 0 deletions examples/blog-with-auth/apps/backend/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
baseplate/.build

/.env
/.env.local
/.*.env

# Prisma generated files
Expand Down
1 change: 1 addition & 0 deletions examples/blog-with-auth/apps/backend/baseplate/generated/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
baseplate/.build

/.env
/.env.local
/.*.env

# Prisma generated files
Expand Down
10 changes: 5 additions & 5 deletions examples/blog-with-auth/apps/backend/baseplate/generated/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@
"scripts": {
"build": "tsc && tsc-alias",
"dev": "concurrently pnpm:dev:*",
"dev:server": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --import ./src/instrument.ts src/index.ts | pino-pretty -t",
"dev:workers": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --import ./src/instrument.ts src/scripts/run-workers.ts | pino-pretty -t",
"generate:schema": "tsx --env-file-if-exists=.env src/index.ts --exit-after-generate-schema",
"dev:server": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts src/index.ts | pino-pretty -t",
"dev:workers": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts src/scripts/run-workers.ts | pino-pretty -t",
"generate:schema": "tsx --env-file-if-exists=.env --env-file-if-exists=.env.local src/index.ts --exit-after-generate-schema",
"preinstall": "npx only-allow pnpm",
"postinstall": "prisma generate",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"prettier:check": "prettier --check .",
"prettier:write": "prettier -w -l .",
"script:dev": "tsx watch --respawn --env-file-if-exists=.env --import ./src/instrument.ts",
"script:run": "tsx --env-file-if-exists=.env --import ./src/instrument.ts",
"script:dev": "tsx watch --respawn --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts",
"script:run": "tsx --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts",
"start": "node --import ./dist/instrument.js dist/index.js",
"start:workers": "node --import ./dist/instrument.js dist/scripts/run-workers.js",
"test": "vitest run",
Expand Down
2 changes: 1 addition & 1 deletion examples/blog-with-auth/apps/backend/baseplate/generated/prisma.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export default {
schema: './prisma/schema.prisma',
migrations: {
path: './prisma/migrations',
seed: /* TPL_SEED_COMMAND:START */ 'tsx --env-file-if-exists=.env --env-file-if-exists=.seed.env src/prisma/seed.ts' /* TPL_SEED_COMMAND:END */,
seed: /* TPL_SEED_COMMAND:START */ 'tsx --env-file-if-exists=.env --env-file-if-exists=.env.local --env-file-if-exists=.seed.env src/prisma/seed.ts' /* TPL_SEED_COMMAND:END */,
},
datasource: {
url: process.env.DATABASE_URL,
Expand Down
10 changes: 5 additions & 5 deletions examples/blog-with-auth/apps/backend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@
"scripts": {
"build": "tsc && tsc-alias",
"dev": "concurrently pnpm:dev:*",
"dev:server": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --import ./src/instrument.ts src/index.ts | pino-pretty -t",
"dev:workers": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --import ./src/instrument.ts src/scripts/run-workers.ts | pino-pretty -t",
"generate:schema": "tsx --env-file-if-exists=.env src/index.ts --exit-after-generate-schema",
"dev:server": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts src/index.ts | pino-pretty -t",
"dev:workers": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts src/scripts/run-workers.ts | pino-pretty -t",
"generate:schema": "tsx --env-file-if-exists=.env --env-file-if-exists=.env.local src/index.ts --exit-after-generate-schema",
"preinstall": "npx only-allow pnpm",
"postinstall": "prisma generate",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"prettier:check": "prettier --check .",
"prettier:write": "prettier -w -l .",
"script:dev": "tsx watch --respawn --env-file-if-exists=.env --import ./src/instrument.ts",
"script:run": "tsx --env-file-if-exists=.env --import ./src/instrument.ts",
"script:dev": "tsx watch --respawn --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts",
"script:run": "tsx --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts",
"start": "node --import ./dist/instrument.js dist/index.js",
"start:workers": "node --import ./dist/instrument.js dist/scripts/run-workers.js",
"test": "vitest run",
Expand Down
2 changes: 1 addition & 1 deletion examples/blog-with-auth/apps/backend/prisma.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export default {
schema: './prisma/schema.prisma',
migrations: {
path: './prisma/migrations',
seed: /* TPL_SEED_COMMAND:START */ 'tsx --env-file-if-exists=.env --env-file-if-exists=.seed.env src/prisma/seed.ts' /* TPL_SEED_COMMAND:END */,
seed: /* TPL_SEED_COMMAND:START */ 'tsx --env-file-if-exists=.env --env-file-if-exists=.env.local --env-file-if-exists=.seed.env src/prisma/seed.ts' /* TPL_SEED_COMMAND:END */,
},
datasource: {
url: process.env.DATABASE_URL,
Expand Down
1 change: 1 addition & 0 deletions examples/todo-with-better-auth/apps/backend/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
baseplate/.build

/.env
/.env.local
/.*.env

# Prisma generated files
Expand Down
1 change: 1 addition & 0 deletions examples/todo-with-better-auth/apps/backend/baseplate/generated/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
baseplate/.build

/.env
/.env.local
/.*.env

# Prisma generated files
Expand Down
10 changes: 5 additions & 5 deletions examples/todo-with-better-auth/apps/backend/baseplate/generated/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@
"scripts": {
"build": "tsc && tsc-alias",
"dev": "concurrently pnpm:dev:*",
"dev:server": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --import ./src/instrument.ts src/index.ts | pino-pretty -t",
"dev:workers": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --import ./src/instrument.ts src/scripts/run-workers.ts | pino-pretty -t",
"generate:schema": "tsx --env-file-if-exists=.env src/index.ts --exit-after-generate-schema",
"dev:server": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts src/index.ts | pino-pretty -t",
"dev:workers": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts src/scripts/run-workers.ts | pino-pretty -t",
"generate:schema": "tsx --env-file-if-exists=.env --env-file-if-exists=.env.local src/index.ts --exit-after-generate-schema",
"preinstall": "npx only-allow pnpm",
"postinstall": "prisma generate",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"prettier:check": "prettier --check .",
"prettier:write": "prettier -w -l .",
"script:dev": "tsx watch --respawn --env-file-if-exists=.env --import ./src/instrument.ts",
"script:run": "tsx --env-file-if-exists=.env --import ./src/instrument.ts",
"script:dev": "tsx watch --respawn --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts",
"script:run": "tsx --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts",
"start": "node --import ./dist/instrument.js dist/index.js",
"start:workers": "node --import ./dist/instrument.js dist/scripts/run-workers.js",
"test": "vitest run",
Expand Down
2 changes: 1 addition & 1 deletion examples/todo-with-better-auth/apps/backend/baseplate/generated/prisma.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export default {
schema: './prisma/schema.prisma',
migrations: {
path: './prisma/migrations',
seed: /* TPL_SEED_COMMAND:START */ 'tsx --env-file-if-exists=.env --env-file-if-exists=.seed.env src/prisma/seed.ts' /* TPL_SEED_COMMAND:END */,
seed: /* TPL_SEED_COMMAND:START */ 'tsx --env-file-if-exists=.env --env-file-if-exists=.env.local --env-file-if-exists=.seed.env src/prisma/seed.ts' /* TPL_SEED_COMMAND:END */,
},
datasource: {
url: process.env.DATABASE_URL,
Expand Down
10 changes: 5 additions & 5 deletions examples/todo-with-better-auth/apps/backend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@
"scripts": {
"build": "tsc && tsc-alias",
"dev": "concurrently pnpm:dev:*",
"dev:server": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --import ./src/instrument.ts src/index.ts | pino-pretty -t",
"dev:workers": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --import ./src/instrument.ts src/scripts/run-workers.ts | pino-pretty -t",
"generate:schema": "tsx --env-file-if-exists=.env src/index.ts --exit-after-generate-schema",
"dev:server": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts src/index.ts | pino-pretty -t",
"dev:workers": "tsx watch --ignore /**/node_modules/** --clear-screen=false --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts src/scripts/run-workers.ts | pino-pretty -t",
"generate:schema": "tsx --env-file-if-exists=.env --env-file-if-exists=.env.local src/index.ts --exit-after-generate-schema",
"preinstall": "npx only-allow pnpm",
"postinstall": "prisma generate",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"prettier:check": "prettier --check .",
"prettier:write": "prettier -w -l .",
"script:dev": "tsx watch --respawn --env-file-if-exists=.env --import ./src/instrument.ts",
"script:run": "tsx --env-file-if-exists=.env --import ./src/instrument.ts",
"script:dev": "tsx watch --respawn --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts",
"script:run": "tsx --env-file-if-exists=.env --env-file-if-exists=.env.local --import ./src/instrument.ts",
"start": "node --import ./dist/instrument.js dist/index.js",
"start:workers": "node --import ./dist/instrument.js dist/scripts/run-workers.js",
"test": "vitest run",
Expand Down
2 changes: 1 addition & 1 deletion examples/todo-with-better-auth/apps/backend/prisma.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export default {
schema: './prisma/schema.prisma',
migrations: {
path: './prisma/migrations',
seed: /* TPL_SEED_COMMAND:START */ 'tsx --env-file-if-exists=.env --env-file-if-exists=.seed.env src/prisma/seed.ts' /* TPL_SEED_COMMAND:END */,
seed: /* TPL_SEED_COMMAND:START */ 'tsx --env-file-if-exists=.env --env-file-if-exists=.env.local --env-file-if-exists=.seed.env src/prisma/seed.ts' /* TPL_SEED_COMMAND:END */,
},
datasource: {
url: process.env.DATABASE_URL,
Expand Down
11 changes: 10 additions & 1 deletion packages/fastify-generators/src/generators/core/config-service/config-service.generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ export const configServiceGenerator = createGenerator({
useCase: 'dev-env',
targetEnvironment: 'dev',
});
fastify.nodeFlags.set('env-file-local', {
flag: '--env-file-if-exists=.env.local',
useCase: 'dev-env',
targetEnvironment: 'dev',
});
}),
// add the node packages
nodePackages: createNodePackagesTask({
Expand All @@ -99,7 +104,11 @@ export const configServiceGenerator = createGenerator({
nodeGitIgnore: createProviderTask(
nodeGitIgnoreProvider,
(nodeGitIgnore) => {
nodeGitIgnore.exclusions.set('config', ['/.env', '/.*.env']);
nodeGitIgnore.exclusions.set('config', [
'/.env',
'/.env.local',
'/.*.env',
]);
},
),
setup: setupTask,
Expand Down
Loading