Upgrades and support node 8+ (#2)

kHRISl33t · web-flow · commit 44d437f3454b · 2021-05-23T14:39:22.000+02:00
* 0.2.1

* updated examples and add support to node 8+

* updated deps on exmaples
diff --git a/README.md b/README.md
@@ -11,6 +11,11 @@ A runtime environment handler for React.js apps that have been bootstraped using
 - [Test Coverage](#test-coverage)
 - [Contributors](#contributors)
 
+## Requirements
+
+- Node.js 8.X or greater
+- npm 5.X or greater
+
 ## Usage
 
 - Installation
@@ -106,7 +111,7 @@ RUN apk add --update nodejs
 RUN apk add --update npm
 
 # install runtime-env-cra package
-RUN npm i -g runtime-env-cra@0.2.0
+RUN npm i -g runtime-env-cra@0.2.2
 
 # start the app with the following CMD
 CMD ["/bin/sh", "-c", "runtime-env-cra && nginx -g \"daemon off;\""]
@@ -140,3 +145,5 @@ Time:        1.751 s
     <td align="center"><a href="https://github.com/peteyycz"><img src="https://avatars1.githubusercontent.com/u/7130689?v=4" width="50px;" alt=""/><br /><sub><b>peteyycz</b></sub></a><br />
   </tr>
 </table>
+
+**_If you find a bug or have a question about the usage, feel free to open an issue!_**
diff --git a/examples/runtime-env-example-js/.env b/examples/runtime-env-example-js/.env
@@ -1,2 +1,2 @@
 NODE_ENV=development
-API_URL=https://my-awesome-api.com
+API_URL=https://my-awesome-api.com
diff --git a/examples/runtime-env-example-js/.env.example b/examples/runtime-env-example-js/.env.example
@@ -1,2 +1,2 @@
 NODE_ENV=development
-API_URL=https://my-awesome-api.com
+API_URL=https://my-awesome-api.com
diff --git a/examples/runtime-env-example-js/package-lock.json b/examples/runtime-env-example-js/package-lock.json
diff --git a/examples/runtime-env-example-js/package.json b/examples/runtime-env-example-js/package.json
@@ -3,13 +3,13 @@
   "version": "0.1.0",
   "private": true,
   "dependencies": {
-    "@testing-library/jest-dom": "^5.11.6",
-    "@testing-library/react": "^11.2.2",
-    "@testing-library/user-event": "^12.6.0",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
-    "react-scripts": "4.0.1",
-    "runtime-env-cra": "0.2.0"
+    "@testing-library/jest-dom": "^5.12.0",
+    "@testing-library/react": "^11.2.7",
+    "@testing-library/user-event": "^13.1.9",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-scripts": "4.0.3",
+    "runtime-env-cra": "0.2.2"
   },
   "scripts": {
     "start": "NODE_ENV=development runtime-env-cra --config-name=./public/runtime-env.js && react-scripts start",
diff --git a/examples/runtime-env-example-ts/.env b/examples/runtime-env-example-ts/.env
@@ -1,2 +1,2 @@
 NODE_ENV=development
-API_URL=https://my-awesome-api.com
+API_URL=https://my-awesome-api.com
diff --git a/examples/runtime-env-example-ts/.env.example b/examples/runtime-env-example-ts/.env.example
@@ -1,2 +1,2 @@
 NODE_ENV=development
-API_URL=https://my-awesome-api.com
+API_URL=https://my-awesome-api.com
diff --git a/examples/runtime-env-example-ts/.gitignore b/examples/runtime-env-example-ts/.gitignore
@@ -18,6 +18,8 @@
 .env.test.local
 .env.production.local
 
+.eslintcache
+
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
diff --git a/examples/runtime-env-example-ts/package-lock.json b/examples/runtime-env-example-ts/package-lock.json
diff --git a/examples/runtime-env-example-ts/package.json b/examples/runtime-env-example-ts/package.json
@@ -3,18 +3,18 @@
   "version": "0.1.0",
   "private": true,
   "dependencies": {
-    "@testing-library/jest-dom": "^5.11.6",
-    "@testing-library/react": "^11.2.2",
-    "@testing-library/user-event": "^12.6.0",
-    "@types/jest": "^26.0.19",
-    "@types/node": "^14.14.14",
-    "@types/react": "^17.0.0",
-    "@types/react-dom": "^17.0.0",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
-    "react-scripts": "4.0.1",
-    "runtime-env-cra": "0.2.0",
-    "typescript": "^4.1.3"
+    "@testing-library/jest-dom": "^5.12.0",
+    "@testing-library/react": "^11.2.7",
+    "@testing-library/user-event": "^13.1.9",
+    "@types/jest": "^26.0.23",
+    "@types/node": "^15.6.0",
+    "@types/react": "^17.0.6",
+    "@types/react-dom": "^17.0.5",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-scripts": "4.0.3",
+    "runtime-env-cra": "0.2.2",
+    "typescript": "^4.2.4"
   },
   "scripts": {
     "start": "NODE_ENV=development runtime-env-cra --config-name=./public/runtime-env.js && react-scripts start",
diff --git a/lib/generateConfig.js b/lib/generateConfig.js
@@ -1,31 +1,30 @@
 const { constants } = require('fs');
-const fs = require('fs').promises;
 
-const { generateJSON, constants: recConstants } = require('./utils');
+const { generateJSON, constants: recConstants, writeFileP, accessP, unlinkP, readFileP } = require('./utils');
 
 const runtimeConfig = {};
 
 async function generateConfig({ envConfig, envFile }) {
   let envConfigExists = true;
 
   try {
-    await fs.access(envConfig, constants.F_OK);
+    await accessP(envConfig, constants.F_OK);
   } catch (err) {
     console.log(`${envConfig} does not exist. Creating one...`);
     envConfigExists = false;
   }
 
   if (envConfigExists) {
-    await fs.unlink(envConfig);
+    await unlinkP(envConfig);
   }
 
   try {
-    await fs.access(envFile, constants.F_OK);
+    await accessP(envFile, constants.F_OK);
   } catch (err) {
     throw err;
   }
 
-  const content = await fs.readFile(envFile, 'utf8');
+  const content = await readFileP(envFile, 'utf8');
 
   content.split('\n').forEach((line) => {
     const equalSignIndex = line.indexOf('=');
@@ -53,7 +52,7 @@ async function generateConfig({ envConfig, envFile }) {
 
   const result = generateJSON(runtimeConfig);
 
-  await fs.writeFile(envConfig, result, 'utf-8');
+  await writeFileP(envConfig, result, 'utf-8');
 
   return result;
 }
diff --git a/lib/utils.js b/lib/utils.js
@@ -1,3 +1,6 @@
+const { promisify } = require('util');
+const fs = require('fs');
+
 const constants = {
   DEVELOPMENT: 'development',
   runtimeConfigPath: 'window.__RUNTIME_CONFIG__',
@@ -6,4 +9,11 @@ const constants = {
 const generateJSON = (config) =>
   `${constants.runtimeConfigPath} = ${JSON.stringify(config)};`;
 
-module.exports = { generateJSON, constants };
+module.exports = {
+  generateJSON,
+  constants,
+  accessP: promisify(fs.access),
+  unlinkP: promisify(fs.unlink),
+  readFileP: promisify(fs.readFile),
+  writeFileP: promisify(fs.writeFile)
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/tests/generateConfig.spec.js b/tests/generateConfig.spec.js

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`NODE_ENV=development`
`2`		`-API_URL=https://my-awesome-api.com`
	`2`	`+API_URL=https://my-awesome-api.com`