insomnia-plugin-jsonc 0.1.0

package/README.md

@@ -0,0 +1,16 @@
+# insomnia-plugin-jsonc
+
+Strip JSON comments from your request body.
+
+## Installation
+
+- Open Insomnia options (Ctrl + , | Cmd + ,)
+- Type `insomnia-plugin-jsonc` on the Plugins tab
+
+## Usage
+
+Just write valid JavaScript comments in JSON body request and send your request without minding them.
+
+## Deps
+
+Use [`json-easy-strip`](https://www.npmjs.com/package/json-easy-strip)'s RegExp to strip comments.

package/main.js

@@ -0,0 +1,36 @@
+/**
+ * JSON Content-Type
+ */
+const CONTENT_TYPE_JSON = "application/json";
+
+/**
+ * Strip comments from a JSON string
+ *
+ * Taken from [`json-easy-strip`](https://www.npmjs.com/package/json-easy-strip).
+ *
+ * Extracted to not parse and stringify again the JSON string
+ *
+ * @param data the JSON string with comments
+ * @returns the JSON string without comments
+ */
+const stripJSONComments = (data) =>
+  data.replace(/\\"|"(?:\\"|[^"])*"|(\/\/.*|\/\*[\s\S]*?\*\/)/g, (m, g) =>
+    g ? "" : m
+  );
+
+/**
+ * Hook to update request body and remove comments
+ * @param context insomnia request context
+ * @link https://docs.insomnia.rest/insomnia/context-object-reference
+ */
+const updateRequestBodyHook = (context) => {
+  const body = context.request.getBody();
+  if (body.mimeType === CONTENT_TYPE_JSON) {
+    context.request.setBody({
+      ...body,
+      text: stripJSONComments(body.text),
+    });
+  }
+};
+
+module.exports.requestHooks = [updateRequestBodyHook];

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "insomnia-plugin-jsonc",
+  "version": "0.1.0",
+  "description": "Insomnia plugin to use comments in JSON body",
+  "main": "main.js",
+  "insomnia": {
+    "name": "jsonc",
+    "displayName": "JSON Comments Plugin",
+    "description": "Plugin to use comments in JSON body.",
+    "publisher": {
+      "name": "Guillaume Ongenae",
+      "icon": "https://avatars.githubusercontent.com/u/9453090"
+    },
+    "unlisted": false
+  },
+  "scripts": {
+    "test": "node test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/algoan/insomnia-plugin-jsonc.git"
+  },
+  "keywords": [
+    "insomnia",
+    "plugin",
+    "jsonc",
+    "json-comments",
+    "comments"
+  ],
+  "author": "Guillaume Ongenae <guillaume.ongenae@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/g-ongenae/insomnia-plugin-jsonc/issues"
+  },
+  "homepage": "https://github.com/g-ongenae/insomnia-plugin-jsonc#readme",
+  "dependencies": {},
+  "devDependencies": {}
+}

package/test.js

@@ -0,0 +1,44 @@
+const { requestHooks } = require('./main');
+
+/**
+ * Create a fake insomnia context with a validation on the setBody
+ * @param {object} givenBody
+ * @param {object} expectedBody
+ * @returns a fake insomnia context with a validation
+ */
+const fakeContext = (id, givenBody, expectedBody) => {
+  return {
+    request: {
+      getBody: () => givenBody,
+      setBody: (actualBody) => {
+        const result = actualBody.text === expectedBody.text
+          ? `${id} | passed`
+          : `${id} | expected: '${expectedBody.text}' => received: '${actualBody.text}'`;
+
+        console.log(result);
+      },
+    }
+  };
+};
+
+/**
+ * List of test cases
+ */
+const cases = [
+  // Should not alter non JSON body
+  [{ mimeType: 'non-json', text: 'foo' }, { mimeType: 'non-json', text: 'foo' }],
+  // Should not alter JSON body without comments
+  [{ mimeType: 'application/json', text: 'foo' }, { mimeType: 'application/json', text: 'foo' }],
+  [{ mimeType: 'application/json', text: '{"foo": "bar"}' }, { mimeType: 'application/json', text: '{"foo": "bar"}' }],
+  // Should remove comments from JSON body (space are preserved)
+  [{ mimeType: 'application/json', text: '{"foo": /* hello */ "bar"}' }, { mimeType: 'application/json', text: '{"foo":  "bar"}' }],
+  [{ mimeType: 'application/json', text: '/* hello */ {"foo": "bar"}' }, { mimeType: 'application/json', text: ' {"foo": "bar"}' }],
+  [{ mimeType: 'application/json', text: '{"foo": "bar" // hello\n }' }, { mimeType: 'application/json', text: '{"foo": "bar" \n }' }],
+];
+
+/**
+ * Call and test the hook
+ */
+for (const [index, test] of Object.entries(cases)) {
+  requestHooks[0](fakeContext(index, ...test));
+}