Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/revert semantic plugins #14

Merged
merged 4 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

## Description

A case-insensitive accent folding functions to replace accented characters with their unaccented equivalents
A case-insensitive accent folding functions to replace accented characters with their unaccented equivalents
or hightlight matched terms in a string, ignoring accents.



## Installation

Install with npm:
Expand All @@ -30,12 +28,13 @@ yarn add accent-folding
## Public Methods

### `replace`

Replaces accented characters in a string with their unaccented equivalents.

#### Key Features:
- Handles various Unicode characters, including fullwidth ASCII
- Preserves original string formatting in the output

- Handles various Unicode characters, including fullwidth ASCII
- Preserves original string formatting in the output

```js
import AccentFolding from 'accent-folding';
Expand All @@ -46,6 +45,7 @@ af.replace('Fulanilo López'); // --> "Fulanilo Lopez"
```

### `highlightMatch`

Highlights matched terms in a string, ignoring accents.

#### Key Features:
Expand All @@ -61,7 +61,6 @@ Highlights matched terms in a string, ignoring accents.
- Search functionality in applications where accents should be ignored
- Highlighting matched terms in search results


```js
import AccentFolding from 'accent-folding';

Expand Down
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@
"homepage": "https://github.com/zr87/accent-folding#readme",
"devDependencies": {
"@eslint/js": "^9.9.0",
"@semantic-release/changelog": "^6.0.3",
"@semantic-release/git": "^10.0.1",
"@vitest/coverage-v8": "^2.0.5",
"eslint": "^9.9.0",
"eslint-config-prettier": "^9.1.0",
Expand Down
Loading