Skip to content

Commit fd86bdd

Browse files
tuchk4tuchk4
committed
support different env configs.
1 parent 9512d97 commit fd86bdd

File tree

14 files changed

+125
-23
lines changed

14 files changed

+125
-23
lines changed

‎packages/react-scripts/config/loadEnv.js

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// @remove-on-eject-begin
2+
/**
3+
* Copyright (c) 2015-present, Facebook, Inc.
4+
* All rights reserved.
5+
*
6+
* This source code is licensed under the BSD-style license found in the
7+
* LICENSE file in the root directory of this source tree. An additional grant
8+
* of patent rights can be found in the PATENTS file in the same directory.
9+
*/
10+
// @remove-on-eject-end
11+
'use strict';
12+
13+
// Load environment variables from .env* files. Suppress warnings using silent
14+
// if this file is missing. dotenv will never modify any environment variables
15+
// that have already been set.
16+
// https://github.com/motdotla/dotenv
17+
// Used .env* files - https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use
18+
var fs = require('fs');
19+
var paths = require('./paths');
20+
21+
var sequence = {
22+
'development': [
23+
paths.dotenvDevelopmentLocal,
24+
paths.dotenvDevelopment,
25+
paths.dotenvLocal,
26+
paths.dotenv
27+
],
28+
'test': [
29+
paths.dotenvTestLocal,
30+
paths.dotenvTest,
31+
paths.dotenvLocal,
32+
paths.dotenv
33+
],
34+
'production': [
35+
paths.dotenvProductionLocal,
36+
paths.dotenvProduction,
37+
paths.dotenvLocal,
38+
paths.dotenv
39+
]
40+
};
41+
42+
var envConfigs = sequence[process.env.NODE_ENV];
43+
44+
if (envConfigs) {
45+
envConfigs.forEach(envConfig => {
46+
if (fs.existsSync(envConfig)) {
47+
require('dotenv').config({
48+
silent: true,
49+
path: envConfig
50+
});
51+
}
52+
});
53+
}

‎packages/react-scripts/config/paths.js

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,14 @@ function getServedPath(appPackageJson) {
7474

7575
// config after eject: we're in ./config/
7676
module.exports = {
77+
dotenv: resolveApp('.env'),
78+
dotenvLocal: resolveApp('.env.local'),
79+
dotenvDevelopment: resolveApp('.env.development'),
80+
dotenvDevelopmentLocal: resolveApp('.env.development.local'),
81+
dotenvTest: resolveApp('.env.test'),
82+
dotenvTestLocal: resolveApp('.env.test.local'),
83+
dotenvProduction: resolveApp('.env.production'),
84+
dotenvProductionLocal: resolveApp('.env.production.local'),
7785
appBuild: resolveApp('build'),
7886
appPublic: resolveApp('public'),
7987
appHtml: resolveApp('public/index.html'),
@@ -96,6 +104,14 @@ function resolveOwn(relativePath) {
96104
// config before eject: we're in ./node_modules/react-scripts/config/
97105
module.exports = {
98106
appPath: resolveApp('.'),
107+
dotenv: resolveApp('.env'),
108+
dotenvLocal: resolveApp('.env.local'),
109+
dotenvDevelopment: resolveApp('.env.development'),
110+
dotenvDevelopmentLocal: resolveApp('.env.development.local'),
111+
dotenvTest: resolveApp('.env.test'),
112+
dotenvTestLocal: resolveApp('.env.test.local'),
113+
dotenvProduction: resolveApp('.env.production'),
114+
dotenvProductionLocal: resolveApp('.env.production.local'),
99115
appBuild: resolveApp('build'),
100116
appPublic: resolveApp('public'),
101117
appHtml: resolveApp('public/index.html'),
@@ -125,6 +141,14 @@ if (
125141
) {
126142
module.exports = {
127143
appPath: resolveApp('.'),
144+
dotenv: resolveOwn('template/.env'),
145+
dotenvLocal: resolveOwn('template/.env.local'),
146+
dotenvDevelopment: resolveOwn('template/.env.development'),
147+
dotenvDevelopmentLocal: resolveOwn('template/.env.development.local'),
148+
dotenvTest: resolveOwn('template/.env.test'),
149+
dotenvTestLocal: resolveOwn('template/.env.test.local'),
150+
dotenvProduction: resolveOwn('template/.env.production'),
151+
dotenvProductionLocal: resolveOwn('template/.env.production.local'),
128152
appBuild: resolveOwn('../../build'),
129153
appPublic: resolveOwn('template/public'),
130154
appHtml: resolveOwn('template/public/index.html'),

‎packages/react-scripts/fixtures/kitchensink/.env

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
REACT_APP_FILE_ENV_MESSAGE=fromtheenvfile
1+
REACT_APP_X = x-from-original-env
2+
REACT_APP_ORIGINAL_1 = from-original-env-1
3+
REACT_APP_ORIGINAL_2 = from-original-env-2

‎packages/react-scripts/fixtures/kitchensink/.env.development

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
REACT_APP_X = x-from-development-env
2+
REACT_APP_DEVELOPMENT = development

‎packages/react-scripts/fixtures/kitchensink/.env.local

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
REACT_APP_X = x-from-original-local-env
2+
REACT_APP_ORIGINAL_2 = override-from-original-local-env-2

‎packages/react-scripts/fixtures/kitchensink/.env.production

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
REACT_APP_X = x-from-production-env
2+
REACT_APP_PRODUCTION = production

‎packages/react-scripts/fixtures/kitchensink/integration/env.test.js

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,16 @@ describe('Integration', () => {
1515
it('file env variables', async () => {
1616
const doc = await initDOM('file-env-variables');
1717

18-
expect(
19-
doc.getElementById('feature-file-env-variables').textContent
20-
).to.equal('fromtheenvfile.');
18+
expect(doc.getElementById('feature-file-env-original-1').textContent).to.equal('from-original-env-1');
19+
expect(doc.getElementById('feature-file-env-original-2').textContent).to.equal('override-from-original-local-env-2');
20+
21+
if (process.env.NODE_ENV === 'production') {
22+
expect(doc.getElementById('feature-file-env').textContent).to.equal('production')
23+
expect(doc.getElementById('feature-file-env-x').textContent).to.equal('x-from-production-env')
24+
} else {
25+
expect(doc.getElementById('feature-file-env').textContent).to.equal('development')
26+
expect(doc.getElementById('feature-file-env-x').textContent).to.equal('x-from-development-env')
27+
}
2128
});
2229

2330
it('NODE_PATH', async () => {

‎packages/react-scripts/fixtures/kitchensink/src/features/env/FileEnvVariables.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@
1010
import React from 'react';
1111

1212
export default () => (
13-
<span id="feature-file-env-variables">
14-
{process.env.REACT_APP_FILE_ENV_MESSAGE}.
13+
<span>
14+
<span id="feature-file-env-original-1">{process.env.REACT_APP_ORIGINAL_1}</span>
15+
<span id="feature-file-env-original-2">{process.env.REACT_APP_ORIGINAL_2}</span>
16+
<span id="feature-file-env">{process.env.REACT_APP_DEVELOPMENT}{process.env.REACT_APP_PRODUCTION}</span>
17+
<span id="feature-file-env-x">{process.env.REACT_APP_X}</span>
1518
</span>
1619
);

‎packages/react-scripts/scripts/build.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,7 @@ process.on('unhandledRejection', err => {
2020
throw err;
2121
});
2222

23-
// Load environment variables from .env file. Suppress warnings using silent
24-
// if this file is missing. dotenv will never modify any environment variables
25-
// that have already been set.
26-
// https://github.com/motdotla/dotenv
27-
require('dotenv').config({ silent: true });
23+
require('../config/loadEnv');
2824

2925
const chalk = require('chalk');
3026
const fs = require('fs-extra');

‎packages/react-scripts/scripts/start.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@ process.on('unhandledRejection', err => {
1919

2020
process.env.NODE_ENV = 'development';
2121

22-
// Load environment variables from .env file. Suppress warnings using silent
23-
// if this file is missing. dotenv will never modify any environment variables
24-
// that have already been set.
25-
// https://github.com/motdotla/dotenv
26-
require('dotenv').config({ silent: true });
22+
require('../config/loadEnv');
2723

2824
const fs = require('fs');
2925
const chalk = require('chalk');

‎packages/react-scripts/scripts/test.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,7 @@ process.on('unhandledRejection', err => {
2020
throw err;
2121
});
2222

23-
// Load environment variables from .env file. Suppress warnings using silent
24-
// if this file is missing. dotenv will never modify any environment variables
25-
// that have already been set.
26-
// https://github.com/motdotla/dotenv
27-
require('dotenv').config({ silent: true });
23+
require('../config/loadEnv');
2824

2925
const jest = require('jest');
3026
const argv = process.argv.slice(2);

‎packages/react-scripts/template/.env

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
REACT_APP_X = 1

‎packages/react-scripts/template/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -752,6 +752,21 @@ To define permanent environment variables, create a file called `.env` in the ro
752752
REACT_APP_SECRET_CODE=abcdef
753753
```
754754

755+
What .env* files are used?
756+
757+
* `.env` - Default
758+
* `.env.development`, `.env.test`, `.env.production` - Environment-specific settings.
759+
* `.env.local` - Local overrides. This file is loaded for all environments except test.
760+
* `.env.development.local`, `.env.test.local`, `.env.production.local` - Local overrides of environment-specific settings.
761+
762+
Files priority (file is skipped if does not exist):
763+
764+
* npm test - `.env.test.local`, `env.test`, `.env.local`, `.env`
765+
* npm run build - `.env.production.local`, `env.production`, `.env.local`, `.env`
766+
* npm start - `.env.development.local`, `env.development`, `.env.local`, `.env`
767+
768+
Priority from left to right.
769+
755770
These variables will act as the defaults if the machine does not explicitly set them.<br>
756771
Please refer to the [dotenv documentation](https://github.com/motdotla/dotenv) for more details.
757772

‎packages/react-scripts/template/gitignore

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,11 @@
1111

1212
# misc
1313
.DS_Store
14-
.env
14+
.env.local
15+
.env.development.local
16+
.env.test.local
17+
.env.production.local
18+
1519
npm-debug.log*
1620
yarn-debug.log*
1721
yarn-error.log*
18-

0 commit comments

Comments
 (0)