Merge pull request #2 from meese-os/feat/comment-support

Author: ajmeese7

README.md

@@ -9,7 +9,7 @@
 npm install complex-dotenv-json
 ```
 
-This is a drop-in replacement for the [dotenv-json](https://www.npmjs.com/package/dotenv-json) package, with support for complex JSON objects.
+This is a drop-in replacement for the [dotenv-json](https://www.npmjs.com/package/dotenv-json) package, with support for complex JSON objects. It ships with zero runtime dependencies for a lightweight install.
 
 ## Usage
 
@@ -28,6 +28,15 @@ Define your environment variables in `.env.json` in the root of your project (or
 }
 ```
 
+Lines beginning with `//` are ignored during parsing, so you can annotate your configuration while keeping it valid:
+
+```json
+// Credentials for local development only
+{
+  "secret_api_key": "s@Mpl3_d@Ta_SECRET"
+}
+```
+
 Note that in the example above, the `database` section is a nested object. This is not able to be stored in a tree structure in environmental variables, so instead it is stored as a JSON string. It can easily be accessed by the following code:
 
 ```js
@@ -55,3 +64,11 @@ You can customize the location of your `.env.json` file by passing a `path` opti
 const dotenvJSON = require("complex-dotenv-json");
 dotenvJSON({ path: "./config/example.json" });
 ```
+
+## Development
+
+Run the tests locally before committing code to ensure everything is working as expected:
+
+```bash
+npm test
+```

index.js

@@ -9,7 +9,12 @@ module.exports = function dotenvJSON(options) {
   });
 
   try {
-    const envConfig = JSON.parse(jsonString);
+    const cleanString = jsonString
+      .split(/\r?\n/)
+      .filter(line => !line.trim().startsWith("//"))
+      .join("\n");
+
+    const envConfig = JSON.parse(cleanString);
 
     for (const key in envConfig) {
       if (process.env.hasOwnProperty(key)) {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "complex-dotenv-json",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Load environment variables via a JSON file",
   "main": "index.js",
   "scripts": {

package.json

@@ -0,0 +1,10 @@
+// Sample comment at top
+{
+  // secret key for tests
+  "secret_api_key": "s@Mpl3_d@Ta_SECRET",
+  "website_url": "https://example.com/login",
+  "feature_flags": {
+    // enable beta
+    "beta": true
+  }
+}

tests/.env.comments.json

@@ -10,9 +10,24 @@ dotenvJSON({ path: "tests/.env.json" });
 // test simple properties
 assert.ok(process.env.hasOwnProperty("secret_api_key"));
 assert.equal(process.env.secret_api_key, "s@Mpl3_d@Ta_SECRET");
+console.log("✔ basic environment variables loaded");
 
 // test nested properties
 assert.ok(process.env.hasOwnProperty("database"));
 const database = JSON.parse(process.env.database);
 assert.ok(database.hasOwnProperty("password"));
 assert.equal(database.password, "postgres");
+console.log("✔ nested environment variables stored as JSON");
+
+// loads JSON file that includes comment lines
+delete process.env.feature_flags;
+delete process.env.website_url;
+dotenvJSON({ path: "tests/.env.comments.json" });
+
+assert.ok(process.env.hasOwnProperty("feature_flags"));
+const featureFlags = JSON.parse(process.env.feature_flags);
+assert.equal(featureFlags.beta, true);
+assert.equal(process.env.website_url, "https://example.com/login");
+console.log("✔ comment-stripping logic applied correctly");
+
+console.log("All tests passed");