Require Node.js 12.20 and move to ESM

Author: sindresorhus

.github/funding.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

.github/workflows/main.yml

@@ -1,7 +1,6 @@
-'use strict';
 /* global bench */
-const fs = require('fs');
-const stripCssComments = require('.');
+import fs from 'node:fs';
+import stripCssComments from './index.js';
 
 const fixture = fs.readFileSync('fixture.css', 'utf8');
 

bench.js

@@ -1,22 +1,20 @@
-declare namespace stripCssComments {
-	interface Options {
-		/**
-		- `true` - Preserve important comments `/*! *\/`.
-		- `false` - Strip all comments.
-		- `RegExp` - Preserve comments where the comment body matches a regular expression.
-		- `Function` - Preserve comments for which a function returns `true`. The function is called on each comment, gets the comment body as the first argument, and is expected to return a boolean of whether to preserve the comment.
-
-		@default true
-		*/
-		readonly preserve?: boolean | RegExp | ((comment: string) => boolean);
-
-		/**
-		Replace comments with whitespace instead of stripping them entirely.
-
-		@default true
-		*/
-		readonly whitespace?: boolean;
-	}
+export interface Options {
+	/**
+	- `true` - Preserve important comments `/*! *\/`.
+	- `false` - Strip all comments.
+	- `RegExp` - Preserve comments where the comment body matches a regular expression.
+	- `Function` - Preserve comments for which a function returns `true`. The function is called on each comment, gets the comment body as the first argument, and is expected to return a boolean of whether to preserve the comment.
+
+	@default true
+	*/
+	readonly preserve?: boolean | RegExp | ((comment: string) => boolean);
+
+	/**
+	Replace comments with whitespace instead of stripping them entirely.
+
+	@default true
+	*/
+	readonly whitespace?: boolean;
 }
 
 /**
@@ -26,7 +24,7 @@ Strip comments from CSS.
 
 @example
 ```
-import stripCssComments = require('strip-css-comments');
+import stripCssComments from 'strip-css-comments';
 
 // By default important comments `/*!` are preserved
 stripCssComments('/*! <copyright> *\/ body { /* unicorns *\/color: hotpink; }');
@@ -56,9 +54,7 @@ stripCssComments(
 //=> '/*# preserved *\/ body { color: hotpink; }'
 ```
 */
-declare function stripCssComments(
+export default function stripCssComments(
 	cssString: string,
-	options?: stripCssComments.Options
+	options?: Options
 ): string;
-
-export = stripCssComments;

index.d.ts

@@ -1,54 +1,53 @@
-'use strict';
-const isRegExp = require('is-regexp');
+import isRegExp from 'is-regexp';
 
-module.exports = (cssString, options = {}) => {
-	let preserveImportant = !(options.preserve === false || options.all === true);
-	const stripWhitespace = options.whitespace === false;
+export default function stripCssComments(cssString, {preserve = true, whitespace = true, all} = {}) {
+	if (all) {
+		throw new Error('The `all` option is no longer supported. Use the `preserve` option instead.');
+	}
 
+	let preserveImportant = preserve;
 	let preserveFilter;
-	if (typeof options.preserve === 'function') {
+	if (typeof preserve === 'function') {
 		preserveImportant = false;
-		preserveFilter = options.preserve;
-	} else if (isRegExp(options.preserve)) {
+		preserveFilter = preserve;
+	} else if (isRegExp(preserve)) {
 		preserveImportant = false;
-		preserveFilter = comment => options.preserve.test(comment);
+		preserveFilter = comment => preserve.test(comment);
 	}
 
 	let isInsideString = false;
 	let currentCharacter = '';
 	let comment = '';
 	let returnValue = '';
 
-	for (let i = 0; i < cssString.length; i++) {
-		currentCharacter = cssString[i];
+	for (let index = 0; index < cssString.length; index++) {
+		currentCharacter = cssString[index];
 
-		if (cssString[i - 1] !== '\\') {
-			if (currentCharacter === '"' || currentCharacter === '\'') {
-				if (isInsideString === currentCharacter) {
-					isInsideString = false;
-				} else if (!isInsideString) {
-					isInsideString = currentCharacter;
-				}
+		if (cssString[index - 1] !== '\\' && (currentCharacter === '"' || currentCharacter === '\'')) {
+			if (isInsideString === currentCharacter) {
+				isInsideString = false;
+			} else if (!isInsideString) {
+				isInsideString = currentCharacter;
 			}
 		}
 
 		// Find beginning of `/*` type comment
-		if (!isInsideString && currentCharacter === '/' && cssString[i + 1] === '*') {
+		if (!isInsideString && currentCharacter === '/' && cssString[index + 1] === '*') {
 			// Ignore important comment when configured to preserve comments using important syntax: /*!
-			const isImportantComment = cssString[i + 2] === '!';
-			let j = i + 2;
+			const isImportantComment = cssString[index + 2] === '!';
+			let index2 = index + 2;
 
 			// Iterate over comment
-			for (; j < cssString.length; j++) {
+			for (; index2 < cssString.length; index2++) {
 				// Find end of comment
-				if (cssString[j] === '*' && cssString[j + 1] === '/') {
+				if (cssString[index2] === '*' && cssString[index2 + 1] === '/') {
 					if ((preserveImportant && isImportantComment) || (preserveFilter && preserveFilter(comment))) {
 						returnValue += `/*${comment}*/`;
-					} else if (stripWhitespace) {
-						if (cssString[j + 2] === '\n') {
-							j++;
-						} else if (cssString[j + 2] + cssString[j + 3] === '\r\n') {
-							j += 2;
+					} else if (!whitespace) {
+						if (cssString[index2 + 2] === '\n') {
+							index2++;
+						} else if (cssString[index2 + 2] + cssString[index2 + 3] === '\r\n') {
+							index2 += 2;
 						}
 					}
 
@@ -58,11 +57,11 @@ module.exports = (cssString, options = {}) => {
 				}
 
 				// Store comment text
-				comment += cssString[j];
+				comment += cssString[index2];
 			}
 
 			// Resume iteration over CSS string from the end of the comment
-			i = j + 1;
+			index = index2 + 1;
 
 			continue;
 		}
@@ -71,4 +70,4 @@ module.exports = (cssString, options = {}) => {
 	}
 
 	return returnValue;
-};
+}

index.js

@@ -1,27 +1,27 @@
 import {expectType} from 'tsd';
-import stripCssComments = require('.');
+import stripCssComments from './index.js';
 
 expectType<string>(
-	stripCssComments('/*! <copyright> */ body { /* unicorns */color: hotpink; }')
+	stripCssComments('/*! <copyright> */ body { /* unicorns */color: hotpink; }'),
 );
 expectType<string>(
 	stripCssComments(
 		'/*! <copyright> */ body { /* unicorns */color: hotpink; }', {
-		preserve: false
-	})
+			preserve: false,
+		}),
 );
 expectType<string>(
 	stripCssComments('/*# preserved */ body { /* unicorns */color: hotpink; }', {
-		preserve: /^#/
-	})
+		preserve: /^#/,
+	}),
 );
 expectType<string>(
 	stripCssComments('/*# preserved */ body { /* unicorns */color: hotpink; }', {
-		preserve: comment => comment.charAt(0) === '#'
-	})
+		preserve: comment => comment.startsWith('#'),
+	}),
 );
 expectType<string>(
 	stripCssComments('/*# preserved */ body { /* unicorns */color: hotpink; }', {
-		whitespace: false
-	})
+		whitespace: false,
+	}),
 );

index.test-d.ts

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <[email protected]> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

license

@@ -4,13 +4,16 @@
 	"description": "Strip comments from CSS",
 	"license": "MIT",
 	"repository": "sindresorhus/strip-css-comments",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"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",
@@ -34,12 +37,12 @@
 		"string"
 	],
 	"dependencies": {
-		"is-regexp": "^2.1.0"
+		"is-regexp": "^3.0.0"
 	},
 	"devDependencies": {
-		"ava": "^2.4.0",
+		"ava": "^3.15.0",
 		"matcha": "^0.7.0",
-		"tsd": "^0.11.0",
-		"xo": "^0.25.3"
+		"tsd": "^0.17.0",
+		"xo": "^0.44.0"
 	}
 }

package.json

@@ -13,7 +13,7 @@ $ npm install strip-css-comments
 ## Usage
 
 ```js
-const stripCssComments = require('strip-css-comments');
+import stripCssComments from 'strip-css-comments';
 
 // By default important comments `/*!` are preserved
 stripCssComments('/*! <copyright> */ body { /* unicorns */color: hotpink; }');

readme.md

@@ -1,5 +1,5 @@
 import test from 'ava';
-import stripCssComments from '.';
+import stripCssComments from './index.js';
 
 test('main', t => {
 	t.is(stripCssComments('/*//comment*/body{}'), 'body{}');
@@ -27,22 +27,6 @@ test('main', t => {
 	t.is(stripCssComments('body{/*!"\'"\'*/}'), 'body{/*!"\'"\'*/}');
 });
 
-test('`all` option', t => {
-	t.is(stripCssComments('/*!//comment*/body{}', {all: true}), 'body{}');
-	t.is(stripCssComments('/*!//comment*/body{}', {all: true}), 'body{}');
-	t.is(stripCssComments('/*!//"comment*/body{}', {all: true}), 'body{}');
-	t.is(stripCssComments('/*!//\'comment*/body{}', {all: true}), 'body{}');
-	t.is(stripCssComments('body{/*!comment*/}', {all: true}), 'body{}');
-	t.is(stripCssComments('body{/*!\ncomment\n\\*/}', {all: true}), 'body{}');
-	t.is(stripCssComments('body{content: "\'/*!ad*/\' \\""}', {all: true}), 'body{content: "\'/*!ad*/\' \\""}');
-	t.is(stripCssComments('body{\r\n /*!\n\n\n\nfoo*/\n}', {all: true}), 'body{\r\n \n}');
-	t.is(stripCssComments('body/*!foo*/{}', {all: true}), 'body{}');
-	t.is(stripCssComments('body{/*!"*/}/*foo*/', {all: true}), 'body{}');
-	t.is(stripCssComments('body{/*!\'*/}/*foo*/', {all: true}), 'body{}');
-	t.is(stripCssComments('body{/*!"\'\\"*/}', {all: true}), 'body{}');
-	t.is(stripCssComments('body{/*!"\'"\'*/}', {all: true}), 'body{}');
-});
-
 test('`preserve` option', t => {
 	t.is(stripCssComments('/*!//comment*/body{}', {preserve: false}), 'body{}');
 	t.is(stripCssComments('/*!//"comment*/body{}', {preserve: false}), 'body{}');
@@ -66,39 +50,39 @@ test('`preserve` option', t => {
 
 	t.is(
 		stripCssComments('body{/*##foo##*/}', {
-			preserve: comment => comment.startsWith('##foo##')
-		}), 'body{/*##foo##*/}'
+			preserve: comment => comment.startsWith('##foo##'),
+		}), 'body{/*##foo##*/}',
 	);
 
 	t.is(
 		stripCssComments('body{/*foo*/}', {
-			preserve: comment => comment.startsWith('##foo##')
-		}), 'body{}'
+			preserve: comment => comment.startsWith('##foo##'),
+		}), 'body{}',
 	);
 
 	t.is(
 		stripCssComments('body{/*##foo##*//*foo*/}', {
-			preserve: comment => comment.startsWith('##foo##')
-		}), 'body{/*##foo##*/}'
+			preserve: comment => comment.startsWith('##foo##'),
+		}), 'body{/*##foo##*/}',
 	);
 
 	t.is(
 		stripCssComments('body{/*##foo##*//*!foo*/}', {
-			preserve: comment => comment.startsWith('##foo##')
-		}), 'body{/*##foo##*/}'
+			preserve: comment => comment.startsWith('##foo##'),
+		}), 'body{/*##foo##*/}',
 	);
 
 	t.is(
 		stripCssComments('body{/*!##foo##*//*foo*/}', {
-			preserve: comment => comment.startsWith('##foo##')
-		}), 'body{}'
+			preserve: comment => comment.startsWith('##foo##'),
+		}), 'body{}',
 	);
 
 	t.is(
 		stripCssComments('body{/*!##foo*//*foo*/}', {
-			preserve: comment => comment.endsWith('foo')
+			preserve: comment => comment.endsWith('foo'),
 		}),
-		'body{/*!##foo*//*foo*/}'
+		'body{/*!##foo*//*foo*/}',
 	);
 });
 
@@ -113,15 +97,15 @@ test('`whitespace` option', t => {
 
 	t.is(
 		stripCssComments('body{/*!##foo*/\n/*foo*/}', {
-			preserve: comment => comment.endsWith('foo'), whitespace: false
+			preserve: comment => comment.endsWith('foo'), whitespace: false,
 		}),
-		'body{/*!##foo*/\n/*foo*/}'
+		'body{/*!##foo*/\n/*foo*/}',
 	);
 
 	t.is(
 		stripCssComments('body{/*!##foo*/\r\n/*foo*/}', {
-			preserve: comment => comment.endsWith('foo'), whitespace: false
+			preserve: comment => comment.endsWith('foo'), whitespace: false,
 		}),
-		'body{/*!##foo*/\r\n/*foo*/}'
+		'body{/*!##foo*/\r\n/*foo*/}',
 	);
 });