feat: Add .env.example and dotenv lib for environment management

Author: leoncheng57

.env.example

@@ -0,0 +1,9 @@
+# Default
+DEEPL_AUTH_KEY= # Add your API key here
+
+# Local
+# Below is the config for running the mock server in docker (https://github.com/DeepLcom/deepl-mock/)
+# DEEPL_MOCK_SERVER_PORT=3000
+# DEEPL_AUTH_KEY=PLACEHOLDER
+# DEEPL_SERVER_URL=http://localhost:3000
+

.gitignore

@@ -6,3 +6,4 @@ junit.xml
 examples/**/package-lock.json
 examples/**/.env
 .DS_Store
+.env

CHANGELOG.md

@@ -4,8 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-
 ## [Unreleased]
+### Added
+* Added .env.example file with `dotenv` library for environment variables management
+* Improve unit tests
+
 ### Changed
 * Upgrade cross-spawn library (see https://github.com/advisories/GHSA-3xgq-45jj-v275)
 
@@ -280,7 +283,7 @@ client library took over this package name. Thanks to
 ownership.
 
 
-[Unreleased]: https://github.com/DeepLcom/deepl-node/compare/v1.15.0...HEAD
+[Unreleased]: https://github.com/DeepLcom/deepl-node/compare/v1.16.0...HEAD
 [1.16.0]: https://github.com/DeepLcom/deepl-node/compare/v1.15.0...v1.16.0
 [1.15.0]: https://github.com/DeepLcom/deepl-node/compare/v1.14.0...v1.15.0
 [1.14.0]: https://github.com/DeepLcom/deepl-node/compare/v1.13.1...v1.14.0

README.md

@@ -526,6 +526,35 @@ feature, please open an [issue][issues].
 We welcome Pull Requests, please read the
 [contributing guidelines](CONTRIBUTING.md).
 
+### Environment Variables
+
+There are multiple ways to manage your own environment variables. You can choose what works best for you. Make sure that only the values for one stage (local, prod, etc) are active at one time.
+
+**Using a global .rc file (such as ~/.bashrc):**
+
+```sh
+# Local
+export DEEPL_MOCK_SERVER_PORT=3000
+export DEEPL_AUTH_KEY=ANY_VALUE
+export DEEPL_SERVER_URL=http://localhost:3000
+```
+
+```sh
+# Prod
+# (Make sure to run `unset DEEPL_MOCK_SERVER_PORT` if it was previously assigned a value)
+export DEEPL_AUTH_KEY={YOUR_API_KEY}
+export DEEPL_SERVER_URL=https://api.deepl.com
+```
+
+**Using .env file**:
+
+(Benefits include: No need to refresh terminal when changing stages, no need to call `unset` to clear vars, can be used to isolate vars between multiple projects)
+
+- Copy `.env.example` file to a `.env` file 
+    - The `.env` file will never be stored in git, so your local credentials will not be shared
+- Edit `.env` file to your own desired variables
+    - If using local mock server, then point to local ports
+
 ### Tests
 
 Execute the tests using `npm test`. The tests communicate with the DeepL API

package-lock.json

@@ -21,6 +21,7 @@
     "dependencies": {
         "@types/node": ">=12.0",
         "axios": "^1.7.4",
+        "dotenv": "^16.4.7",
         "form-data": "^3.0.0",
         "loglevel": ">=1.6.2"
     },

package.json

@@ -50,6 +50,9 @@ import path from 'path';
 import * as os from 'os';
 import { URLSearchParams } from 'url';
 import * as util from 'util';
+import dotenv from 'dotenv';
+
+dotenv.config(); // Load environment variables from .env file
 
 export * from './errors';
 export * from './glossaryEntries';