insomnia-plugin-jsonc 0.1.0 → 0.2.0

package/README.md

@@ -1,16 +1,70 @@
 # insomnia-plugin-jsonc
 
-Strip JSON comments from your request body.
+Write comments and trailing commas in your JSON request bodies. They are stripped before the request is sent.
+
+## Example
+
+What you write in Insomnia:
+
+```jsonc
+{
+  "page": 1, // current page
+  /* "debug": true, */
+  "url": "https://example.com", // `//` inside strings is kept
+  "tags": ["a", "b",],
+}
+```
+
+What the server receives:
+
+```json
+{
+  "page": 1,
+
+  "url": "https://example.com",
+  "tags": ["a", "b"]
+}
+```
 
 ## Installation
 
-- Open Insomnia options (Ctrl + , | Cmd + ,)
-- Type `insomnia-plugin-jsonc` on the Plugins tab
+### Plugin Hub
+
+Install from the [Insomnia Plugin Hub](https://insomnia.rest/plugins/insomnia-plugin-jsonc).
+
+### From Insomnia
+
+1. Open Preferences (Ctrl + , | Cmd + ,)
+2. Go to the Plugins tab
+3. Enter `insomnia-plugin-jsonc` and click Install Plugin
+
+### Manually
+
+Copy this folder into the Insomnia plugins directory:
+
+- Windows: `%APPDATA%\Insomnia\plugins\`
+- macOS: `~/Library/Application Support/Insomnia/plugins/`
+- Linux: `~/.config/Insomnia/plugins/`
+
+## What is stripped
+
+- Line comments: `// ...` up to the end of the line
+- Block comments: `/* ... */`, which can span several lines
+- Trailing commas before `]` or `}`, even with a comment in between
+
+Content inside strings is never touched, so `"https://example.com"` or `"a /* b */"` stay as they are.
+
+The plugin only applies to JSON bodies: `application/json`, with or without parameters (`application/json; charset=utf-8`), and `+json` types (`application/vnd.api+json`). Other bodies are sent unchanged.
+
+## Limitations
+
+- Whitespace around a removed comment is kept, so the sent body may contain extra spaces or blank lines.
+- The result is not validated: invalid JSON is sent as is, and the server reports the error.
 
-## Usage
+## How it works
 
-Just write valid JavaScript comments in JSON body request and send your request without minding them.
+A request hook strips comments with a regular expression adapted from [`json-easy-strip`](https://www.npmjs.com/package/json-easy-strip), then removes trailing commas. The body is not parsed and serialized again, so its formatting is preserved.
 
-## Deps
+## License
 
-Use [`json-easy-strip`](https://www.npmjs.com/package/json-easy-strip)'s RegExp to strip comments.
+MIT

package/cover.svg

@@ -0,0 +1,28 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1200 400" width="1200" height="400">
+  <defs>
+    <linearGradient id="bg" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0" stop-color="#4000BF"/>
+      <stop offset="1" stop-color="#2A0080"/>
+    </linearGradient>
+  </defs>
+  <rect width="1200" height="400" fill="url(#bg)"/>
+  <!-- { } logo -->
+  <g transform="translate(80 72) scale(0.5)">
+    <g fill="none" stroke="#FFFFFF" stroke-width="32" stroke-linecap="round" stroke-linejoin="round">
+      <path d="M176 112h-16c-24 0-40 16-40 40v56c0 24-16 48-40 48 24 0 40 24 40 48v56c0 24 16 40 40 40h16"/>
+      <path d="M336 112h16c24 0 40 16 40 40v56c0 24 16 48 40 48-24 0-40 24-40 48v56c0 24-16 40-40 40h-16"/>
+    </g>
+    <g stroke="#B794FF" stroke-width="28" stroke-linecap="round">
+      <path d="M196 312l40-112"/>
+      <path d="M276 312l40-112"/>
+    </g>
+  </g>
+  <g font-family="Menlo, Consolas, 'DejaVu Sans Mono', monospace">
+    <text x="400" y="190" font-size="64" font-weight="bold" fill="#FFFFFF">JSON Comments</text>
+    <text x="400" y="250" font-size="30" fill="#D9C7FF">Strips comments from JSON request bodies.</text>
+    <!-- before → after -->
+    <text x="400" y="318" font-size="24" fill="#FFFFFF">{"a": 1<tspan fill="#B794FF" text-decoration="line-through">, /* note */</tspan>}</text>
+    <text x="720" y="318" font-size="24" fill="#B794FF">→</text>
+    <text x="770" y="318" font-size="24" fill="#FFFFFF">{"a": 1}</text>
+  </g>
+</svg>

package/icon.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" width="512" height="512">
+  <rect width="512" height="512" rx="96" fill="#4000BF"/>
+  <!-- { } -->
+  <g fill="none" stroke="#FFFFFF" stroke-width="32" stroke-linecap="round" stroke-linejoin="round">
+    <path d="M176 112h-16c-24 0-40 16-40 40v56c0 24-16 48-40 48 24 0 40 24 40 48v56c0 24 16 40 40 40h16"/>
+    <path d="M336 112h16c24 0 40 16 40 40v56c0 24 16 48 40 48-24 0-40 24-40 48v56c0 24-16 40-40 40h-16"/>
+  </g>
+  <!-- // -->
+  <g stroke="#B794FF" stroke-width="28" stroke-linecap="round">
+    <path d="M196 312l40-112"/>
+    <path d="M276 312l40-112"/>
+  </g>
+</svg>

package/main.js

@@ -1,34 +1,35 @@
+const { stripJSONC } = require("./strip");
+
 /**
  * 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).
+ * Check if a MIME type is JSON, ignoring its parameters
  *
- * Extracted to not parse and stringify again the JSON string
+ * Matches `application/json` and structured syntax suffixes like `application/vnd.api+json`.
  *
- * @param data the JSON string with comments
- * @returns the JSON string without comments
+ * @param mimeType the MIME type, possibly with parameters (`application/json; charset=utf-8`)
+ * @returns whether the MIME type is JSON
  */
-const stripJSONComments = (data) =>
-  data.replace(/\\"|"(?:\\"|[^"])*"|(\/\/.*|\/\*[\s\S]*?\*\/)/g, (m, g) =>
-    g ? "" : m
-  );
+const isJSONMimeType = (mimeType) => {
+  const type = String(mimeType ?? "").split(";")[0].trim().toLowerCase();
+  return type === CONTENT_TYPE_JSON || type.endsWith("+json");
+};
 
 /**
- * Hook to update request body and remove comments
+ * Hook to update request body and remove comments and trailing commas
  * @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) {
+  // `text` is undefined on an empty body
+  if (isJSONMimeType(body.mimeType) && typeof body.text === "string") {
     context.request.setBody({
       ...body,
-      text: stripJSONComments(body.text),
+      text: stripJSONC(body.text),
     });
   }
 };

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "insomnia-plugin-jsonc",
-  "version": "0.1.0",
-  "description": "Insomnia plugin to use comments in JSON body",
+  "version": "0.2.0",
+  "description": "Insomnia plugin to strip JSON body comments",
   "main": "main.js",
   "insomnia": {
     "name": "jsonc",
     "displayName": "JSON Comments Plugin",
-    "description": "Plugin to use comments in JSON body.",
+    "description": "Strips comments from JSON request bodies.",
+    "images": {
+      "icon": "icon.svg",
+      "cover": "cover.svg"
+    },
     "publisher": {
       "name": "Guillaume Ongenae",
       "icon": "https://avatars.githubusercontent.com/u/9453090"
@@ -14,11 +18,11 @@
     "unlisted": false
   },
   "scripts": {
-    "test": "node test.js"
+    "test": "node --test test.js"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/algoan/insomnia-plugin-jsonc.git"
+    "url": "git+ssh://git@github.com/g-ongenae/insomnia-plugin-jsonc.git"
   },
   "keywords": [
     "insomnia",
@@ -33,6 +37,7 @@
     "url": "https://github.com/g-ongenae/insomnia-plugin-jsonc/issues"
   },
   "homepage": "https://github.com/g-ongenae/insomnia-plugin-jsonc#readme",
-  "dependencies": {},
-  "devDependencies": {}
+  "devDependencies": {
+    "fast-check": "^4.10.2"
+  }
 }

package/strip.js

@@ -0,0 +1,40 @@
+/**
+ * Strip comments from a JSON string
+ *
+ * Adapted from [`json-easy-strip`](https://www.npmjs.com/package/json-easy-strip),
+ * with strings matched as a whole (any escaped character included) so that
+ * an escaped backslash before a closing quote is handled.
+ *
+ * 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
+  );
+
+/**
+ * Strip trailing commas before a closing `]` or `}` from a JSON string
+ *
+ * Must run after `stripJSONComments`, so that a comment between the comma
+ * and the closing bracket does not hide it.
+ *
+ * @param data the JSON string without comments
+ * @returns the JSON string without trailing commas
+ */
+const stripTrailingCommas = (data) =>
+  data.replace(/"(?:\\.|[^"\\])*"|,(\s*[\]}])/g, (m, g) =>
+    g === undefined ? m : g
+  );
+
+/**
+ * Strip comments and trailing commas from a JSONC string
+ *
+ * @param data the JSONC string
+ * @returns the JSON string
+ */
+const stripJSONC = (data) => stripTrailingCommas(stripJSONComments(data));
+
+module.exports = { stripJSONComments, stripTrailingCommas, stripJSONC };

package/test.js

@@ -1,44 +1,92 @@
+const { test } = require('node:test');
+const assert = require('node:assert/strict');
+const fc = require('fast-check');
 const { requestHooks } = require('./main');
+const { stripJSONC } = require('./strip');
 
 /**
- * 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
+ * Run the hook on a fake insomnia context
+ * @param {object} givenBody the body returned by getBody
+ * @returns the list of bodies passed to setBody
  */
-const fakeContext = (id, givenBody, expectedBody) => {
-  return {
+const runHook = (givenBody) => {
+  const calls = [];
+  requestHooks[0]({
     request: {
       getBody: () => givenBody,
-      setBody: (actualBody) => {
-        const result = actualBody.text === expectedBody.text
-          ? `${id} | passed`
-          : `${id} | expected: '${expectedBody.text}' => received: '${actualBody.text}'`;
-
-        console.log(result);
-      },
-    }
-  };
+      setBody: (body) => calls.push(body),
+    },
+  });
+  return calls;
 };
 
 /**
- * List of test cases
+ * List of test cases: [name, given body, expected body]
  */
 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 }' }],
+  ['should not alter invalid JSON body without comments', { mimeType: 'application/json', text: 'foo' }, { mimeType: 'application/json', text: 'foo' }],
+  ['should not alter JSON body without comments', { mimeType: 'application/json', text: '{"foo": "bar"}' }, { mimeType: 'application/json', text: '{"foo": "bar"}' }],
+  // Spaces around comments are preserved
+  ['should remove inline block comment', { mimeType: 'application/json', text: '{"foo": /* hello */ "bar"}' }, { mimeType: 'application/json', text: '{"foo":  "bar"}' }],
+  ['should remove leading block comment', { mimeType: 'application/json', text: '/* hello */ {"foo": "bar"}' }, { mimeType: 'application/json', text: ' {"foo": "bar"}' }],
+  ['should remove line comment after the last item', { mimeType: 'application/json', text: '{"a": 1 // last\n}' }, { mimeType: 'application/json', text: '{"a": 1 \n}' }],
+  ['should remove line comment', { mimeType: 'application/json', text: '{"foo": "bar" // hello\n }' }, { mimeType: 'application/json', text: '{"foo": "bar" \n }' }],
+  ['should remove trailing comma in object', { mimeType: 'application/json', text: '{"a": 1, }' }, { mimeType: 'application/json', text: '{"a": 1 }' }],
+  ['should remove trailing comma in array', { mimeType: 'application/json', text: '[1,\n]' }, { mimeType: 'application/json', text: '[1\n]' }],
+  ['should remove trailing comma followed by a comment', { mimeType: 'application/json', text: '{"a": 1, // last\n}' }, { mimeType: 'application/json', text: '{"a": 1 \n}' }],
+  ['should remove trailing comma followed by a block comment', { mimeType: 'application/json', text: '[1, /* last */]' }, { mimeType: 'application/json', text: '[1 ]' }],
+  ['should not remove comma-like content in strings', { mimeType: 'application/json', text: '{"a": ",}", "b": ",]"}' }, { mimeType: 'application/json', text: '{"a": ",}", "b": ",]"}' }],
+  ['should handle JSON MIME type with parameters', { mimeType: 'application/json; charset=utf-8', text: '{"a": 1 /* b */}' }, { mimeType: 'application/json; charset=utf-8', text: '{"a": 1 }' }],
+  ['should handle JSON MIME type case-insensitively', { mimeType: 'Application/JSON', text: '{"a": 1 /* b */}' }, { mimeType: 'Application/JSON', text: '{"a": 1 }' }],
+  ['should handle +json MIME types', { mimeType: 'application/vnd.api+json', text: '{"a": 1 /* b */}' }, { mimeType: 'application/vnd.api+json', text: '{"a": 1 }' }],
 ];
 
-/**
- * Call and test the hook
- */
-for (const [index, test] of Object.entries(cases)) {
-  requestHooks[0](fakeContext(index, ...test));
+test('should not call setBody on non JSON body', () => {
+  assert.deepEqual(runHook({ mimeType: 'non-json', text: 'foo // bar' }), []);
+  assert.deepEqual(runHook({ mimeType: 'application/jsonp', text: 'foo // bar' }), []);
+  assert.deepEqual(runHook({ text: 'foo // bar' }), []);
+});
+
+test('should not throw nor call setBody on empty JSON body', () => {
+  assert.deepEqual(runHook({ mimeType: 'application/json' }), []);
+});
+
+for (const [name, givenBody, expectedBody] of cases) {
+  test(name, () => {
+    const calls = runHook(givenBody);
+    assert.equal(calls.length, 1);
+    assert.equal(calls[0].text, expectedBody.text);
+  });
 }
+
+test('should keep comment-like content in a string after an escaped backslash', () => {
+  const text = String.raw`{"a": "x\\", "b": "// y"}`;
+  const [body] = runHook({ mimeType: 'application/json', text });
+  assert.equal(body.text, text);
+  assert.deepEqual(JSON.parse(body.text), { a: 'x\\', b: '// y' });
+});
+
+test('should strip comments and trailing commas inserted in any JSON document', () => {
+  const comment = fc.string({ unit: 'grapheme-ascii' }).filter((c) => !c.includes('*/'));
+  const lineComments = fc.array(fc.record({ block: fc.option(comment), line: fc.option(comment), trailingComma: fc.boolean() }));
+
+  fc.assert(
+    fc.property(fc.jsonValue(), lineComments, (value, comments) => {
+      // JSON.stringify escapes newlines in strings, so each line starts and ends on a token boundary
+      const json = JSON.stringify(value, null, 2);
+      const text = json
+        .split('\n')
+        .map((line, i, lines) => {
+          const { block = null, line: lineComment = null, trailingComma = false } = comments[i] ?? {};
+          // A trailing comma is allowed after the last value of a non-empty array or object
+          const isLastValue = /^\s*[\]}]/.test(lines[i + 1] ?? '') && !/[[{]$/.test(line);
+          const comma = trailingComma && isLastValue ? ',' : '';
+          return `${block === null ? '' : `/*${block}*/`}${line}${comma}${lineComment === null ? '' : `//${lineComment}`}`;
+        })
+        .join('\n');
+
+      // Compare with the parsed original rather than `value`, since -0 does not survive JSON
+      assert.deepEqual(JSON.parse(stripJSONC(text)), JSON.parse(json));
+    }),
+  );
+});