tiny-escape 1.0.0 → 1.0.1

package/README.md

@@ -5,31 +5,19 @@
 [![CI](https://github.com/ofershap/tiny-escape/actions/workflows/ci.yml/badge.svg)](https://github.com/ofershap/tiny-escape/actions/workflows/ci.yml)
 [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue.svg)](https://www.typescriptlang.org/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Bundle size](https://img.shields.io/badge/gzip-201_B-brightgreen)](https://github.com/ofershap/tiny-escape)
-[![Zero dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)](https://github.com/ofershap/tiny-escape)
 
-Escape special characters in a string for use in a regular expression. A modern, type-safe replacement for [`escape-string-regexp`](https://github.com/sindresorhus/escape-string-regexp).
+Escape special characters in a string for use in a regular expression. Same behavior as [`escape-string-regexp`](https://github.com/sindresorhus/escape-string-regexp), but ships both ESM and CJS.
 
 ```ts
 import { escapeRegExp } from "tiny-escape";
 
 const input = "price is $5.00 (USD)";
-const re = new RegExp(escapeRegExp(input));
-re.test(input); // true
+new RegExp(escapeRegExp(input)).test(input); // true
 ```
 
-> Native TypeScript. ESM + CJS dual export. Zero dependencies. 201 bytes gzipped.
+> 201 bytes gzipped. Zero dependencies.
 
-## Why tiny-escape?
-
-[`escape-string-regexp`](https://github.com/sindresorhus/escape-string-regexp) has 163M weekly downloads but hasn't been updated in 3 years. Version 5 went ESM-only, breaking CommonJS consumers and forcing many projects to pin v4. `tiny-escape` ships both ESM and CJS with native TypeScript types.
-
-| | `escape-string-regexp` | `tiny-escape` |
-|---|---|---|
-| CJS support | v4 only (v5 ESM-only) | ESM + CJS |
-| TypeScript | native (v5) | native |
-| Maintenance | inactive (3 years) | active |
-| API | default export | named export |
+![Demo](assets/demo.gif)
 
 ## Install
 
@@ -42,24 +30,23 @@ npm install tiny-escape
 ```ts
 import { escapeRegExp } from "tiny-escape";
 
-escapeRegExp("hello.world");           // "hello\\.world"
-escapeRegExp("[test] (1+1)");          // "\\[test\\] \\(1\\+1\\)"
-escapeRegExp("foo|bar");               // "foo\\|bar"
-escapeRegExp("a-b");                   // "a\\x2db"
+escapeRegExp("hello.world"); // "hello\\.world"
+escapeRegExp("[test] (1+1)"); // "\\[test\\] \\(1\\+1\\)"
+escapeRegExp("foo|bar"); // "foo\\|bar"
+escapeRegExp("a-b"); // "a\\x2db"
 
-// Use in RegExp constructor
 const userInput = "How much $ for mass?";
 const re = new RegExp(escapeRegExp(userInput), "i");
 re.test(userInput); // true
 ```
 
-## API
+## Differences from `escape-string-regexp`
 
-### `escapeRegExp(string: string): string`
-
-Escapes all characters with special meaning in regular expressions: `| \ { } ( ) [ ] ^ $ + * ? .` and `-`.
-
-Throws `TypeError` if the input is not a string.
+|             | `escape-string-regexp` | `tiny-escape` |
+| ----------- | ---------------------- | ------------- |
+| CJS support | v4 only (v5 ESM-only)  | ESM + CJS     |
+| TypeScript  | native (v5)            | native        |
+| Export      | default                | named         |
 
 ## Migrating from escape-string-regexp
 
@@ -70,6 +57,14 @@ Throws `TypeError` if the input is not a string.
 + const escaped = escapeRegExp(input);
 ```
 
+## API
+
+### `escapeRegExp(string: string): string`
+
+Escapes `| \ { } ( ) [ ] ^ $ + * ? .` and `-`.
+
+Throws `TypeError` if the input is not a string.
+
 ## Author
 
 [![Made by ofershap](https://gitshow.dev/api/card/ofershap)](https://gitshow.dev/ofershap)
@@ -79,4 +74,4 @@ Throws `TypeError` if the input is not a string.
 
 ## License
 
-MIT
+[MIT](LICENSE) © [Ofer Shapira](https://github.com/ofershap)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tiny-escape",
-  "version": "1.0.0",
-  "description": "Modern escape-string-regexp replacement — escape special regex characters. TypeScript, ESM + CJS, zero dependencies, ~120B.",
+  "version": "1.0.1",
+  "description": "Escape special characters for use in regular expressions. Like escape-string-regexp, ships ESM + CJS.",
   "type": "module",
   "exports": {
     ".": {
@@ -18,7 +18,9 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsup",
     "typecheck": "tsc --noEmit",
@@ -30,24 +32,49 @@
     "prepare": "husky"
   },
   "lint-staged": {
-    "*.{ts,js}": ["eslint --fix", "prettier --write"],
-    "*.{json,md,yml,yaml}": ["prettier --write"]
+    "*.{ts,js}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
   },
   "release": {
-    "branches": ["main"],
+    "branches": [
+      "main"
+    ],
     "plugins": [
       "@semantic-release/commit-analyzer",
       "@semantic-release/release-notes-generator",
       "@semantic-release/changelog",
       "@semantic-release/npm",
       "@semantic-release/github",
-      ["@semantic-release/git", {
-        "assets": ["CHANGELOG.md", "package.json"],
-        "message": "chore(release): ${nextRelease.version} [skip ci]"
-      }]
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "CHANGELOG.md",
+            "package.json"
+          ],
+          "message": "chore(release): ${nextRelease.version} [skip ci]"
+        }
+      ]
     ]
   },
-  "keywords": ["escape", "regex", "regexp", "regular-expression", "string", "sanitize", "tiny", "typescript", "esm", "zero-dependency"],
+  "keywords": [
+    "escape",
+    "regex",
+    "regexp",
+    "regular-expression",
+    "escape-string-regexp",
+    "string",
+    "sanitize",
+    "drop-in-replacement",
+    "typescript",
+    "esm",
+    "zero-dependency"
+  ],
   "author": "Ofer Shapira <ofer@ofershap.dev>",
   "license": "MIT",
   "repository": {