feat: first commit 🎉

Author: mesqueeb

.github/SPONSORS.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: mesqueeb
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Test
+on:
+  push:
+    branches: main
+    paths:
+      - src/**
+      - test/**
+      - '*.js'
+      - '*.ts'
+      - '*.json'
+      - .github/workflows/test.yml
+  pull_request:
+    branches: main
+    paths:
+      - src/**
+      - test/**
+      - '*.js'
+      - '*.ts'
+      - '*.json'
+      - .github/workflows/test.yml
+concurrency:
+  group: test-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  test:
+    strategy:
+      matrix:
+        node-version: ['18', '20']
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+      - run: npm ci
+      - run: npm test

.prettierrc.js

@@ -0,0 +1,3 @@
+import prettier from "@cycraft/eslint/prettier"
+
+export default prettier

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.tabSize": 2,
+  "editor.insertSpaces": true,
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+  "files.trimTrailingWhitespace": true,
+  "javascript.preferences.importModuleSpecifierEnding": "js",
+  "typescript.preferences.importModuleSpecifierEnding": "js"
+}

README.md

@@ -1,2 +1,87 @@
-# replace-regex
-📂 TS compatible modern nodeJS find-and-replace in files with Regex & Glob support
+# replace-regex 📂
+
+<a href="https://www.npmjs.com/package/replace-regex"><img src="https://img.shields.io/npm/v/replace-regex.svg" alt="Total Downloads"></a>
+<a href="https://www.npmjs.com/package/replace-regex"><img src="https://img.shields.io/npm/dw/replace-regex.svg" alt="Latest Stable Version"></a>
+
+📂 TS compatible modern nodeJS find-and-replace in files with Regex & Glob support.
+
+```
+npm i replace-regex
+```
+
+## Features
+
+- **Glob Support**: Use glob patterns to specify files.
+- **Regex Support**: Replace text using regular expressions.
+- **Dry Run**: Preview changes without modifying files.
+- **Counts**: Count matches and replacements.
+- **Customizable**: Pass custom options to fine-tune behavior.
+
+## Usage
+
+### Basic Usage
+
+```ts
+import { replaceRegex } from 'replace-regex'
+
+const results = await replaceRegex({
+  files: 'src/**/*.js',
+  from: /foo/g,
+  to: 'bar',
+  dry: false,
+  countMatches: true,
+})
+
+console.log(results)
+```
+
+### Options
+
+- `files` (string or string[]): Glob patterns or file paths to process.
+- `from` (string | RegExp | (file: string) => string | RegExp): The pattern to search for.
+- `to` (string | (match: string, file: string) => string): The replacement string or function.
+- `dry` (boolean, optional): If true, no files will be overwritten. Default is `false`.
+- `ignore` (string[], optional): An array of glob patterns to exclude matches.
+- `disableGlobs` (boolean, optional): If true, disables glob pattern matching. Default is `false`.
+- `fastGlobOptions` (object, optional): Options to pass to fast-glob.
+- `countMatches` (boolean, optional): If true, counts the number of matches and replacements. Default is `false`.
+
+### Examples
+
+**Replace text in JavaScript files**
+
+```ts
+replaceRegex({
+  files: 'src/**/*.js',
+  from: /console\.log/g,
+  to: 'logger.log',
+  dry: false,
+  countMatches: true,
+})
+```
+
+**Dry Run**
+
+```ts
+const result = await replaceRegex({
+  files: 'src/**/*.js',
+  from: /foo/g,
+  to: 'bar',
+  dry: true, // No files will be overwritten
+  countMatches: true,
+})
+
+console.log(`result → `, result)
+```
+
+**Custom Replacement Function**
+
+```ts
+replaceRegex({
+  files: 'src/**/*.js',
+  from: /foo/g,
+  to: (match, file) => `${match.toUpperCase()} in ${file}`,
+  dry: false,
+  countMatches: true,
+})
+```

eslint.config.js

@@ -0,0 +1,3 @@
+import config from '@cycraft/eslint/config'
+
+export default config