Require Node.js 12.20 and move to ESM

Author: sindresorhus

.github/workflows/main.yml

@@ -10,13 +10,10 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-          - 14
-          - 12
-          - 10
-          - 8
+          - 16
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install

benchmark.js

@@ -1,7 +1,6 @@
 /* globals bench, set */
-'use strict';
-const fs = require('fs');
-const stripJsonComments = require('.');
+import fs from 'node:fs';
+import stripJsonComments from './index.js';
 
 const json = fs.readFileSync('sample.json', 'utf8');
 const bigJson = fs.readFileSync('sample-big.json', 'utf8');

index.d.ts

@@ -1,12 +1,10 @@
-declare namespace stripJsonComments {
-	interface Options {
-		/**
-		Replace comments with whitespace instead of stripping them entirely.
+export interface Options {
+	/**
+	Replace comments with whitespace instead of stripping them entirely.
 
-		@default true
-		*/
-		readonly whitespace?: boolean;
-	}
+	@default true
+	*/
+	readonly whitespace?: boolean;
 }
 
 /**
@@ -19,7 +17,7 @@ It will replace single-line comments `//` and multi-line comments `/**\/` with w
 
 @example
 ```
-import stripJsonComments = require('strip-json-comments');
+import stripJsonComments from 'strip-json-comments';
 
 const json = `{
 	// Rainbows
@@ -30,9 +28,7 @@ JSON.parse(stripJsonComments(json));
 //=> {unicorn: 'cake'}
 ```
 */
-declare function stripJsonComments(
+export default function stripJsonComments(
 	jsonString: string,
-	options?: stripJsonComments.Options
+	options?: Options
 ): string;
-
-export = stripJsonComments;

index.js

@@ -1,6 +1,6 @@
-'use strict';
 const singleComment = Symbol('singleComment');
 const multiComment = Symbol('multiComment');
+
 const stripWithoutWhitespace = () => '';
 const stripWithWhitespace = (string, start, end) => string.slice(start, end).replace(/\S/g, ' ');
 
@@ -16,62 +16,62 @@ const isEscaped = (jsonString, quotePosition) => {
 	return Boolean(backslashCount % 2);
 };
 
-module.exports = (jsonString, options = {}) => {
+export default function stripJsonComments(jsonString, {whitespace = true} = {}) {
 	if (typeof jsonString !== 'string') {
 		throw new TypeError(`Expected argument \`jsonString\` to be a \`string\`, got \`${typeof jsonString}\``);
 	}
 
-	const strip = options.whitespace === false ? stripWithoutWhitespace : stripWithWhitespace;
+	const strip = whitespace ? stripWithWhitespace : stripWithoutWhitespace;
 
-	let insideString = false;
-	let insideComment = false;
+	let isInsideString = false;
+	let isInsideComment = false;
 	let offset = 0;
 	let result = '';
 
-	for (let i = 0; i < jsonString.length; i++) {
-		const currentCharacter = jsonString[i];
-		const nextCharacter = jsonString[i + 1];
+	for (let index = 0; index < jsonString.length; index++) {
+		const currentCharacter = jsonString[index];
+		const nextCharacter = jsonString[index + 1];
 
-		if (!insideComment && currentCharacter === '"') {
-			const escaped = isEscaped(jsonString, i);
+		if (!isInsideComment && currentCharacter === '"') {
+			const escaped = isEscaped(jsonString, index);
 			if (!escaped) {
-				insideString = !insideString;
+				isInsideString = !isInsideString;
 			}
 		}
 
-		if (insideString) {
+		if (isInsideString) {
 			continue;
 		}
 
-		if (!insideComment && currentCharacter + nextCharacter === '//') {
-			result += jsonString.slice(offset, i);
-			offset = i;
-			insideComment = singleComment;
-			i++;
-		} else if (insideComment === singleComment && currentCharacter + nextCharacter === '\r\n') {
-			i++;
-			insideComment = false;
-			result += strip(jsonString, offset, i);
-			offset = i;
+		if (!isInsideComment && currentCharacter + nextCharacter === '//') {
+			result += jsonString.slice(offset, index);
+			offset = index;
+			isInsideComment = singleComment;
+			index++;
+		} else if (isInsideComment === singleComment && currentCharacter + nextCharacter === '\r\n') {
+			index++;
+			isInsideComment = false;
+			result += strip(jsonString, offset, index);
+			offset = index;
 			continue;
-		} else if (insideComment === singleComment && currentCharacter === '\n') {
-			insideComment = false;
-			result += strip(jsonString, offset, i);
-			offset = i;
-		} else if (!insideComment && currentCharacter + nextCharacter === '/*') {
-			result += jsonString.slice(offset, i);
-			offset = i;
-			insideComment = multiComment;
-			i++;
+		} else if (isInsideComment === singleComment && currentCharacter === '\n') {
+			isInsideComment = false;
+			result += strip(jsonString, offset, index);
+			offset = index;
+		} else if (!isInsideComment && currentCharacter + nextCharacter === '/*') {
+			result += jsonString.slice(offset, index);
+			offset = index;
+			isInsideComment = multiComment;
+			index++;
 			continue;
-		} else if (insideComment === multiComment && currentCharacter + nextCharacter === '*/') {
-			i++;
-			insideComment = false;
-			result += strip(jsonString, offset, i + 1);
-			offset = i + 1;
+		} else if (isInsideComment === multiComment && currentCharacter + nextCharacter === '*/') {
+			index++;
+			isInsideComment = false;
+			result += strip(jsonString, offset, index + 1);
+			offset = index + 1;
 			continue;
 		}
 	}
 
-	return result + (insideComment ? strip(jsonString.slice(offset)) : jsonString.slice(offset));
-};
+	return result + (isInsideComment ? strip(jsonString.slice(offset)) : jsonString.slice(offset));
+}

index.test-d.ts

@@ -1,7 +1,5 @@
 import {expectType} from 'tsd';
-import stripJsonComments = require('.');
-
-const options: stripJsonComments.Options = {};
+import stripJsonComments from './index.js';
 
 const json = '{/*rainbows*/"unicorn":"cake"}';
 

package.json

@@ -10,8 +10,10 @@
 		"email": "[email protected]",
 		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
+	"exports": "./index.js",
 	"engines": {
-		"node": ">=8"
+		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd",
@@ -39,9 +41,9 @@
 		"jsonc"
 	],
 	"devDependencies": {
-		"ava": "^1.4.1",
+		"ava": "^3.15.0",
 		"matcha": "^0.7.0",
-		"tsd": "^0.7.2",
-		"xo": "^0.24.0"
+		"tsd": "^0.17.0",
+		"xo": "^0.44.0"
 	}
 }

readme.md

@@ -24,7 +24,7 @@ $ npm install strip-json-comments
 ## Usage
 
 ```js
-const stripJsonComments = require('strip-json-comments');
+import stripJsonComments from 'strip-json-comments';
 
 const json = `{
 	// Rainbows

test.js

@@ -1,5 +1,5 @@
 import test from 'ava';
-import stripJsonComments from '.';
+import stripJsonComments from './index.js';
 
 test('replace comments with whitespace', t => {
 	t.is(stripJsonComments('//comment\n{"a":"b"}'), '         \n{"a":"b"}');